Refactor Move Describable to methodical.interface

src/methodical/core.clj

@@ -6,7 +6,6 @@
             methodical.interface
             methodical.macros
             methodical.util
-            methodical.util.describe
             methodical.util.dispatch
             methodical.util.trace
             [potemkin :as p]))
@@ -16,7 +15,6 @@
   methodical.impl/keep-me
   methodical.interface/keep-me
   methodical.macros/keep-me
-  methodical.util.describe/keep-me
   methodical.util.dispatch/keep-me
   methodical.util.trace/keep-me
   methodical.util/keep-me)
@@ -48,7 +46,8 @@
   with-dispatcher
   method-table
   with-method-table
-  effective-method]
+  effective-method
+  describe]
 
  [methodical.impl
   ;; method combinations
@@ -125,8 +124,6 @@
   unprefer-method!
   with-prefers!]
 
- [methodical.util.describe
-  describe]
 
  [methodical.util.dispatch
   dispatch-on-first-arg

src/methodical/impl/cache/simple.clj

@@ -3,41 +3,62 @@
   offers no facilities to deduplicate identical methods for the same dispatch value. This behaves similarly to the
   caching mechanism in vanilla Clojure."
   (:require
-   [clojure.core.protocols :as clojure.protocols]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
-   [pretty.core :as pretty])
+    [clojure.core.protocols :as clojure.protocols]
+    [methodical.interface :as i]
+    [pretty.core :as pretty])
   (:import
-   (methodical.interface Cache)))
+    (methodical.interface
+      Cache)))
+
 
 (set! *warn-on-reflection* true)
 
 (comment methodical.interface/keep-me)
 
-(deftype SimpleCache [atomm]
+
+(deftype SimpleCache
+  [atomm]
+
   pretty/PrettyPrintable
-  (pretty [_]
+
+  (pretty
+    [_]
     '(simple-cache))
 
+
   Cache
-  (cached-method [_ dispatch-value]
+
+  (cached-method
+    [_ dispatch-value]
     (get @atomm dispatch-value))
 
-  (cache-method! [_ dispatch-value method]
+
+  (cache-method!
+    [_ dispatch-value method]
     (swap! atomm assoc dispatch-value method))
 
-  (clear-cache! [this]
+
+  (clear-cache!
+    [this]
     (reset! atomm {})
     this)
 
-  (empty-copy [_]
+
+  (empty-copy
+    [_]
     (SimpleCache. (atom {})))
 
+
   clojure.protocols/Datafiable
-  (datafy [this]
+
+  (datafy
+    [this]
     {:class (class this)
      :cache @atomm})
 
-  describe/Describable
-  (describe [this]
+
+  i/Describable
+
+  (describe
+    [this]
     (format "It caches methods using a [[%s]]." (.getCanonicalName (class this)))))

src/methodical/impl/cache/watching.clj

@@ -15,7 +15,6 @@
    [clojure.core.protocols :as clojure.protocols]
    [clojure.datafy :as datafy]
    [methodical.interface :as i]
-   [methodical.util.describe :as describe]
    [pretty.core :as pretty])
   (:import
    (java.lang.ref WeakReference)
@@ -55,7 +54,7 @@
      :cache (datafy/datafy cache)
      :refs  refs})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It caches methods using a [[%s]]." (.getCanonicalName (class this)))))
 

src/methodical/impl/combo/clojure.clj

@@ -3,8 +3,7 @@
   not at all. Like vanilla Clojure multimethods, this method combination only supports primary methods."
   (:require
    [clojure.core.protocols :as clojure.protocols]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
+   [methodical.interface :as i]
    [pretty.core :as pretty])
   (:import
    (methodical.interface MethodCombination)))
@@ -38,6 +37,6 @@
   (datafy [this]
     {:class (class this)})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the method combination [[%s]]." (.getCanonicalName (class this)))))

src/methodical/impl/combo/clos.clj

@@ -6,8 +6,7 @@
   (:require
    [clojure.core.protocols :as clojure.protocols]
    [methodical.impl.combo.common :as combo.common]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
+   [methodical.interface :as i]
    [pretty.core :as pretty])
   (:import
    (methodical.interface MethodCombination)))
@@ -87,6 +86,6 @@
   (datafy [this]
     {:class (class this)})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the method combination [[%s]]." (.getCanonicalName (class this)))))

src/methodical/impl/combo/operator.clj

@@ -45,8 +45,7 @@
    [clojure.core.protocols :as clojure.protocols]
    [clojure.spec.alpha :as s]
    [methodical.impl.combo.common :as combo.common]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
+   [methodical.interface :as i]
    [pretty.core :as pretty])
   (:import
    (methodical.interface MethodCombination)))
@@ -202,7 +201,7 @@
     {:class    (class this)
      :operator operator-name})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the method combination [[%s]]\nwith the operator `%s`."
             (.getCanonicalName (class this))

src/methodical/impl/combo/threaded.clj

@@ -3,8 +3,7 @@
   (:require
    [clojure.core.protocols :as clojure.protocols]
    [methodical.impl.combo.common :as combo.common]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
+   [methodical.interface :as i]
    [pretty.core :as pretty])
   (:import
    (methodical.interface MethodCombination)))
@@ -105,7 +104,7 @@
     {:class          (class this)
      :threading-type threading-type})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the method combination [[%s]]\nwith the threading strategy `%s`."
             (.getCanonicalName (class this))

