Add config for ignoring specific paths

This change will allow users to configure refactor-nrepl to ignore
certain paths when finding the dirs on classpath by specifying a seq of
regexes which the paths will be matched against.

Currently refactor-nrepl considers all the .clj files that are reachable
from project root. This is a problem if the project repository includes
example .clj files, if a user has symlinked other clj projects under
'checkouts' or if there are any other files that need to be ignored.

This change is backward compatible and wouldn't affect the current
behaviour in existing installations as the default value is an empty
seq.

Also added tests and updated README and Changelog.

Author: naiquevin

CHANGELOG.md

@@ -15,6 +15,7 @@
 ### New features
 
 * New config setting `:libspec-whitelist` which makes it possible to create a seq of namespaces `clean-ns` shouldn't prune.  This is useful for libspecs which aren't used except through side-effecting loads.
+* New config setting `:ignore-paths` for ignoring certain paths when finding dirs on classpath.
 
 ## 2.2.0
 

README.md

@@ -85,6 +85,9 @@ Configuration settings are passed along with each msg, currently the recognized
  ;; This seq of strings will be used as regexp patterns to match
  ;; against the libspec name.
  :libspec-whitelist ["^cljsjs"]
+
+ ;; Regexes matching paths that are to be ignored
+ :ignore-paths []
 }
 ```
 

src/refactor_nrepl/config.clj

@@ -21,6 +21,9 @@
    ;; This seq of strings will be used as regexp patterns to match
    ;; against the libspec name.
    :libspec-whitelist ["^cljsjs"]
+
+   ;; Regexes matching paths that are to be ignored
+   :ignore-paths []
    })
 
 (defn opts-from-msg [msg]

src/refactor_nrepl/core.clj

@@ -6,7 +6,8 @@
             [clojure.tools.reader.reader-types :as readers]
             [me.raynes.fs :as fs]
             [refactor-nrepl.util :refer [normalize-to-unix-path]]
-            [refactor-nrepl.s-expressions :as sexp])
+            [refactor-nrepl.s-expressions :as sexp]
+            [refactor-nrepl.config :as config])
   (:import [java.io File FileReader PushbackReader StringReader]))
 
 (defn version []
@@ -30,13 +31,23 @@
   [readable]
   (-> readable slurp ns-from-string))
 
+(defn ignore-dir-on-classpath?
+  [^String path]
+  (or (.endsWith path "target/srcdeps")
+      (reduce (fn [acc x]
+                (if (re-find x path)
+                  (reduced true)
+                  acc))
+              false
+              (:ignore-paths config/*config*))))
+
 (defn dirs-on-classpath
   "Return all dirs on classpath, filtering out our inlined deps
-  directory."
+  directory and paths matching :ignore-paths specified in config."
   []
   (->> (cp/classpath)
        (filter fs/directory?)
-       (remove #(-> % str normalize-to-unix-path (.endsWith "target/srcdeps")))))
+       (remove #(-> % str normalize-to-unix-path ignore-dir-on-classpath?))))
 
 (defn project-root
   "Return the project root directory.

test/refactor_nrepl/core_test.clj

@@ -0,0 +1,28 @@
+(ns refactor-nrepl.core-test
+  (:require [clojure.test :refer :all]
+            [refactor-nrepl.config :as config]
+            [refactor-nrepl.core :refer [ignore-dir-on-classpath?]]))
+
+
+(defmacro assert-ignored-paths
+  [paths pred]
+  `(doseq [p# ~paths]
+     (is (~pred (ignore-dir-on-classpath? p#)))))
+
+
+(deftest test-ignore-dir-on-classpath?
+  (let [not-ignored ["/home/user/project/test"
+                     "/home/user/project/src"
+                     "/home/user/project/target/classes"]
+        sometimes-ignored ["/home/user/project/checkouts/subproject"
+                           "/home/user/project/resources"]
+        always-ignored ["/home/user/project/target/srcdeps"]]
+    (testing "predicate to ignore dirs on classpath with default config"
+      (assert-ignored-paths (concat not-ignored sometimes-ignored) false?)
+      (assert-ignored-paths always-ignored true?))
+    (testing "predicate to ignore dirs on classpath with custom config"
+      (binding [config/*config* (assoc config/*config*
+                                       :ignore-paths
+                                       [#".+checkouts/.+" #"resources"])]
+        (assert-ignored-paths not-ignored false?)
+        (assert-ignored-paths (concat always-ignored sometimes-ignored) true?)))))