Merge pull request #3228 from ajoberstar/gradle-inject

Support injecting dependencies into Gradle

Author: vemv

CHANGELOG.md

@@ -7,6 +7,7 @@
 - [#3226](https://github.com/clojure-emacs/cider/pull/3226): Populate completions metadata, making it possible to change the style of completion via `completion-category-override` or `completion-category-defaults`.
 - [#2946](https://github.com/clojure-emacs/cider/issues/2946): Add custom var `cider-merge-sessions` to allow combining sessions in two different ways: Setting `cider-merge-sessions` to `'host` will merge all sessions associated with the same host within a project. Setting it to `'project` will combine all sessions of a project irrespective of their host.
 - Support Gradle jack-in via the Gradle wrapper, instead of just a globally installed `gradle` on the `PATH`.
+- Gradle projects can now inject dependencies and middleware as with other build tools (dependency injection requires [Clojurephant](https://github.com/clojurephant/clojurephant) 0.7.0-alpha.6 or higher)
 
 ## Changes
 

cider.el

@@ -577,6 +577,49 @@ and MIDDLEWARES.  PARAMS and MIDDLEWARES are passed on to
           (cider-boot-dependencies (append (cider--jack-in-required-dependencies) dependencies))
           (cider-boot-middleware-task params middlewares)))
 
+(defun cider--gradle-dependency-notation (dependency)
+  "Returns Gradle's GAV dependency syntax.
+For a \"group/artifact\" \"version\") DEPENDENCY list
+return as group:artifact:version notation."
+  (let ((group-artifact (replace-regexp-in-string "/" ":" (car dependency)))
+        (version (cadr dependency)))
+    (format "%s:%s" group-artifact version)))
+
+(defun cider--gradle-jack-in-property (dependencies)
+  "Returns Clojurephant's dependency jack-in property.
+For DEPENDENCIES, translates to Gradle's dependency notation
+using `cider--gradle-dependency-notation`.''"
+  (if (seq-empty-p dependencies)
+      ""
+    (shell-quote-argument
+     (concat "-Pdev.clojurephant.jack-in.nrepl="
+             (mapconcat #'cider--gradle-dependency-notation dependencies ",")))))
+
+(defun cider--gradle-middleware-params (middlewares)
+  "Returns Gradle-formatted middleware params.
+Given a list of MIDDLEWARES symbols, this returns
+the Gradle parameters expected by Clojurephant's
+ClojureNRepl task."
+  (mapconcat (lambda (middleware)
+               (shell-quote-argument (concat "--middleware=" middleware)))
+             middlewares
+             " "))
+
+(defun cider-gradle-jack-in-dependencies (global-opts params dependencies middlewares)
+  "Create gradle jack in dependencies.
+Does so by concatenating GLOBAL-OPTS, DEPENDENCIES,
+and MIDDLEWARES.  GLOBAL-OPTS and PARAMS are taken as-is.
+DEPENDENCIES are translated into Gradle's typical
+group:artifact:version notation and MIDDLEWARES are
+prepared as arguments to Clojurephant's ClojureNRepl task."
+  (concat global-opts
+          (unless (seq-empty-p global-opts) " ")
+          (cider--gradle-jack-in-property (append (cider--jack-in-required-dependencies) dependencies))
+          " "
+          params
+          (unless (seq-empty-p params) " ")
+          (cider--gradle-middleware-params middlewares)))
+
 (defun cider--lein-artifact-exclusions (exclusions)
   "Return an exclusions vector described by the elements of EXCLUSIONS."
   (if exclusions
@@ -717,10 +760,12 @@ dependencies."
                    params
                    (cider-add-clojure-dependencies-maybe
                     cider-jack-in-dependencies)))
-    ('gradle (concat
+    ('gradle (cider-gradle-jack-in-dependencies
               global-opts
-              (unless (seq-empty-p global-opts) " ")
-              params))
+              params
+              (cider-add-clojure-dependencies-maybe
+               cider-jack-in-dependencies)
+              (cider-jack-in-normalized-nrepl-middlewares)))
     (_ (error "Unsupported project type `%S'" project-type))))
 
 

doc/modules/ROOT/pages/basics/middleware_setup.adoc

@@ -12,7 +12,8 @@ automatically injects this middleware and other dependencies as required.
 NOTE: In the past, if you were setting up CIDER, you might have had to
 modify `profiles.clj` or `profile.boot`. CIDER now handles
 everything automatically and you don't need to add anything
-special to these files. The same is true of your `deps.edn` file.
+special to these files. The same is true of your `deps.edn` file and
+your `build.gradle` (as of Clojurephant 0.7.0-alpha.6).
 
 If you prefer a standalone REPL, you will need to invoke
 `cider-connect` instead of `cider-jack-in` and manually add the
@@ -45,7 +46,7 @@ A minimal `profiles.clj` for CIDER would be:
 
 [source,clojure]
 ----
-{:repl {:plugins [[cider/cider-nrepl "0.28.4"]
+{:repl {:plugins [[cider/cider-nrepl "0.28.5"]
                   [mx.cider/enrich-classpath "1.9.0"]]}}
 ----
 
@@ -95,7 +96,24 @@ run `cider-connect` or `cider-connect-cljs`.
 
 === Using Gradle
 
-NOTE: This section is currently a stub. Contributions welcome!
+NOTE: Make sure you're using https://github.com/clojurephant/clojurephant[Clojurephant] 0.4.0 or newer.
+
+.build.gradle
+[source, groovy]
+----
+dependencies {
+  devImplementation 'nrepl:nrepl:0.9.0'
+  devImplementation 'cider:cider-nrepl:0.28.5'
+}
+
+tasks.named('clojureRepl') {
+  middleware = ['cider.nrepl/cider-middleware']
+}
+----
+
+You can then launch the nREPL server from the command line via: `./gradlew clojureRepl`.
+
+For more information, see the https://clojurephant.dev[Clojurephant docs].
 
 === Using Maven
 

doc/modules/ROOT/pages/basics/up_and_running.adoc

@@ -88,6 +88,8 @@ Here's how you can modify the injected dependencies for `cider-jack-in-clj`:
                     "foo/bar" "1.0")
 ----
 
+IMPORTANT: Always use the fully qualified `group/artifact` (e.g. `re-frame/re-frame`) in these dependencies, since only Leiningen supports the bare `re-frame` syntax.
+
 CIDER will also inject the most recent version of nREPL that it supports. This is a simple
 trick to override the version of nREPL bundled with your build tool (e.g. Leiningen), so you can gain
 access to the newest nREPL features. Generally that's one aspect of CIDER's inner workings
@@ -104,10 +106,6 @@ for example, if your project defaults to an older version of Clojure than that
 supported by the CIDER middleware. Set `cider-jack-in-auto-inject-clojure`
 appropriately to enable this.
 
-NOTE: CIDER does not currently support
-dependency auto-injection for Gradle projects. Unfortunately there's no
-way to pass extra dependencies to Gradle via its command-line interface.
-
 === Jacking-in without a Project
 
 If you try to run `cider-jack-in` outside a project

doc/modules/ROOT/pages/cljs/configuration.adoc

@@ -17,6 +17,8 @@ variable. Here's an example:
 (cider-add-to-alist 'cider-jack-in-cljs-dependencies "weasel/weasel" "0.7.1")
 ----
 
+IMPORTANT: Always use the fully qualified `group/artifact` (e.g. `re-frame/re-frame`) in these dependencies, since only Leiningen supports the bare `re-frame` syntax.
+
 Typically, modifying this variable is not needed, as ClojureScript dependencies are declared
 explicitly in your project configuration most of the time.
 

doc/modules/ROOT/pages/cljs/up_and_running.adoc

@@ -55,6 +55,21 @@ or in `deps.edn`:
    "[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}}}
 ----
 
+or in `build.gradle`:
+
+[source, groovy]
+----
+dependencies {
+  devImplementation 'nrepl:nrepl:0.9.0'
+  devImplementation 'cider:cider-nrepl:0.28.5'
+  devImplementation 'cider:cider-piggieback:0.5.3'
+}
+
+tasks.named('clojureRepl') {
+  middleware = ['cider.nrepl/cider-middleware', 'cider.piggieback/wrap-cljs-repl']
+}
+----
+
 == Starting a ClojureScript REPL
 
 Open a ClojureScript file in your project and type kbd:[M-x]