Generate suggested code

.circleci/config.yml

@@ -67,7 +67,7 @@ jobs:
 
       - run: bin/install-chrome
       - run: sudo bin/install-node && npm install
-      - run: lein check
+      - run: lein with-profile test-common javac && lein check
       - run: lein with-profile test-common test
       - run: lein clean && lein with-profile test-web cljsbuild once test && bin/tests
       - run: lein jar && diff -u <(jar tf target/*.jar | sort) <(cat expected-jar-contents.txt | sort)

doc/development.md

@@ -30,6 +30,17 @@ or
 
 `lein with-profile +test-common test-refresh :changes-only`
 
+## Profiling in the REPL
+
+```
+(comment
+  (require '[clj-async-profiler.core :as prof])
+  (do
+    (prof/start {})
+    ;; some expensive operation here
+    (prof/stop {}))
+  )
+
 ## Release
 
 ### clojars

expected-jar-contents.txt

@@ -16,5 +16,13 @@ expound/alpha.cljc
 expound/problems.cljc
 expound/printer.cljc
 expound/specs.cljc
+expound/suggest.cljc
+expound/java/
+expound/java/Util.java
+expound/java/Util.class
+expound/js/
+expound/js/util.js
+Util.class
+Util.java
 project.clj
 expound/ansi.cljc

project.clj

@@ -8,11 +8,13 @@
                  [org.clojure/spec.alpha "0.1.143" :scope "provided"]]
   :deploy-repositories [["releases" :clojars]]
   :jar-exclusions [#"^public/.*"]
+  :java-source-paths ["src/expound/java"]
   :plugins [[com.jakemccrary/lein-test-refresh "0.22.0"]
             [lein-cljfmt "0.5.7"]
             [lein-cljsbuild "1.1.7" :exclusions [[org.clojure/clojure]]]
             [lein-figwheel "0.5.15"]]
 
+
   :cljsbuild {:builds
               [{:id "test"
                 :source-paths ["src" "test"]
@@ -26,7 +28,9 @@
                            :main "expound.test-runner"
                            :optimizations :none
                            :verbose true
-                           :compiler-stats true}}]}
+                           :compiler-stats true
+                           :libs ["src/expound/js/util.js"]
+                           }}]}
   :figwheel {;; :http-server-root "public" ;; default and assumes "resources"
              :server-port 3446 ;; default is 3449
 
@@ -78,6 +82,7 @@
                                   [io.aviso/pretty "0.1.34"]
                                   [vvvvalvalval/scope-capture "0.1.4"]
                                   [org.clojure/test.check "0.9.0"]
+                                  [com.clojure-goes-fast/clj-async-profiler "0.1.2"]
                                   [metosin/spec-tools "0.6.1"]]
                    :plugins [[io.aviso/pretty "0.1.34"]]
                    ;; need to add dev source path here to get user.clj loaded

src/expound/alpha.cljc

@@ -10,7 +10,8 @@
             #?(:cljs [goog.string])
             [expound.printer :as printer]
             [expound.util :as util]
-            [expound.ansi :as ansi]))
+            [expound.ansi :as ansi]
+            [expound.suggest :as suggest]))
 
 ;;;;;; registry ;;;;;;
 
@@ -617,7 +618,7 @@ returned an invalid value.
        (str
         (ansi/color (instrumentation-info failure caller) :none)
         (printer/format
-         "%s%s
+         "%s%s%s
 %s %s %s\n"
          (apply str
                 (for [[[in type] probs] problems]
@@ -630,6 +631,20 @@ returned an invalid value.
                      (if (empty? s)
                        s
                        (str s "\n\n"))))))
+         ;; FIXME - this is not a very clear heuristic, but until
+             ;; https://dev.clojure.org/jira/browse/CLJ-2271 is fixed, I think it's the best we can do
+             (if (::s/args explain-data')
+               (str
+                (header-label "Example")
+                "\n\n"
+                (printer/indent (str (conj
+                                      (suggest/suggestion (::s/spec explain-data') (::s/value explain-data'))
+                                      ;; FIXME - when https://dev.clojure.org/jira/browse/CLJ-2218 and
+                                      ;; https://dev.clojure.org/jira/browse/CLJ-2271 are fixed and explain-data
+                                      ;; contains the name of the function, use it here
+                                      (symbol "<f>"))))
+                "\n\n")
+               "")
          (ansi/color (section-label) :footer)
          (ansi/color "Detected" :footer)
          (ansi/color (count problems) :footer)

src/expound/java/Util.java

@@ -0,0 +1,20 @@
+package expound.java;
+
+public class Util {
+
+  public static int distance(String a, String b) {
+    int [] costs = new int [b.length() + 1];
+    for (int j = 0; j < costs.length; j++)
+      costs[j] = j;
+    for (int i = 1; i <= a.length(); i++) {
+      costs[0] = i;
+      int nw = i - 1;
+      for (int j = 1; j <= b.length(); j++) {
+        int cj = Math.min(1 + Math.min(costs[j], costs[j - 1]), a.charAt(i - 1) == b.charAt(j - 1) ? nw : nw + 1);
+        nw = costs[j];
+        costs[j] = cj;
+      }
+    }
+    return costs[b.length()];
+  }
+}

src/expound/js/util.js

@@ -0,0 +1,15 @@
+goog.provide("expound.js.util")
+
+expound.js.util.hello = function() { return "hi";}
+
+expound.js.util.levenshtein = function levenshtein(a, b) {
+  var t = [], u, i, j, m = a.length, n = b.length;
+  if (!m) { return n; }
+  if (!n) { return m; }
+  for (j = 0; j <= n; j++) { t[j] = j; }
+  for (i = 1; i <= m; i++) {
+    for (u = [i], j = 1; j <= n; j++) {
+      u[j] = a[i - 1] === b[j - 1] ? t[j - 1] : Math.min(t[j - 1], t[j], u[j - 1]) + 1;
+    } t = u;
+  } return u[n];
+}

src/expound/problems.cljc

@@ -57,9 +57,9 @@
                       (assoc k (summary-form show-valid-values? (nth form k) rst))))
 
       (and (int? k) (set? form))
-      (into #{} (-> displayed-form
-                    vec
-                    (assoc k (summary-form show-valid-values? (nth (seq form) k) rst))))
+      (set (-> displayed-form
+               vec
+               (assoc k (summary-form show-valid-values? (nth (seq form) k) rst))))
 
       (and (int? k) (list? form))
       (into '() (-> displayed-form
@@ -122,24 +122,26 @@
      problems)))
 
 (defn annotate [explain-data]
-  (let [{:keys [::s/problems ::s/value ::s/args ::s/ret ::s/fn ::s/failure ::s/spec]} explain-data
-        caller (or (:clojure.spec.test.alpha/caller explain-data) (:orchestra.spec.test/caller explain-data))
-        form (if (not= :instrument failure)
-               value
-               (cond
-                 (contains? explain-data ::s/ret) ret
-                 (contains? explain-data ::s/fn) fn
-                 (contains? explain-data ::s/args) args))
-        problems' (map (comp (partial adjust-in form)
-                             (partial adjust-path failure)
-                             (partial add-spec spec)
-                             (partial fix-via spec)
-                             #(assoc % :expound/form form))
-                       problems)]
-    (assoc explain-data
-           :expound/form form
-           :expound/caller caller
-           :expound/problems problems')))
+  (if (nil? explain-data)
+    nil
+    (let [{:keys [::s/problems ::s/value ::s/args ::s/ret ::s/fn ::s/failure ::s/spec]} explain-data
+          caller (or (:clojure.spec.test.alpha/caller explain-data) (:orchestra.spec.test/caller explain-data))
+          form (if (not= :instrument failure)
+                 value
+                 (cond
+                   (contains? explain-data ::s/ret) ret
+                   (contains? explain-data ::s/fn) fn
+                   (contains? explain-data ::s/args) args))
+          problems' (map (comp (partial adjust-in form)
+                               (partial adjust-path failure)
+                               (partial add-spec spec)
+                               (partial fix-via spec)
+                               #(assoc % :expound/form form))
+                         problems)]
+      (assoc explain-data
+             :expound/form form
+             :expound/caller caller
+             :expound/problems problems'))))
 
 (defn value-in
   "Similar to get-in, but works with paths that reference map keys"
@@ -161,6 +163,27 @@
       (and (int? k) (seqable? form))
       (recur (nth (seq form) k) rst))))
 
+;; TODO - deduple with value-in??
+;; TODO - rename
+(defn assoc-in1 [form in value]
+  (let [[k & rst] in]
+    (cond
+      (empty? in)
+      value
+
+      (and (map? form) (paths/kps? k))
+      (assoc form (:key k) value)
+
+      ;; TODO - make this work
+      ;;(and (map? form) (paths/kvps? k))
+      ;;(recur (nth (seq form) (:idx k)) rst)
+
+      (associative? form)
+      (assoc form k (assoc-in1 (get form k) rst value))
+
+      (and (int? k) (seq? form))
+      (list* (assoc (vec form) k (assoc-in1 (nth (seq form) k) rst value))))))
+
 (defn escape-replacement [pattern s]
   #?(:clj (if (string? pattern)
             s