-
Notifications
You must be signed in to change notification settings - Fork 22
Allow custom names for properties in JSON serialization #451
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
thegridman
wants to merge
2
commits into
master
Choose a base branch
from
jk/json-property
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+70
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /** | ||
| * An annotation to allow customization of the JSON name of a value. | ||
| * | ||
| * For example, if the JSON field name for a property needs to be "$data", this is invalid as an | ||
| * Ecstasy identifier name. The property can be annotated like this: | ||
| * | ||
| * @JsonProperty("$data") | ||
| * String data; | ||
| * | ||
| * The [ReflectionMapping] will use the value from the annotation to map the JSON field name to the | ||
| * property name. | ||
| * | ||
| * @param jsonName - the customized name of the field | ||
| */ | ||
| annotation JsonProperty(String jsonName) | ||
| into Class | Property { | ||
| } |
This file contains hidden or 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
34 changes: 34 additions & 0 deletions
34
lib_json/src/test/x/JsonTest/annotations/JsonPropertyTest.x
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import json.Mapping; | ||
| import json.ObjectInputStream; | ||
| import json.Parser; | ||
| import json.Schema; | ||
|
|
||
| import json.annotations.JsonProperty; | ||
|
|
||
| class JsonPropertyTest { | ||
|
|
||
| Schema jsonSchema = Schema.DEFAULT; | ||
|
|
||
| static const Data(@JsonProperty("$data") String? s, String foo) {} | ||
|
|
||
| @Test | ||
| void shouldParseValueWithCustomPropertyName() { | ||
| Data data = new Data("One", "Two"); | ||
| String jsonStr = \|{"$data":"One", "foo":"Two"} | ||
| ; | ||
| Mapping<Data> valueMapping = jsonSchema.ensureMapping(Data); | ||
| using (ObjectInputStream stream = new ObjectInputStream(jsonSchema, jsonStr.toReader())) { | ||
| val parsed = valueMapping.read(stream.ensureElementInput()); | ||
| assert parsed == data; | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldWriteValueWithCustomPropertyName() { | ||
| StringBuffer buf = new StringBuffer(); | ||
| Data data = new Data("One", "Two"); | ||
| jsonSchema.createObjectOutput(buf).write(data); | ||
| assert buf.toString() == \|{"$data":"One","foo":"Two"} | ||
| ; | ||
| } | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.