Fix an issue where importing an Objective-C type called Optional causes LLDB to sometimes not be able to distinguish between Swift.Optional and OptimizelySDKiOS.Optional. (#274)

Author: tprevost-phunware

OptimizelySDKCore/OPTLYJSONModel/OPTLYJSONModel/OPTLYJSONModel/OPTLYJSONModel.h

@@ -57,16 +57,16 @@ DEPRECATED_ATTRIBUTE
  * Protocol for defining optional properties in a JSON Model class. Use like below to define
  * model properties that are not required to have values in the JSON input:
  *
- * @property (strong, nonatomic) NSString<Optional> *propertyName;
+ * @property (strong, nonatomic) NSString<OPTLYOptional> *propertyName;
  *
  */
-@protocol Optional
+@protocol OPTLYOptional
 @end
 
 /**
  * Make all objects compatible to avoid compiler warnings
  */
-@interface NSObject (OPTLYJSONModelPropertyCompatibility) <Optional, Ignore>
+@interface NSObject (OPTLYJSONModelPropertyCompatibility) <OPTLYOptional, Ignore>
 @end
 
 /////////////////////////////////////////////////////////////////////////////////////////////
@@ -250,11 +250,11 @@ DEPRECATED_ATTRIBUTE
 + (OPTLYJSONKeyMapper *)keyMapper;
 
 /**
- * Indicates whether the property with the given name is Optional.
- * To have a model with all of its properties being Optional just return YES.
+ * Indicates whether the property with the given name is OPTLYOptional.
+ * To have a model with all of its properties being OPTLYOptional just return YES.
  * This method returns by default NO, since the default behaviour is to have all properties required.
  * @param propertyName the name of the property
- * @return a BOOL result indicating whether the property is optional
+ * @return a BOOL result indicating whether the property is OPTLYOptional
  */
 + (BOOL)propertyIsOptional:(NSString *)propertyName;
 

OptimizelySDKCore/OPTLYJSONModel/OPTLYJSONModel/OPTLYJSONModel/OPTLYJSONModel.m

@@ -607,7 +607,7 @@ -(void)__inspectProperties
 
                     [scanner scanUpToString:@">" intoString: &protocolName];
 
-                    if ([protocolName isEqualToString:@"Optional"]) {
+                    if ([protocolName isEqualToString:@"OPTLYOptional"]) {
                         p.isOptional = YES;
                     } else if([protocolName isEqualToString:@"Index"]) {
 #pragma GCC diagnostic push

OptimizelySDKCore/OPTLYJSONModel/README.md

@@ -211,9 +211,9 @@ for OPTLYJSONModel to work, the protocol must be in place.
 ```objc
 @interface ProductModel : OPTLYJSONModel
 @property (nonatomic) NSInteger id;
-@property (nonatomic) NSString <Optional> *name;
+@property (nonatomic) NSString <OPTLYOptional> *name;
 @property (nonatomic) float price;
-@property (nonatomic) NSNumber <Optional> *uuid;
+@property (nonatomic) NSNumber <OPTLYOptional> *uuid;
 @end
 ```
 

OptimizelySDKCore/OPTLYJSONModelTests/KeyMappingTests.m

@@ -39,9 +39,9 @@
 @interface TestModel: OPTLYJSONModel
 
 @property (strong, nonatomic) NSString* text1;
-@property (strong, nonatomic) NSString<Optional>* text2;
+@property (strong, nonatomic) NSString<OPTLYOptional>* text2;
 
-@property (strong, nonatomic) NSString<Optional>* text3;
+@property (strong, nonatomic) NSString<OPTLYOptional>* text3;
 
 @end
 

OptimizelySDKCore/OPTLYJSONModelTests/Models/Headers/ConcurrentReposModel.h

@@ -32,7 +32,7 @@
 @property (assign, nonatomic) int watchers;
 @property (strong, nonatomic) NSString* owner;
 @property (assign, nonatomic) int forks;
-@property (strong, nonatomic) NSString<Optional>* language;
+@property (strong, nonatomic) NSString<OPTLYOptional>* language;
 @property (assign, nonatomic) BOOL fork;
 @property (assign, nonatomic) double size;
 @property (assign, nonatomic) int followers;

OptimizelySDKCore/OPTLYJSONModelTests/Models/Headers/GitHubKeyMapRepoModel.h

@@ -27,7 +27,7 @@
 @interface GitHubKeyMapRepoModel : OPTLYJSONModel
 
 @property (strong, nonatomic) NSString* __description;
-@property (strong, nonatomic) NSString<Optional>* language;
+@property (strong, nonatomic) NSString<OPTLYOptional>* language;
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"

OptimizelySDKCore/OPTLYJSONModelTests/Models/Headers/GitHubRepoModel.h

@@ -31,7 +31,7 @@
 @property (assign, nonatomic) int watchers;
 @property (strong, nonatomic) NSString* owner;
 @property (assign, nonatomic) int forks;
-@property (strong, nonatomic) NSString<Optional>* language;
+@property (strong, nonatomic) NSString<OPTLYOptional>* language;
 @property (assign, nonatomic) BOOL fork;
 @property (assign, nonatomic) double size;
 @property (assign, nonatomic) int followers;

OptimizelySDKCore/OPTLYJSONModelTests/Models/Headers/GitHubRepoModelForUSMapper.h

@@ -30,6 +30,6 @@
 @property (strong, nonatomic) NSDate* createdAt;
 @property (assign, nonatomic) int aVeryLongPropertyName;
 @property (strong, nonatomic) NSString* itemObject145;
-@property (strong, nonatomic) NSString<Optional>* itemObject176Details;
+@property (strong, nonatomic) NSString<OPTLYOptional>* itemObject176Details;
 
 @end

OptimizelySDKCore/OPTLYJSONModelTests/Models/Headers/ImageModel.h

@@ -30,6 +30,6 @@
 
 @property (strong, nonatomic) NSNumber* idImage;
 @property (strong, nonatomic) NSString* name;
-@property (strong, nonatomic) CopyrightModel<Optional>* copyright;
+@property (strong, nonatomic) CopyrightModel<OPTLYOptional>* copyright;
 
 @end

OptimizelySDKCore/OPTLYJSONModelTests/Models/Headers/JSONTypesModel.h

@@ -34,6 +34,6 @@
 @property (strong, nonatomic) NSMutableArray* dynamicList;
 @property (strong, nonatomic) NSDictionary* dictionary;
 @property (strong, nonatomic) NSMutableDictionary* dynamicDictionary;
-@property (strong, nonatomic) NSString<Optional>* notAvailable;
+@property (strong, nonatomic) NSString<OPTLYOptional>* notAvailable;
 
 @end