[Fix #415] add and hot-load dependencies for deps.edn

Projects using deps.edn, instead of leiningen or boot, for dependency management now have the ability to add and hotload project dependencies.

Author: mbuczko

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- [#415](https://github.com/clojure-emacs/clj-refactor.el/issues/415) Support for deps.edn - based projects
 - [#394](https://github.com/clojure-emacs/clj-refactor.el/issues/394) New config option `cljr-assume-language-context`: by default, when clj-refactor encounters an ambiguous context (clj vs cljs) it creates a popup asking user which context is meant. If this option is changed to "clj" or "cljs", clj-refactor will use that as the assumed context in such ambigous cases.
 - [#391](https://github.com/clojure-emacs/clj-refactor.el/issues/391) Prevent refactor-nrepl from being injected when starting a REPL outside a project, and add an option `cljr-suppress-outside-project-warning` to suppress the resultant warning.
 

clj-refactor.el

@@ -315,6 +315,9 @@ Otherwise open the file and do the changes non-interactively."
   (and cljr-use-multiple-cursors
        (not (bound-and-true-p evil-mode))))
 
+(defun cljr--vector-at-point-p ()
+  (eq (char-after) ?\[))
+
 (defun cljr--fix-special-modifier-combinations (key)
   (cl-case key
     ("C-s-i" "s-TAB")
@@ -570,8 +573,12 @@ errors."
   (join-line)
   (paredit-forward-delete 1))
 
-(defun cljr--looking-at-dependency-vector-p ()
-  (looking-at "\\[[^[[:space:]]+[[:space:]]+\""))
+(defun cljr--looking-at-dependency-p ()
+  (or
+   ;; boot & leiningen dependency vector
+   (looking-at "\\[[^[[:space:]]+[[:space:]]+\"")
+   ;; clj dependency style
+   (looking-at "\\([a-z0-9\-\./]+\\)[[:space:]]*\{.*\\(:mvn\\|:local\\|:git\\)/\\(root\\|version\\|url\\)[[:space:]]+\\(\"[^\"]+\"\\)")))
 
 (defun cljr--just-one-blank-line ()
   "Ensure there's only one blank line at POINT."
@@ -787,7 +794,7 @@ A new record is created to define this constructor."
 
 (defun cljr--project-dir ()
   (or
-   (thread-last  '("project.clj" "build.boot" "pom.xml")
+   (thread-last  '("project.clj" "build.boot" "pom.xml" "deps.edn")
      (mapcar 'cljr--locate-project-file)
      (delete 'nil)
      car)
@@ -804,6 +811,8 @@ A new record is created to define this constructor."
         (let ((file (expand-file-name "build.boot" project-dir)))
           (and (file-exists-p file) file))
         (let ((file (expand-file-name "pom.xml" project-dir)))
+          (and (file-exists-p file) file))
+        (let ((file (expand-file-name "deps.edn" project-dir)))
           (and (file-exists-p file) file)))))
 
 (defun cljr--project-files ()
@@ -815,6 +824,9 @@ A new record is created to define this constructor."
                          "-not -regex \".*svn.*\""
                          1000))))
 
+(defun cljr--project-with-deps-p (project-file)
+  (string-match "/deps.edn$" project-file))
+
 (defun cljr--buffers-visiting-dir (dir)
   (seq-filter (lambda (buf)
                 (when-let (path (buffer-file-name buf))
@@ -1979,7 +1991,7 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-project-clean"
     (cljr--post-command-message "Project clean done.")))
 
 (defun cljr--extract-dependency-name ()
-  (cl-assert (cljr--looking-at-dependency-vector-p))
+  (cl-assert (cljr--looking-at-dependency-p))
   (forward-char)
   (prog1
       (buffer-substring-no-properties
@@ -1998,9 +2010,9 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-project-clean"
 
 (defun cljr--extract-next-dependency-name ()
   (while (not (or (cljr--empty-buffer-p)
-                  (cljr--looking-at-dependency-vector-p)))
+                  (cljr--looking-at-dependency-p)))
     (delete-char 1))
-  (when (cljr--looking-at-dependency-vector-p)
+  (when (cljr--looking-at-dependency-p)
     (cljr--extract-dependency-name)))
 
 (defun cljr--get-sorted-dependency-names (deps)
@@ -2074,19 +2086,22 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-project-clean"
 
 See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-sort-project-dependencies"
   (interactive)
-  (cljr--update-file (cljr--project-file)
-    (goto-char (point-min))
-    (while (re-search-forward ":dependencies" (point-max) t)
-      (forward-char)
-      (thread-first (buffer-substring-no-properties (point)
-                                                    (cljr--point-after 'paredit-forward))
-        cljr--get-sorted-dependency-names
-        (cljr--sort-dependency-vectors (thread-last (clojure-delete-and-extract-sexp)
-                                         (string-remove-prefix "[")
-                                         (string-remove-suffix "]")))
-        insert))
-    (indent-region (point-min) (point-max))
-    (save-buffer)))
+  (let ((project-file (cljr--project-file)))
+    (if (cljr--project-with-deps-p project-file)
+        (user-error "Dependencies sorting not supported in deps.edn yet.")
+      (cljr--update-file project-file
+        (goto-char (point-min))
+        (while (re-search-forward ":dependencies" (point-max) t)
+          (forward-char)
+          (thread-first (buffer-substring-no-properties (point)
+                                                        (cljr--point-after 'paredit-forward))
+            cljr--get-sorted-dependency-names
+            (cljr--sort-dependency-vectors (thread-last (clojure-delete-and-extract-sexp)
+                                             (string-remove-prefix "[")
+                                             (string-remove-suffix "]")))
+            insert))
+        (indent-region (point-min) (point-max))
+        (save-buffer)))))
 
 (defun cljr--call-middleware-sync (request &optional key)
   "Call the middleware with REQUEST.
@@ -2182,18 +2197,34 @@ possible choices. If the choice is trivial, return it."
         (completing-read prompt choices nil nil nil nil (car choices)))
     (read-from-minibuffer prompt)))
 
+(defun cljr--insert-into-leiningen-dependencies (artifact version)
+  (re-search-forward ":dependencies")
+  (paredit-forward)
+  (paredit-backward-down)
+  (newline-and-indent)
+  (insert "[" artifact " \"" version "\"]"))
+
+(defun cljr--insert-into-clj-dependencies (artifact version)
+  (re-search-forward ":deps")
+  (forward-sexp)
+  (backward-char)
+  (newline-and-indent)
+  (insert artifact " {:mvn/version \"" version "\"}"))
+
 (defun cljr--add-project-dependency (artifact version)
-  (cljr--update-file (cljr--project-file)
-    (goto-char (point-min))
-    (re-search-forward ":dependencies")
-    (paredit-forward)
-    (paredit-backward-down)
-    (newline-and-indent)
-    (insert "[" artifact " \"" version "\"]")
-    (cljr--post-command-message "Added %s version %s as a project dependency" artifact version)
-    (when cljr-hotload-dependencies
-      (paredit-backward-down)
-      (cljr-hotload-dependency))))
+  (let* ((project-file (cljr--project-file))
+         (deps (cljr--project-with-deps-p project-file)))
+    (cljr--update-file project-file
+      (goto-char (point-min))
+      (if deps
+          (cljr--insert-into-clj-dependencies artifact version)
+        (cljr--insert-into-leiningen-dependencies artifact version))
+      (cljr--post-command-message "Added %s version %s as a project dependency" artifact version)
+      (when cljr-hotload-dependencies
+        (if deps
+            (back-to-indentation)
+          (paredit-backward-down))
+        (cljr-hotload-dependency)))))
 
 ;;;###autoload
 (defun cljr-add-project-dependency (force)
@@ -2209,22 +2240,27 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-add-project-depe
     (cljr--add-project-dependency lib-name version)))
 
 ;;;###autoload
-(defun cljr-update-project-dependency ()
+(defun cljr-update-project-dependency (&optional version)
   "Update the version of the dependency at point."
   (interactive)
   (cljr--ensure-op-supported "artifact-list")
-  (unless (cljr--looking-at-dependency-vector-p)
-    (user-error "Place cursor in front of dependency vector to update."))
+  (unless (cljr--looking-at-dependency-p)
+    (user-error "Place cursor in front of dependency to update."))
   (save-excursion
-    (let (lib-name)
-      (paredit-forward-down)
+    (let (lib-name
+          (lein-style (cljr--vector-at-point-p)))
+      (if lein-style
+          (paredit-forward-down))
       (setq lib-name (cljr--extract-sexp))
       (paredit-forward)
       (skip-syntax-forward " ")
-      (let ((version (thread-last (cljr--get-versions-from-middleware lib-name)
-                       (cljr--prompt-user-for (concat lib-name " version: ")))))
+      (let ((artifact-version (or version
+                                  (thread-last (cljr--get-versions-from-middleware lib-name)
+                                    (cljr--prompt-user-for (concat lib-name " version: "))))))
         (cljr--delete-sexp)
-        (insert "\"" version "\""))))
+        (if lein-style
+            (insert "\"" artifact-version "\"")
+          (insert "\{:mvn/version \"" artifact-version "\"\}")))))
   (when cljr-hotload-dependencies
     (cljr-hotload-dependency)
     (cljr--ensure-op-supported "artifact-list")))
@@ -2236,19 +2272,25 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-add-project-depe
 See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-update-project-dependencies"
   (interactive)
   (cljr--ensure-op-supported "artifact-list")
-  (find-file (cljr--project-file))
-  (goto-char (point-min))
-  (let (cljr-hotload-dependencies)
-    (while (re-search-forward ":dependencies" (point-max) t)
-      (paredit-forward-down)
-      (cljr--skip-past-whitespace-and-comments)
-      (while (not (looking-at "]"))
-        (let ((highlight (cljr--highlight-sexp)))
-          (unwind-protect
-              (cljr-update-project-dependency)
-            (delete-overlay highlight)))
-        (paredit-forward)
-        (cljr--skip-past-whitespace-and-comments)))))
+  (let ((project-file (cljr--project-file)))
+    (find-file project-file)
+    (goto-char (point-min))
+    (let (cljr-hotload-dependencies)
+      (if (cljr--project-with-deps-p project-file)
+          (cljr--update-dependencies ":deps" "}" 2)
+        (cljr--update-dependencies ":dependencies" "]" 1)))))
+
+(defun cljr--update-dependencies (keyword dependency-closing-brace forward-count)
+  (while (re-search-forward keyword (point-max) t)
+    (paredit-forward-down)
+    (cljr--skip-past-whitespace-and-comments)
+    (while (not (looking-at dependency-closing-brace))
+      (let ((highlight (cljr--highlight-sexp)))
+        (unwind-protect
+            (cljr-update-project-dependency)
+          (delete-overlay highlight)))
+      (paredit-forward forward-count)
+      (cljr--skip-past-whitespace-and-comments))))
 
 (defun cljr--skip-past-whitespace-and-comments ()
   (skip-syntax-forward " >")
@@ -2844,13 +2886,25 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-add-missing-libs
   (cljr--maybe-clean-ns)
   (cljr--maybe-eval-ns-form))
 
-(defun cljr--dependency-vector-at-point ()
+(defun cljr--dependency-at-point ()
+  "Returns project dependency at point.
+
+Recognizes both leiningen- and deps.edn-style dependencies, but the latter is always
+transformed back to leiningen dependency vector which is what nrepl backend
+expects for hot-loading."
   (save-excursion
     (ignore-errors
-      (while (not (cljr--looking-at-dependency-vector-p))
+      (while (not (cljr--looking-at-dependency-p))
         (paredit-backward-up))
-      (buffer-substring-no-properties (point)
-                                      (cljr--point-after 'paredit-forward)))))
+
+      (if (cljr--vector-at-point-p)
+          (buffer-substring-no-properties (point)
+                                          (cljr--point-after 'paredit-forward))
+        (concat "["
+                (match-string-no-properties 1)
+                " "
+                (match-string-no-properties 4)
+                "]")))))
 
 (defun cljr--hotload-dependency-callback (response)
   (cljr--maybe-rethrow-error response)
@@ -2866,10 +2920,11 @@ See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-add-missing-libs
   (with-temp-buffer
     (insert string)
     (goto-char (point-min))
-    (cl-assert (cljr--looking-at-dependency-vector-p) nil
+    (cl-assert (cljr--looking-at-dependency-p) nil
                (format
                 (concat "Expected dependency vector of type "
-                        "[org.clojure \"1.7.0\"], but got '%s'")
+                        "[org.clojure \"1.7.0\"] or "
+                        "org.clojure {:mvn/version \"1.7.0\"}, but got '%s'")
                 string)))
   string)
 
@@ -2882,8 +2937,9 @@ Defaults to the dependency vector at point, but prompts if none is found.
 See: https://github.com/clojure-emacs/clj-refactor.el/wiki/cljr-hotload-dependency"
   (interactive)
   (cljr--ensure-op-supported "hotload-dependency")
-  (let ((dependency-vector (or (cljr--dependency-vector-at-point)
+  (let ((dependency-vector (or (cljr--dependency-at-point)
                                (cljr--prompt-user-for "Dependency vector: "))))
+
     (cljr--assert-dependency-vector dependency-vector)
     (cljr--call-middleware-async
      (cljr--create-msg "hotload-dependency" "coordinates" dependency-vector)

features/add-or-update-dependency-in-clj-project.feature

@@ -0,0 +1,23 @@
+Feature: Add or update dependency in clj project
+
+  Background:
+    Given I have a clj project with dependencies "cljr" in "tmp"
+    And I open file "tmp/deps.edn"
+
+  Scenario: New dependency is added
+    When I add dependency artifact "org.clojure/tools.namespace" with version "0.3.0-alpha4"
+    Then I should see:
+    """
+    {:paths ["src" "resources"]
+     :deps {org.clojure/clojure {:mvn/version "1.9.0"}
+            org.clojure/tools.namespace {:mvn/version "0.3.0-alpha4"}}}
+    """
+
+  Scenario: Existing dependency is updated
+    When I locate dependency artifact "org.clojure/clojure"
+    And I update artifact version to "1.9.1"
+    Then I should see:
+    """
+    {:paths ["src" "resources"]
+     :deps {org.clojure/clojure {:mvn/version "1.9.1"}}}
+    """

features/add-or-update-dependency-in-leiningen-project.feature

@@ -0,0 +1,23 @@
+Feature: Add or update dependency in leiningen project
+
+  Background:
+    Given I have a leiningen project with dependencies "cljr" in "tmp"
+    And I open file "tmp/project.clj"
+
+  Scenario: New dependency is added
+    When I add dependency artifact "org.clojure/tools.namespace" with version "0.3.0-alpha4"
+    Then I should see:
+    """
+    (defproject cljr "0.1.0-SNAPSHOT"
+      :dependencies [[org.clojure/clojure "1.9.0"]
+                     [org.clojure/tools.namespace "0.3.0-alpha4"]])
+    """
+
+  Scenario: Existing dependency is updated
+    When I locate dependency artifact "org.clojure/clojure"
+    And I update artifact version to "1.9.1"
+    Then I should see:
+    """
+    (defproject cljr "0.1.0-SNAPSHOT"
+      :dependencies [[org.clojure/clojure "1.9.1"]])
+    """

features/step-definitions/clj-refactor-steps.el

@@ -21,6 +21,30 @@
          (with-temp-file (expand-file-name "project.clj" dir-name)
            (insert "(defproject " project-name " \"0.1.0-SNAPSHOT\")"))))
 
+(Given "^I have a \\(clj\\|leiningen\\) project with dependencies \"\\([^\"]+\\)\" in \"\\([^\"]+\\)\"$"
+       (lambda (project-type project-name dir-name)
+         (setq default-directory clj-refactor-root-path)
+
+         ;; delete old directory
+         (when (file-exists-p dir-name)
+           (delete-directory dir-name t))
+
+         ;; create directory structure
+         (mkdir (expand-file-name project-name (expand-file-name "src" dir-name)) t)
+         (mkdir (expand-file-name project-name (expand-file-name "test" dir-name)) t)
+
+         (cond
+
+          ;; add project.clj
+          ((string= project-type "leiningen")
+           (with-temp-file (expand-file-name "project.clj" dir-name)
+             (insert "(defproject " project-name " \"0.1.0-SNAPSHOT\"\n  :dependencies [[org.clojure/clojure \"1.9.0\"]])")))
+
+          ;; add deps.edn
+          ((string= project-type "clj")
+           (with-temp-file (expand-file-name "deps.edn" dir-name)
+             (insert "{:paths [\"src\" \"resources\"]\n :deps {org.clojure/clojure {:mvn/version \"1.9.0\"}}}"))))))
+
 (Given "^I have a clojure-file \"\\([^\"]+\\)\"$"
        (lambda (file-name)
          (setq default-directory clj-refactor-root-path)
@@ -483,3 +507,20 @@ pprint (cljs.pprint)}}"))))
 (And "^I disable cljr-clean-ns$"
      (lambda ()
        (defun cljr-clean-ns ()(interactive))))
+
+(When "^I add dependency artifact \"\\([^ ]+\\)\" with version \"\\([^\"]+\\)\"$"
+  (lambda (artifact version)
+    (setq cljr-hotload-dependencies nil)
+    (cljr--add-project-dependency artifact version)))
+
+(When "^I locate dependency artifact \"\\([^ ]+\\)\"$"
+  (lambda (artifact)
+    (goto-char (point-min))
+    (re-search-forward artifact)
+    (cljr--dependency-at-point)
+    (goto-char
+     (match-beginning 0))))
+
+(And "^I update artifact version to \"\\([^\"]+\\)\"$"
+  (lambda (version)
+    (cljr-update-project-dependency version)))