Added the "Cat Ipsum generator" to the documentation.

Author: green-coder

doc/usage.md

@@ -78,6 +78,71 @@
 ; 15
 ; true
 ; false)
+```
+
+### Cat Ipsum generator
+
+```clojure
+;; Model builder
+(defn ipsum-model [subjects verbs pronouns objects]
+  (h/let ['subject (h/enum subjects)
+          'verb    (h/enum verbs)
+          'pronoun (h/enum pronouns)
+          'object  (h/enum objects)
+          'group   (h/alt (h/cat (h/ref 'pronoun)
+                                 (h/ref 'object))
+                          (h/cat (h/ref 'group)
+                                 (h/enum #{"and" "with"})
+                                 (h/ref 'group)))
+          'sentence (h/cat (h/ref 'subject)
+                           (h/ref 'verb)
+                           (h/ref 'group))]
+    (h/repeat 1 10 (h/not-inlined (h/ref 'sentence)))))
+
+;; A model from the model builder
+(def cat-ipsum (ipsum-model #{"I"
+                              "My human"
+                              "The baby"
+                              "Bad mouses"}
+                            #{"slept on"
+                              "ate"
+                              "played with"
+                              "jumped over"
+                              "stared at"
+                              "scratched"
+                              "broke"
+                              "stretched nearby"
+                              "was singing for"
+                              "owned"}
+                            #{"the" "a" "my" "*MY*"}
+                            #{"fish" "dry food"
+                              "colorful balls" "table"
+                              "sofa" "bed"
+                              "toy" "trash"
+                              "apartment"
+                              "toilet"}))
 
+;; A generator from the model
+(def cat-ipsum-generator
+  (tcg/fmap (fn [sentences]
+              (->> sentences
+                   (map (fn [sentence]
+                          (-> (str/join " " sentence)
+                              (str "."))))
+                   (str/join " ")))
+            (mg/gen cat-ipsum 50)))
 
+;; Generate data from the generator, and have fun
+(tcg/sample cat-ipsum-generator)
+;("Bad mouses broke the toilet. I scratched *MY* sofa. I slept on *MY* toilet. The baby jumped over the apartment. The baby stared at my toy. Bad mouses ate *MY* bed."
+; "My human was singing for a toilet. My human slept on *MY* sofa with *MY* fish. My human owned a toilet."
+; "My human was singing for a toilet. The baby ate *MY* trash. I owned the toy. I broke a trash. The baby jumped over my dry food. Bad mouses jumped over my sofa. I scratched the dry food."
+; "My human ate the colorful balls. The baby played with the sofa. My human played with the toy. The baby played with a fish. My human was singing for my toilet. The baby stared at my colorful balls. Bad mouses scratched a sofa."
+; "The baby stared at the fish. I broke my fish. My human ate my toilet. Bad mouses slept on a trash. The baby stretched nearby the apartment. The baby slept on my fish. I scratched *MY* sofa. My human was singing for a toy. Bad mouses ate *MY* colorful balls."
+; "The baby was singing for *MY* toy. Bad mouses stared at my bed. I owned the apartment. My human played with *MY* fish. Bad mouses owned my apartment. Bad mouses stretched nearby my toy. I slept on *MY* apartment. My human was singing for my dry food. Bad mouses ate a dry food."
+; "I broke a fish. I slept on a apartment. The baby broke the toilet. My human owned *MY* apartment. Bad mouses ate *MY* trash and my toilet. My human was singing for *MY* bed."
+; "I ate my bed. My human was singing for a toy. The baby owned the toilet. The baby slept on *MY* fish."
+; "The baby owned my bed. The baby played with a toilet. Bad mouses ate *MY* colorful balls. I scratched the sofa."
+; "Bad mouses stared at my fish. My human ate *MY* toilet. My human stretched nearby the toilet. Bad mouses sleeped on my fish. My human scratched a fish. I broke the dry food.")
 ```
+