Support TRAMP connections

Fixes #552

Author: vemv

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.10.0
+
+* [#552](https://github.com/clojure-emacs/clj-refactor.el/issues/552): support TRAMP connections.
+
 ## 3.9.4
 
 * Fix `cljr-version`.

clj-refactor.el

@@ -7,10 +7,10 @@
 ;;         Lars Andersen <[email protected]>
 ;;         Benedek Fazekas <[email protected]>
 ;;         Bozhidar Batsov <[email protected]>
-;; Version: 3.9.4
+;; Version: 3.10.0
 ;; Keywords: convenience, clojure, cider
 
-;; Package-Requires: ((emacs "26.1") (seq "2.19") (yasnippet "0.6.1") (paredit "24") (multiple-cursors "1.2.2") (clojure-mode "5.16.1") (cider "1.7.0") (parseedn "1.1.0") (inflections "2.6") (hydra "0.13.2"))
+;; Package-Requires: ((emacs "26.1") (seq "2.19") (yasnippet "0.6.1") (paredit "24") (multiple-cursors "1.2.2") (clojure-mode "5.17.0") (cider "1.7.0") (parseedn "1.1.0") (inflections "2.6") (hydra "0.13.2"))
 
 ;; This program is free software; you can redistribute it and/or
 ;; modify it under the terms of the GNU General Public License
@@ -746,26 +746,43 @@ if the point is currently placed at the opening parentheses of an anonymous func
   ;; evenp lives in cl.el...
   (zerop (mod n 2)))
 
+(defun cljr--remove-tramp-prefix-from-msg (entry)
+  (let* ((k (car entry))
+         (v (cadr entry)))
+    (list k
+          (if (and (member k '("file" "dir" "path" "old-path" "new-path"))
+                   (stringp v))
+              (if-let* ((p (cider-tramp-prefix)))
+                  (string-remove-prefix p v)
+                v)
+            v))))
+
 (defun cljr--create-msg (op &rest kvs)
   "Create a msg for the middleware for OP and optionally include the kv pairs KVS.
 
 All config settings are included in the created msg."
   (cl-assert (cljr--evenp (length kvs)) nil "Can't create msg to send to the middleware.\
   Received an uneven number of kv pairs: %s " kvs)
-  (apply #'list "op" op
+  (apply #'list
+         "op" op
+
          "prefix-rewriting"
          (if cljr-favor-prefix-notation
              "true"
            "false")
+
          "insert-newline-after-require"
          (if cljr-insert-newline-after-require
              "true"
            "false")
+
          "debug"
          (if cljr--debug-mode
              "true"
            "false")
-         kvs))
+
+         (seq-mapcat #'cljr--remove-tramp-prefix-from-msg
+                     (seq-partition kvs 2))))
 
 (defun cljr--post-command-message (format-string &rest args)
   "Display msg in a post command hook, to ensure it doesn't drown in emacs' general chatter."
@@ -2709,8 +2726,14 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-promote-function
   (string-remove-prefix (cljr--project-dir) path))
 
 (defun cljr--get-valid-filename (hash)
-  "Get :file value from the hash table and convert path if necessary."
-  (funcall cider-from-nrepl-filename-function (gethash :file hash)))
+  "Get :file value from the hash table and convert path if necessary.
+
+Translate it back to TRAMP notation if needed."
+  (let ((file (funcall cider-from-nrepl-filename-function (gethash :file hash)))
+        (current (funcall cider-from-nrepl-filename-function (buffer-file-name))))
+    (if (tramp-tramp-file-p current)
+        (concat (cider-tramp-prefix) file)
+      file)))
 
 (defun cljr--format-symbol-occurrence (occurrence)
   (let ((file (cljr--get-valid-filename occurrence))
@@ -3429,7 +3452,7 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-inline-symbol"
             (cljr--post-command-message "No occurrences of '%s' found.  Deleted the definition." symbol)))))
     (cljr--indent-defun)))
 
-(defconst cljr-version "3.9.4"
+(defconst cljr-version "3.10.0"
   "The current version of clj-refactor.")
 
 (defun cljr--pkg-version ()

tests/unit-test.el

@@ -18,6 +18,14 @@
      (delay-mode-hooks (clojure-mode))
      ,@body))
 
+(defmacro with-point-at (text &rest body)
+  (declare (indent 1))
+  `(progn (insert ,text)
+          (goto-char (point-min))
+          (re-search-forward "|")
+          (delete-char -1)
+          ,@body))
+
 (describe "cljr--insert-require-libspec"
   :var (after-inserting-a
         after-inserting-b)
@@ -170,14 +178,6 @@
       (expect (cljr--unresolved-alias-ref "js")
               :to-equal "js"))))
 
-(defmacro with-point-at (text &rest body)
-  (declare (indent 1))
-  `(progn (insert ,text)
-          (goto-char (point-min))
-          (re-search-forward "|")
-          (delete-char -1)
-          ,@body))
-
 (describe "cljr--language-context-at-point"
   (it "identifies a clj file"
     (cljr--with-clojure-temp-file "foo.clj"
@@ -396,3 +396,14 @@ ex/")))
       (expect (buffer-string) :to-equal "(ns foo
   (:require [baz.example :as ex :refer [a b c] ]))
 ex/"))))
+
+(describe "cljr--remove-tramp-prefix-from-msg"
+  (it "Removes the tramp prefix from specifc nrepl message attributes"
+    (with-temp-buffer
+      (setq buffer-file-name "/ssh:[email protected]#22:a.clj")
+      (let* ((v (seq-mapcat #'cljr--remove-tramp-prefix-from-msg
+                            (seq-partition (list "file" "/ssh:[email protected]#22:a.clj"
+                                                 "something" "else")
+                                           2))))
+        (setq-local tramp-mode nil) ;; prevent hanging
+        (expect v :to-equal '("file" "a.clj" "something" "else"))))))