From dff07ebfe83d6da8421f3839c1b9020b8f714b53 Mon Sep 17 00:00:00 2001
From: Benoit Blanchon <git@benoitblanchon.fr>
Date: Mon, 19 Dec 2022 12:20:05 +0100
Subject: [PATCH] Rename `ObjectRef` to `JsonObject`

---
 extras/tests/Misc/TypeTraits.cpp              |  4 +--
 src/ArduinoJson.hpp                           |  6 ++--
 src/ArduinoJson/Array/JsonArray.hpp           |  4 +--
 src/ArduinoJson/Array/JsonArrayConst.hpp      |  2 +-
 src/ArduinoJson/Array/JsonArrayImpl.hpp       | 10 +++---
 .../Document/BasicJsonDocument.hpp            |  2 +-
 src/ArduinoJson/Document/JsonDocument.hpp     | 15 +++++----
 .../Object/{ObjectRef.hpp => JsonObject.hpp}  | 32 +++++++++----------
 .../{ObjectImpl.hpp => JsonObjectImpl.hpp}    | 14 ++++----
 src/ArduinoJson/Object/ObjectConstRef.hpp     |  2 +-
 src/ArduinoJson/Object/ObjectIterator.hpp     |  4 +--
 src/ArduinoJson/Variant/VariantConstRef.hpp   |  2 +-
 src/ArduinoJson/Variant/VariantImpl.hpp       |  6 ++--
 src/ArduinoJson/Variant/VariantRefBase.hpp    | 11 ++++---
 src/ArduinoJson/Variant/VariantTo.hpp         |  6 ++--
 15 files changed, 61 insertions(+), 59 deletions(-)
 rename src/ArduinoJson/Object/{ObjectRef.hpp => JsonObject.hpp} (81%)
 rename src/ArduinoJson/Object/{ObjectImpl.hpp => JsonObjectImpl.hpp} (83%)

