cleanup, test, and diff
This commit is contained in:
1 parent
96cfe7463f
commit
5e0bf75d60
10 files changed
+1765
-413
No files matched your search
@@ -428,7 +428,7 @@ $ make
|
|||||||
$ ./json_unit "*"
|
$ ./json_unit "*"
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
All tests passed (3344416 assertions in 30 test cases)
|
All tests passed (3344554 assertions in 31 test cases)
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, have a look at the file [.travis.yml](https://github.com/nlohmann/json/blob/master/.travis.yml).
|
For more information, have a look at the file [.travis.yml](https://github.com/nlohmann/json/blob/master/.travis.yml).
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
#include <json.hpp>
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
// the source document
|
||||||
|
json source = R"(
|
||||||
|
{
|
||||||
|
"baz": "qux",
|
||||||
|
"foo": "bar"
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// the target document
|
||||||
|
json target = R"(
|
||||||
|
{
|
||||||
|
"baz": "boo",
|
||||||
|
"hello": [
|
||||||
|
"world"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// create the patch
|
||||||
|
json patch = json::diff(source, target);
|
||||||
|
|
||||||
|
// roundtrip
|
||||||
|
json patched_source = source.patch(patch);
|
||||||
|
|
||||||
|
// output patch and roundtrip result
|
||||||
|
std::cout << std::setw(4) << patch << "\n\n"
|
||||||
|
<< std::setw(4) << patched_source << std::endl;
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<a target="_blank" href="http://melpon.org/wandbox/permlink/hicmeOK39tBxaluM"><b>online</b></a>
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"op": "replace",
|
||||||
|
"path": "/baz",
|
||||||
|
"value": "boo"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"op": "remove",
|
||||||
|
"path": "/foo"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"op": "add",
|
||||||
|
"path": "/hello",
|
||||||
|
"value": [
|
||||||
|
"world"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
{
|
||||||
|
"baz": "boo",
|
||||||
|
"hello": [
|
||||||
|
"world"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
#include <json.hpp>
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
// the original document
|
||||||
|
json doc = R"(
|
||||||
|
{
|
||||||
|
"baz": "qux",
|
||||||
|
"foo": "bar"
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// the patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{ "op": "replace", "path": "/baz", "value": "boo" },
|
||||||
|
{ "op": "add", "path": "/hello", "value": ["world"] },
|
||||||
|
{ "op": "remove", "path": "/foo"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// apply the patch
|
||||||
|
json patched_doc = doc.patch(patch);
|
||||||
|
|
||||||
|
// output original and patched document
|
||||||
|
std::cout << std::setw(4) << doc << "\n\n"
|
||||||
|
<< std::setw(4) << patched_doc << std::endl;
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<a target="_blank" href="http://melpon.org/wandbox/permlink/lbczW3AzcUbH1Nbo"><b>online</b></a>
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"baz": "qux",
|
||||||
|
"foo": "bar"
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
"baz": "boo",
|
||||||
|
"hello": [
|
||||||
|
"world"
|
||||||
|
]
|
||||||
|
}
|
||||||
+512
-167
@@ -3595,121 +3595,6 @@ class basic_json
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
|
||||||
No bound checking is performed. Similar to
|
|
||||||
@ref operator[](const typename object_t::key_type&), `null` values
|
|
||||||
are created in arrays and objects if necessary.
|
|
||||||
|
|
||||||
In particular:
|
|
||||||
- If the JSON pointer points to an object key that does not exist, it
|
|
||||||
is created an filled with a `null` value before a reference to it
|
|
||||||
is returned.
|
|
||||||
- If the JSON pointer points to an array index that does not exist, it
|
|
||||||
is created an filled with a `null` value before a reference to it
|
|
||||||
is returned. All indices between the current maximum and the given
|
|
||||||
index are also filled with `null`.
|
|
||||||
- The special value `-` is treated as a synonym for the index past the
|
|
||||||
end.
|
|
||||||
|
|
||||||
@param[in] ptr a JSON pointer
|
|
||||||
|
|
||||||
@return reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,operatorjson_pointer}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
reference operator[](const json_pointer& ptr)
|
|
||||||
{
|
|
||||||
return ptr.get_unchecked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
|
||||||
No bound checking is performed. The function does not change the JSON
|
|
||||||
value; no `null` values are created. In particular, the the special value
|
|
||||||
`-` yields an exception.
|
|
||||||
|
|
||||||
@param[in] ptr JSON pointer to the desired element
|
|
||||||
|
|
||||||
@return const reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,operatorjson_pointer_const}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
const_reference operator[](const json_pointer& ptr) const
|
|
||||||
{
|
|
||||||
return ptr.get_unchecked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Returns a reference to the element at with specified JSON pointer @a ptr,
|
|
||||||
with bounds checking.
|
|
||||||
|
|
||||||
@param[in] ptr JSON pointer to the desired element
|
|
||||||
|
|
||||||
@return reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,at_json_pointer}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
reference at(const json_pointer& ptr)
|
|
||||||
{
|
|
||||||
return ptr.get_checked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Returns a const reference to the element at with specified JSON pointer
|
|
||||||
@a ptr, with bounds checking.
|
|
||||||
|
|
||||||
@param[in] ptr JSON pointer to the desired element
|
|
||||||
|
|
||||||
@return reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,at_json_pointer_const}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
const_reference at(const json_pointer& ptr) const
|
|
||||||
{
|
|
||||||
return ptr.get_checked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief access specified object element with default value
|
@brief access specified object element with default value
|
||||||
|
|
||||||
@@ -4145,8 +4030,8 @@ class basic_json
|
|||||||
|
|
||||||
@throw std::domain_error when called on a type other than JSON array;
|
@throw std::domain_error when called on a type other than JSON array;
|
||||||
example: `"cannot use erase() with null"`
|
example: `"cannot use erase() with null"`
|
||||||
@throw std::out_of_range when `idx >= size()`; example: `"index out of
|
@throw std::out_of_range when `idx >= size()`; example: `"array index 17
|
||||||
range"`
|
is out of range"`
|
||||||
|
|
||||||
@complexity Linear in distance between @a idx and the end of the container.
|
@complexity Linear in distance between @a idx and the end of the container.
|
||||||
|
|
||||||
@@ -4167,7 +4052,7 @@ class basic_json
|
|||||||
{
|
{
|
||||||
if (idx >= size())
|
if (idx >= size())
|
||||||
{
|
{
|
||||||
throw std::out_of_range("index out of range");
|
throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
|
||||||
}
|
}
|
||||||
|
|
||||||
assert(m_value.array != nullptr);
|
assert(m_value.array != nullptr);
|
||||||
@@ -8969,9 +8854,17 @@ basic_json_parser_63:
|
|||||||
: reference_tokens(split(s))
|
: reference_tokens(split(s))
|
||||||
{}
|
{}
|
||||||
|
|
||||||
|
/// test for inequality
|
||||||
|
bool operator!=(const json_pointer& rhs) const
|
||||||
|
{
|
||||||
|
return reference_tokens != rhs.reference_tokens;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
/// remove and return last reference pointer
|
||||||
std::string pop_back()
|
std::string pop_back()
|
||||||
{
|
{
|
||||||
if (reference_tokens.empty())
|
if (is_root())
|
||||||
{
|
{
|
||||||
throw std::domain_error("JSON pointer has no parent");
|
throw std::domain_error("JSON pointer has no parent");
|
||||||
}
|
}
|
||||||
@@ -8981,7 +8874,24 @@ basic_json_parser_63:
|
|||||||
return last;
|
return last;
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
/// return whether pointer points to the root document
|
||||||
|
bool is_root() const
|
||||||
|
{
|
||||||
|
return reference_tokens.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
json_pointer top() const
|
||||||
|
{
|
||||||
|
if (is_root())
|
||||||
|
{
|
||||||
|
throw std::domain_error("JSON pointer has no parent");
|
||||||
|
}
|
||||||
|
|
||||||
|
json_pointer result = *this;
|
||||||
|
result.reference_tokens = {reference_tokens[0]};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief create and return a reference to the pointed to value
|
@brief create and return a reference to the pointed to value
|
||||||
*/
|
*/
|
||||||
@@ -9020,7 +8930,7 @@ basic_json_parser_63:
|
|||||||
case value_t::array:
|
case value_t::array:
|
||||||
{
|
{
|
||||||
// create an entry in the array
|
// create an entry in the array
|
||||||
result = &result->operator[](static_cast<size_t>(std::stoi(reference_token)));
|
result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -9083,7 +8993,7 @@ basic_json_parser_63:
|
|||||||
else
|
else
|
||||||
{
|
{
|
||||||
// convert array index to number; unchecked access
|
// convert array index to number; unchecked access
|
||||||
ptr = &ptr->operator[](static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -9128,7 +9038,7 @@ basic_json_parser_63:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// note: at performs range check
|
// note: at performs range check
|
||||||
ptr = &ptr->at(static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -9180,7 +9090,7 @@ basic_json_parser_63:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// use unchecked array access
|
// use unchecked array access
|
||||||
ptr = &ptr->operator[](static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -9224,7 +9134,7 @@ basic_json_parser_63:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// note: at performs range check
|
// note: at performs range check
|
||||||
ptr = &ptr->at(static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -9291,12 +9201,8 @@ basic_json_parser_63:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// first transform any occurrence of the sequence '~1' to '/'
|
|
||||||
replace_substring(reference_token, "~1", "/");
|
|
||||||
// then transform any occurrence of the sequence '~0' to '~'
|
|
||||||
replace_substring(reference_token, "~0", "~");
|
|
||||||
|
|
||||||
// finally, store the reference token
|
// finally, store the reference token
|
||||||
|
unescape(reference_token);
|
||||||
result.push_back(reference_token);
|
result.push_back(reference_token);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -9332,6 +9238,24 @@ basic_json_parser_63:
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// escape tilde and slash
|
||||||
|
static std::string escape(std::string s)
|
||||||
|
{
|
||||||
|
// escape "~"" to "~0" and "/" to "~1"
|
||||||
|
replace_substring(s, "~", "~0");
|
||||||
|
replace_substring(s, "/", "~1");
|
||||||
|
return s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// unescape tilde and slash
|
||||||
|
static void unescape(std::string& s)
|
||||||
|
{
|
||||||
|
// first transform any occurrence of the sequence '~1' to '/'
|
||||||
|
replace_substring(s, "~1", "/");
|
||||||
|
// then transform any occurrence of the sequence '~0' to '~'
|
||||||
|
replace_substring(s, "~0", "~");
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@param[in] reference_string the reference string to the current value
|
@param[in] reference_string the reference string to the current value
|
||||||
@param[in] value the value to consider
|
@param[in] value the value to consider
|
||||||
@@ -9339,7 +9263,7 @@ basic_json_parser_63:
|
|||||||
|
|
||||||
@note Empty objects or arrays are flattened to `null`.
|
@note Empty objects or arrays are flattened to `null`.
|
||||||
*/
|
*/
|
||||||
static void flatten(const std::string reference_string,
|
static void flatten(const std::string& reference_string,
|
||||||
const basic_json& value,
|
const basic_json& value,
|
||||||
basic_json& result)
|
basic_json& result)
|
||||||
{
|
{
|
||||||
@@ -9376,12 +9300,7 @@ basic_json_parser_63:
|
|||||||
// iterate object and use keys as reference string
|
// iterate object and use keys as reference string
|
||||||
for (const auto& element : *value.m_value.object)
|
for (const auto& element : *value.m_value.object)
|
||||||
{
|
{
|
||||||
// escape "~"" to "~0" and "/" to "~1"
|
flatten(reference_string + "/" + escape(element.first),
|
||||||
std::string key(element.first);
|
|
||||||
replace_substring(key, "~", "~0");
|
|
||||||
replace_substring(key, "/", "~1");
|
|
||||||
|
|
||||||
flatten(reference_string + "/" + key,
|
|
||||||
element.second, result);
|
element.second, result);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -9435,13 +9354,128 @@ basic_json_parser_63:
|
|||||||
std::vector<std::string> reference_tokens {};
|
std::vector<std::string> reference_tokens {};
|
||||||
};
|
};
|
||||||
|
|
||||||
////////////////////////////
|
//////////////////////////
|
||||||
// JSON Pointer functions //
|
// JSON Pointer support //
|
||||||
////////////////////////////
|
//////////////////////////
|
||||||
|
|
||||||
/// @name JSON Pointer functions
|
/// @name JSON Pointer functions
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
||||||
|
No bound checking is performed. Similar to
|
||||||
|
@ref operator[](const typename object_t::key_type&), `null` values
|
||||||
|
are created in arrays and objects if necessary.
|
||||||
|
|
||||||
|
In particular:
|
||||||
|
- If the JSON pointer points to an object key that does not exist, it
|
||||||
|
is created an filled with a `null` value before a reference to it
|
||||||
|
is returned.
|
||||||
|
- If the JSON pointer points to an array index that does not exist, it
|
||||||
|
is created an filled with a `null` value before a reference to it
|
||||||
|
is returned. All indices between the current maximum and the given
|
||||||
|
index are also filled with `null`.
|
||||||
|
- The special value `-` is treated as a synonym for the index past the
|
||||||
|
end.
|
||||||
|
|
||||||
|
@param[in] ptr a JSON pointer
|
||||||
|
|
||||||
|
@return reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,operatorjson_pointer}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
reference operator[](const json_pointer& ptr)
|
||||||
|
{
|
||||||
|
return ptr.get_unchecked(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
||||||
|
No bound checking is performed. The function does not change the JSON
|
||||||
|
value; no `null` values are created. In particular, the the special value
|
||||||
|
`-` yields an exception.
|
||||||
|
|
||||||
|
@param[in] ptr JSON pointer to the desired element
|
||||||
|
|
||||||
|
@return const reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,operatorjson_pointer_const}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
const_reference operator[](const json_pointer& ptr) const
|
||||||
|
{
|
||||||
|
return ptr.get_unchecked(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Returns a reference to the element at with specified JSON pointer @a ptr,
|
||||||
|
with bounds checking.
|
||||||
|
|
||||||
|
@param[in] ptr JSON pointer to the desired element
|
||||||
|
|
||||||
|
@return reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,at_json_pointer}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
reference at(const json_pointer& ptr)
|
||||||
|
{
|
||||||
|
return ptr.get_checked(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Returns a const reference to the element at with specified JSON pointer
|
||||||
|
@a ptr, with bounds checking.
|
||||||
|
|
||||||
|
@param[in] ptr JSON pointer to the desired element
|
||||||
|
|
||||||
|
@return reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,at_json_pointer_const}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
const_reference at(const json_pointer& ptr) const
|
||||||
|
{
|
||||||
|
return ptr.get_checked(this);
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief return flattened JSON value
|
@brief return flattened JSON value
|
||||||
|
|
||||||
@@ -9505,35 +9539,119 @@ basic_json_parser_63:
|
|||||||
|
|
||||||
/// @}
|
/// @}
|
||||||
|
|
||||||
|
//////////////////////////
|
||||||
|
// JSON Patch functions //
|
||||||
|
//////////////////////////
|
||||||
|
|
||||||
|
/// @name JSON Patch functions
|
||||||
|
/// @{
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief applies a JSON patch
|
@brief applies a JSON patch
|
||||||
|
|
||||||
|
[JSON Patch](http://jsonpatch.com) defines a JSON document structure for
|
||||||
|
expressing a sequence of operations to apply to a JSON) document. With
|
||||||
|
this funcion, a JSON Patch is applied to the current JSON value by
|
||||||
|
executing all operations from the patch.
|
||||||
|
|
||||||
@param[in] patch JSON patch document
|
@param[in] patch JSON patch document
|
||||||
@return patched document
|
@return patched document
|
||||||
|
|
||||||
@note The original JSON value is not changed; that is, the patch is
|
@note The application of a patch is atomic: Either all operations succeed
|
||||||
applied to a copy of the value.
|
and the patched document is returned or an exception is thrown. In
|
||||||
|
any case, the original value is not changed: the patch is applied
|
||||||
|
to a copy of the value.
|
||||||
|
|
||||||
@sa [RFC 6902](https://tools.ietf.org/html/rfc6902)
|
@throw std::out_of_range if a JSON pointer inside the patch could not
|
||||||
|
be resolved successfully in the current JSON value; example: `"key baz
|
||||||
|
not found"`
|
||||||
|
@throw invalid_argument if the JSON patch is malformed (e.g., mandatory
|
||||||
|
attributes are missing); example: `"operation add must have member path"`
|
||||||
|
|
||||||
|
@complexity Linear in the size of the JSON value and the length of the
|
||||||
|
JSON patch. As usually only a fraction of the JSON value is affected by
|
||||||
|
the patch, the complexity can usually be neglected.
|
||||||
|
|
||||||
|
@liveexample{The following code shows how a JSON patch is applied to a
|
||||||
|
value.,patch}
|
||||||
|
|
||||||
|
@sa @ref diff -- create a JSON patch by comparing two JSON values
|
||||||
|
|
||||||
|
@sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
|
||||||
|
@sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
*/
|
*/
|
||||||
basic_json apply_patch(const basic_json& patch) const
|
basic_json patch(const basic_json& patch) const
|
||||||
{
|
{
|
||||||
// make a working copy to apply the patch to
|
// make a working copy to apply the patch to
|
||||||
basic_json result = *this;
|
basic_json result = *this;
|
||||||
|
|
||||||
|
// the valid JSON Patch operations
|
||||||
|
enum class patch_operations {add, remove, replace, move, copy, test, invalid};
|
||||||
|
|
||||||
|
const auto get_op = [](const std::string op)
|
||||||
|
{
|
||||||
|
if (op == "add")
|
||||||
|
{
|
||||||
|
return patch_operations::add;
|
||||||
|
}
|
||||||
|
if (op == "remove")
|
||||||
|
{
|
||||||
|
return patch_operations::remove;
|
||||||
|
}
|
||||||
|
if (op == "replace")
|
||||||
|
{
|
||||||
|
return patch_operations::replace;
|
||||||
|
}
|
||||||
|
if (op == "move")
|
||||||
|
{
|
||||||
|
return patch_operations::move;
|
||||||
|
}
|
||||||
|
if (op == "copy")
|
||||||
|
{
|
||||||
|
return patch_operations::copy;
|
||||||
|
}
|
||||||
|
if (op == "test")
|
||||||
|
{
|
||||||
|
return patch_operations::test;
|
||||||
|
}
|
||||||
|
|
||||||
|
return patch_operations::invalid;
|
||||||
|
};
|
||||||
|
|
||||||
// wrapper for "add" operation; add value at ptr
|
// wrapper for "add" operation; add value at ptr
|
||||||
const auto operation_add = [&result](json_pointer & ptr, basic_json val)
|
const auto operation_add = [&result](json_pointer & ptr, basic_json val)
|
||||||
{
|
{
|
||||||
|
// adding to the root of the target document means replacing it
|
||||||
|
if (ptr.is_root())
|
||||||
|
{
|
||||||
|
result = val;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// make sure the top element of the pointer exists
|
||||||
|
json_pointer top_pointer = ptr.top();
|
||||||
|
if (top_pointer != ptr)
|
||||||
|
{
|
||||||
|
basic_json& x = result.at(top_pointer);
|
||||||
|
}
|
||||||
|
|
||||||
// get reference to parent of JSON pointer ptr
|
// get reference to parent of JSON pointer ptr
|
||||||
const auto last_path = ptr.pop_back();
|
const auto last_path = ptr.pop_back();
|
||||||
basic_json& parent = result.at(ptr);
|
basic_json& parent = result[ptr];
|
||||||
|
|
||||||
if (parent.is_object())
|
switch (parent.m_type)
|
||||||
|
{
|
||||||
|
case value_t::null:
|
||||||
|
case value_t::object:
|
||||||
{
|
{
|
||||||
// use operator[] to add value
|
// use operator[] to add value
|
||||||
parent[last_path] = val;
|
parent[last_path] = val;
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (parent.is_array())
|
|
||||||
|
case value_t::array:
|
||||||
{
|
{
|
||||||
if (last_path == "-")
|
if (last_path == "-")
|
||||||
{
|
{
|
||||||
@@ -9541,9 +9659,26 @@ basic_json_parser_63:
|
|||||||
parent.push_back(val);
|
parent.push_back(val);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
|
{
|
||||||
|
const auto idx = std::stoi(last_path);
|
||||||
|
if (static_cast<size_type>(idx) > parent.size())
|
||||||
|
{
|
||||||
|
// avoid undefined behavior
|
||||||
|
throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
|
||||||
|
}
|
||||||
|
else
|
||||||
{
|
{
|
||||||
// default case: insert add offset
|
// default case: insert add offset
|
||||||
parent.insert(parent.begin() + std::stoi(last_path), val);
|
parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
throw std::domain_error("unexpected parent type " + parent.type_name());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -9558,11 +9693,21 @@ basic_json_parser_63:
|
|||||||
// remove child
|
// remove child
|
||||||
if (parent.is_object())
|
if (parent.is_object())
|
||||||
{
|
{
|
||||||
parent.erase(parent.find(last_path));
|
// perform range check
|
||||||
|
auto it = parent.find(last_path);
|
||||||
|
if (it != parent.end())
|
||||||
|
{
|
||||||
|
parent.erase(it);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
throw std::out_of_range("key '" + last_path + "' not found");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
else if (parent.is_array())
|
else if (parent.is_array())
|
||||||
{
|
{
|
||||||
parent.erase(parent.begin() + std::stoi(last_path));
|
// note erase performs range check
|
||||||
|
parent.erase(static_cast<size_type>(std::stoi(last_path)));
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -9570,7 +9715,7 @@ basic_json_parser_63:
|
|||||||
if (not patch.is_array())
|
if (not patch.is_array())
|
||||||
{
|
{
|
||||||
// a JSON patch must be an array of objects
|
// a JSON patch must be an array of objects
|
||||||
throw std::domain_error("JSON patch must be an array of objects");
|
throw std::invalid_argument("JSON patch must be an array of objects");
|
||||||
}
|
}
|
||||||
|
|
||||||
// iterate and apply th eoperations
|
// iterate and apply th eoperations
|
||||||
@@ -9590,13 +9735,13 @@ basic_json_parser_63:
|
|||||||
// check if desired value is present
|
// check if desired value is present
|
||||||
if (it == val.m_value.object->end())
|
if (it == val.m_value.object->end())
|
||||||
{
|
{
|
||||||
throw std::domain_error(error_msg + " must have member '" + member + "'");
|
throw std::invalid_argument(error_msg + " must have member '" + member + "'");
|
||||||
}
|
}
|
||||||
|
|
||||||
// check if result is of type string
|
// check if result is of type string
|
||||||
if (string_type and not it->second.is_string())
|
if (string_type and not it->second.is_string())
|
||||||
{
|
{
|
||||||
throw std::domain_error(error_msg + " must have string member '" + member + "'");
|
throw std::invalid_argument(error_msg + " must have string member '" + member + "'");
|
||||||
}
|
}
|
||||||
|
|
||||||
// no error: return value
|
// no error: return value
|
||||||
@@ -9606,7 +9751,7 @@ basic_json_parser_63:
|
|||||||
// type check
|
// type check
|
||||||
if (not val.is_object())
|
if (not val.is_object())
|
||||||
{
|
{
|
||||||
throw std::domain_error("JSON patch must be an array of objects");
|
throw std::invalid_argument("JSON patch must be an array of objects");
|
||||||
}
|
}
|
||||||
|
|
||||||
// collect mandatory members
|
// collect mandatory members
|
||||||
@@ -9614,51 +9759,251 @@ basic_json_parser_63:
|
|||||||
const std::string path = get_value(op, "path", true);
|
const std::string path = get_value(op, "path", true);
|
||||||
json_pointer ptr(path);
|
json_pointer ptr(path);
|
||||||
|
|
||||||
if (op == "add")
|
switch (get_op(op))
|
||||||
|
{
|
||||||
|
case patch_operations::add:
|
||||||
{
|
{
|
||||||
operation_add(ptr, get_value("add", "value", false));
|
operation_add(ptr, get_value("add", "value", false));
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "remove")
|
|
||||||
|
case patch_operations::remove:
|
||||||
{
|
{
|
||||||
operation_remove(ptr);
|
operation_remove(ptr);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "replace")
|
|
||||||
|
case patch_operations::replace:
|
||||||
{
|
{
|
||||||
|
// the "path" location must exist - use at()
|
||||||
result.at(ptr) = get_value("replace", "value", false);
|
result.at(ptr) = get_value("replace", "value", false);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "move")
|
|
||||||
|
case patch_operations::move:
|
||||||
{
|
{
|
||||||
const std::string from_path = get_value("move", "from", true);
|
const std::string from_path = get_value("move", "from", true);
|
||||||
json_pointer from_ptr(from_path);
|
json_pointer from_ptr(from_path);
|
||||||
basic_json v = result[from_ptr];
|
|
||||||
|
|
||||||
|
// the "from" location must exist - use at()
|
||||||
|
basic_json v = result.at(from_ptr);
|
||||||
|
|
||||||
|
// The move operation is functionally identical to a
|
||||||
|
// "remove" operation on the "from" location, followed
|
||||||
|
// immediately by an "add" operation at the target
|
||||||
|
// location with the value that was just removed.
|
||||||
operation_remove(from_ptr);
|
operation_remove(from_ptr);
|
||||||
operation_add(ptr, v);
|
operation_add(ptr, v);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "copy")
|
|
||||||
|
case patch_operations::copy:
|
||||||
{
|
{
|
||||||
const std::string from_path = get_value("copy", "from", true);;
|
const std::string from_path = get_value("copy", "from", true);;
|
||||||
const json_pointer from_ptr(from_path);
|
const json_pointer from_ptr(from_path);
|
||||||
|
|
||||||
|
// the "from" location must exist - use at()
|
||||||
result[ptr] = result.at(from_ptr);
|
result[ptr] = result.at(from_ptr);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "test")
|
|
||||||
|
case patch_operations::test:
|
||||||
{
|
{
|
||||||
if (result.at(ptr) != get_value("test", "value", false))
|
bool success = false;
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// check if "value" matches the one at "path"
|
||||||
|
// the "path" location must exist - use at()
|
||||||
|
success = (result.at(ptr) == get_value("test", "value", false));
|
||||||
|
}
|
||||||
|
catch (std::out_of_range&)
|
||||||
|
{
|
||||||
|
// ignore out of range errors: success remains false
|
||||||
|
}
|
||||||
|
|
||||||
|
// throw an exception if test fails
|
||||||
|
if (not success)
|
||||||
{
|
{
|
||||||
throw std::domain_error("unsuccessful: " + val.dump());
|
throw std::domain_error("unsuccessful: " + val.dump());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else
|
|
||||||
|
case patch_operations::invalid:
|
||||||
{
|
{
|
||||||
// op must be "add", "remove", "replace", "move", "copy", or
|
// op must be "add", "remove", "replace", "move", "copy", or
|
||||||
// "test"
|
// "test"
|
||||||
throw std::domain_error("operation value '" + op + "' is invalid");
|
throw std::invalid_argument("operation value '" + op + "' is invalid");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief creates a diff as a JSON patch
|
||||||
|
|
||||||
|
Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
|
||||||
|
be changed into the value @a target by calling @ref patch function.
|
||||||
|
|
||||||
|
@invariant For two JSON values @a source and @a target, the following code
|
||||||
|
yields always `true`:
|
||||||
|
@code {.cpp}
|
||||||
|
source.patch(diff(source, target)) == target;
|
||||||
|
@endcode
|
||||||
|
|
||||||
|
@note Currently, only `remove`, `add`, and `replace` operations are
|
||||||
|
generated.
|
||||||
|
|
||||||
|
@param[in] source JSON value to copare from
|
||||||
|
@param[in] target JSON value to copare against
|
||||||
|
@param[in] path helper value to create JSON pointers
|
||||||
|
|
||||||
|
@return a JSON patch to convert the @a source to @a target
|
||||||
|
|
||||||
|
@complexity Linear in the lengths of @a source and @a target.
|
||||||
|
|
||||||
|
@liveexample{The following code shows how a JSON patch is created as a
|
||||||
|
diff for two JSON values.,diff}
|
||||||
|
|
||||||
|
@sa @ref patch -- apply a JSON patch
|
||||||
|
|
||||||
|
@sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
static basic_json diff(const basic_json& source,
|
||||||
|
const basic_json& target,
|
||||||
|
std::string path = "") noexcept
|
||||||
|
{
|
||||||
|
// the patch
|
||||||
|
basic_json result(value_t::array);
|
||||||
|
|
||||||
|
// if the values are the same, return empty patch
|
||||||
|
if (source == target)
|
||||||
|
{
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (source.type() != target.type())
|
||||||
|
{
|
||||||
|
// different types: replace value
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "replace"},
|
||||||
|
{"path", path},
|
||||||
|
{"value", target}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
switch (source.type())
|
||||||
|
{
|
||||||
|
case value_t::array:
|
||||||
|
{
|
||||||
|
// first pass: traverse common elements
|
||||||
|
size_t i = 0;
|
||||||
|
while (i < source.size() and i < target.size())
|
||||||
|
{
|
||||||
|
// recursive call to compare array values at index i
|
||||||
|
auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i));
|
||||||
|
result.insert(result.end(), temp_diff.begin(), temp_diff.end());
|
||||||
|
++i;
|
||||||
|
}
|
||||||
|
|
||||||
|
// i now reached the end of at least one array
|
||||||
|
// in a second pass, traverse the remaining elements
|
||||||
|
|
||||||
|
// remove my remaining elements
|
||||||
|
while (i < source.size())
|
||||||
|
{
|
||||||
|
result.push_back(object(
|
||||||
|
{
|
||||||
|
{"op", "remove"},
|
||||||
|
{"path", path + "/" + std::to_string(i)}
|
||||||
|
}));
|
||||||
|
++i;
|
||||||
|
}
|
||||||
|
|
||||||
|
// add other remaining elements
|
||||||
|
while (i < target.size())
|
||||||
|
{
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "add"},
|
||||||
|
{"path", path + "/" + std::to_string(i)},
|
||||||
|
{"value", target[i]}
|
||||||
|
});
|
||||||
|
++i;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case value_t::object:
|
||||||
|
{
|
||||||
|
// first pass: traverse this object's elements
|
||||||
|
for (auto it = source.begin(); it != source.end(); ++it)
|
||||||
|
{
|
||||||
|
// escape the key name to be used in a JSON patch
|
||||||
|
const auto key = json_pointer::escape(it.key());
|
||||||
|
|
||||||
|
if (target.find(it.key()) != target.end())
|
||||||
|
{
|
||||||
|
// recursive call to compare object values at key it
|
||||||
|
auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key);
|
||||||
|
result.insert(result.end(), temp_diff.begin(), temp_diff.end());
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// found a key that is not in o -> remove it
|
||||||
|
result.push_back(object(
|
||||||
|
{
|
||||||
|
{"op", "remove"},
|
||||||
|
{"path", path + "/" + key}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// second pass: traverse other object's elements
|
||||||
|
for (auto it = target.begin(); it != target.end(); ++it)
|
||||||
|
{
|
||||||
|
if (source.find(it.key()) == source.end())
|
||||||
|
{
|
||||||
|
// found a key that is not in this -> add it
|
||||||
|
const auto key = json_pointer::escape(it.key());
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "add"},
|
||||||
|
{"path", path + "/" + key},
|
||||||
|
{"value", it.value()}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
// both primitive type: replace value
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "replace"},
|
||||||
|
{"path", path},
|
||||||
|
{"value", target}
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// @}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
@@ -9678,9 +10023,9 @@ using json = basic_json<>;
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/////////////////////////
|
///////////////////////
|
||||||
// nonmember functions //
|
// nonmember support //
|
||||||
/////////////////////////
|
///////////////////////
|
||||||
|
|
||||||
// specialization of std::swap, and std::hash
|
// specialization of std::swap, and std::hash
|
||||||
namespace std
|
namespace std
|
||||||
|
|||||||
+512
-167
@@ -3595,121 +3595,6 @@ class basic_json
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
|
||||||
No bound checking is performed. Similar to
|
|
||||||
@ref operator[](const typename object_t::key_type&), `null` values
|
|
||||||
are created in arrays and objects if necessary.
|
|
||||||
|
|
||||||
In particular:
|
|
||||||
- If the JSON pointer points to an object key that does not exist, it
|
|
||||||
is created an filled with a `null` value before a reference to it
|
|
||||||
is returned.
|
|
||||||
- If the JSON pointer points to an array index that does not exist, it
|
|
||||||
is created an filled with a `null` value before a reference to it
|
|
||||||
is returned. All indices between the current maximum and the given
|
|
||||||
index are also filled with `null`.
|
|
||||||
- The special value `-` is treated as a synonym for the index past the
|
|
||||||
end.
|
|
||||||
|
|
||||||
@param[in] ptr a JSON pointer
|
|
||||||
|
|
||||||
@return reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,operatorjson_pointer}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
reference operator[](const json_pointer& ptr)
|
|
||||||
{
|
|
||||||
return ptr.get_unchecked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
|
||||||
No bound checking is performed. The function does not change the JSON
|
|
||||||
value; no `null` values are created. In particular, the the special value
|
|
||||||
`-` yields an exception.
|
|
||||||
|
|
||||||
@param[in] ptr JSON pointer to the desired element
|
|
||||||
|
|
||||||
@return const reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,operatorjson_pointer_const}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
const_reference operator[](const json_pointer& ptr) const
|
|
||||||
{
|
|
||||||
return ptr.get_unchecked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Returns a reference to the element at with specified JSON pointer @a ptr,
|
|
||||||
with bounds checking.
|
|
||||||
|
|
||||||
@param[in] ptr JSON pointer to the desired element
|
|
||||||
|
|
||||||
@return reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,at_json_pointer}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
reference at(const json_pointer& ptr)
|
|
||||||
{
|
|
||||||
return ptr.get_checked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief access specified element via JSON Pointer
|
|
||||||
|
|
||||||
Returns a const reference to the element at with specified JSON pointer
|
|
||||||
@a ptr, with bounds checking.
|
|
||||||
|
|
||||||
@param[in] ptr JSON pointer to the desired element
|
|
||||||
|
|
||||||
@return reference to the element pointed to by @a ptr
|
|
||||||
|
|
||||||
@complexity Constant.
|
|
||||||
|
|
||||||
@throw std::out_of_range if the JSON pointer can not be resolved
|
|
||||||
@throw std::domain_error if an array index begins with '0'
|
|
||||||
@throw std::invalid_argument if an array index was not a number
|
|
||||||
|
|
||||||
@liveexample{The behavior is shown in the example.,at_json_pointer_const}
|
|
||||||
|
|
||||||
@since version 2.0.0
|
|
||||||
*/
|
|
||||||
const_reference at(const json_pointer& ptr) const
|
|
||||||
{
|
|
||||||
return ptr.get_checked(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief access specified object element with default value
|
@brief access specified object element with default value
|
||||||
|
|
||||||
@@ -4145,8 +4030,8 @@ class basic_json
|
|||||||
|
|
||||||
@throw std::domain_error when called on a type other than JSON array;
|
@throw std::domain_error when called on a type other than JSON array;
|
||||||
example: `"cannot use erase() with null"`
|
example: `"cannot use erase() with null"`
|
||||||
@throw std::out_of_range when `idx >= size()`; example: `"index out of
|
@throw std::out_of_range when `idx >= size()`; example: `"array index 17
|
||||||
range"`
|
is out of range"`
|
||||||
|
|
||||||
@complexity Linear in distance between @a idx and the end of the container.
|
@complexity Linear in distance between @a idx and the end of the container.
|
||||||
|
|
||||||
@@ -4167,7 +4052,7 @@ class basic_json
|
|||||||
{
|
{
|
||||||
if (idx >= size())
|
if (idx >= size())
|
||||||
{
|
{
|
||||||
throw std::out_of_range("index out of range");
|
throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
|
||||||
}
|
}
|
||||||
|
|
||||||
assert(m_value.array != nullptr);
|
assert(m_value.array != nullptr);
|
||||||
@@ -8279,9 +8164,17 @@ class basic_json
|
|||||||
: reference_tokens(split(s))
|
: reference_tokens(split(s))
|
||||||
{}
|
{}
|
||||||
|
|
||||||
|
/// test for inequality
|
||||||
|
bool operator!=(const json_pointer& rhs) const
|
||||||
|
{
|
||||||
|
return reference_tokens != rhs.reference_tokens;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
/// remove and return last reference pointer
|
||||||
std::string pop_back()
|
std::string pop_back()
|
||||||
{
|
{
|
||||||
if (reference_tokens.empty())
|
if (is_root())
|
||||||
{
|
{
|
||||||
throw std::domain_error("JSON pointer has no parent");
|
throw std::domain_error("JSON pointer has no parent");
|
||||||
}
|
}
|
||||||
@@ -8291,7 +8184,24 @@ class basic_json
|
|||||||
return last;
|
return last;
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
/// return whether pointer points to the root document
|
||||||
|
bool is_root() const
|
||||||
|
{
|
||||||
|
return reference_tokens.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
json_pointer top() const
|
||||||
|
{
|
||||||
|
if (is_root())
|
||||||
|
{
|
||||||
|
throw std::domain_error("JSON pointer has no parent");
|
||||||
|
}
|
||||||
|
|
||||||
|
json_pointer result = *this;
|
||||||
|
result.reference_tokens = {reference_tokens[0]};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief create and return a reference to the pointed to value
|
@brief create and return a reference to the pointed to value
|
||||||
*/
|
*/
|
||||||
@@ -8330,7 +8240,7 @@ class basic_json
|
|||||||
case value_t::array:
|
case value_t::array:
|
||||||
{
|
{
|
||||||
// create an entry in the array
|
// create an entry in the array
|
||||||
result = &result->operator[](static_cast<size_t>(std::stoi(reference_token)));
|
result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8393,7 +8303,7 @@ class basic_json
|
|||||||
else
|
else
|
||||||
{
|
{
|
||||||
// convert array index to number; unchecked access
|
// convert array index to number; unchecked access
|
||||||
ptr = &ptr->operator[](static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -8438,7 +8348,7 @@ class basic_json
|
|||||||
}
|
}
|
||||||
|
|
||||||
// note: at performs range check
|
// note: at performs range check
|
||||||
ptr = &ptr->at(static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8490,7 +8400,7 @@ class basic_json
|
|||||||
}
|
}
|
||||||
|
|
||||||
// use unchecked array access
|
// use unchecked array access
|
||||||
ptr = &ptr->operator[](static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8534,7 +8444,7 @@ class basic_json
|
|||||||
}
|
}
|
||||||
|
|
||||||
// note: at performs range check
|
// note: at performs range check
|
||||||
ptr = &ptr->at(static_cast<size_t>(std::stoi(reference_token)));
|
ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8601,12 +8511,8 @@ class basic_json
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// first transform any occurrence of the sequence '~1' to '/'
|
|
||||||
replace_substring(reference_token, "~1", "/");
|
|
||||||
// then transform any occurrence of the sequence '~0' to '~'
|
|
||||||
replace_substring(reference_token, "~0", "~");
|
|
||||||
|
|
||||||
// finally, store the reference token
|
// finally, store the reference token
|
||||||
|
unescape(reference_token);
|
||||||
result.push_back(reference_token);
|
result.push_back(reference_token);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8642,6 +8548,24 @@ class basic_json
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// escape tilde and slash
|
||||||
|
static std::string escape(std::string s)
|
||||||
|
{
|
||||||
|
// escape "~"" to "~0" and "/" to "~1"
|
||||||
|
replace_substring(s, "~", "~0");
|
||||||
|
replace_substring(s, "/", "~1");
|
||||||
|
return s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// unescape tilde and slash
|
||||||
|
static void unescape(std::string& s)
|
||||||
|
{
|
||||||
|
// first transform any occurrence of the sequence '~1' to '/'
|
||||||
|
replace_substring(s, "~1", "/");
|
||||||
|
// then transform any occurrence of the sequence '~0' to '~'
|
||||||
|
replace_substring(s, "~0", "~");
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@param[in] reference_string the reference string to the current value
|
@param[in] reference_string the reference string to the current value
|
||||||
@param[in] value the value to consider
|
@param[in] value the value to consider
|
||||||
@@ -8649,7 +8573,7 @@ class basic_json
|
|||||||
|
|
||||||
@note Empty objects or arrays are flattened to `null`.
|
@note Empty objects or arrays are flattened to `null`.
|
||||||
*/
|
*/
|
||||||
static void flatten(const std::string reference_string,
|
static void flatten(const std::string& reference_string,
|
||||||
const basic_json& value,
|
const basic_json& value,
|
||||||
basic_json& result)
|
basic_json& result)
|
||||||
{
|
{
|
||||||
@@ -8686,12 +8610,7 @@ class basic_json
|
|||||||
// iterate object and use keys as reference string
|
// iterate object and use keys as reference string
|
||||||
for (const auto& element : *value.m_value.object)
|
for (const auto& element : *value.m_value.object)
|
||||||
{
|
{
|
||||||
// escape "~"" to "~0" and "/" to "~1"
|
flatten(reference_string + "/" + escape(element.first),
|
||||||
std::string key(element.first);
|
|
||||||
replace_substring(key, "~", "~0");
|
|
||||||
replace_substring(key, "/", "~1");
|
|
||||||
|
|
||||||
flatten(reference_string + "/" + key,
|
|
||||||
element.second, result);
|
element.second, result);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -8745,13 +8664,128 @@ class basic_json
|
|||||||
std::vector<std::string> reference_tokens {};
|
std::vector<std::string> reference_tokens {};
|
||||||
};
|
};
|
||||||
|
|
||||||
////////////////////////////
|
//////////////////////////
|
||||||
// JSON Pointer functions //
|
// JSON Pointer support //
|
||||||
////////////////////////////
|
//////////////////////////
|
||||||
|
|
||||||
/// @name JSON Pointer functions
|
/// @name JSON Pointer functions
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
||||||
|
No bound checking is performed. Similar to
|
||||||
|
@ref operator[](const typename object_t::key_type&), `null` values
|
||||||
|
are created in arrays and objects if necessary.
|
||||||
|
|
||||||
|
In particular:
|
||||||
|
- If the JSON pointer points to an object key that does not exist, it
|
||||||
|
is created an filled with a `null` value before a reference to it
|
||||||
|
is returned.
|
||||||
|
- If the JSON pointer points to an array index that does not exist, it
|
||||||
|
is created an filled with a `null` value before a reference to it
|
||||||
|
is returned. All indices between the current maximum and the given
|
||||||
|
index are also filled with `null`.
|
||||||
|
- The special value `-` is treated as a synonym for the index past the
|
||||||
|
end.
|
||||||
|
|
||||||
|
@param[in] ptr a JSON pointer
|
||||||
|
|
||||||
|
@return reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,operatorjson_pointer}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
reference operator[](const json_pointer& ptr)
|
||||||
|
{
|
||||||
|
return ptr.get_unchecked(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Uses a JSON pointer to retrieve a reference to the respective JSON value.
|
||||||
|
No bound checking is performed. The function does not change the JSON
|
||||||
|
value; no `null` values are created. In particular, the the special value
|
||||||
|
`-` yields an exception.
|
||||||
|
|
||||||
|
@param[in] ptr JSON pointer to the desired element
|
||||||
|
|
||||||
|
@return const reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,operatorjson_pointer_const}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
const_reference operator[](const json_pointer& ptr) const
|
||||||
|
{
|
||||||
|
return ptr.get_unchecked(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Returns a reference to the element at with specified JSON pointer @a ptr,
|
||||||
|
with bounds checking.
|
||||||
|
|
||||||
|
@param[in] ptr JSON pointer to the desired element
|
||||||
|
|
||||||
|
@return reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,at_json_pointer}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
reference at(const json_pointer& ptr)
|
||||||
|
{
|
||||||
|
return ptr.get_checked(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief access specified element via JSON Pointer
|
||||||
|
|
||||||
|
Returns a const reference to the element at with specified JSON pointer
|
||||||
|
@a ptr, with bounds checking.
|
||||||
|
|
||||||
|
@param[in] ptr JSON pointer to the desired element
|
||||||
|
|
||||||
|
@return reference to the element pointed to by @a ptr
|
||||||
|
|
||||||
|
@complexity Constant.
|
||||||
|
|
||||||
|
@throw std::out_of_range if the JSON pointer can not be resolved
|
||||||
|
@throw std::domain_error if an array index begins with '0'
|
||||||
|
@throw std::invalid_argument if an array index was not a number
|
||||||
|
|
||||||
|
@liveexample{The behavior is shown in the example.,at_json_pointer_const}
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
const_reference at(const json_pointer& ptr) const
|
||||||
|
{
|
||||||
|
return ptr.get_checked(this);
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief return flattened JSON value
|
@brief return flattened JSON value
|
||||||
|
|
||||||
@@ -8815,35 +8849,119 @@ class basic_json
|
|||||||
|
|
||||||
/// @}
|
/// @}
|
||||||
|
|
||||||
|
//////////////////////////
|
||||||
|
// JSON Patch functions //
|
||||||
|
//////////////////////////
|
||||||
|
|
||||||
|
/// @name JSON Patch functions
|
||||||
|
/// @{
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief applies a JSON patch
|
@brief applies a JSON patch
|
||||||
|
|
||||||
|
[JSON Patch](http://jsonpatch.com) defines a JSON document structure for
|
||||||
|
expressing a sequence of operations to apply to a JSON) document. With
|
||||||
|
this funcion, a JSON Patch is applied to the current JSON value by
|
||||||
|
executing all operations from the patch.
|
||||||
|
|
||||||
@param[in] patch JSON patch document
|
@param[in] patch JSON patch document
|
||||||
@return patched document
|
@return patched document
|
||||||
|
|
||||||
@note The original JSON value is not changed; that is, the patch is
|
@note The application of a patch is atomic: Either all operations succeed
|
||||||
applied to a copy of the value.
|
and the patched document is returned or an exception is thrown. In
|
||||||
|
any case, the original value is not changed: the patch is applied
|
||||||
|
to a copy of the value.
|
||||||
|
|
||||||
@sa [RFC 6902](https://tools.ietf.org/html/rfc6902)
|
@throw std::out_of_range if a JSON pointer inside the patch could not
|
||||||
|
be resolved successfully in the current JSON value; example: `"key baz
|
||||||
|
not found"`
|
||||||
|
@throw invalid_argument if the JSON patch is malformed (e.g., mandatory
|
||||||
|
attributes are missing); example: `"operation add must have member path"`
|
||||||
|
|
||||||
|
@complexity Linear in the size of the JSON value and the length of the
|
||||||
|
JSON patch. As usually only a fraction of the JSON value is affected by
|
||||||
|
the patch, the complexity can usually be neglected.
|
||||||
|
|
||||||
|
@liveexample{The following code shows how a JSON patch is applied to a
|
||||||
|
value.,patch}
|
||||||
|
|
||||||
|
@sa @ref diff -- create a JSON patch by comparing two JSON values
|
||||||
|
|
||||||
|
@sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
|
||||||
|
@sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
*/
|
*/
|
||||||
basic_json apply_patch(const basic_json& patch) const
|
basic_json patch(const basic_json& patch) const
|
||||||
{
|
{
|
||||||
// make a working copy to apply the patch to
|
// make a working copy to apply the patch to
|
||||||
basic_json result = *this;
|
basic_json result = *this;
|
||||||
|
|
||||||
|
// the valid JSON Patch operations
|
||||||
|
enum class patch_operations {add, remove, replace, move, copy, test, invalid};
|
||||||
|
|
||||||
|
const auto get_op = [](const std::string op)
|
||||||
|
{
|
||||||
|
if (op == "add")
|
||||||
|
{
|
||||||
|
return patch_operations::add;
|
||||||
|
}
|
||||||
|
if (op == "remove")
|
||||||
|
{
|
||||||
|
return patch_operations::remove;
|
||||||
|
}
|
||||||
|
if (op == "replace")
|
||||||
|
{
|
||||||
|
return patch_operations::replace;
|
||||||
|
}
|
||||||
|
if (op == "move")
|
||||||
|
{
|
||||||
|
return patch_operations::move;
|
||||||
|
}
|
||||||
|
if (op == "copy")
|
||||||
|
{
|
||||||
|
return patch_operations::copy;
|
||||||
|
}
|
||||||
|
if (op == "test")
|
||||||
|
{
|
||||||
|
return patch_operations::test;
|
||||||
|
}
|
||||||
|
|
||||||
|
return patch_operations::invalid;
|
||||||
|
};
|
||||||
|
|
||||||
// wrapper for "add" operation; add value at ptr
|
// wrapper for "add" operation; add value at ptr
|
||||||
const auto operation_add = [&result](json_pointer & ptr, basic_json val)
|
const auto operation_add = [&result](json_pointer & ptr, basic_json val)
|
||||||
{
|
{
|
||||||
|
// adding to the root of the target document means replacing it
|
||||||
|
if (ptr.is_root())
|
||||||
|
{
|
||||||
|
result = val;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// make sure the top element of the pointer exists
|
||||||
|
json_pointer top_pointer = ptr.top();
|
||||||
|
if (top_pointer != ptr)
|
||||||
|
{
|
||||||
|
basic_json& x = result.at(top_pointer);
|
||||||
|
}
|
||||||
|
|
||||||
// get reference to parent of JSON pointer ptr
|
// get reference to parent of JSON pointer ptr
|
||||||
const auto last_path = ptr.pop_back();
|
const auto last_path = ptr.pop_back();
|
||||||
basic_json& parent = result.at(ptr);
|
basic_json& parent = result[ptr];
|
||||||
|
|
||||||
if (parent.is_object())
|
switch (parent.m_type)
|
||||||
|
{
|
||||||
|
case value_t::null:
|
||||||
|
case value_t::object:
|
||||||
{
|
{
|
||||||
// use operator[] to add value
|
// use operator[] to add value
|
||||||
parent[last_path] = val;
|
parent[last_path] = val;
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (parent.is_array())
|
|
||||||
|
case value_t::array:
|
||||||
{
|
{
|
||||||
if (last_path == "-")
|
if (last_path == "-")
|
||||||
{
|
{
|
||||||
@@ -8851,9 +8969,26 @@ class basic_json
|
|||||||
parent.push_back(val);
|
parent.push_back(val);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
|
{
|
||||||
|
const auto idx = std::stoi(last_path);
|
||||||
|
if (static_cast<size_type>(idx) > parent.size())
|
||||||
|
{
|
||||||
|
// avoid undefined behavior
|
||||||
|
throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
|
||||||
|
}
|
||||||
|
else
|
||||||
{
|
{
|
||||||
// default case: insert add offset
|
// default case: insert add offset
|
||||||
parent.insert(parent.begin() + std::stoi(last_path), val);
|
parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
throw std::domain_error("unexpected parent type " + parent.type_name());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -8868,11 +9003,21 @@ class basic_json
|
|||||||
// remove child
|
// remove child
|
||||||
if (parent.is_object())
|
if (parent.is_object())
|
||||||
{
|
{
|
||||||
parent.erase(parent.find(last_path));
|
// perform range check
|
||||||
|
auto it = parent.find(last_path);
|
||||||
|
if (it != parent.end())
|
||||||
|
{
|
||||||
|
parent.erase(it);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
throw std::out_of_range("key '" + last_path + "' not found");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
else if (parent.is_array())
|
else if (parent.is_array())
|
||||||
{
|
{
|
||||||
parent.erase(parent.begin() + std::stoi(last_path));
|
// note erase performs range check
|
||||||
|
parent.erase(static_cast<size_type>(std::stoi(last_path)));
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -8880,7 +9025,7 @@ class basic_json
|
|||||||
if (not patch.is_array())
|
if (not patch.is_array())
|
||||||
{
|
{
|
||||||
// a JSON patch must be an array of objects
|
// a JSON patch must be an array of objects
|
||||||
throw std::domain_error("JSON patch must be an array of objects");
|
throw std::invalid_argument("JSON patch must be an array of objects");
|
||||||
}
|
}
|
||||||
|
|
||||||
// iterate and apply th eoperations
|
// iterate and apply th eoperations
|
||||||
@@ -8900,13 +9045,13 @@ class basic_json
|
|||||||
// check if desired value is present
|
// check if desired value is present
|
||||||
if (it == val.m_value.object->end())
|
if (it == val.m_value.object->end())
|
||||||
{
|
{
|
||||||
throw std::domain_error(error_msg + " must have member '" + member + "'");
|
throw std::invalid_argument(error_msg + " must have member '" + member + "'");
|
||||||
}
|
}
|
||||||
|
|
||||||
// check if result is of type string
|
// check if result is of type string
|
||||||
if (string_type and not it->second.is_string())
|
if (string_type and not it->second.is_string())
|
||||||
{
|
{
|
||||||
throw std::domain_error(error_msg + " must have string member '" + member + "'");
|
throw std::invalid_argument(error_msg + " must have string member '" + member + "'");
|
||||||
}
|
}
|
||||||
|
|
||||||
// no error: return value
|
// no error: return value
|
||||||
@@ -8916,7 +9061,7 @@ class basic_json
|
|||||||
// type check
|
// type check
|
||||||
if (not val.is_object())
|
if (not val.is_object())
|
||||||
{
|
{
|
||||||
throw std::domain_error("JSON patch must be an array of objects");
|
throw std::invalid_argument("JSON patch must be an array of objects");
|
||||||
}
|
}
|
||||||
|
|
||||||
// collect mandatory members
|
// collect mandatory members
|
||||||
@@ -8924,51 +9069,251 @@ class basic_json
|
|||||||
const std::string path = get_value(op, "path", true);
|
const std::string path = get_value(op, "path", true);
|
||||||
json_pointer ptr(path);
|
json_pointer ptr(path);
|
||||||
|
|
||||||
if (op == "add")
|
switch (get_op(op))
|
||||||
|
{
|
||||||
|
case patch_operations::add:
|
||||||
{
|
{
|
||||||
operation_add(ptr, get_value("add", "value", false));
|
operation_add(ptr, get_value("add", "value", false));
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "remove")
|
|
||||||
|
case patch_operations::remove:
|
||||||
{
|
{
|
||||||
operation_remove(ptr);
|
operation_remove(ptr);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "replace")
|
|
||||||
|
case patch_operations::replace:
|
||||||
{
|
{
|
||||||
|
// the "path" location must exist - use at()
|
||||||
result.at(ptr) = get_value("replace", "value", false);
|
result.at(ptr) = get_value("replace", "value", false);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "move")
|
|
||||||
|
case patch_operations::move:
|
||||||
{
|
{
|
||||||
const std::string from_path = get_value("move", "from", true);
|
const std::string from_path = get_value("move", "from", true);
|
||||||
json_pointer from_ptr(from_path);
|
json_pointer from_ptr(from_path);
|
||||||
basic_json v = result[from_ptr];
|
|
||||||
|
|
||||||
|
// the "from" location must exist - use at()
|
||||||
|
basic_json v = result.at(from_ptr);
|
||||||
|
|
||||||
|
// The move operation is functionally identical to a
|
||||||
|
// "remove" operation on the "from" location, followed
|
||||||
|
// immediately by an "add" operation at the target
|
||||||
|
// location with the value that was just removed.
|
||||||
operation_remove(from_ptr);
|
operation_remove(from_ptr);
|
||||||
operation_add(ptr, v);
|
operation_add(ptr, v);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "copy")
|
|
||||||
|
case patch_operations::copy:
|
||||||
{
|
{
|
||||||
const std::string from_path = get_value("copy", "from", true);;
|
const std::string from_path = get_value("copy", "from", true);;
|
||||||
const json_pointer from_ptr(from_path);
|
const json_pointer from_ptr(from_path);
|
||||||
|
|
||||||
|
// the "from" location must exist - use at()
|
||||||
result[ptr] = result.at(from_ptr);
|
result[ptr] = result.at(from_ptr);
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else if (op == "test")
|
|
||||||
|
case patch_operations::test:
|
||||||
{
|
{
|
||||||
if (result.at(ptr) != get_value("test", "value", false))
|
bool success = false;
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// check if "value" matches the one at "path"
|
||||||
|
// the "path" location must exist - use at()
|
||||||
|
success = (result.at(ptr) == get_value("test", "value", false));
|
||||||
|
}
|
||||||
|
catch (std::out_of_range&)
|
||||||
|
{
|
||||||
|
// ignore out of range errors: success remains false
|
||||||
|
}
|
||||||
|
|
||||||
|
// throw an exception if test fails
|
||||||
|
if (not success)
|
||||||
{
|
{
|
||||||
throw std::domain_error("unsuccessful: " + val.dump());
|
throw std::domain_error("unsuccessful: " + val.dump());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
else
|
|
||||||
|
case patch_operations::invalid:
|
||||||
{
|
{
|
||||||
// op must be "add", "remove", "replace", "move", "copy", or
|
// op must be "add", "remove", "replace", "move", "copy", or
|
||||||
// "test"
|
// "test"
|
||||||
throw std::domain_error("operation value '" + op + "' is invalid");
|
throw std::invalid_argument("operation value '" + op + "' is invalid");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief creates a diff as a JSON patch
|
||||||
|
|
||||||
|
Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
|
||||||
|
be changed into the value @a target by calling @ref patch function.
|
||||||
|
|
||||||
|
@invariant For two JSON values @a source and @a target, the following code
|
||||||
|
yields always `true`:
|
||||||
|
@code {.cpp}
|
||||||
|
source.patch(diff(source, target)) == target;
|
||||||
|
@endcode
|
||||||
|
|
||||||
|
@note Currently, only `remove`, `add`, and `replace` operations are
|
||||||
|
generated.
|
||||||
|
|
||||||
|
@param[in] source JSON value to copare from
|
||||||
|
@param[in] target JSON value to copare against
|
||||||
|
@param[in] path helper value to create JSON pointers
|
||||||
|
|
||||||
|
@return a JSON patch to convert the @a source to @a target
|
||||||
|
|
||||||
|
@complexity Linear in the lengths of @a source and @a target.
|
||||||
|
|
||||||
|
@liveexample{The following code shows how a JSON patch is created as a
|
||||||
|
diff for two JSON values.,diff}
|
||||||
|
|
||||||
|
@sa @ref patch -- apply a JSON patch
|
||||||
|
|
||||||
|
@sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
|
||||||
|
|
||||||
|
@since version 2.0.0
|
||||||
|
*/
|
||||||
|
static basic_json diff(const basic_json& source,
|
||||||
|
const basic_json& target,
|
||||||
|
std::string path = "") noexcept
|
||||||
|
{
|
||||||
|
// the patch
|
||||||
|
basic_json result(value_t::array);
|
||||||
|
|
||||||
|
// if the values are the same, return empty patch
|
||||||
|
if (source == target)
|
||||||
|
{
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (source.type() != target.type())
|
||||||
|
{
|
||||||
|
// different types: replace value
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "replace"},
|
||||||
|
{"path", path},
|
||||||
|
{"value", target}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
switch (source.type())
|
||||||
|
{
|
||||||
|
case value_t::array:
|
||||||
|
{
|
||||||
|
// first pass: traverse common elements
|
||||||
|
size_t i = 0;
|
||||||
|
while (i < source.size() and i < target.size())
|
||||||
|
{
|
||||||
|
// recursive call to compare array values at index i
|
||||||
|
auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i));
|
||||||
|
result.insert(result.end(), temp_diff.begin(), temp_diff.end());
|
||||||
|
++i;
|
||||||
|
}
|
||||||
|
|
||||||
|
// i now reached the end of at least one array
|
||||||
|
// in a second pass, traverse the remaining elements
|
||||||
|
|
||||||
|
// remove my remaining elements
|
||||||
|
while (i < source.size())
|
||||||
|
{
|
||||||
|
result.push_back(object(
|
||||||
|
{
|
||||||
|
{"op", "remove"},
|
||||||
|
{"path", path + "/" + std::to_string(i)}
|
||||||
|
}));
|
||||||
|
++i;
|
||||||
|
}
|
||||||
|
|
||||||
|
// add other remaining elements
|
||||||
|
while (i < target.size())
|
||||||
|
{
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "add"},
|
||||||
|
{"path", path + "/" + std::to_string(i)},
|
||||||
|
{"value", target[i]}
|
||||||
|
});
|
||||||
|
++i;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case value_t::object:
|
||||||
|
{
|
||||||
|
// first pass: traverse this object's elements
|
||||||
|
for (auto it = source.begin(); it != source.end(); ++it)
|
||||||
|
{
|
||||||
|
// escape the key name to be used in a JSON patch
|
||||||
|
const auto key = json_pointer::escape(it.key());
|
||||||
|
|
||||||
|
if (target.find(it.key()) != target.end())
|
||||||
|
{
|
||||||
|
// recursive call to compare object values at key it
|
||||||
|
auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key);
|
||||||
|
result.insert(result.end(), temp_diff.begin(), temp_diff.end());
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// found a key that is not in o -> remove it
|
||||||
|
result.push_back(object(
|
||||||
|
{
|
||||||
|
{"op", "remove"},
|
||||||
|
{"path", path + "/" + key}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// second pass: traverse other object's elements
|
||||||
|
for (auto it = target.begin(); it != target.end(); ++it)
|
||||||
|
{
|
||||||
|
if (source.find(it.key()) == source.end())
|
||||||
|
{
|
||||||
|
// found a key that is not in this -> add it
|
||||||
|
const auto key = json_pointer::escape(it.key());
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "add"},
|
||||||
|
{"path", path + "/" + key},
|
||||||
|
{"value", it.value()}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
// both primitive type: replace value
|
||||||
|
result.push_back(
|
||||||
|
{
|
||||||
|
{"op", "replace"},
|
||||||
|
{"path", path},
|
||||||
|
{"value", target}
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// @}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
@@ -8988,9 +9333,9 @@ using json = basic_json<>;
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/////////////////////////
|
///////////////////////
|
||||||
// nonmember functions //
|
// nonmember support //
|
||||||
/////////////////////////
|
///////////////////////
|
||||||
|
|
||||||
// specialization of std::swap, and std::hash
|
// specialization of std::swap, and std::hash
|
||||||
namespace std
|
namespace std
|
||||||
|
|||||||
+638
-78
@@ -3455,7 +3455,7 @@ TEST_CASE("element access")
|
|||||||
{
|
{
|
||||||
json jarray = {1, 1u, true, nullptr, "string", 42.23, json::object(), {1, 2, 3}};
|
json jarray = {1, 1u, true, nullptr, "string", 42.23, json::object(), {1, 2, 3}};
|
||||||
CHECK_THROWS_AS(jarray.erase(8), std::out_of_range);
|
CHECK_THROWS_AS(jarray.erase(8), std::out_of_range);
|
||||||
CHECK_THROWS_WITH(jarray.erase(8), "index out of range");
|
CHECK_THROWS_WITH(jarray.erase(8), "array index 8 is out of range");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12395,7 +12395,60 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
SECTION("examples from RFC 6902")
|
SECTION("examples from RFC 6902")
|
||||||
{
|
{
|
||||||
SECTION("example A.1 - Adding an Object Member")
|
SECTION("4. Operations")
|
||||||
|
{
|
||||||
|
// the ordering of members in JSON objects is not significant:
|
||||||
|
json op1 = R"({ "op": "add", "path": "/a/b/c", "value": "foo" })"_json;
|
||||||
|
json op2 = R"({ "path": "/a/b/c", "op": "add", "value": "foo" })"_json;
|
||||||
|
json op3 = R"({ "value": "foo", "path": "/a/b/c", "op": "add" })"_json;
|
||||||
|
|
||||||
|
// check if the operation objects are equivalent
|
||||||
|
CHECK(op1 == op2);
|
||||||
|
CHECK(op1 == op3);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("4.1 add")
|
||||||
|
{
|
||||||
|
json patch = R"([{ "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] }])"_json;
|
||||||
|
|
||||||
|
// However, the object itself or an array containing it does need
|
||||||
|
// to exist, and it remains an error for that not to be the case.
|
||||||
|
// For example, an "add" with a target location of "/a/b" starting
|
||||||
|
// with this document
|
||||||
|
json doc1 = R"({ "a": { "foo": 1 } })"_json;
|
||||||
|
|
||||||
|
// is not an error, because "a" exists, and "b" will be added to
|
||||||
|
// its value.
|
||||||
|
CHECK_NOTHROW(doc1.patch(patch));
|
||||||
|
CHECK(doc1.patch(patch) == R"(
|
||||||
|
{
|
||||||
|
"a": {
|
||||||
|
"foo": 1,
|
||||||
|
"b": {
|
||||||
|
"c": [ "foo", "bar" ]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)"_json);
|
||||||
|
|
||||||
|
// It is an error in this document:
|
||||||
|
json doc2 = R"({ "q": { "bar": 2 } })"_json;
|
||||||
|
|
||||||
|
// because "a" does not exist.
|
||||||
|
CHECK_THROWS_AS(doc2.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(doc2.patch(patch), "key 'a' not found");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("4.2 remove")
|
||||||
|
{
|
||||||
|
// If removing an element from an array, any elements above the
|
||||||
|
// specified index are shifted one position to the left.
|
||||||
|
json doc = {1, 2, 3, 4};
|
||||||
|
json patch = {{{"op", "remove"}, {"path", "/1"}}};
|
||||||
|
CHECK(doc.patch(patch) == json({1, 3, 4}));
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("A.1. Adding an Object Member")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12418,10 +12471,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.2 - Adding an Array Element")
|
SECTION("A.2. Adding an Array Element")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12441,10 +12497,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.3 - Removing an Object Member")
|
SECTION("A.3. Removing an Object Member")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12467,10 +12526,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.4 - Removing an Array Element")
|
SECTION("A.4. Removing an Array Element")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12490,10 +12552,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.5 - Replacing a Value")
|
SECTION("A.5. Replacing a Value")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12518,10 +12583,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.6 - Moving a Value")
|
SECTION("A.6. Moving a Value")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12557,10 +12625,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.7 - Moving a Value")
|
SECTION("A.7. Moving a Value")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12580,10 +12651,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.8 - Testing a Value: Success")
|
SECTION("A.8. Testing a Value: Success")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12602,12 +12676,12 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if evaluation does not throw
|
// check if evaluation does not throw
|
||||||
CHECK_NOTHROW(doc.apply_patch(patch));
|
CHECK_NOTHROW(doc.patch(patch));
|
||||||
// check if patched document is unchanged
|
// check if patched document is unchanged
|
||||||
CHECK(doc.apply_patch(patch) == doc);
|
CHECK(doc.patch(patch) == doc);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.9 - Testing a Value: Error")
|
SECTION("A.9. Testing a Value: Error")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12622,11 +12696,11 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check that evaluation throws
|
// check that evaluation throws
|
||||||
CHECK_THROWS_AS(doc.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(doc.patch(patch), std::domain_error);
|
||||||
CHECK_THROWS_WITH(doc.apply_patch(patch), "unsuccessful: " + patch[0].dump());
|
CHECK_THROWS_WITH(doc.patch(patch), "unsuccessful: " + patch[0].dump());
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.10 - Adding a Nested Member Object")
|
SECTION("A.10. Adding a Nested Member Object")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12652,10 +12726,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.11 - Ignoring Unrecognized Elements")
|
SECTION("A.11. Ignoring Unrecognized Elements")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12677,10 +12754,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.12 - Adding to a Nonexistent Target")
|
SECTION("A.12. Adding to a Nonexistent Target")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12700,14 +12780,14 @@ TEST_CASE("JSON patch")
|
|||||||
// references neither the root of the document, nor a member of
|
// references neither the root of the document, nor a member of
|
||||||
// an existing object, nor a member of an existing array.
|
// an existing object, nor a member of an existing array.
|
||||||
|
|
||||||
CHECK_THROWS_AS(doc.apply_patch(patch), std::out_of_range);
|
CHECK_THROWS_AS(doc.patch(patch), std::out_of_range);
|
||||||
CHECK_THROWS_WITH(doc.apply_patch(patch), "key 'baz' not found");
|
CHECK_THROWS_WITH(doc.patch(patch), "key 'baz' not found");
|
||||||
}
|
}
|
||||||
|
|
||||||
// A.13. Invalid JSON Patch Document
|
// A.13. Invalid JSON Patch Document
|
||||||
// not applicable
|
// not applicable
|
||||||
|
|
||||||
SECTION("example A.14 - Escape Ordering")
|
SECTION("A.14. Escape Ordering")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12732,10 +12812,13 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.15 - Comparing Strings and Numbers")
|
SECTION("A.15. Comparing Strings and Numbers")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12753,11 +12836,11 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check that evaluation throws
|
// check that evaluation throws
|
||||||
CHECK_THROWS_AS(doc.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(doc.patch(patch), std::domain_error);
|
||||||
CHECK_THROWS_WITH(doc.apply_patch(patch), "unsuccessful: " + patch[0].dump());
|
CHECK_THROWS_WITH(doc.patch(patch), "unsuccessful: " + patch[0].dump());
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("example A.16 - Adding an Array Value")
|
SECTION("A.16. Adding an Array Value")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
json doc = R"(
|
json doc = R"(
|
||||||
@@ -12777,12 +12860,70 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("own examples")
|
SECTION("own examples")
|
||||||
{
|
{
|
||||||
|
SECTION("add")
|
||||||
|
{
|
||||||
|
SECTION("add to the root element")
|
||||||
|
{
|
||||||
|
// If the path is the root of the target document - the
|
||||||
|
// specified value becomes the entire content of the target
|
||||||
|
// document.
|
||||||
|
|
||||||
|
// An example target JSON document:
|
||||||
|
json doc = 17;
|
||||||
|
|
||||||
|
// A JSON Patch document:
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{ "op": "add", "path": "", "value": [1,2,3] }
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The resulting JSON document:
|
||||||
|
json expected = {1, 2, 3};
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("add to end of the array")
|
||||||
|
{
|
||||||
|
// The specified index MUST NOT be greater than the number of
|
||||||
|
// elements in the array. The example below uses and index of
|
||||||
|
// exactly the number of elements in the array which is legal.
|
||||||
|
|
||||||
|
// An example target JSON document:
|
||||||
|
json doc = {0, 1, 2};
|
||||||
|
|
||||||
|
// A JSON Patch document:
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{ "op": "add", "path": "/3", "value": 3 }
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The resulting JSON document:
|
||||||
|
json expected = {0, 1, 2, 3};
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
SECTION("copy")
|
SECTION("copy")
|
||||||
{
|
{
|
||||||
// An example target JSON document:
|
// An example target JSON document:
|
||||||
@@ -12805,6 +12946,7 @@ TEST_CASE("JSON patch")
|
|||||||
]
|
]
|
||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
|
// The resulting JSON document:
|
||||||
json expected = R"(
|
json expected = R"(
|
||||||
{
|
{
|
||||||
"foo": {
|
"foo": {
|
||||||
@@ -12819,7 +12961,60 @@ TEST_CASE("JSON patch")
|
|||||||
)"_json;
|
)"_json;
|
||||||
|
|
||||||
// check if patched value is as expected
|
// check if patched value is as expected
|
||||||
CHECK(doc.apply_patch(patch) == expected);
|
CHECK(doc.patch(patch) == expected);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, expected)) == expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("replace")
|
||||||
|
{
|
||||||
|
json j = "string";
|
||||||
|
json patch = {{{"op", "replace"}, {"path", ""}, {"value", 1}}};
|
||||||
|
CHECK(j.patch(patch) == json(1));
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("documentation GIF")
|
||||||
|
{
|
||||||
|
{
|
||||||
|
// a JSON patch
|
||||||
|
json p1 = R"(
|
||||||
|
[{"op": "add", "path": "/GB", "value": "London"}]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// a JSON value
|
||||||
|
json source = R"(
|
||||||
|
{"D": "Berlin", "F": "Paris"}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// apply the patch
|
||||||
|
json target = source.patch(p1);
|
||||||
|
// target = { "D": "Berlin", "F": "Paris", "GB": "London" }
|
||||||
|
CHECK(target == R"({ "D": "Berlin", "F": "Paris", "GB": "London" })"_json);
|
||||||
|
|
||||||
|
// create a diff from two JSONs
|
||||||
|
json p2 = json::diff(target, source);
|
||||||
|
// p2 = [{"op": "delete", "path": "/GB"}]
|
||||||
|
CHECK(p2 == R"([{"op":"remove","path":"/GB"}])"_json);
|
||||||
|
}
|
||||||
|
{
|
||||||
|
// a JSON value
|
||||||
|
json j = {"good", "bad", "ugly"};
|
||||||
|
|
||||||
|
// a JSON pointer
|
||||||
|
auto ptr = json::json_pointer("/2");
|
||||||
|
|
||||||
|
// use to access elements
|
||||||
|
j[ptr] = {{"it", "cattivo"}};
|
||||||
|
CHECK(j == R"(["good","bad",{"it":"cattivo"}])"_json);
|
||||||
|
|
||||||
|
// use user-defined string literal
|
||||||
|
j["/2/en"_json_pointer] = "ugly";
|
||||||
|
CHECK(j == R"(["good","bad",{"en":"ugly","it":"cattivo"}])"_json);
|
||||||
|
|
||||||
|
json flat = j.flatten();
|
||||||
|
CHECK(flat == R"({"/0":"good","/1":"bad","/2/en":"ugly","/2/it":"cattivo"})"_json);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12827,20 +13022,44 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
SECTION("unknown operation")
|
SECTION("unknown operation")
|
||||||
{
|
{
|
||||||
|
SECTION("not an array")
|
||||||
|
{
|
||||||
|
json j;
|
||||||
|
json patch = {{"op", "add"}, {"path", ""}, {"value", 1}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "JSON patch must be an array of objects");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("not an array of objects")
|
||||||
|
{
|
||||||
|
json j;
|
||||||
|
json patch = {"op", "add", "path", "", "value", 1};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "JSON patch must be an array of objects");
|
||||||
|
}
|
||||||
|
|
||||||
SECTION("missing 'op'")
|
SECTION("missing 'op'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"foo", "bar"}}};
|
json patch = {{{"foo", "bar"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation must have member 'op'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation must have member 'op'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'op'")
|
SECTION("non-string 'op'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", 1}}};
|
json patch = {{{"op", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation must have string member 'op'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation must have string member 'op'");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("invalid operation")
|
||||||
|
{
|
||||||
|
json j;
|
||||||
|
json patch = {{{"op", "foo"}, {"path", ""}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "operation value 'foo' is invalid");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12850,24 +13069,32 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "add"}}};
|
json patch = {{{"op", "add"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'add' must have member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'add' must have member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'path'")
|
SECTION("non-string 'path'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "add"}, {"path", 1}}};
|
json patch = {{{"op", "add"}, {"path", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'add' must have string member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'add' must have string member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("missing 'value'")
|
SECTION("missing 'value'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "add"}, {"path", ""}}};
|
json patch = {{{"op", "add"}, {"path", ""}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'add' must have member 'value'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'add' must have member 'value'");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("invalid array index")
|
||||||
|
{
|
||||||
|
json j = {1, 2};
|
||||||
|
json patch = {{{"op", "add"}, {"path", "/4"}, {"value", 4}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "array index 4 is out of range");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12877,16 +13104,40 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "remove"}}};
|
json patch = {{{"op", "remove"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'remove' must have member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'remove' must have member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'path'")
|
SECTION("non-string 'path'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "remove"}, {"path", 1}}};
|
json patch = {{{"op", "remove"}, {"path", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'remove' must have string member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'remove' must have string member 'path'");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting target location (array)")
|
||||||
|
{
|
||||||
|
json j = {1, 2, 3};
|
||||||
|
json patch = {{{"op", "remove"}, {"path", "/17"}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "array index 17 is out of range");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting target location (object)")
|
||||||
|
{
|
||||||
|
json j = {{"foo", 1}, {"bar", 2}};
|
||||||
|
json patch = {{{"op", "remove"}, {"path", "/baz"}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "key 'baz' not found");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("root element as target location")
|
||||||
|
{
|
||||||
|
json j = "string";
|
||||||
|
json patch = {{{"op", "remove"}, {"path", ""}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::domain_error);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "JSON pointer has no parent");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12896,24 +13147,40 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "replace"}}};
|
json patch = {{{"op", "replace"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'replace' must have member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'replace' must have member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'path'")
|
SECTION("non-string 'path'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "replace"}, {"path", 1}}};
|
json patch = {{{"op", "replace"}, {"path", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'replace' must have string member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'replace' must have string member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("missing 'value'")
|
SECTION("missing 'value'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "replace"}, {"path", ""}}};
|
json patch = {{{"op", "replace"}, {"path", ""}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'replace' must have member 'value'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'replace' must have member 'value'");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting target location (array)")
|
||||||
|
{
|
||||||
|
json j = {1, 2, 3};
|
||||||
|
json patch = {{{"op", "replace"}, {"path", "/17"}, {"value", 19}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "array index 17 is out of range");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting target location (object)")
|
||||||
|
{
|
||||||
|
json j = {{"foo", 1}, {"bar", 2}};
|
||||||
|
json patch = {{{"op", "replace"}, {"path", "/baz"}, {"value", 3}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "key 'baz' not found");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12923,32 +13190,48 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "move"}}};
|
json patch = {{{"op", "move"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'move' must have member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'move' must have member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'path'")
|
SECTION("non-string 'path'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "move"}, {"path", 1}}};
|
json patch = {{{"op", "move"}, {"path", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'move' must have string member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'move' must have string member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("missing 'from'")
|
SECTION("missing 'from'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "move"}, {"path", ""}}};
|
json patch = {{{"op", "move"}, {"path", ""}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'move' must have member 'from'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'move' must have member 'from'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'from'")
|
SECTION("non-string 'from'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "move"}, {"path", ""}, {"from", 1}}};
|
json patch = {{{"op", "move"}, {"path", ""}, {"from", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'move' must have string member 'from'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'move' must have string member 'from'");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting from location (array)")
|
||||||
|
{
|
||||||
|
json j = {1, 2, 3};
|
||||||
|
json patch = {{{"op", "move"}, {"path", "/0"}, {"from", "/5"}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "array index 5 is out of range");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting from location (object)")
|
||||||
|
{
|
||||||
|
json j = {{"foo", 1}, {"bar", 2}};
|
||||||
|
json patch = {{{"op", "move"}, {"path", "/baz"}, {"from", "/baz"}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "key 'baz' not found");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12958,32 +13241,48 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "copy"}}};
|
json patch = {{{"op", "copy"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'copy' must have member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'copy' must have member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'path'")
|
SECTION("non-string 'path'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "copy"}, {"path", 1}}};
|
json patch = {{{"op", "copy"}, {"path", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'copy' must have string member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'copy' must have string member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("missing 'from'")
|
SECTION("missing 'from'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "copy"}, {"path", ""}}};
|
json patch = {{{"op", "copy"}, {"path", ""}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'copy' must have member 'from'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'copy' must have member 'from'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'from'")
|
SECTION("non-string 'from'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "copy"}, {"path", ""}, {"from", 1}}};
|
json patch = {{{"op", "copy"}, {"path", ""}, {"from", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'copy' must have string member 'from'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'copy' must have string member 'from'");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting from location (array)")
|
||||||
|
{
|
||||||
|
json j = {1, 2, 3};
|
||||||
|
json patch = {{{"op", "copy"}, {"path", "/0"}, {"from", "/5"}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "array index 5 is out of range");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nonexisting from location (object)")
|
||||||
|
{
|
||||||
|
json j = {{"foo", 1}, {"bar", 2}};
|
||||||
|
json patch = {{{"op", "copy"}, {"path", "/fob"}, {"from", "/baz"}}};
|
||||||
|
CHECK_THROWS_AS(j.patch(patch), std::out_of_range);
|
||||||
|
CHECK_THROWS_WITH(j.patch(patch), "key 'baz' not found");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12993,27 +13292,288 @@ TEST_CASE("JSON patch")
|
|||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "test"}}};
|
json patch = {{{"op", "test"}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'test' must have member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'test' must have member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("non-string 'path'")
|
SECTION("non-string 'path'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "test"}, {"path", 1}}};
|
json patch = {{{"op", "test"}, {"path", 1}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'test' must have string member 'path'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'test' must have string member 'path'");
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("missing 'value'")
|
SECTION("missing 'value'")
|
||||||
{
|
{
|
||||||
json j;
|
json j;
|
||||||
json patch = {{{"op", "test"}, {"path", ""}}};
|
json patch = {{{"op", "test"}, {"path", ""}}};
|
||||||
CHECK_THROWS_AS(j.apply_patch(patch), std::domain_error);
|
CHECK_THROWS_AS(j.patch(patch), std::invalid_argument);
|
||||||
CHECK_THROWS_WITH(j.apply_patch(patch), "operation 'test' must have member 'value'");
|
CHECK_THROWS_WITH(j.patch(patch), "operation 'test' must have member 'value'");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
SECTION("Examples from jsonpatch.com")
|
||||||
|
{
|
||||||
|
SECTION("Simple Example")
|
||||||
|
{
|
||||||
|
// The original document
|
||||||
|
json doc = R"(
|
||||||
|
{
|
||||||
|
"baz": "qux",
|
||||||
|
"foo": "bar"
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{ "op": "replace", "path": "/baz", "value": "boo" },
|
||||||
|
{ "op": "add", "path": "/hello", "value": ["world"] },
|
||||||
|
{ "op": "remove", "path": "/foo"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The result
|
||||||
|
json result = R"(
|
||||||
|
{
|
||||||
|
"baz": "boo",
|
||||||
|
"hello": ["world"]
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == result);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, result)) == result);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("Operations")
|
||||||
|
{
|
||||||
|
// The original document
|
||||||
|
json doc = R"(
|
||||||
|
{
|
||||||
|
"biscuits": [
|
||||||
|
{"name":"Digestive"},
|
||||||
|
{"name": "Choco Liebniz"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
SECTION("add")
|
||||||
|
{
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{"op": "add", "path": "/biscuits/1", "value": {"name": "Ginger Nut"}}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The result
|
||||||
|
json result = R"(
|
||||||
|
{
|
||||||
|
"biscuits": [
|
||||||
|
{"name": "Digestive"},
|
||||||
|
{"name": "Ginger Nut"},
|
||||||
|
{"name": "Choco Liebniz"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == result);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, result)) == result);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("remove")
|
||||||
|
{
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{"op": "remove", "path": "/biscuits"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The result
|
||||||
|
json result = R"(
|
||||||
|
{}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == result);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, result)) == result);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("replace")
|
||||||
|
{
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{"op": "replace", "path": "/biscuits/0/name", "value": "Chocolate Digestive"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The result
|
||||||
|
json result = R"(
|
||||||
|
{
|
||||||
|
"biscuits": [
|
||||||
|
{"name": "Chocolate Digestive"},
|
||||||
|
{"name": "Choco Liebniz"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == result);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, result)) == result);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("copy")
|
||||||
|
{
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{"op": "copy", "from": "/biscuits/0", "path": "/best_biscuit"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The result
|
||||||
|
json result = R"(
|
||||||
|
{
|
||||||
|
"biscuits": [
|
||||||
|
{"name": "Digestive"},
|
||||||
|
{"name": "Choco Liebniz"}
|
||||||
|
],
|
||||||
|
"best_biscuit": {
|
||||||
|
"name": "Digestive"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == result);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, result)) == result);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("move")
|
||||||
|
{
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{"op": "move", "from": "/biscuits", "path": "/cookies"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// The result
|
||||||
|
json result = R"(
|
||||||
|
{
|
||||||
|
"cookies": [
|
||||||
|
{"name": "Digestive"},
|
||||||
|
{"name": "Choco Liebniz"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// check if patched value is as expected
|
||||||
|
CHECK(doc.patch(patch) == result);
|
||||||
|
|
||||||
|
// check roundtrip
|
||||||
|
CHECK(doc.patch(json::diff(doc, result)) == result);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("test")
|
||||||
|
{
|
||||||
|
// The patch
|
||||||
|
json patch = R"(
|
||||||
|
[
|
||||||
|
{"op": "test", "path": "/best_biscuit/name", "value": "Choco Liebniz"}
|
||||||
|
]
|
||||||
|
)"_json;
|
||||||
|
|
||||||
|
// the test will fail
|
||||||
|
CHECK_THROWS_AS(doc.patch(patch), std::domain_error);
|
||||||
|
CHECK_THROWS_WITH(doc.patch(patch), "unsuccessful: " + patch[0].dump());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("Examples from bruth.github.io/jsonpatch-js")
|
||||||
|
{
|
||||||
|
SECTION("add")
|
||||||
|
{
|
||||||
|
CHECK(R"( {} )"_json.patch(
|
||||||
|
R"( [{"op": "add", "path": "/foo", "value": "bar"}] )"_json
|
||||||
|
) == R"( {"foo": "bar"} )"_json);
|
||||||
|
|
||||||
|
CHECK(R"( {"foo": [1, 3]} )"_json.patch(
|
||||||
|
R"( [{"op": "add", "path": "/foo", "value": "bar"}] )"_json
|
||||||
|
) == R"( {"foo": "bar"} )"_json);
|
||||||
|
|
||||||
|
CHECK(R"( {"foo": [{}]} )"_json.patch(
|
||||||
|
R"( [{"op": "add", "path": "/foo/0/bar", "value": "baz"}] )"_json
|
||||||
|
) == R"( {"foo": [{"bar": "baz"}]} )"_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("remove")
|
||||||
|
{
|
||||||
|
CHECK(R"( {"foo": "bar"} )"_json.patch(
|
||||||
|
R"( [{"op": "remove", "path": "/foo"}] )"_json
|
||||||
|
) == R"( {} )"_json);
|
||||||
|
|
||||||
|
CHECK(R"( {"foo": [1, 2, 3]} )"_json.patch(
|
||||||
|
R"( [{"op": "remove", "path": "/foo/1"}] )"_json
|
||||||
|
) == R"( {"foo": [1, 3]} )"_json);
|
||||||
|
|
||||||
|
CHECK(R"( {"foo": [{"bar": "baz"}]} )"_json.patch(
|
||||||
|
R"( [{"op": "remove", "path": "/foo/0/bar"}] )"_json
|
||||||
|
) == R"( {"foo": [{}]} )"_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("replace")
|
||||||
|
{
|
||||||
|
CHECK(R"( {"foo": "bar"} )"_json.patch(
|
||||||
|
R"( [{"op": "replace", "path": "/foo", "value": 1}] )"_json
|
||||||
|
) == R"( {"foo": 1} )"_json);
|
||||||
|
|
||||||
|
CHECK(R"( {"foo": [1, 2, 3]} )"_json.patch(
|
||||||
|
R"( [{"op": "replace", "path": "/foo/1", "value": 4}] )"_json
|
||||||
|
) == R"( {"foo": [1, 4, 3]} )"_json);
|
||||||
|
|
||||||
|
CHECK(R"( {"foo": [{"bar": "baz"}]} )"_json.patch(
|
||||||
|
R"( [{"op": "replace", "path": "/foo/0/bar", "value": 1}] )"_json
|
||||||
|
) == R"( {"foo": [{"bar": 1}]} )"_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("move")
|
||||||
|
{
|
||||||
|
CHECK(R"( {"foo": [1, 2, 3]} )"_json.patch(
|
||||||
|
R"( [{"op": "move", "from": "/foo", "path": "/bar"}] )"_json
|
||||||
|
) == R"( {"bar": [1, 2, 3]} )"_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("copy")
|
||||||
|
{
|
||||||
|
CHECK(R"( {"foo": [1, 2, 3]} )"_json.patch(
|
||||||
|
R"( [{"op": "copy", "from": "/foo/1", "path": "/bar"}] )"_json
|
||||||
|
) == R"( {"foo": [1, 2, 3], "bar": 2} )"_json);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("copy")
|
||||||
|
{
|
||||||
|
CHECK_NOTHROW(R"( {"foo": "bar"} )"_json.patch(
|
||||||
|
R"( [{"op": "test", "path": "/foo", "value": "bar"}] )"_json));
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
TEST_CASE("regression tests")
|
TEST_CASE("regression tests")
|
||||||
|
|||||||
Reference in new issue
Block a user