src/methodical/impl/dispatcher/everything.clj

@@ -4,7 +4,6 @@
    [clojure.core.protocols :as clojure.protocols]
    [methodical.impl.dispatcher.common :as dispatcher.common]
    [methodical.interface :as i]
-   [methodical.util.describe :as describe]
    [pretty.core :as pretty])
   (:import
    (methodical.interface Dispatcher)))
@@ -71,7 +70,7 @@
      :hierarchy hierarchy-var
      :prefs     prefs})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the dispatcher [[%s]]\nwith hierarchy `%s`\nand prefs `%s`."
             (.getCanonicalName (class this))

src/methodical/impl/dispatcher/multi_default.clj

@@ -7,7 +7,6 @@
    [methodical.impl.dispatcher.common :as dispatcher.common]
    [methodical.impl.dispatcher.standard :as dispatcher.standard]
    [methodical.interface :as i]
-   [methodical.util.describe :as describe]
    [pretty.core :as pretty])
   (:import
    (methodical.interface Dispatcher)))
@@ -198,7 +197,7 @@
      :hierarchy     hierarchy-var
      :prefs         prefs})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the dispatcher [[%s]]\nwith hierarchy `%s`\nand prefs `%s`.\n\nThe default value is `%s`."
             (.getCanonicalName (class this))

src/methodical/impl/dispatcher/standard.clj

@@ -6,7 +6,6 @@
    [clojure.core.protocols :as clojure.protocols]
    [methodical.impl.dispatcher.common :as dispatcher.common]
    [methodical.interface :as i]
-   [methodical.util.describe :as describe]
    [pretty.core :as pretty])
   (:import
    (methodical.interface Dispatcher)))
@@ -174,7 +173,7 @@
      :hierarchy     hierarchy-var
      :prefs         prefs})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (format "It uses the dispatcher [[%s]]\nwith hierarchy `%s`\nand prefs `%s`.\n\nThe default value is `%s`."
             (.getCanonicalName (class this))

src/methodical/impl/method_table/clojure.clj

@@ -1,61 +1,89 @@
 (ns methodical.impl.method-table.clojure
   (:require
-   [clojure.core.protocols :as clojure.protocols]
-   [methodical.impl.method-table.common :as method-table.common]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
-   [pretty.core :as pretty])
+    [clojure.core.protocols :as clojure.protocols]
+    [methodical.impl.method-table.common :as method-table.common]
+    [methodical.interface :as i]
+    [pretty.core :as pretty])
   (:import
-   (methodical.interface MethodTable)))
+    (methodical.interface
+      MethodTable)))
+
 
 (set! *warn-on-reflection* true)
 
 (comment methodical.interface/keep-me)
 
