Merge pull request #682 from ParsePlatform/nlutsenko.synchronous

Split synchronous methods of all public classes into categories.

Author: nlutsenko

Parse.podspec

@@ -30,6 +30,7 @@ Pod::Spec.new do |s|
                         'Parse/Internal/PFMemoryEventuallyQueue.{h,m}'
   s.tvos.exclude_files = 'Parse/PFNetworkActivityIndicatorManager.{h,m}',
                          'Parse/PFPush.{h,m}',
+                         'Parse/PFPush+Synchronous.{h,m}',
                          'Parse/PFPush+Deprecated.{h,m}',
                          'Parse/PFInstallation.{h,m}',
                          'Parse/Internal/PFAlertView.{h,m}',
@@ -43,6 +44,7 @@ Pod::Spec.new do |s|
                             'Parse/PFProduct.{h,m}',
                             'Parse/PFPurchase.{h,m}',
                             'Parse/PFPush.{h,m}',
+                            'Parse/PFPush+Synchronous.{h,m}',
                             'Parse/PFPush+Deprecated.{h,m}',
                             'Parse/PFInstallation.{h,m}',
                             'Parse/Internal/PFAlertView.{h,m}',

Parse.xcodeproj/project.pbxproj

@@ -0,0 +1,47 @@
+/**
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Parse/PFCloud.h>
+#import <Parse/PFConstants.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ This category lists all methods of `PFCloud` class that are synchronous, but have asynchronous counterpart,
+ Calling one of these synchronous methods could potentially block the current thread for a large amount of time,
+ since it might be fetching from network or saving/loading data from disk.
+ */
+@interface PFCloud (Synchronous)
+
+/**
+ Calls the given cloud function *synchronously* with the parameters provided.
+
+ @param function The function name to call.
+ @param parameters The parameters to send to the function.
+
+ @return The response from the cloud function.
+ */
++ (nullable id)callFunction:(NSString *)function withParameters:(nullable NSDictionary *)parameters PF_SWIFT_UNAVAILABLE;
+
+/**
+ Calls the given cloud function *synchronously* with the parameters provided and
+ sets the error if there is one.
+
+ @param function The function name to call.
+ @param parameters The parameters to send to the function.
+ @param error Pointer to an `NSError` that will be set if necessary.
+
+ @return The response from the cloud function.
+ This result could be a `NSDictionary`, an `NSArray`, `NSNumber` or `NSString`.
+ */
++ (nullable id)callFunction:(NSString *)function withParameters:(nullable NSDictionary *)parameters error:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

Parse/PFCloud+Synchronous.h

@@ -20,31 +20,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface PFCloud : NSObject
 
