Attribute type aliases with Shale::Type.register and Shale::Type.lookup #44
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
kgiszczak
requested changes
Oct 5, 2024
| @@ -1208,12 +1208,12 @@ PersonMapper.to_json(person, pretty: true) | |||
|
|
|||
| Shale supports these types out of the box: | |||
There was a problem hiding this comment.
Can you add a section to the readme, describing that passing a class as a type is also valid, with some small example?
| @@ -8,14 +8,14 @@ module ShaleMapperTesting | |||
| BAR_DEFAULT_PROC = -> { 'bar' } | |||
|
|
|||
| class Parent < Shale::Mapper | |||
| attribute :foo, Shale::Type::String | |||
There was a problem hiding this comment.
Can you also add a test case using classes?
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.
Design
Introduces
Shale::Type.registerandShale::Type.lookupthat theShale::Mapperuses to map a short symbol alias to a fullShale::Type::Valuesubclass.Existing built-in types have been registered with aliases, with the following exceptions:
Shale::Type::Value- base class, couldn't come up with a good use case why this would be used directly enough to warrant an aliasShale::Type::Complex- private API, shouldn't be used directly anywayOut of Scope
I left the lookups for the XML/JSON schema compiler and generation alone such that they continue to stamp in the full class name instead of the symbol alias, but can switch those if you'd prefer.
I was going to swap them, but felt that the
namemethod returning something like":string"felt a bit more awkward than the full class name as it would need to have the:prefix.Resolves #43.