Prepare for v0.0.4 release.

Author: green-coder

CHANGELOG

@@ -7,10 +7,14 @@ Versions prior to v0.1.0 are considered experimental, their API may change.
 
 ## [Unreleased]
 
+
+## [0.0.4] - 2020-08-09
+
 ### Added
 - this changelog file.
 - the models `gen/fn-simple-symbol`, `gen/fn-qualified-symbol`,
   `gen/fn-simple-keyword` and `gen/fn-qualified-keyword`.
+- the `describe` function, for parsing data.
 
 ### Changed
 - the models `gen/fn-symbol`, `gen/fn-keyword` now generate qualified symbols and keywords,

README.md

@@ -5,6 +5,7 @@ A minimalist data driven data model library, inspired by [Clojure Spec](https://
 [![Clojars Project](https://img.shields.io/clojars/v/minimallist.svg)](https://clojars.org/minimallist)
 [![cljdoc badge](https://cljdoc.org/badge/minimallist/minimallist)](https://cljdoc.org/d/minimallist/minimallist/CURRENT)
 [![project chat](https://img.shields.io/badge/slack-join_chat-brightgreen.svg)](https://clojurians.slack.com/archives/C012HUX1VPC)
+[![cljdoc badge](https://img.shields.io/clojars/dt/minimallist?color=opal)](https://clojars.org/minimallist)
 
 ## Usage
 
@@ -14,29 +15,37 @@ A minimalist data driven data model library, inspired by [Clojure Spec](https://
             [minimallist.helper :as h]))
 
 (def hiccup-model
-  (h/let ['hiccup (h/alt [:node (h/in-vector (h/cat (h/fn keyword?)
-                                                    (h/? (h/map))
-                                                    (h/* (h/not-inlined (h/ref 'hiccup)))))]
-                         [:primitive (h/alt (h/fn nil?)
-                                            (h/fn boolean?)
-                                            (h/fn number?)
-                                            (h/fn string?))])]
+  (h/let ['hiccup (h/alt [:node (h/in-vector (h/cat [:name (h/fn keyword?)]
+                                                    [:props (h/? (h/map-of (h/fn keyword?) (h/fn any?)))]
+                                                    [:children (h/* (h/not-inlined (h/ref 'hiccup)))]))]
+                         [:primitive (h/alt [:nil (h/fn nil?)]
+                                            [:boolean (h/fn boolean?)]
+                                            [:number (h/fn number?)]
+                                            [:text (h/fn string?)])])]
     (h/ref 'hiccup)))
 
 (valid? hiccup-model [:div {:class [:foo :bar]}
                       [:p "Hello, world of data"]])
 ;=> true
+
+(describe hiccup-model [:div {:class [:foo :bar]}
+                        [:p "Hello, world of data"]])
+;=> [:node {:name :div,
+;           :props [{:class [:foo :bar]}],
+;           :children [[:node {:name :p
+;                              :props []
+;                              :children [[:primitive [:text "Hello, world of data"]]]}]]}]
 ```
 
 ## Features
 
-- validates and generates data,
+- validates, parses and generates data,
 - fully data driven, models are hash-map based created via helpers,
 - support recursive definitions and sequence regex,
 - no macro, no static registry, pure functions,
 - relatively simple implementation, easy to read and modify,
 - cross platform (`.cljc`),
-- `valid?` runs in [Babashka](https://github.com/borkdude/babashka)
+- `valid?` and `describe` run in [Babashka](https://github.com/borkdude/babashka)
 
 ## Non-goals (for now)
 
@@ -48,7 +57,7 @@ A minimalist data driven data model library, inspired by [Clojure Spec](https://
 See the [latest documentation on cljdoc](https://cljdoc.org/d/minimallist/minimallist/CURRENT) for:
 - A general description of the Minimallist project.
 - How to use the helpers to build your models.
-- How to validate and generate your data.
+- How to validate, parse and generate your data.
 
 ## Status
 

doc/babashka.md

@@ -18,6 +18,9 @@ As a babashka shell script:
 (m/valid? (h/fn int?) 1)   ;=> true
 (m/valid? (h/fn int?) "1") ;=> false
 
+(m/describe (h/fn int?) 1)   ;=> 1
+(m/describe (h/fn int?) "1") ;=> :invalid
+
 ;; Does not work for now.
 ;(require '[clojure.test.check.generators :as tcg])
 ;(require '[minimallist.generator :as mg])

doc/cljdoc.edn

@@ -5,5 +5,6 @@
                    ["Model Anatomy"     {:file "doc/model_anatomy.md"}]
                    ["Model Builder"     {:file "doc/model_builder.md"}]
                    ["Data Validation"   {:file "doc/data_validation.md"}]
+                   ["Data Parsing"      {:file "doc/data_parsing.md"}]
                    ["Data Generation"   {:file "doc/data_generation.md"}]
                    ["Usage in Babashka" {:file "doc/babashka.md"}]]}

doc/data_parsing.md

@@ -0,0 +1,23 @@
+## Data Parsing
+
+```clojure
+(require '[minimallist.core :refer [describe]])
+(require '[minimallist.helper :as h])
+
+(describe (h/fn string?) "Hello, world!")
+;=> "Hello, world"
+
+(describe (h/cat (h/fn int?)
+                 (h/alt [:option1 (h/fn string?)]
+                        [:option2 (h/fn keyword?)]
+                        [:option3 (h/cat (h/fn string?)
+                                         (h/fn keyword?))])
+                 (h/fn int?))
+          [1 "a" :b 3])
+;=> [1 [:option3 ["a" :b]] 3]
+```
+
+A more complete documentation will come later.
+
+In the mean time, please take a look at the test files
+for more examples.

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>minimallist</groupId>
   <artifactId>minimallist</artifactId>
-  <version>0.0.3</version>
+  <version>0.0.4</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>