-/**
- Calls the given cloud function *synchronously* with the parameters provided.
-
- @param function The function name to call.
- @param parameters The parameters to send to the function.
-
- @return The response from the cloud function.
- */
-+ (nullable id)callFunction:(NSString *)function withParameters:(nullable NSDictionary *)parameters PF_SWIFT_UNAVAILABLE;
-
-/**
- Calls the given cloud function *synchronously* with the parameters provided and
- sets the error if there is one.
-
- @param function The function name to call.
- @param parameters The parameters to send to the function.
- @param error Pointer to an `NSError` that will be set if necessary.
-
- @return The response from the cloud function.
- This result could be a `NSDictionary`, an `NSArray`, `NSNumber` or `NSString`.
- */
-+ (nullable id)callFunction:(NSString *)function
-             withParameters:(nullable NSDictionary *)parameters
-                      error:(NSError **)error;
-
 /**
  Calls the given cloud function *asynchronously* with the parameters provided.
 

Parse/PFCloud.h

@@ -22,14 +22,6 @@ @implementation PFCloud
 #pragma mark - Public
 ///--------------------------------------
 
-+ (id)callFunction:(NSString *)function withParameters:(NSDictionary *)parameters {
-    return [self callFunction:function withParameters:parameters error:nil];
-}
-
-+ (id)callFunction:(NSString *)function withParameters:(NSDictionary *)parameters error:(NSError **)error {
-    return [[self callFunctionInBackground:function withParameters:parameters] waitForResult:error];
-}
-
 + (BFTask *)callFunctionInBackground:(NSString *)functionName withParameters:(NSDictionary *)parameters {
     return [[PFUser _getCurrentUserSessionTokenAsync] continueWithBlock:^id(BFTask *task) {
         NSString *sessionToken = task.result;
@@ -48,6 +40,22 @@ + (void)callFunctionInBackground:(NSString *)function
 
 @end
 
+///--------------------------------------
+#pragma mark - Synchronous
+///--------------------------------------
+
+@implementation PFCloud (Synchronous)
+
++ (id)callFunction:(NSString *)function withParameters:(NSDictionary *)parameters {
+    return [self callFunction:function withParameters:parameters error:nil];
+}
+
++ (id)callFunction:(NSString *)function withParameters:(NSDictionary *)parameters error:(NSError **)error {
+    return [[self callFunctionInBackground:function withParameters:parameters] waitForResult:error];
+}
+
+@end
+
 ///--------------------------------------
 #pragma mark - Deprecated
 ///--------------------------------------

Parse/PFCloud.m

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Parse/PFConfig.h>
+#import <Parse/PFConstants.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ This category lists all methods of `PFConfig` class that are synchronous, but have asynchronous counterpart,
+ Calling one of these synchronous methods could potentially block the current thread for a large amount of time,
+ since it might be fetching from network or saving/loading data from disk.
+ */
+@interface PFConfig (Synchronous)
+
+///--------------------------------------
+/// @name Retrieving Config
+///--------------------------------------
+
+/**
+ Gets the `PFConfig` object *synchronously* from the server.
+
+ @return Instance of `PFConfig` if the operation succeeded, otherwise `nil`.
+ */
++ (nullable PFConfig *)getConfig PF_SWIFT_UNAVAILABLE;
+
+/**
+ Gets the `PFConfig` object *synchronously* from the server and sets an error if it occurs.
+
+ @param error Pointer to an `NSError` that will be set if necessary.
+
+ @return Instance of PFConfig if the operation succeeded, otherwise `nil`.
+ */
++ (nullable PFConfig *)getConfig:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

Parse/PFConfig+Synchronous.h

