Merge pull request #135 from cdunn2001/removeMember

Deprecate old `removeMember()`. Add new.

[Deprecated methods will be removed at the next major version bump](http://apr.apache.org/versioning.html#binary).

Author: cdunn2001

include/json/value.h

@@ -392,14 +392,21 @@ Json::Value obj_value(Json::objectValue); // {}
   /// \return the removed Value, or null.
   /// \pre type() is objectValue or nullValue
   /// \post type() is unchanged
+  /// \deprecated
   Value removeMember(const char* key);
   /// Same as removeMember(const char*)
+  /// \deprecated
   Value removeMember(const std::string& key);
+  /** \brief Remove the named map member.
+
+      Update 'removed' iff removed.
+      \return true iff removed (no exceptions)
+  */
+  bool removeMember(const char* key, Value* removed);
   /** \brief Remove the indexed array element.
 
       O(n) expensive operations.
       Update 'removed' iff removed.
-      (This is a better pattern than removeMember().)
       \return true iff removed (no exceptions)
   */
   bool removeIndex(ArrayIndex i, Value* removed);

include/json/version.h

@@ -4,10 +4,10 @@
 #ifndef JSON_VERSION_H_INCLUDED
 # define JSON_VERSION_H_INCLUDED
 
-# define JSONCPP_VERSION_STRING "1.2.1"
+# define JSONCPP_VERSION_STRING "1.3.0"
 # define JSONCPP_VERSION_MAJOR 1
-# define JSONCPP_VERSION_MINOR 2
-# define JSONCPP_VERSION_PATCH 1
+# define JSONCPP_VERSION_MINOR 3
+# define JSONCPP_VERSION_PATCH 0
 # define JSONCPP_VERSION_QUALIFIER
 # define JSONCPP_VERSION_HEXA ((JSONCPP_VERSION_MAJOR << 24) | (JSONCPP_VERSION_MINOR << 16) | (JSONCPP_VERSION_PATCH << 8))
 

src/lib_json/json_value.cpp

@@ -989,31 +989,42 @@ Value Value::get(const std::string& key, const Value& defaultValue) const {
   return get(key.c_str(), defaultValue);
 }
 
-Value Value::removeMember(const char* key) {
-  JSON_ASSERT_MESSAGE(type_ == nullValue || type_ == objectValue,
-                      "in Json::Value::removeMember(): requires objectValue");
-  if (type_ == nullValue)
-    return null;
+
+bool Value::removeMember(const char* key, Value* removed) {
+  if (type_ != objectValue) {
+    return false;
+  }
 #ifndef JSON_VALUE_USE_INTERNAL_MAP
   CZString actualKey(key, CZString::noDuplication);
   ObjectValues::iterator it = value_.map_->find(actualKey);
   if (it == value_.map_->end())
-    return null;
-  Value old(it->second);
+    return false;
+  *removed = it->second;
   value_.map_->erase(it);
-  return old;
+  return true;
 #else
   Value* value = value_.map_->find(key);
   if (value) {
-    Value old(*value);
+    *removed = *value;
     value_.map_.remove(key);
-    return old;
+    return true;
   } else {
-    return null;
+    return false;
   }
 #endif
 }
 
+Value Value::removeMember(const char* key) {
+  JSON_ASSERT_MESSAGE(type_ == nullValue || type_ == objectValue,
+                      "in Json::Value::removeMember(): requires objectValue");
+  if (type_ == nullValue)
+    return null;
+
+  Value removed;  // null
+  removeMember(key, &removed);
+  return removed; // still null if removeMember() did nothing
+}
+
 Value Value::removeMember(const std::string& key) {
   return removeMember(key.c_str());
 }

src/test_lib_json/main.cpp

@@ -202,10 +202,14 @@ JSONTEST_FIXTURE(ValueTest, objects) {
 
   // Remove.
   Json::Value got;
-  got = object1_.removeMember("some other id");
+  bool did;
+  did = object1_.removeMember("some other id", &got);
   JSONTEST_ASSERT_EQUAL(Json::Value("foo"), got);
-  got = object1_.removeMember("some other id");
-  JSONTEST_ASSERT_EQUAL(Json::nullValue, got);
+  JSONTEST_ASSERT_EQUAL(true, did);
+  got = Json::Value("bar");
+  did = object1_.removeMember("some other id", &got);
+  JSONTEST_ASSERT_EQUAL(Json::Value("bar"), got);
+  JSONTEST_ASSERT_EQUAL(false, did);
 }
 
 JSONTEST_FIXTURE(ValueTest, arrays) {

version

@@ -1 +1 @@
-1.2.1
+1.3.0