Tried to make cljdoc happy.

Author: green-coder

doc/SUMMARY.md

@@ -12,8 +12,8 @@
 
 ## Data
 
-* [Data Validation](usage.md#data-validation)
-* [Data Generation](usage.md#data-generation)
+* [Data Validation](data_validation.md)
+* [Data Generation](data_generation.md)
 
 ## Misc
 

doc/cljdoc.edn

@@ -0,0 +1,7 @@
+{:cljdoc.doc/tree [["Introduction"      {:file "doc/README.md"}]
+                   ["Design Choices"    {:file "doc/design_choices.md"}]
+                   ["Model Anatomy"     {:file "doc/model_anatomy.md"}]
+                   ["Model Builder"     {:file "doc/model_builder.md"}]
+                   ["Data Validation"   {:file "doc/data_validation.md"}]
+                   ["Data Generation"   {:file "doc/data_generation.md"}]
+                   ["Usage in Babashka" {:file "doc/babashka.md"}]]}

doc/usage.md doc/data_generation.mddoc/usage.md renamed to doc/data_generation.md

@@ -1,15 +1,3 @@
-# Usage
-
-## Data Validation
-
-```clojure
-(require '[minimallist.core :refer [valid?]])
-(require '[minimallist.helper :as h])
-
-(valid? (h/fn string?) "Hello, world!")
-;=> true
-```
-
 ## Data Generation
 
 ```clojure

doc/data_validation.md

@@ -0,0 +1,9 @@
+## Data Validation
+
+```clojure
+(require '[minimallist.core :refer [valid?]])
+(require '[minimallist.helper :as h])
+
+(valid? (h/fn string?) "Hello, world!")
+;=> true
+```

pom.xml

@@ -3,15 +3,14 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>minimallist</groupId>
   <artifactId>minimallist</artifactId>
-  <version>0.0.2</version>
+  <version>0.0.3</version>
   <name>Minimallist</name>
   <description>A minimalist data driven data model library, inspired by Spec and Malli.</description>
   <url>https://github.com/green-coder/minimallist</url>
   <scm>
     <url>https://github.com/green-coder/minimallist</url>
-    <connection>
-            scm:git:git://github.com/green-coder/minimallist.git
-        </connection>
+    <connection>scm:git:git://github.com/green-coder/minimallist.git</connection>
+    <developerConnection>scm:git:ssh://git@github.com/green-coder/minimallist.git</developerConnection>
   </scm>
   <licenses>
     <license>
@@ -31,6 +30,12 @@
       <artifactId>clojure</artifactId>
       <version>1.10.1</version>
     </dependency>
+    <dependency>
+      <groupId>org.clojure</groupId>
+      <artifactId>test.check</artifactId>
+      <version>1.1.0</version>
+      <scope>provided</scope>
+    </dependency>
   </dependencies>
   <build>
     <sourceDirectory>src</sourceDirectory>

src/minimallist/core.cljc

@@ -34,9 +34,11 @@
 
 ;;---
 
-(defmacro implies [condition & expressions]
-  `(if ~condition
-     (do ~@expressions)
+(defmacro ^:no-doc implies
+  "Logically equivalent to `(or (not condition) expression)`"
+  [cause consequence]
+  `(if ~cause
+     ~consequence
      true))
 
 (declare -valid?)

src/minimallist/generator.cljc

@@ -9,38 +9,49 @@
 ;; Helpers for generating non-structural data.
 ;; If you can't find what you need here, you can define your own helpers.
 
-(def fn-any? (-> (h/fn any?)
-                 (h/with-test-check-gen gen/any)))
+(def ^{:doc "A model that matches and generates anything."}
+  fn-any? (-> (h/fn any?)
+              (h/with-test-check-gen gen/any)))
 
-(def fn-any-simple? (-> (h/fn any?)
-                        (h/with-test-check-gen gen/simple-type)))
+(def ^{:doc "A model that matches anything and generates any scalar type."}
+  fn-any-simple? (-> (h/fn any?)
+                     (h/with-test-check-gen gen/simple-type)))
 
-(def fn-nil? (-> (h/fn nil?)
-                 (h/with-test-check-gen (gen/return nil))))
+(def ^{:doc "A model that matches and generates the nil value."}
+  fn-nil? (-> (h/fn nil?)
+              (h/with-test-check-gen (gen/return nil))))
 
-(def fn-boolean? (-> (h/fn boolean?)
-                     (h/with-test-check-gen (gen/elements [false true]))))
+(def ^{:doc "A model that matches and generates booleans."}
+  fn-boolean? (-> (h/fn boolean?)
+                  (h/with-test-check-gen (gen/elements [false true]))))
 
-(def fn-int? (-> (h/fn int?)
-                 (h/with-test-check-gen gen/nat)))
+(def ^{:doc "A model that matches and generates integers."}
+  fn-int? (-> (h/fn int?)
+              (h/with-test-check-gen gen/nat)))
 
-(def fn-double? (-> (h/fn double?)
-                    (h/with-test-check-gen gen/double)))
+(def ^{:doc "A model that matches and generates doubles."}
+  fn-double? (-> (h/fn double?)
+                 (h/with-test-check-gen gen/double)))
 
-(def fn-number? (-> (h/fn number?)
-                    (h/with-test-check-gen (gen/one-of [gen/nat gen/double]))))
+(def ^{:doc "A model that matches any number and generates intergers and doubles."}
+  fn-number? (-> (h/fn number?)
+                 (h/with-test-check-gen (gen/one-of [gen/nat gen/double]))))
 
-(def fn-string? (-> (h/fn string?)
-                    (h/with-test-check-gen gen/string-alphanumeric)))
+(def ^{:doc "A model that matches strings and generates alphanumeric strings."}
+  fn-string? (-> (h/fn string?)
+                 (h/with-test-check-gen gen/string-alphanumeric)))
 
-(def fn-symbol? (-> (h/fn symbol?)
-                    (h/with-test-check-gen gen/symbol)))
+(def ^{:doc "A model that matches and generates symbols."}
+  fn-symbol? (-> (h/fn symbol?)
+                 (h/with-test-check-gen gen/symbol)))
 
-(def fn-keyword? (-> (h/fn keyword?)
-                     (h/with-test-check-gen gen/keyword)))
+(def ^{:doc "A model that matches and generates keywords."}
+  fn-keyword? (-> (h/fn keyword?)
+                  (h/with-test-check-gen gen/keyword)))
 
-(def fn-keyword-ns? (-> (h/fn keyword?)
-                        (h/with-test-check-gen gen/keyword-ns)))
+(def ^{:doc "A model that matches keywords and generates keywords with a namespace."}
+  fn-keyword-ns? (-> (h/fn keyword?)
+                     (h/with-test-check-gen gen/keyword-ns)))
 
 
 
@@ -54,7 +65,7 @@
           (recur (dec index) (next elements)))))))
 
 ;; TODO: walk on :count-model and :condition-model nodes
-(defn postwalk [model visitor]
+(defn ^:no-doc postwalk [model visitor]
   (let [walk (fn walk [[stack walked-bindings] model path]
                (let [[[stack walked-bindings] model]
                      (case (:type model)
@@ -113,7 +124,7 @@
           :fn (:min-value count-model)
           nil)))))
 
-(defn assoc-leaf-distance-visitor
+(defn ^:no-doc assoc-leaf-distance-visitor
   "Associate an 'distance to leaf' measure to each node of the model.
    It is used as a hint on which path to choose when running out of budget
    in a budget-based data generation. It's very useful as well to avoid
@@ -154,7 +165,7 @@
     (cond-> model
       (some? distance) (assoc ::leaf-distance distance))))
 
-(defn assoc-min-cost-visitor
+(defn ^:no-doc assoc-min-cost-visitor
   "Associate an 'minimun cost' measure to each node of the model.
    It is used as a hint during the budget-based data generation."
   [model stack path]

src/minimallist/util.cljc

@@ -1,4 +1,4 @@
-(ns minimallist.util
+(ns ^:no-doc minimallist.util
   (:require [clojure.set :as set]
             [clojure.walk :as walk]))