Port FSTFieldValueOptions to C++ (#2989)

wilhuff · web-flow · commit 7ae2af4e6f10 · 2019-05-14T07:43:51.000-07:00
diff --git a/Firestore/Source/API/FIRDocumentSnapshot.mm b/Firestore/Source/API/FIRDocumentSnapshot.mm
@@ -34,6 +34,7 @@
 #include "Firestore/core/src/firebase/firestore/model/database_id.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/field_value.h"
+#include "Firestore/core/src/firebase/firestore/model/field_value_options.h"
 #include "Firestore/core/src/firebase/firestore/util/hard_assert.h"
 #include "Firestore/core/src/firebase/firestore/util/string_apple.h"
 
@@ -45,6 +46,8 @@
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::model::DocumentKey;
 using firebase::firestore::model::FieldValue;
+using firebase::firestore::model::FieldValueOptions;
+using firebase::firestore::model::ServerTimestampBehavior;
 using firebase::firestore::util::WrapNSString;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -57,11 +60,11 @@
 ServerTimestampBehavior InternalServerTimestampBehavior(FIRServerTimestampBehavior behavior) {
   switch (behavior) {
     case FIRServerTimestampBehaviorNone:
-      return ServerTimestampBehavior::None;
+      return ServerTimestampBehavior::kNone;
     case FIRServerTimestampBehaviorEstimate:
-      return ServerTimestampBehavior::Estimate;
+      return ServerTimestampBehavior::kEstimate;
     case FIRServerTimestampBehaviorPrevious:
-      return ServerTimestampBehavior::Previous;
+      return ServerTimestampBehavior::kPrevious;
     default:
       HARD_FAIL("Unexpected server timestamp option: %s", behavior);
   }
@@ -147,7 +150,7 @@ - (FIRSnapshotMetadata *)metadata {
 
 - (nullable NSDictionary<NSString *, id> *)dataWithServerTimestampBehavior:
     (FIRServerTimestampBehavior)serverTimestampBehavior {
-  FSTFieldValueOptions *options = [self optionsForServerTimestampBehavior:serverTimestampBehavior];
+  FieldValueOptions options = [self optionsForServerTimestampBehavior:serverTimestampBehavior];
   FSTObjectValue *data = _snapshot.GetData();
   return data == nil ? nil : [self convertedObject:data options:options];
 }
@@ -168,26 +171,23 @@ - (nullable id)valueForField:(id)field
   }
 
   FSTFieldValue *fieldValue = _snapshot.GetValue(fieldPath.internalValue);
-  FSTFieldValueOptions *options = [self optionsForServerTimestampBehavior:serverTimestampBehavior];
+  FieldValueOptions options = [self optionsForServerTimestampBehavior:serverTimestampBehavior];
   return fieldValue == nil ? nil : [self convertedValue:fieldValue options:options];
 }
 
 - (nullable id)objectForKeyedSubscript:(id)key {
   return [self valueForField:key];
 }
 
-- (FSTFieldValueOptions *)optionsForServerTimestampBehavior:
+- (FieldValueOptions)optionsForServerTimestampBehavior:
     (FIRServerTimestampBehavior)serverTimestampBehavior {
   SUPPRESS_DEPRECATED_DECLARATIONS_BEGIN()
-  return [[FSTFieldValueOptions alloc]
-      initWithServerTimestampBehavior:InternalServerTimestampBehavior(serverTimestampBehavior)
-         timestampsInSnapshotsEnabled:_snapshot.firestore()
-                                          ->settings()
-                                          .timestamps_in_snapshots_enabled()];
+  return FieldValueOptions(InternalServerTimestampBehavior(serverTimestampBehavior),
+                           _snapshot.firestore()->settings().timestamps_in_snapshots_enabled());
   SUPPRESS_END()
 }
 
-- (id)convertedValue:(FSTFieldValue *)value options:(FSTFieldValueOptions *)options {
+- (id)convertedValue:(FSTFieldValue *)value options:(const FieldValueOptions &)options {
   if (value.type == FieldValue::Type::Object) {
     return [self convertedObject:(FSTObjectValue *)value options:options];
   } else if (value.type == FieldValue::Type::Array) {
@@ -213,7 +213,7 @@ - (id)convertedValue:(FSTFieldValue *)value options:(FSTFieldValueOptions *)opti
 }
 
 - (NSDictionary<NSString *, id> *)convertedObject:(FSTObjectValue *)objectValue
-                                          options:(FSTFieldValueOptions *)options {
+                                          options:(const FieldValueOptions &)options {
   NSMutableDictionary *result = [NSMutableDictionary dictionary];
   [objectValue.internalValue
       enumerateKeysAndObjectsUsingBlock:^(NSString *key, FSTFieldValue *value, BOOL *stop) {
@@ -223,7 +223,7 @@ - (id)convertedValue:(FSTFieldValue *)value options:(FSTFieldValueOptions *)opti
 }
 
 - (NSArray<id> *)convertedArray:(FSTArrayValue *)arrayValue
-                        options:(FSTFieldValueOptions *)options {
+                        options:(const FieldValueOptions &)options {
   NSArray<FSTFieldValue *> *internalValue = arrayValue.internalValue;
   NSMutableArray *result = [NSMutableArray arrayWithCapacity:internalValue.count];
   [internalValue enumerateObjectsUsingBlock:^(id value, NSUInteger idx, BOOL *stop) {
diff --git a/Firestore/Source/Model/FSTFieldValue.h b/Firestore/Source/Model/FSTFieldValue.h
@@ -23,9 +23,9 @@
 #include "Firestore/core/src/firebase/firestore/model/field_mask.h"
 #include "Firestore/core/src/firebase/firestore/model/field_path.h"
 #include "Firestore/core/src/firebase/firestore/model/field_value.h"
+#include "Firestore/core/src/firebase/firestore/model/field_value_options.h"
 
 @class FIRTimestamp;
-@class FSTFieldValueOptions;
 @class FIRGeoPoint;
 
 namespace model = firebase::firestore::model;
@@ -46,28 +46,6 @@ typedef NS_ENUM(NSInteger, FSTTypeOrder) {
   FSTTypeOrderObject,
 };
 
-/** Defines the return value for pending server timestamps. */
-enum class ServerTimestampBehavior { None, Estimate, Previous };
-
-/** Holds properties that define field value deserialization options. */
-@interface FSTFieldValueOptions : NSObject
-
-@property(nonatomic, readonly, assign) ServerTimestampBehavior serverTimestampBehavior;
-
-@property(nonatomic) BOOL timestampsInSnapshotsEnabled;
-
-- (instancetype)init NS_UNAVAILABLE;
-
-/**
- * Creates an FSTFieldValueOptions instance that specifies deserialization behavior for pending
- * server timestamps.
- */
-- (instancetype)initWithServerTimestampBehavior:(ServerTimestampBehavior)serverTimestampBehavior
-                   timestampsInSnapshotsEnabled:(BOOL)timestampsInSnapshotsEnabled
-    NS_DESIGNATED_INITIALIZER;
-
-@end
-
 /**
  * Abstract base class representing an immutable data value as stored in Firestore. FSTFieldValue
  * represents all the different kinds of values that can be stored in fields in a document.
@@ -111,7 +89,7 @@ enum class ServerTimestampBehavior { None, Estimate, Previous };
  * Options can be provided to configure the deserialization of some field values (such as server
  * timestamps).
  */
-- (T)valueWithOptions:(FSTFieldValueOptions *)options;
+- (T)valueWithOptions:(const model::FieldValueOptions &)options;
 
 /** Compares against another FSTFieldValue. */
 - (NSComparisonResult)compare:(FSTFieldValue *)other;
@@ -164,7 +142,7 @@ enum class ServerTimestampBehavior { None, Estimate, Previous };
  *   (see [FSTTransformMutation applyTo]). They can only exist in the local view of a document.
  *   Therefore they do not need to be parsed or serialized.
  * - When evaluated locally (e.g. via FSTDocumentSnapshot data), they by default evaluate to NSNull.
- *   This behavior can be configured by passing custom FSTFieldValueOptions to `valueWithOptions:`.
+ *   This behavior can be configured by passing custom FieldValueOptions to `valueWithOptions:`.
  * - They sort after all FSTTimestampValues. With respect to other FSTServerTimestampValues, they
  *   sort by their localWriteTime.
  */
diff --git a/Firestore/Source/Model/FSTFieldValue.mm b/Firestore/Source/Model/FSTFieldValue.mm
@@ -38,6 +38,8 @@
 using firebase::firestore::model::FieldMask;
 using firebase::firestore::model::FieldPath;
 using firebase::firestore::model::FieldValue;
+using firebase::firestore::model::FieldValueOptions;
+using firebase::firestore::model::ServerTimestampBehavior;
 using firebase::firestore::util::Comparator;
 using firebase::firestore::util::CompareMixedNumber;
 using firebase::firestore::util::DoubleBitwiseEquals;
@@ -48,23 +50,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-#pragma mark - FSTFieldValueOptions
-
-@implementation FSTFieldValueOptions
-
-- (instancetype)initWithServerTimestampBehavior:(ServerTimestampBehavior)serverTimestampBehavior
-                   timestampsInSnapshotsEnabled:(BOOL)timestampsInSnapshotsEnabled {
-  self = [super init];
-
-  if (self) {
-    _serverTimestampBehavior = serverTimestampBehavior;
-    _timestampsInSnapshotsEnabled = timestampsInSnapshotsEnabled;
-  }
-  return self;
-}
-
-@end
-
 #pragma mark - FSTFieldValue
 
 @interface FSTFieldValue ()
@@ -88,7 +73,7 @@ - (id)value {
   @throw FSTAbstractMethodException();  // NOLINT
 }
 
-- (id)valueWithOptions:(FSTFieldValueOptions *)options {
+- (id)valueWithOptions:(const FieldValueOptions &)options {
   return [self value];
 }
 
@@ -337,8 +322,8 @@ - (id)value {
   return self.internalValue;
 }
 
-- (id)valueWithOptions:(FSTFieldValueOptions *)options {
-  if (options.timestampsInSnapshotsEnabled) {
+- (id)valueWithOptions:(const FieldValueOptions &)options {
+  if (options.timestamps_in_snapshots_enabled()) {
     return self.value;
   } else {
     return [self.value dateValue];
@@ -399,16 +384,16 @@ - (id)value {
   return [NSNull null];
 }
 
-- (id)valueWithOptions:(FSTFieldValueOptions *)options {
-  switch (options.serverTimestampBehavior) {
-    case ServerTimestampBehavior::None:
+- (id)valueWithOptions:(const FieldValueOptions &)options {
+  switch (options.server_timestamp_behavior()) {
+    case ServerTimestampBehavior::kNone:
       return [NSNull null];
-    case ServerTimestampBehavior::Estimate:
+    case ServerTimestampBehavior::kEstimate:
       return [[FSTTimestampValue timestampValue:self.localWriteTime] valueWithOptions:options];
-    case ServerTimestampBehavior::Previous:
+    case ServerTimestampBehavior::kPrevious:
       return self.previousValue ? [self.previousValue valueWithOptions:options] : [NSNull null];
     default:
-      HARD_FAIL("Unexpected server timestamp option: %s", options.serverTimestampBehavior);
+      HARD_FAIL("Unexpected server timestamp option: %s", options.server_timestamp_behavior());
   }
 }
 
@@ -680,7 +665,7 @@ - (id)value {
   return result;
 }
 
-- (id)valueWithOptions:(FSTFieldValueOptions *)options {
+- (id)valueWithOptions:(const FieldValueOptions &)options {
   NSMutableDictionary *result = [NSMutableDictionary dictionary];
   [self.internalValue
       enumerateKeysAndObjectsUsingBlock:^(NSString *key, FSTFieldValue *obj, BOOL *stop) {
@@ -863,7 +848,7 @@ - (id)value {
   return result;
 }
 
-- (id)valueWithOptions:(FSTFieldValueOptions *)options {
+- (id)valueWithOptions:(const FieldValueOptions &)options {
   NSMutableArray *result = [NSMutableArray arrayWithCapacity:_internalValue.count];
   [self.internalValue enumerateObjectsUsingBlock:^(FSTFieldValue *obj, NSUInteger idx, BOOL *stop) {
     [result addObject:[obj valueWithOptions:options]];
diff --git a/Firestore/core/src/firebase/firestore/model/CMakeLists.txt b/Firestore/core/src/firebase/firestore/model/CMakeLists.txt
@@ -29,6 +29,7 @@ cc_library(
     field_transform.h
     field_value.cc
     field_value.h
+    field_value_options.h
     maybe_document.cc
     maybe_document.h
     mutation.cc
diff --git a/Firestore/core/src/firebase/firestore/model/field_value_options.h b/Firestore/core/src/firebase/firestore/model/field_value_options.h
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_FIELD_VALUE_OPTIONS_H_
+#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_FIELD_VALUE_OPTIONS_H_
+
+namespace firebase {
+namespace firestore {
+namespace model {
+
+/** Defines the return value for pending server timestamps. */
+enum class ServerTimestampBehavior { kNone, kEstimate, kPrevious };
+
+/** Holds properties that define field value deserialization options. */
+class FieldValueOptions {
+ public:
+  /**
+   * Creates an FieldValueOptions instance that specifies deserialization
+   * behavior for pending server timestamps.
+   */
+  FieldValueOptions(ServerTimestampBehavior server_timestamp_behavior,
+                    bool timestamps_in_snapshots_enabled)
+      : server_timestamp_behavior_(server_timestamp_behavior),
+        timestamps_in_snapshots_enabled_(timestamps_in_snapshots_enabled) {
+  }
+
+  ServerTimestampBehavior server_timestamp_behavior() const {
+    return server_timestamp_behavior_;
+  }
+
+  bool timestamps_in_snapshots_enabled() const {
+    return timestamps_in_snapshots_enabled_;
+  }
+
+ private:
+  ServerTimestampBehavior server_timestamp_behavior_;
+  bool timestamps_in_snapshots_enabled_;
+};
+
+}  // namespace model
+}  // namespace firestore
+}  // namespace firebase
+
+#endif  // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_FIELD_VALUE_OPTIONS_H_
diff --git a/Firestore/core/test/firebase/firestore/testutil/xcgmock.h b/Firestore/core/test/firebase/firestore/testutil/xcgmock.h
@@ -157,7 +157,6 @@ OBJC_PRINT_TO(FSTDocumentSet);
 OBJC_PRINT_TO(FSTDoubleValue);
 OBJC_PRINT_TO(FSTEventManager);
 OBJC_PRINT_TO(FSTFieldValue);
-OBJC_PRINT_TO(FSTFieldValueOptions);
 OBJC_PRINT_TO(FSTFilter);
 OBJC_PRINT_TO(FSTFirestoreClient);
 OBJC_PRINT_TO(FSTFirestoreComponent);
