Merge pull request #3 from scicloj/data-representation

redefined the way data representations work
scicloj · Aug 14, 2023 · c813302 · c813302
2 parents c1d2023 + 170b841
commit c813302
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -75,9 +75,9 @@ For example, let us add support for [tech.ml.dataset](https://github.com/techasc
   "tech.ml.dataset dataset"
   {:predicate tc/dataset?
    :representation (fn [ds]
-                     `(tc/dataset ~(-> ds
-                                       (update-vals vec)
-                                       (->> (into {})))))})
+                     (-> ds
+                         (update-vals vec)
+                         (->> (into {}))))})
 ```
 
 Now, a code example like
@@ -88,29 +88,28 @@ Now, a code example like
 ```
 will result in a test like
 ```clj
-(deftest test-3
-  (is (=
+(deftest test-4
+  (is (->
        (-> {:x [1 2 3]}
            tc/dataset
            (tc/map-columns :y [:x] (partial * 10)))
-       ;; =>
-       (tablecloth.api/dataset {:x [1 2 3], :y [10 20 30]}))))
+       note-to-test/represent-value
+       (=
+        {:x [1 2 3], :y [10 20 30]}))))
 ```
 
-You see, the output value is represented as a code snippet that would generate that value. Since `tech.ml.dataset` datasets can be compared using the `=` function, this is a valid test for our code example.
-
 ## Wishlist
 - support running from command line
 - support an alternative plain-data output format to help seeing the output changes explicitly
 - make clear error messages:
-  - when outputs change
-  - when the code fails
+- when outputs change
+- when the code fails
 - support code examples in comment blocks?
 - support metadata to skip certain forms
 - remove nil outputs?
 - support docstrings
-  - generate tests from code examples in docstrings
-  - explore generate docstrings in a structured way (marking code examples explicitly)
+- generate tests from code examples in docstrings
+- explore generate docstrings in a structured way (marking code examples explicitly)
 - support approximate comparisons of values for floating-point computations
 - support automatic regeneration (say, using file watch)
 

diff --git a/notebooks/dum/dummy.clj b/notebooks/dum/dummy.clj
@@ -6,9 +6,9 @@
   "tablecloth dataset"
   {:predicate tc/dataset?
    :representation (fn [ds]
-                     `(tc/dataset ~(-> ds
-                                       (update-vals vec)
-                                       (->> (into {})))))})
+                     (-> ds
+                         (update-vals vec)
+                         (->> (into {}))))})
 
 (+ 4
    5

diff --git a/src/scicloj/note_to_test/v1/api.clj b/src/scicloj/note_to_test/v1/api.clj
@@ -50,3 +50,9 @@
   "
   [name spec]
   (impl/define-value-representation! name spec))
+
+
+(defn represent-value
+  "Represent a given value `v` using the extensible definitions of special value representations."
+  [v]
+  (impl/represent-value v))
diff --git a/src/scicloj/note_to_test/v1/impl.clj b/src/scicloj/note_to_test/v1/impl.clj
@@ -45,10 +45,11 @@
 (def test-template
   "
 (deftest %s
-  (is (=
+  (is (->
 %s
-    ;; =>
-%s)))
+    note-to-test/represent-value
+    (=
+%s))))
 ")
 
 (defn ->test [code index source-ns]
@@ -71,7 +72,7 @@
                   represent-value
                   pp/pprint
                   with-out-str
-                  (indent 4))))))
+                  (indent 5))))))
 
 
 

diff --git a/test/dum/dummy_generated_test.clj b/test/dum/dummy_generated_test.clj
@@ -5,47 +5,52 @@
    [tablecloth.api :as tc]))
 
 (deftest test-0
-  (is (=
+  (is (->
     (note-to-test/define-value-representation!
       "tablecloth dataset"
       {:predicate tc/dataset?
        :representation (fn [ds]
-                         `(tc/dataset ~(-> ds
-                                           (update-vals vec)
-                                           (->> (into {})))))})
-    ;; =>
-    :ok)))
+                         (-> ds
+                             (update-vals vec)
+                             (->> (into {}))))})
+    note-to-test/represent-value
+    (=
+     :ok))))
 
 
 (deftest test-1
-  (is (=
+  (is (->
     (+ 4
        5
        6)
-    ;; =>
-    15)))
+    note-to-test/represent-value
+    (=
+     15))))
 
 (defn f [x]
   (+ x 19))
 
 (deftest test-3
-  (is (=
+  (is (->
     (f 12)
-    ;; =>
-    31)))
+    note-to-test/represent-value
+    (=
+     31))))
 
 
 (deftest test-4
-  (is (=
+  (is (->
     (-> {:x [1 2 3]}
         tc/dataset
         (tc/map-columns :y [:x] (partial * 10)))
-    ;; =>
-    (tablecloth.api/dataset {:x [1 2 3], :y [10 20 30]}))))
+    note-to-test/represent-value
+    (=
+     {:x [1 2 3], :y [10 20 30]}))))
 
 
 (deftest test-5
-  (is (=
+  (is (->
     (f 13)
-    ;; =>
-    32)))
+    note-to-test/represent-value
+    (=
+     32))))