diff --git a/extras/tests/Misc/TypeTraits.cpp b/extras/tests/Misc/TypeTraits.cpp
index 698ac857..bb3f6df8 100644
--- a/extras/tests/Misc/TypeTraits.cpp
+++ b/extras/tests/Misc/TypeTraits.cpp
@@ -187,8 +187,8 @@ TEST_CASE("Polyfills/type_traits") {
     CHECK((is_convertible<ElementProxy<JsonArray>, JsonVariantConst>::value ==
            true));
     CHECK((is_convertible<JsonArrayConst, JsonVariantConst>::value == true));
-    CHECK((is_convertible<ObjectRef, JsonVariantConst>::value == true));
-    CHECK((is_convertible<MemberProxy<ObjectRef, const char*>,
+    CHECK((is_convertible<JsonObject, JsonVariantConst>::value == true));
+    CHECK((is_convertible<MemberProxy<JsonObject, const char*>,
                           JsonVariantConst>::value == true));
     CHECK((is_convertible<ObjectConstRef, JsonVariantConst>::value == true));
     CHECK(
diff --git a/src/ArduinoJson.hpp b/src/ArduinoJson.hpp
index dd5d1a31..16a987d9 100644
--- a/src/ArduinoJson.hpp
+++ b/src/ArduinoJson.hpp
@@ -22,7 +22,7 @@
 #endif
 
 #include "ArduinoJson/Array/JsonArray.hpp"
-#include "ArduinoJson/Object/ObjectRef.hpp"
+#include "ArduinoJson/Object/JsonObject.hpp"
 #include "ArduinoJson/Variant/VariantConstRef.hpp"
 
 #include "ArduinoJson/Document/DynamicJsonDocument.hpp"
@@ -32,8 +32,8 @@
 #include "ArduinoJson/Array/JsonArrayImpl.hpp"
 #include "ArduinoJson/Array/Utilities.hpp"
 #include "ArduinoJson/Collection/CollectionImpl.hpp"
+#include "ArduinoJson/Object/JsonObjectImpl.hpp"
 #include "ArduinoJson/Object/MemberProxy.hpp"
-#include "ArduinoJson/Object/ObjectImpl.hpp"
 #include "ArduinoJson/Variant/ConverterImpl.hpp"
 #include "ArduinoJson/Variant/VariantCompare.hpp"
 #include "ArduinoJson/Variant/VariantImpl.hpp"
@@ -52,7 +52,7 @@ using ARDUINOJSON_NAMESPACE::JsonArrayConst;
 typedef ARDUINOJSON_NAMESPACE::Float JsonFloat;
 typedef ARDUINOJSON_NAMESPACE::Integer JsonInteger;
 typedef ARDUINOJSON_NAMESPACE::ObjectConstRef JsonObjectConst;
-typedef ARDUINOJSON_NAMESPACE::ObjectRef JsonObject;
+using ARDUINOJSON_NAMESPACE::JsonObject;
 typedef ARDUINOJSON_NAMESPACE::Pair JsonPair;
 typedef ARDUINOJSON_NAMESPACE::PairConst JsonPairConst;
 typedef ARDUINOJSON_NAMESPACE::String JsonString;
diff --git a/src/ArduinoJson/Array/JsonArray.hpp b/src/ArduinoJson/Array/JsonArray.hpp
index f8311cc0..9bf6a39c 100644
--- a/src/ArduinoJson/Array/JsonArray.hpp
+++ b/src/ArduinoJson/Array/JsonArray.hpp
@@ -9,7 +9,7 @@
 
 namespace ARDUINOJSON_NAMESPACE {
 
-class ObjectRef;
+class JsonObject;
 
 class JsonArray : public VariantOperators<JsonArray> {
   friend class VariantAttorney;
@@ -92,7 +92,7 @@ class JsonArray : public VariantOperators<JsonArray> {
     return ElementProxy<JsonArray>(*this, index);
   }
 
-  FORCE_INLINE ObjectRef createNestedObject() const;
+  FORCE_INLINE JsonObject createNestedObject() const;
 
   FORCE_INLINE JsonArray createNestedArray() const {
     return add().to<JsonArray>();
diff --git a/src/ArduinoJson/Array/JsonArrayConst.hpp b/src/ArduinoJson/Array/JsonArrayConst.hpp
index d5a0d1af..24bd9ed5 100644
--- a/src/ArduinoJson/Array/JsonArrayConst.hpp
+++ b/src/ArduinoJson/Array/JsonArrayConst.hpp
@@ -10,7 +10,7 @@
 
 namespace ARDUINOJSON_NAMESPACE {
 
-class ObjectRef;
+class JsonObject;
 
 class JsonArrayConst : public VariantOperators<JsonArrayConst> {
   friend class JsonArray;
diff --git a/src/ArduinoJson/Array/JsonArrayImpl.hpp b/src/ArduinoJson/Array/JsonArrayImpl.hpp
index a65d6086..45a520f4 100644
--- a/src/ArduinoJson/Array/JsonArrayImpl.hpp
+++ b/src/ArduinoJson/Array/JsonArrayImpl.hpp
@@ -5,12 +5,12 @@
 #pragma once
 
 #include <ArduinoJson/Array/JsonArray.hpp>
-#include <ArduinoJson/Object/ObjectRef.hpp>
+#include <ArduinoJson/Object/JsonObject.hpp>
 
 namespace ARDUINOJSON_NAMESPACE {
 
-inline ObjectRef JsonArray::createNestedObject() const {
-  return add().to<ObjectRef>();
+inline JsonObject JsonArray::createNestedObject() const {
+  return add().to<JsonObject>();
 }
 
 template <typename TDerived>
@@ -19,8 +19,8 @@ inline JsonArray VariantRefBase<TDerived>::createNestedArray() const {
 }
 
 template <typename TDerived>
-inline ObjectRef VariantRefBase<TDerived>::createNestedObject() const {
-  return add().template to<ObjectRef>();
+inline JsonObject VariantRefBase<TDerived>::createNestedObject() const {
+  return add().template to<JsonObject>();
 }
 
 template <typename TDerived>
diff --git a/src/ArduinoJson/Document/BasicJsonDocument.hpp b/src/ArduinoJson/Document/BasicJsonDocument.hpp
index cc77152e..621264f3 100644
--- a/src/ArduinoJson/Document/BasicJsonDocument.hpp
+++ b/src/ArduinoJson/Document/BasicJsonDocument.hpp
@@ -67,7 +67,7 @@ class BasicJsonDocument : AllocatorOwner<TAllocator>, public JsonDocument {
       typename enable_if<
           is_same<T, VariantRef>::value || is_same<T, VariantConstRef>::value ||
           is_same<T, JsonArray>::value || is_same<T, JsonArrayConst>::value ||
-          is_same<T, ObjectRef>::value ||
+          is_same<T, JsonObject>::value ||
           is_same<T, ObjectConstRef>::value>::type* = 0)
       : JsonDocument(allocPool(src.memoryUsage())) {
     set(src);
diff --git a/src/ArduinoJson/Document/JsonDocument.hpp b/src/ArduinoJson/Document/JsonDocument.hpp
index 6014f71d..66f3a14e 100644
--- a/src/ArduinoJson/Document/JsonDocument.hpp
+++ b/src/ArduinoJson/Document/JsonDocument.hpp
@@ -6,12 +6,13 @@
 
 #include <ArduinoJson/Array/ElementProxy.hpp>
 #include <ArduinoJson/Memory/MemoryPool.hpp>
+#include <ArduinoJson/Object/JsonObject.hpp>
 #include <ArduinoJson/Object/MemberProxy.hpp>
-#include <ArduinoJson/Object/ObjectRef.hpp>
 #include <ArduinoJson/Strings/StoragePolicy.hpp>
 #include <ArduinoJson/Variant/VariantConstRef.hpp>
 #include <ArduinoJson/Variant/VariantTo.hpp>
 
+
 namespace ARDUINOJSON_NAMESPACE {
 
 class JsonDocument : public VariantOperators<const JsonDocument&> {
@@ -102,23 +103,23 @@ class JsonDocument : public VariantOperators<const JsonDocument&> {
     return operator[](key).template to<JsonArray>();
   }
 
-  ObjectRef createNestedObject() {
-    return add().to<ObjectRef>();
+  JsonObject createNestedObject() {
+    return add().to<JsonObject>();
   }
 
   // createNestedObject(char*)
   // createNestedObject(const char*)
   // createNestedObject(const __FlashStringHelper*)
   template <typename TChar>
-  ObjectRef createNestedObject(TChar* key) {
-    return operator[](key).template to<ObjectRef>();
+  JsonObject createNestedObject(TChar* key) {
+    return operator[](key).template to<JsonObject>();
   }
 
   // createNestedObject(const std::string&)
   // createNestedObject(const String&)
   template <typename TString>
-  ObjectRef createNestedObject(const TString& key) {
-    return operator[](key).template to<ObjectRef>();
+  JsonObject createNestedObject(const TString& key) {
+    return operator[](key).template to<JsonObject>();
   }
 
   // containsKey(char*) const
diff --git a/src/ArduinoJson/Object/ObjectRef.hpp b/src/ArduinoJson/Object/JsonObject.hpp
similarity index 81%
rename from src/ArduinoJson/Object/ObjectRef.hpp
rename to src/ArduinoJson/Object/JsonObject.hpp
index a247b652..ddff4504 100644
--- a/src/ArduinoJson/Object/ObjectRef.hpp
+++ b/src/ArduinoJson/Object/JsonObject.hpp
@@ -11,14 +11,14 @@ namespace ARDUINOJSON_NAMESPACE {
 
 class JsonArray;
 
-class ObjectRef : public VariantOperators<ObjectRef> {
+class JsonObject : public VariantOperators<JsonObject> {
   friend class VariantAttorney;
 
  public:
   typedef ObjectIterator iterator;
 
-  FORCE_INLINE ObjectRef() : _data(0), _pool(0) {}
-  FORCE_INLINE ObjectRef(MemoryPool* buf, CollectionData* data)
+  FORCE_INLINE JsonObject() : _data(0), _pool(0) {}
+  FORCE_INLINE JsonObject(MemoryPool* buf, CollectionData* data)
       : _data(data), _pool(buf) {}
 
   operator VariantRef() const {
@@ -76,22 +76,22 @@ class ObjectRef : public VariantOperators<ObjectRef> {
     return _data->copyFrom(*src._data, _pool);
   }
 
-  FORCE_INLINE bool operator==(ObjectRef rhs) const {
+  FORCE_INLINE bool operator==(JsonObject rhs) const {
     return ObjectConstRef(_data) == ObjectConstRef(rhs._data);
   }
 
   template <typename TString>
   FORCE_INLINE typename enable_if<IsString<TString>::value,
-                                  MemberProxy<ObjectRef, TString> >::type
+                                  MemberProxy<JsonObject, TString> >::type
   operator[](const TString& key) const {
-    return MemberProxy<ObjectRef, TString>(*this, key);
+    return MemberProxy<JsonObject, TString>(*this, key);
   }
 
   template <typename TChar>
   FORCE_INLINE typename enable_if<IsString<TChar*>::value,
-                                  MemberProxy<ObjectRef, TChar*> >::type
+                                  MemberProxy<JsonObject, TChar*> >::type
   operator[](TChar* key) const {
-    return MemberProxy<ObjectRef, TChar*>(*this, key);
+    return MemberProxy<JsonObject, TChar*>(*this, key);
   }
 
   FORCE_INLINE void remove(iterator it) const {
@@ -134,13 +134,13 @@ class ObjectRef : public VariantOperators<ObjectRef> {
   FORCE_INLINE JsonArray createNestedArray(TChar* key) const;
 
   template <typename TString>
-  ObjectRef createNestedObject(const TString& key) const {
-    return operator[](key).template to<ObjectRef>();
+  JsonObject createNestedObject(const TString& key) const {
+    return operator[](key).template to<JsonObject>();
   }
 
   template <typename TChar>
-  ObjectRef createNestedObject(TChar* key) const {
-    return operator[](key).template to<ObjectRef>();
+  JsonObject createNestedObject(TChar* key) const {
+    return operator[](key).template to<JsonObject>();
   }
 
  private:
@@ -175,18 +175,18 @@ class ObjectRef : public VariantOperators<ObjectRef> {
 };
 
 template <>
-struct Converter<ObjectRef> : private VariantAttorney {
+struct Converter<JsonObject> : private VariantAttorney {
   static void toJson(VariantConstRef src, VariantRef dst) {
     variantCopyFrom(getData(dst), getData(src), getPool(dst));
   }
 
-  static ObjectRef fromJson(VariantRef src) {
+  static JsonObject fromJson(VariantRef src) {
     VariantData* data = getData(src);
     MemoryPool* pool = getPool(src);
-    return ObjectRef(pool, data != 0 ? data->asObject() : 0);
+    return JsonObject(pool, data != 0 ? data->asObject() : 0);
   }
 
-  static InvalidConversion<VariantConstRef, ObjectRef> fromJson(
+  static InvalidConversion<VariantConstRef, JsonObject> fromJson(
       VariantConstRef);
 
   static bool checkJson(VariantConstRef) {
diff --git a/src/ArduinoJson/Object/ObjectImpl.hpp b/src/ArduinoJson/Object/JsonObjectImpl.hpp
similarity index 83%
rename from src/ArduinoJson/Object/ObjectImpl.hpp
rename to src/ArduinoJson/Object/JsonObjectImpl.hpp
index fa1839c9..fc6c96e2 100644
--- a/src/ArduinoJson/Object/ObjectImpl.hpp
+++ b/src/ArduinoJson/Object/JsonObjectImpl.hpp
@@ -5,17 +5,17 @@
 #pragma once
 
 #include <ArduinoJson/Array/JsonArray.hpp>
-#include <ArduinoJson/Object/ObjectRef.hpp>
+#include <ArduinoJson/Object/JsonObject.hpp>
 
 namespace ARDUINOJSON_NAMESPACE {
 
 template <typename TString>
-inline JsonArray ObjectRef::createNestedArray(const TString& key) const {
+inline JsonArray JsonObject::createNestedArray(const TString& key) const {
   return operator[](key).template to<JsonArray>();
 }
 
 template <typename TChar>
-inline JsonArray ObjectRef::createNestedArray(TChar* key) const {
+inline JsonArray JsonObject::createNestedArray(TChar* key) const {
   return operator[](key).template to<JsonArray>();
 }
 
@@ -34,16 +34,16 @@ inline JsonArray VariantRefBase<TDerived>::createNestedArray(TChar* key) const {
 
 template <typename TDerived>
 template <typename TString>
-inline ObjectRef VariantRefBase<TDerived>::createNestedObject(
+inline JsonObject VariantRefBase<TDerived>::createNestedObject(
     const TString& key) const {
-  return operator[](key).template to<ObjectRef>();
+  return operator[](key).template to<JsonObject>();
 }
 
 template <typename TDerived>
 template <typename TChar>
-inline ObjectRef VariantRefBase<TDerived>::createNestedObject(
+inline JsonObject VariantRefBase<TDerived>::createNestedObject(
     TChar* key) const {
-  return operator[](key).template to<ObjectRef>();
+  return operator[](key).template to<JsonObject>();
 }
 
 template <typename TDerived>
diff --git a/src/ArduinoJson/Object/ObjectConstRef.hpp b/src/ArduinoJson/Object/ObjectConstRef.hpp
index fc62d9b1..c8aaf011 100644
--- a/src/ArduinoJson/Object/ObjectConstRef.hpp
+++ b/src/ArduinoJson/Object/ObjectConstRef.hpp
@@ -10,7 +10,7 @@
 namespace ARDUINOJSON_NAMESPACE {
 
 class ObjectConstRef : public VariantOperators<ObjectConstRef> {
-  friend class ObjectRef;
+  friend class JsonObject;
   friend class VariantAttorney;
 
  public:
diff --git a/src/ArduinoJson/Object/ObjectIterator.hpp b/src/ArduinoJson/Object/ObjectIterator.hpp
index b41f302e..01456bd6 100644
--- a/src/ArduinoJson/Object/ObjectIterator.hpp
+++ b/src/ArduinoJson/Object/ObjectIterator.hpp
@@ -26,7 +26,7 @@ class PairPtr {
 };
 
 class ObjectIterator {
-  friend class ObjectRef;
+  friend class JsonObject;
 
  public:
   ObjectIterator() : _slot(0) {}
@@ -81,7 +81,7 @@ class PairConstPtr {
 };
 
 class ObjectConstIterator {
-  friend class ObjectRef;
+  friend class JsonObject;
 
  public:
   ObjectConstIterator() : _slot(0) {}
diff --git a/src/ArduinoJson/Variant/VariantConstRef.hpp b/src/ArduinoJson/Variant/VariantConstRef.hpp
index 625bba1b..6b42aa12 100644
--- a/src/ArduinoJson/Variant/VariantConstRef.hpp
+++ b/src/ArduinoJson/Variant/VariantConstRef.hpp
@@ -20,7 +20,7 @@ namespace ARDUINOJSON_NAMESPACE {
 
 // Forward declarations.
 class JsonArray;
-class ObjectRef;
+class JsonObject;
 
 class VariantConstRef : public VariantTag,
                         public VariantOperators<VariantConstRef> {
diff --git a/src/ArduinoJson/Variant/VariantImpl.hpp b/src/ArduinoJson/Variant/VariantImpl.hpp
index 051bd752..9479537f 100644
--- a/src/ArduinoJson/Variant/VariantImpl.hpp
+++ b/src/ArduinoJson/Variant/VariantImpl.hpp
@@ -8,7 +8,7 @@
 #include <ArduinoJson/Configuration.hpp>
 #include <ArduinoJson/Numbers/convertNumber.hpp>
 #include <ArduinoJson/Numbers/parseNumber.hpp>
-#include <ArduinoJson/Object/ObjectRef.hpp>
+#include <ArduinoJson/Object/JsonObject.hpp>
 #include <ArduinoJson/Variant/VariantRef.hpp>
 
 #include <string.h>  // for strcmp
@@ -128,9 +128,9 @@ VariantRefBase<TDerived>::to() const {
 
 template <typename TDerived>
 template <typename T>
-typename enable_if<is_same<T, ObjectRef>::value, ObjectRef>::type
+typename enable_if<is_same<T, JsonObject>::value, JsonObject>::type
 VariantRefBase<TDerived>::to() const {
-  return ObjectRef(getPool(), variantToObject(getOrCreateData()));
+  return JsonObject(getPool(), variantToObject(getOrCreateData()));
 }
 
 template <typename TDerived>
diff --git a/src/ArduinoJson/Variant/VariantRefBase.hpp b/src/ArduinoJson/Variant/VariantRefBase.hpp
index 754b2171..d566c4ee 100644
--- a/src/ArduinoJson/Variant/VariantRefBase.hpp
+++ b/src/ArduinoJson/Variant/VariantRefBase.hpp
@@ -78,9 +78,10 @@ class VariantRefBase : public VariantTag {
   template <typename T>
   typename enable_if<is_same<T, JsonArray>::value, JsonArray>::type to() const;
   //
-  // ObjectRef to<ObjectRef>()
+  // JsonObject to<JsonObject>()
   template <typename T>
-  typename enable_if<is_same<T, ObjectRef>::value, ObjectRef>::type to() const;
+  typename enable_if<is_same<T, JsonObject>::value, JsonObject>::type to()
+      const;
   //
   // VariantRef to<VariantRef>()
   template <typename T>
@@ -200,7 +201,7 @@ class VariantRefBase : public VariantTag {
   }
 
   FORCE_INLINE JsonArray createNestedArray() const;
-  FORCE_INLINE ObjectRef createNestedObject() const;
+  FORCE_INLINE JsonObject createNestedObject() const;
   FORCE_INLINE ElementProxy<TDerived> operator[](size_t index) const;
 
   template <typename TString>
@@ -228,10 +229,10 @@ class VariantRefBase : public VariantTag {
   FORCE_INLINE JsonArray createNestedArray(TChar* key) const;
 
   template <typename TString>
-  ObjectRef createNestedObject(const TString& key) const;
+  JsonObject createNestedObject(const TString& key) const;
 
   template <typename TChar>
-  ObjectRef createNestedObject(TChar* key) const;
+  JsonObject createNestedObject(TChar* key) const;
 
  private:
   TDerived& derived() {
diff --git a/src/ArduinoJson/Variant/VariantTo.hpp b/src/ArduinoJson/Variant/VariantTo.hpp
index 02558d2a..6d81edc5 100644
--- a/src/ArduinoJson/Variant/VariantTo.hpp
+++ b/src/ArduinoJson/Variant/VariantTo.hpp
@@ -8,7 +8,7 @@
 
 namespace ARDUINOJSON_NAMESPACE {
 class JsonArray;
-class ObjectRef;
+class JsonObject;
 class VariantRef;
 
 // A metafunction that returns the type of the value returned by
@@ -21,8 +21,8 @@ struct VariantTo<JsonArray> {
   typedef JsonArray type;
 };
 template <>
-struct VariantTo<ObjectRef> {
-  typedef ObjectRef type;
+struct VariantTo<JsonObject> {
+  typedef JsonObject type;
 };
 template <>
 struct VariantTo<VariantRef> {