Use custom Tag / Tags records (instead of MapEntry / Map) in parse output #1150
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 16, 2024
|
Oh bother, the ordering of malli.destructure schemas is now different on clj and cljs. I'll fix the test. |
opqdonut
force-pushed
the
tagged-record
branch
from
c395b5d to
a446df9
Compare
|
Looks Good. Parse docs/examples should be changed too, e.g. in README: (m/parse
[:* [:catn
[:prop string?]
[:val [:altn
[:s string?]
[:b boolean?]]]]]
["-server" "foo" "-verbose" true "-user" "joe"])
;[{:prop "-server", :val #malli.impl.util.Tagged{:key :s, :value "foo"}}
; {:prop "-verbose", :val #malli.impl.util.Tagged{:key :b, :value true}}
; {:prop "-user", :val #malli.impl.util.Tagged{:key :s, :value "joe"}}] |
|
see also #1153 |
Using a MapEntry was confusing users, because it printed like a vector, but you couldn't give a vector to unparse. The current method of using MapEntry was broken for weird schemas: ``` (def schema [:or [:tuple :string :keyword] [:orn ["any" :keyword]]]) (->> (m/parse schema :any) (m/unparse schema)) ; => ["any" :any] ; should've been :any ``` Changes the parse behaviour for (at least) :orn, :altn and :multi Some place (like the entry parsers) used miu/-tagged to generate MapEntry values. These use sites now use the new miu/-entry. This keeps the surface area of this change a lot smaller since we don't need to touch all the map entry logic. fixes #1123 replaces #1140
This avoids a problem where the map output from :catn could be
confused with an actual map value. For example:
```
(def Schema
[:or
[:vector [:map
[:s :string]
[:a :any]]]
[:* [:catn
[:s :string]
[:a :any]]]])
(m/parse Schema ["kikka" {:a 1}])
; => [{:s "kikka", :a {:a 1}}]
(m/unparse Schema *1)
; => [{:s "kikka", :a {:a 1}}]
; should've been the original value, ["kikka" {:a 1}]
```
fixes #1153
opqdonut
force-pushed
the
tagged-record
branch
from
a446df9 to
43acc12
Compare
|
still need to update the docs, will try to do that tomorrow |
ikitommi
reviewed
Jan 7, 2025
... and rename Tagged to Tag
opqdonut
force-pushed
the
tagged-record
branch
from
43acc12 to
9a1ba56
Compare
opqdonut
force-pushed
the
tagged-record
branch
from
9a1ba56 to
5e3d6b4
Compare
|
Ready for review/merge now IMO. |
opqdonut
changed the title
ikitommi
approved these changes
Jan 8, 2025
|
Yeah, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using a MapEntry was confusing users, because it printed like a vector, but
you couldn't give a vector to unparse.
The current method of using MapEntry was broken for weird schemas:
Changes the parse behaviour for (at least) :orn, :altn and :multi
For similar reasons, also use a new Tags record, instead of a map, for :catn
parse results. See #1153.
Some place (like the entry parsers) used miu/-tagged to generate MapEntry
values. These use sites now use the new miu/-entry. This keeps the surface
area of this change a lot smaller since we don't need to touch all the map
entry logic.
fixes #1123 #1153 replaces #1140