Merge pull request #726 from ParsePlatform/nlutsenko.properties.user

Convert all private ivars of PFUser to properties.

Author: nlutsenko

Parse/Internal/User/AuthenticationProviders/Controller/PFUserAuthenticationController.m

@@ -118,7 +118,7 @@ - (void)unregisterAuthenticationDelegateForAuthType:(NSString *)authType {
     return [[self.dataSource.currentUserController getCurrentUserAsyncWithOptions:0] continueWithSuccessBlock:^id(BFTask<PFUser *> *task) {
         PFUser *currentUser = task.result;
         if (currentUser && [PFAnonymousUtils isLinkedWithUser:currentUser]) {
-            if (currentUser.isLazy) {
+            if (currentUser._lazy) {
                 BFTask *resolveLaziness = nil;
                 NSDictionary *oldAnonymousData = nil;
                 @synchronized(currentUser.lock) {

Parse/Internal/User/CurrentUserController/PFCurrentUserController.m

@@ -120,9 +120,9 @@ - (BFTask *)_getCurrentUserAsyncWithOptions:(PFCurrentUserLoadingOptions)options
         return [[[[self _loadCurrentUserFromDiskAsync] continueWithSuccessBlock:^id(BFTask *task) {
             PFUser *user = task.result;
             // If the object was not yet saved, but is already linked with AnonymousUtils - it means it is lazy.
-            // So mark it's state as `isLazy` and make it `dirty`
+            // So mark it's state as `lazy` and make it `dirty`
             if (!user.objectId && [PFAnonymousUtils isLinkedWithUser:user]) {
-                user.isLazy = YES;
+                user._lazy = YES;
                 [user _setDirty:YES];
             }
             return user;
@@ -158,7 +158,7 @@ - (BFTask *)_saveCurrentUserAsync:(PFUser *)user {
         }
         return [[task continueWithBlock:^id(BFTask *task) {
             @synchronized (user.lock) {
-                [user setIsCurrentUser:YES];
+                user._current = YES;
                 [user synchronizeAllAuthData];
             }
             return [self _saveCurrentUserToDiskAsync:user];
@@ -246,7 +246,7 @@ - (BFTask *)_loadCurrentUserFromDiskAsync {
     }
     return [task continueWithSuccessBlock:^id(BFTask *task) {
         PFUser *user = task.result;
-        [user setIsCurrentUser:YES];
+        user._current = YES;
         return [[self _loadSensitiveUserDataAsync:user
                          fromKeychainItemWithName:PFUserCurrentUserKeychainItemName] continueWithSuccessResult:user];
     }];

Parse/Internal/User/PFUserPrivate.h

@@ -51,20 +51,17 @@ extern NSString *const PFUserCurrentUserKeychainItemName;
 @end
 
 // Private Properties
-@interface PFUser () {
-    BOOL isCurrentUser;
-    NSMutableDictionary *authData;
-    NSMutableSet *linkedServiceNames;
-    BOOL isLazy;
-}
-
-// This earmarks the user as being an "identity" user. This will make saves write through
-// to the currentUser singleton and disk object
-@property (nonatomic, assign) BOOL isCurrentUser;
-
-@property (nonatomic, strong, readonly) NSMutableDictionary *authData;
-@property (nonatomic, strong, readonly) NSMutableSet *linkedServiceNames;
-@property (nonatomic, assign) BOOL isLazy;
+@interface PFUser ()
+
+@property (nonatomic, strong, readonly) NSMutableDictionary<NSString *, id> *authData;
+@property (nonatomic, strong, readonly) NSMutableSet<NSString *> *linkedServiceNames;
+
+/**
+ This earmarks the user as being an "identity" user.
+ This will make saves write through to the currentUser singleton and disk object
+ */
+@property (nonatomic, assign) BOOL _current;
+@property (nonatomic, assign) BOOL _lazy;
 
 - (BOOL)_isAuthenticatedWithCurrentUser:(PFUser *)currentUser;
 

Parse/PFACL.m

@@ -275,7 +275,7 @@ - (void)setUnresolvedReadAccess:(BOOL)allowed forUser:(PFUser *)user {
 - (void)setReadAccess:(BOOL)allowed forUser:(PFUser *)user {
     NSString *objectId = user.objectId;
     if (!objectId) {
-        if (user.isLazy) {
+        if (user._lazy) {
             [self setUnresolvedReadAccess:allowed forUser:user];
             return;
         }
@@ -301,7 +301,7 @@ - (void)setUnresolvedWriteAccess:(BOOL)allowed forUser:(PFUser *)user {
 - (void)setWriteAccess:(BOOL)allowed forUser:(PFUser *)user {
     NSString *objectId = user.objectId;
     if (!objectId) {
-        if (user.isLazy) {
+        if (user._lazy) {
             [self setUnresolvedWriteAccess:allowed forUser:user];
             return;
         }

Parse/PFObject.m

@@ -435,7 +435,7 @@ + (BFTask *)_deepSaveAsyncChildrenOfObject:(id)object withCurrentUser:(PFUser *)
         // This has to happen separately from everything else because there [PFUser save]
         // is special-cased to work for lazy users, but new users can't be created by
         // PFMultiCommand's regular save.
-        if (currentUser.isLazy && [current containsObject:currentUser]) {
+        if (currentUser._lazy && [current containsObject:currentUser]) {
             task = [task continueAsyncWithSuccessBlock:^id(BFTask *task) {
                 return [currentUser saveInBackground];
             }];
@@ -607,7 +607,7 @@ + (BFTask *)_enqueueSaveEventuallyChildrenOfObject:(PFObject *)object
             // Unfortunately, ACLs with lazy users still cannot be saved, because the ACL does
             // does not get updated after the user save completes.
             // TODO: (nlutsenko) Make the ACL update after the user is saved.
-            if (currentUser.isLazy && [current containsObject:currentUser]) {
+            if (currentUser._lazy && [current containsObject:currentUser]) {
                 [enqueueTasks addObject:[currentUser _enqueueSaveEventuallyWithChildren:NO]];
                 [finished addObject:currentUser];
                 [current removeObject:currentUser];

Parse/PFUser.m

@@ -70,7 +70,7 @@ @implementation PFUser (Private)
 
 - (void)setDefaultValues {
     [super setDefaultValues];
-    self.isCurrentUser = NO;
+    self._current = NO;
 }
 
 - (BOOL)needsDefaultACL {
@@ -136,7 +136,7 @@ + (void)_assertValidInstanceClassName:(NSString *)className {
 // Checks the properties on the object before saving.
 - (void)_checkSaveParametersWithCurrentUser:(PFUser *)currentUser {
     @synchronized([self lock]) {
-        PFConsistencyAssert(self.objectId || self.isLazy,
+        PFConsistencyAssert(self.objectId || self._lazy,
                             @"User cannot be saved unless they are already signed up. Call signUp first.");
 
         PFConsistencyAssert([self _isAuthenticatedWithCurrentUser:currentUser] ||
@@ -181,7 +181,7 @@ - (NSMutableDictionary *)_convertToDictionaryForSaving:(PFOperationSet *)changes
 
 - (BFTask *)handleSaveResultAsync:(NSDictionary *)result {
     return [[super handleSaveResultAsync:result] continueWithSuccessBlock:^id(BFTask *saveTask) {
-        if (self.isCurrentUser) {
+        if (self._current) {
             [self cleanUpAuthData];
             PFCurrentUserController *controller = [[self class] currentUserController];
             return [[controller saveCurrentObjectAsync:self] continueWithBlock:^id(BFTask *task) {
@@ -233,7 +233,7 @@ - (BFTask *)_handleServiceLoginCommandResult:(PFCommandResult *)result {
                     }];
                 }
                 if (resultDictionary) {
-                    self.isLazy = NO;
+                    self._lazy = NO;
 
                     // Serialize the object to disk so we can later access it via currentUser
                     PFCurrentUserController *controller = [[self class] currentUserController];
@@ -271,7 +271,7 @@ - (BFTask *)handleSignUpResultAsync:(BFTask *)task {
                         state.sessionToken = result[PFUserSessionTokenRESTKey];
                         state.isNew = YES;
                     }];
-                    self.isLazy = NO;
+                    self._lazy = NO;
                 }
             }
             return signUpTask;
@@ -380,7 +380,7 @@ - (void)_mergeFromServerWithResult:(NSDictionary *)result decoder:(PFDecoder *)d
 
 - (void)synchronizeAuthDataWithAuthType:(NSString *)authType {
     @synchronized([self lock]) {
-        if (!self.isCurrentUser) {
+        if (!self._current) {
             return;
         }
 
@@ -407,13 +407,13 @@ - (void)synchronizeAllAuthData {
 
 - (BFTask *)resolveLazinessAsync:(BFTask *)toAwait {
     @synchronized([self lock]) {
-        if (!self.isLazy) {
+        if (!self._lazy) {
             return [BFTask taskWithResult:self];
         }
         if (self.linkedServiceNames.count == 0) {
             // If there are no linked services, treat this like a sign-up.
             return [[self signUpAsync:toAwait] continueAsyncWithSuccessBlock:^id(BFTask *task) {
-                self.isLazy = NO;
+                self._lazy = NO;
                 return self;
             }];
         }
@@ -458,8 +458,8 @@ - (BFTask *)_logOutAsyncWithAuthType:(NSString *)authType {
 + (instancetype)logInLazyUserWithAuthType:(NSString *)authType authData:(NSDictionary *)authData {
     PFUser *user = [self user];
     @synchronized([user lock]) {
-        [user setIsCurrentUser:YES];
-        user.isLazy = YES;
+        user._current = YES;
+        user._lazy = YES;
         user.authData[authType] = authData;
         [user.linkedServiceNames addObject:authType];
     }
@@ -497,7 +497,7 @@ - (BFTask *)signUpAsync:(BFTask *)toAwait {
                 // self doesn't have any outstanding saves, so we can safely merge its operations
                 // into the current user.
 
-                PFConsistencyAssert(!isCurrentUser, @"Attempt to merge currentUser with itself.");
+                PFConsistencyAssert(!self._current, @"Attempt to merge currentUser with itself.");
 
                 @synchronized ([currentUser lock]) {
                     NSString *oldUsername = [currentUser.username copy];
@@ -603,7 +603,7 @@ - (PFRESTCommand *)_constructSaveCommandForChanges:(PFOperationSet *)changes
                                      objectEncoder:(PFEncoder *)encoder {
     // If we are curent user - use the latest available session token, as it might have been changed since
     // this command was enqueued.
-    if (self.isCurrentUser) {
+    if (self._current) {
         token = self.sessionToken;
     }
     return [super _constructSaveCommandForChanges:changes
@@ -770,9 +770,10 @@ @implementation PFUser
 @dynamic password;
 
 // PFUser (Private):
-@dynamic authData;
-@dynamic linkedServiceNames;
-@dynamic isLazy;
+@synthesize authData = _authData;
+@synthesize linkedServiceNames = _linkedServiceNames;
+@synthesize _current = _current;
+@synthesize _lazy = _lazy;
 
 + (NSString *)parseClassName {
     return @"_User";
@@ -783,15 +784,15 @@ + (instancetype)currentUser {
     return [[controller getCurrentObjectAsync] waitForResult:nil withMainThreadWarning:NO];
 }
 
-- (BOOL)isCurrentUser {
+- (BOOL)_current {
     @synchronized(self.lock) {
-        return isCurrentUser;
+        return _current;
     }
 }
 
-- (void)setIsCurrentUser:(BOOL)aBool {
+- (void)set_current:(BOOL)current {
     @synchronized(self.lock) {
-        isCurrentUser = aBool;
+        _current = current;
     }
 }
 
@@ -985,7 +986,7 @@ - (BFTask *)_logOutAsync {
             [tasks addObject:task];
         }];
 
-        self.isCurrentUser = NO;
+        self._current = NO;
 
         token = [self.sessionToken copy];
 
@@ -1025,20 +1026,20 @@ - (void)removeObjectForKey:(NSString *)key {
 
 - (NSMutableDictionary *)authData {
     @synchronized([self lock]) {
-        if (!authData) {
-            authData = [[NSMutableDictionary alloc] init];
+        if (!_authData) {
+            _authData = [[NSMutableDictionary alloc] init];
         }
     }
-    return authData;
+    return _authData;
 }
 
 - (NSMutableSet *)linkedServiceNames {
     @synchronized([self lock]) {
-        if (!linkedServiceNames) {
-            linkedServiceNames = [[NSMutableSet alloc] init];
+        if (!_linkedServiceNames) {
+            _linkedServiceNames = [[NSMutableSet alloc] init];
         }
     }
-    return linkedServiceNames;
+    return _linkedServiceNames;
 }
 
 + (instancetype)user {
@@ -1054,7 +1055,7 @@ - (BFTask *)saveAsync:(BFTask *)toAwait {
     // but not always. Using continueAsyncWithBlock unlocks from the taskQueue, and solves the proplem.
     return [toAwait continueAsyncWithBlock:^id(BFTask *task) {
         @synchronized ([self lock]) {
-            if (self.isLazy) {
+            if (self._lazy) {
                 return [[self resolveLazinessAsync:toAwait] continueAsyncWithSuccessBlock:^id(BFTask *task) {
                     return @(!!task.result);
                 }];
@@ -1066,12 +1067,12 @@ - (BFTask *)saveAsync:(BFTask *)toAwait {
 }
 
 - (BFTask *)fetchAsync:(BFTask *)toAwait {
-    if (self.isLazy) {
+    if (self._lazy) {
         return [BFTask taskWithResult:@YES];
     }
 
     return [[super fetchAsync:toAwait] continueAsyncWithSuccessBlock:^id(BFTask *fetchAsyncTask) {
-        if (self.isCurrentUser) {
+        if (self._current) {
             [self cleanUpAuthData];
             PFCurrentUserController *controller = [[self class] currentUserController];
             return [[controller saveCurrentObjectAsync:self] continueAsyncWithBlock:^id(BFTask *task) {
@@ -1083,14 +1084,14 @@ - (BFTask *)fetchAsync:(BFTask *)toAwait {
 }
 
 - (instancetype)fetch:(NSError **)error {
-    if (self.isLazy) {
+    if (self._lazy) {
         return self;
     }
     return [super fetch:error];
 }
 
 - (void)fetchInBackgroundWithBlock:(PFObjectResultBlock)block {
-    if (self.isLazy) {
+    if (self._lazy) {
         if (block) {
             block(self, nil);
             return;
@@ -1116,11 +1117,11 @@ - (BOOL)isAuthenticated {
 
 - (BOOL)_isAuthenticatedWithCurrentUser:(PFUser *)currentUser {
     @synchronized([self lock]) {
-        BOOL authenticated = self.isLazy || self.sessionToken;
+        BOOL authenticated = self._lazy || self.sessionToken;
         if (!authenticated && currentUser != nil) {
             authenticated = [self.objectId isEqualToString:currentUser.objectId];
         } else {
-            authenticated = self.isCurrentUser;
+            authenticated = self._current;
         }
         return authenticated;
     }
@@ -1140,7 +1141,7 @@ - (void)signUpInBackgroundWithBlock:(PFBooleanResultBlock)block {
             // For anonymous users, there may be an objectId.  Setting the userName
             // will have removed the anonymous link and set the value in the authData
             // object to [NSNull null], so we can just treat it like a save operation.
-            if (authData[PFAnonymousUserAuthenticationType] == [NSNull null]) {
+            if (self.authData[PFAnonymousUserAuthenticationType] == [NSNull null]) {
                 [self saveInBackgroundWithBlock:block];
                 return;
             }

Tests/Unit/ACLTests.m

@@ -122,7 +122,7 @@ - (void)testLazyUser {
     OCMStub(lazyUser.objectId).andDo(^(NSInvocation *invocation) {
         [invocation setReturnValue:&userId];
     });
-    OCMStub(lazyUser.isLazy).andReturn(YES);
+    OCMStub(lazyUser._lazy).andReturn(YES);
 
     __block void (^saveListener)(id, NSError *) = nil;