@@ -42,22 +42,6 @@ typedef void(^PFConfigResultBlock)(PFConfig *__nullable config, NSError *__nulla
 /// @name Retrieving Config
 ///--------------------------------------
 
-/**
- Gets the `PFConfig` object *synchronously* from the server.
-
- @return Instance of `PFConfig` if the operation succeeded, otherwise `nil`.
- */
-+ (nullable PFConfig *)getConfig PF_SWIFT_UNAVAILABLE;
-
-/**
- Gets the `PFConfig` object *synchronously* from the server and sets an error if it occurs.
-
- @param error Pointer to an `NSError` that will be set if necessary.
-
- @return Instance of PFConfig if the operation succeeded, otherwise `nil`.
- */
-+ (nullable PFConfig *)getConfig:(NSError **)error;
-
 /**
  Gets the `PFConfig` *asynchronously* and sets it as a result of a task.
 

Parse/PFConfig.h

@@ -61,14 +61,6 @@ - (instancetype)initWithFetchedConfig:(NSDictionary *)resultDictionary {
 #pragma mark - Fetch
 ///--------------------------------------
 
-+ (PFConfig *)getConfig {
-    return [self getConfig:nil];
-}
-
-+ (PFConfig *)getConfig:(NSError **)error {
-    return [[self getConfigInBackground] waitForResult:error];
-}
-
 + (BFTask *)getConfigInBackground {
     PFCurrentUserController *controller = [Parse _currentManager].coreManager.currentUserController;
     return [[controller getCurrentUserSessionTokenAsync] continueWithBlock:^id(BFTask *task) {
@@ -112,3 +104,21 @@ - (BOOL)isEqual:(id)object {
 }
 
 @end
+
+///--------------------------------------
+#pragma mark - Synchronous
+///--------------------------------------
+
+@implementation PFConfig (Synchronous)
+
+#pragma mark Retrieving Config
+
++ (PFConfig *)getConfig {
+    return [self getConfig:nil];
+}
+
++ (PFConfig *)getConfig:(NSError **)error {
+    return [[self getConfigInBackground] waitForResult:error];
+}
+
+@end

Parse/PFConfig.m

@@ -0,0 +1,89 @@
+/**
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Parse/PFConstants.h>
+#import <Parse/PFFile.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ This category lists all methods of `PFFile` class that are synchronous, but have asynchronous counterpart,
+ Calling one of these synchronous methods could potentially block the current thread for a large amount of time,
+ since it might be fetching from network or saving/loading data from disk.
+ */
+@interface PFFile (Synchronous)
+
+///--------------------------------------
+/// @name Storing Data with Parse
+///--------------------------------------
+
+/**
+ Saves the file *synchronously*.
+
+ @return Returns whether the save succeeded.
+ */
+- (BOOL)save PF_SWIFT_UNAVAILABLE;
+
+/**
+ Saves the file *synchronously* and sets an error if it occurs.
+
+ @param error Pointer to an `NSError` that will be set if necessary.
+
+ @return Returns whether the save succeeded.
+ */
+- (BOOL)save:(NSError **)error;
+
+///--------------------------------------
+/// @name Getting Data from Parse
+///--------------------------------------
+
+/**
+ Whether the data is available in memory or needs to be downloaded.
+ */
+@property (nonatomic, assign, readonly, getter=isDataAvailable) BOOL dataAvailable;
+
+/**
+ *Synchronously* gets the data from cache if available or fetches its contents from the network.
+
+ @return The `NSData` object containing file data. Returns `nil` if there was an error in fetching.
+ */
+- (nullable NSData *)getData PF_SWIFT_UNAVAILABLE;
+
+/**
+ *Synchronously* gets the data from cache if available or fetches its contents from the network.
+ Sets an error if it occurs.
+
+ @param error Pointer to an `NSError` that will be set if necessary.
+
+ @return The `NSData` object containing file data. Returns `nil` if there was an error in fetching.
+ */
+- (nullable NSData *)getData:(NSError **)error;
+
+/**
+ This method is like `-getData` but avoids ever holding the entire `PFFile` contents in memory at once.
+
+ This can help applications with many large files avoid memory warnings.
+
+ @return A stream containing the data. Returns `nil` if there was an error in fetching.
+ */
+- (nullable NSInputStream *)getDataStream PF_SWIFT_UNAVAILABLE;
+
+/**
+ This method is like `-getData` but avoids ever holding the entire `PFFile` contents in memory at once.
+
+ @param error Pointer to an `NSError` that will be set if necessary.
+
+ @return A stream containing the data. Returns nil if there was an error in
+ fetching.
+ */
+- (nullable NSInputStream *)getDataStream:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

Parse/PFFile+Synchronous.h

@@ -151,22 +151,6 @@ NS_ASSUME_NONNULL_BEGIN
 /// @name Storing Data with Parse
 ///--------------------------------------
 
-/**
- Saves the file *synchronously*.
-
- @return Returns whether the save succeeded.
- */
-- (BOOL)save PF_SWIFT_UNAVAILABLE;
-
-/**
- Saves the file *synchronously* and sets an error if it occurs.
-
- @param error Pointer to an `NSError` that will be set if necessary.
-
- @return Returns whether the save succeeded.
- */
-- (BOOL)save:(NSError **)error;
-
 /**
  Saves the file *asynchronously*.
 
@@ -211,41 +195,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign, readonly, getter=isDataAvailable) BOOL dataAvailable;
 
-/**
- *Synchronously* gets the data from cache if available or fetches its contents from the network.
-
- @return The `NSData` object containing file data. Returns `nil` if there was an error in fetching.
- */
-- (nullable NSData *)getData PF_SWIFT_UNAVAILABLE;
-
-/**
- This method is like `-getData` but avoids ever holding the entire `PFFile` contents in memory at once.
-
- This can help applications with many large files avoid memory warnings.
-
- @return A stream containing the data. Returns `nil` if there was an error in fetching.
- */
-- (nullable NSInputStream *)getDataStream PF_SWIFT_UNAVAILABLE;
-
-/**
- *Synchronously* gets the data from cache if available or fetches its contents from the network.
- Sets an error if it occurs.
-
- @param error Pointer to an `NSError` that will be set if necessary.
-
- @return The `NSData` object containing file data. Returns `nil` if there was an error in fetching.
- */
-- (nullable NSData *)getData:(NSError **)error;
-
-/**
- This method is like `-getData` but avoids ever holding the entire `PFFile` contents in memory at once.
-
- @param error Pointer to an `NSError` that will be set if necessary.
-
- @return A stream containing the data. Returns nil if there was an error in
- fetching.
- */
-- (nullable NSInputStream *)getDataStream:(NSError **)error;
 
 /**
  This method is like `-getData` but it fetches asynchronously to avoid blocking the current thread.