Skip to content
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

allow push_back() and pop_back() calls on json_pointer #1434

Merged
merged 1 commit into from
Jan 19, 2019

Conversation

pboettch
Copy link
Contributor

@pboettch pboettch commented Jan 15, 2019

Putting pop_back() to public and creating a trivial push_back()
method allows users of nlohmann::json_pointer to manipulate an
existing json-pointer by adding or removing keys at the end.

This is useful for traversing a JSON-instance and keeping track
of its "absolute path" at any moment.

In my case for a schema-validator error-handler.

[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]


Pull request checklist

Read the Contribution Guidelines for detailed information.

  • Changes are described in the pull request, or an existing issue is referenced.
  • The test suite compiles and runs without error.
  • Code coverage is 100%. Test cases can be added by editing the test suite.
  • The source code is amalgamated; that is, after making changes to the sources in the include/nlohmann directory, run make amalgamate to create the single-header file single_include/nlohmann/json.hpp. The whole process is described here.

Please don't

  • The C++11 support varies between different compilers and versions. Please note the list of supported compilers. Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with #ifdefs or other means.
  • Specifically, I am aware of compilation problems with Microsoft Visual Studio (there even is an issue label for these kind of bugs). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
  • Please refrain from proposing changes that would break JSON conformance. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
  • Please do not open pull requests that address multiple issues.

Putting pop_back() to public and creating a trivial push_back()
method allows users of nlohmann::json_pointer to manipulate an
existing json-pointer by adding or removing keys at the end.

This is useful for traversing a JSON-instance and keeping track
of its "absolute path" at any moment.

In my case for a schema-validator error-handler.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 9225cf2 on pboettch:develop into e5753b1 on nlohmann:develop.

@nlohmann
Copy link
Owner

FYI: We had some discussions on this topic some time ago: #837. It would be great if you could have a look at that discussion and see if you can comment on it.

Copy link
Owner

@nlohmann nlohmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@nlohmann nlohmann self-assigned this Jan 19, 2019
@nlohmann nlohmann added this to the Release 3.5.1 milestone Jan 19, 2019
@nlohmann nlohmann merged commit b9a39b3 into nlohmann:develop Jan 19, 2019
@nlohmann
Copy link
Owner

Thanks!

@nlohmann
Copy link
Owner

nlohmann commented Mar 17, 2019

@pboettch It's been a long time that I merged this, and I am currently preparing the 3.6.0 release and thus working on documentation for the new JSON Pointer functions. Though I approved the respective PRs, I would propose some changes before making the actual release, as later interface changes are complicated.

  • I would make array_index() private. I see little value in having this helper function called by the user.
  • I find it confusing that pop_back() returns a value. I would rather have it void, and add a function back() to return the last reference token. This would make the interface more consistent to std::vector.
  • I would rename parent_pointer() to parent(), but that is just a stylistic question.

@pboettch What are your thoughts? I do not expect any PRs; I can make the changes myself once we get an agreement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants