jsonpointer doc and example update

Author: danielaparker

doc/ref/jsonpointer/add.md

@@ -26,7 +26,7 @@ On error, returns a null Json value and a [jsonpointer_errc](jsonpointer_errc.md
 
 ### Examples
 
-#### Add a member to an object
+#### Add a member to a target location that does not already exist
 
 ```c++
 #include <jsoncons/json.hpp>
@@ -58,7 +58,6 @@ Output:
 
 #### Add an element to the second position in an array
 
-
 ```c++
 #include <jsoncons/json.hpp>
 #include <jsoncons_ext/jsonpointer/jsonpointer.hpp>
@@ -87,7 +86,7 @@ Output:
 {"foo":["bar","qux","baz"]}
 ```
 
-#### Add an element to the end of an array
+#### Add a value to the end of an array
 
 ```c++
 #include <jsoncons/json.hpp>
@@ -117,7 +116,7 @@ Output:
 {"foo":["bar","baz","qux"]}
 ```
 
-#### The specified index must not exceed the size of the array
+#### Add an object member to a location that already exists
 
 ```c++
 #include <jsoncons/json.hpp>
@@ -128,12 +127,12 @@ using namespace jsoncons;
 int main()
 {
     json target = json::parse(R"(
-    { "foo": [ "bar", "baz" ] }
+        { "foo": "bar", "baz" : "abc"}
     )");
 
     try
     {
-        jsonpointer::add(target, "/foo/3", json("qux"));
+        jsonpointer::add(target, "/baz", json("qux"));
         std::cout << target << std::endl;
     }
     catch (const parse_error& e)
@@ -143,11 +142,11 @@ int main()
 }
 ```
 Output:
-```
-Index exceeds array size at line 1 and column 7
+```json
+{"baz":"qux","foo":"bar"}
 ```
 
-#### The specified index must not exceed the size of the array
+#### Add a value to a location in an array that exceeds the size of the array
 
 ```c++
 #include <jsoncons/json.hpp>

doc/ref/jsonpointer/remove.md

@@ -26,7 +26,7 @@ On error, returns a null Json value and a [jsonpointer_errc](jsonpointer_errc.md
 
 ### Examples
 
-#### Remove an array element
+#### Remove an object member
 
 ```c++
 #include <jsoncons/json.hpp>
@@ -37,12 +37,12 @@ using namespace jsoncons;
 int main()
 {
     json target = json::parse(R"(
-        { "foo": [ "bar", "qux", "baz" ] }
+        { "foo": "bar", "baz" : "qux"}
     )");
 
     try
     {
-        jsonpointer::remove(target, "/foo/1");
+        jsonpointer::remove(target, "/baz");
         std::cout << target << std::endl;
     }
     catch (const parse_error& e)
@@ -53,7 +53,7 @@ int main()
 ```
 Output:
 ```json
-{"foo":["bar","baz"]}
+{"foo":"bar"}
 ```
 
 #### Remove an array element

doc/ref/jsonpointer/replace.md

@@ -26,7 +26,7 @@ On error, returns a null Json value and a [jsonpointer_errc](jsonpointer_errc.md
 
 ### Examples
 
-#### Replace a value
+#### Replace an object value
 
 ```c++
 #include <jsoncons/json.hpp>
@@ -62,7 +62,7 @@ Output:
 }
 ```
 
-#### Replace a value
+#### Replace an array value
 
 ```c++
 #include <jsoncons/json.hpp>
@@ -73,13 +73,10 @@ using namespace jsoncons;
 int main()
 {
     json target = json::parse(R"(
-        {
-          "baz": "qux",
-          "foo": "bar"
-        }
+        { "foo": [ "bar", "baz" ] }
     )");
 
-    auto ec = jsonpointer::try_replace(target, "/baz", json("boo"));
+    auto ec = jsonpointer::try_replace(target, "/foo/1", json("qux"));
     if (ec == jsonpointer::jsonpointer_errc())
     {
         std::cout << pretty_print(target) << std::endl;
@@ -93,8 +90,7 @@ int main()
 Output:
 ```json
 {
-    "baz": "boo",
-    "foo": "bar"
+    "foo": ["bar","qux"]
 }
 ```
 

examples/src/jsonpointer_examples.cpp

@@ -82,46 +82,12 @@ void jsonpointer_add_member_to_object()
     }
 }
 
-void jsonpointer_try_add_member_to_object()
-{
-    json target = json::parse(R"(
-    { "foo": "bar"}
-    )");
-
-    auto ec = jsonpointer::try_add(target, "/baz", json("qux"));
-    if (ec == jsonpointer::jsonpointer_errc())
-    {
-        std::cout << target << std::endl;
-    }
-    else
-    {
-        std::cout << make_error_code(ec).message() << std::endl;
-    }
-}
-
 void jsonpointer_add_element_to_array()
 {
     json target = json::parse(R"(
     { "foo": [ "bar", "baz" ] }
     )");
 
-    try
-    {
-        jsonpointer::add(target, "/foo/1", json("qux"));
-        std::cout << target << std::endl;
-    }
-    catch (const parse_error& e)
-    {
-        std::cout << e.what() << std::endl;
-    }
-}
-
-void jsonpointer_try_add_element_to_array()
-{
-    json target = json::parse(R"(
-    { "foo": [ "bar", "baz" ] }
-    )");
-
     auto ec = jsonpointer::try_add(target, "/foo/1", json("qux"));
     if (ec == jsonpointer::jsonpointer_errc())
     {
@@ -150,32 +116,15 @@ void jsonpointer_add_element_to_end_array()
     }
 }
 
-void jsonpointer_try_add_element_to_end_array()
+void jsonpointer_add_value_name_exists()
 {
     json target = json::parse(R"(
-    { "foo": [ "bar", "baz" ] }
-    )");
-
-    auto ec = jsonpointer::try_add(target, "/foo/-", json("qux"));
-    if (ec == jsonpointer::jsonpointer_errc())
-    {
-        std::cout << target << std::endl;
-    }
-    else
-    {
-        std::cout << make_error_code(ec).message() << std::endl;
-    }
-}
-
-void jsonpointer_add_element_outside_range()
-{
-    json target = json::parse(R"(
-    { "foo": [ "bar", "baz" ] }
+        { "foo": "bar", "baz" : "abc"}
     )");
 
     try
     {
-        jsonpointer::add(target, "/foo/3", json("qux"));
+        jsonpointer::add(target, "/baz", json("qux"));
         std::cout << target << std::endl;
     }
     catch (const parse_error& e)
@@ -184,7 +133,7 @@ void jsonpointer_add_element_outside_range()
     }
 }
 
-void jsonpointer_try_add_element_outside_range()
+void jsonpointer_add_element_outside_range()
 {
     json target = json::parse(R"(
     { "foo": [ "bar", "baz" ] }
@@ -201,15 +150,15 @@ void jsonpointer_try_add_element_outside_range()
     }
 }
 
-void jsonpointer_remove()
+void jsonpointer_remove_object_member()
 {
     json target = json::parse(R"(
-        { "foo": [ "bar", "qux", "baz" ] }
+        { "foo": "bar", "baz" : "qux"}
     )");
 
     try
     {
-        jsonpointer::remove(target, "/foo/1");
+        jsonpointer::remove(target, "/baz");
         std::cout << target << std::endl;
     }
     catch (const parse_error& e)
@@ -218,7 +167,7 @@ void jsonpointer_remove()
     }
 }
 
-void jsonpointer_try_remove()
+void jsonpointer_remove_array_element()
 {
     json target = json::parse(R"(
         { "foo": [ "bar", "qux", "baz" ] }
@@ -235,7 +184,7 @@ void jsonpointer_try_remove()
     }
 }
 
-void jsonpointer_replace()
+void jsonpointer_replace_object_value()
 {
     json target = json::parse(R"(
         {
@@ -255,16 +204,13 @@ void jsonpointer_replace()
     }
 }
 
-void jsonpointer_try_replace()
+void jsonpointer_replace_array_value()
 {
     json target = json::parse(R"(
-        {
-          "baz": "qux",
-          "foo": "bar"
-        }
+        { "foo": [ "bar", "baz" ] }
     )");
 
-    auto ec = jsonpointer::try_replace(target, "/baz", json("boo"));
+    auto ec = jsonpointer::try_replace(target, "/foo/1", json("qux"));
     if (ec == jsonpointer::jsonpointer_errc())
     {
         std::cout << pretty_print(target) << std::endl;
@@ -281,17 +227,14 @@ void jsonpointer_examples()
     jsonpointer_select();
     jsonpointer_try_select();
     jsonpointer_add_member_to_object();
-    jsonpointer_try_add_member_to_object();
     jsonpointer_add_element_to_array();
-    jsonpointer_try_add_element_to_array();
     jsonpointer_add_element_to_end_array();
-    jsonpointer_try_add_element_to_end_array();
+    jsonpointer_add_value_name_exists();
     jsonpointer_add_element_outside_range();
-    jsonpointer_try_add_element_outside_range();
-    jsonpointer_remove();
-    jsonpointer_try_remove();
-    jsonpointer_replace();
-    jsonpointer_try_replace();
+    jsonpointer_remove_object_member();
+    jsonpointer_remove_array_element();
+    jsonpointer_replace_object_value();
+    jsonpointer_replace_array_value();
     std::cout << std::endl;
 }
 

tests/src/jsonpointer/jsonpointer_tests.cpp

@@ -150,6 +150,19 @@ BOOST_AUTO_TEST_CASE(test_add_array_value)
 
 // remove
 
+BOOST_AUTO_TEST_CASE(test_remove_object_member)
+{
+    json example = json::parse(R"(
+    { "foo": "bar", "baz" : "qux"}
+    )");
+
+    const json expected = json::parse(R"(
+        { "foo": "bar"}
+    )");
+
+    check_remove(example,"/baz", expected);
+}
+
 BOOST_AUTO_TEST_CASE(test_remove_array_element)
 {
     json example = json::parse(R"(
@@ -165,7 +178,7 @@ BOOST_AUTO_TEST_CASE(test_remove_array_element)
 
 // replace
 
-BOOST_AUTO_TEST_CASE(test_replace_value)
+BOOST_AUTO_TEST_CASE(test_replace_object_value)
 {
     json example = json::parse(R"(
         {
@@ -184,6 +197,19 @@ BOOST_AUTO_TEST_CASE(test_replace_value)
     check_replace(example,"/baz", json("boo"), expected);
 }
 
+BOOST_AUTO_TEST_CASE(test_replace_array_value)
+{
+    json example = json::parse(R"(
+        { "foo": [ "bar", "baz" ] }
+    )");
+
+    const json expected = json::parse(R"(
+        { "foo": [ "bar", "qux" ] }
+    )");
+
+    check_replace(example,"/foo/1", json("qux"), expected);
+}
+
 // move
 /*
 BOOST_AUTO_TEST_CASE(test_move_value)