-(deftype ClojureMethodTable [m]
+
+(deftype ClojureMethodTable
+  [m]
+
   pretty/PrettyPrintable
-  (pretty [_]
+
+  (pretty
+    [_]
     (if (seq m)
       (list 'clojure-method-table (count m) 'primary)
       '(clojure-method-table)))
 
+
   Object
-  (equals [_ another]
+
+  (equals
+    [_ another]
     (and (instance? ClojureMethodTable another)
          (= m (.m ^ClojureMethodTable another))))
 
+
   MethodTable
-  (primary-methods [_]
+
+  (primary-methods
+    [_]
     m)
 
-  (aux-methods [_]
+
+  (aux-methods
+    [_]
     nil)
 
-  (add-primary-method [this dispatch-val method]
+
+  (add-primary-method
+    [this dispatch-val method]
     (let [new-m (assoc m dispatch-val method)]
       (if (= m new-m)
         this
         (ClojureMethodTable. new-m))))
 
-  (remove-primary-method [this dispatch-val]
+
+  (remove-primary-method
+    [this dispatch-val]
     (let [new-m (dissoc m dispatch-val)]
       (if (= m new-m)
         this
         (ClojureMethodTable. new-m))))
 
-  (add-aux-method [_ _ _ _]
+
+  (add-aux-method
+    [_ _ _ _]
     (throw (UnsupportedOperationException. "Clojure-style multimethods do not support auxiliary methods.")))
 
-  (remove-aux-method [_ _ _ _]
+
+  (remove-aux-method
+    [_ _ _ _]
     (throw (UnsupportedOperationException. "Clojure-style multimethods do not support auxiliary methods.")))
 
+
   clojure.protocols/Datafiable
-  (datafy [this]
+
+  (datafy
+    [this]
     {:class   (class this)
      :primary (method-table.common/datafy-primary-methods m)})
 
-  describe/Describable
-  (describe [this]
+
+  i/Describable
+
+  (describe
+    [this]
     (format "It uses the method table [[%s]]. These primary methods are known:\n\n%s"
             (.getCanonicalName (class this))
             (method-table.common/describe-primary-methods m))))

src/methodical/impl/method_table/common.clj

@@ -60,7 +60,7 @@
                                                  (str/split-lines (describe-method f))))))
 
 (defn describe-primary-methods
-  "Helper for [[methodical.util.describe/describe]]ing the primary methods in a method table."
+  "Helper for [[methodical.interface/describe]]ing the primary methods in a method table."
   ^String [dispatch-value->method]
   (when (seq dispatch-value->method)
     (format
@@ -71,7 +71,7 @@
         (describe-method dispatch-value f))))))
 
 (defn describe-aux-methods
-  "Helper for [[methodical.util.describe/describe]]ing the aux methods in a method table."
+  "Helper for [[methodical.interface/describe]]ing the aux methods in a method table."
   ^String [qualifier->dispatch-value->methods]
   (when (seq qualifier->dispatch-value->methods)
     (format

src/methodical/impl/method_table/standard.clj

@@ -2,8 +2,7 @@
   (:require
    [clojure.core.protocols :as clojure.protocols]
    [methodical.impl.method-table.common :as method-table.common]
-   [methodical.interface]
-   [methodical.util.describe :as describe]
+   [methodical.interface :as i]
    [pretty.core :as pretty])
   (:import
    (methodical.interface MethodTable)))
@@ -95,7 +94,7 @@
      :primary (method-table.common/datafy-primary-methods primary)
      :aux     (method-table.common/datafy-aux-methods aux)})
 
-  describe/Describable
+  i/Describable
   (describe [this]
     (str (format "It uses the method table [[%s]]." (.getCanonicalName (class this)))
          (method-table.common/describe-primary-methods primary)