Ensure all examples work without sci unless mentioned otherwise

[vharmain]

Closes #723

[ikitommi]

this would not require sci:

;; portable :gen/fmap
(mg/generate
  [:and {:gen/fmap (partial str "kikka_")} string?]
  {:seed 10, :size 10})
;; => "kikka_WT3K0yax2"

if you think so, we could add both examples for clarity. anyway 👍

[vharmain]

Good point! I adjusted it so that there are now both examples, first the "simple one" and then the portable one.

;; :gen/fmap 
(mg/generate
  [:and {:gen/fmap (partial str "kikka_")} string?]
  {:seed 10, :size 10})
;; => "kikka_WT3K0yax2"

;; portable :gen/fmap (requires `org.babashka/sci` dependency to work)
(mg/generate
  [:and {:gen/fmap '(partial str "kikka_")} string?]
  {:seed 10, :size 10})
;; => "kikka_nWT3K0ya7"

I hope it's clear enough that the first one will only work on the particular runtime and the quoted one can be serialized. 🤔 (I also hope that I got it right 😉)

[vharmain]

Hmm I think there's similar gotcha in Multi schemas section:

Any (serializable) function can be used for :dispatch:

(m/validate
  [:multi {:dispatch 'first}
   [:sized [:tuple keyword? [:map [:size int?]]]]
   [:human [:tuple keyword? [:map [:name string?] [:address [:map [:country keyword?]]]]]]]
  [:human {:name "seppo", :address {:country :sweden}}])
; true

I guess also here unquoted first would work similarly.

[vharmain]

Actually, @ikitommi we should probably clarify in the README what are the limitations to functions in general

• when serialization is needed (sci)
• when no serialization is needed (will just about any function work..?)

If you think this is a good idea I could make a separate issue + PR about it.

[ikitommi]

Yes, all examples besides a specific sci-part could be without sci. Any function works in all places. Quoting is just a trick to get 'em serialized.

Feel free to tune the README however it's better.

[vharmain]

I went through all the examples in README.md and changed them to work without sci when appropriate. Also fixed a couple small other things while going through.

I also lifted commonly used Address schema to its own section because it's assumed in many examples across the README and earlier it was defined in a bit random place.

[ikitommi]

so good.