Allow configuring imageCache when initializing ASPINRemoteImageDownlo…

…ader. (TextureGroup#1197) * Allow configuring imageCache along with NSURLSessionConfiguration when initializing ASPINRemoteImageDownloader. * Update CHANGELOG.md * Update Source/Details/ASPINRemoteImageDownloader.m Co-Authored-By: wiseoldduck <[email protected]> * Put class linkage tests behind #if DEBUG * Remove silly nil check * Add non-nil assert * Update documentation
mikezucc · Nov 7, 2018 · 7b14960 · 7b14960
1 parent e55d999
commit 7b14960
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## master
 * Add your own contributions to the next release on the line below this with your name.
+- [ASPINRemoteImageManager] Allow specifying an image cache when configuring ASPINRemoteImageManager. [Kevin Smith](https://github.com/wiseoldduck). [#1197](https://github.com/TextureGroup/Texture/pull/1197)
 - [ASTextNode2] Newline character support and truncated line sizing improvement.  [Kevin Smith](https://github.com/wiseoldduck). [#1193](https://github.com/TextureGroup/Texture/pull/1193)
 - [ASScrollNode] A11y support for ASScrollNode. [Max Wang](https://github.com/wsdwsd0829). [#1188](https://github.com/TextureGroup/Texture/pull/1188)
 - [ASDisplayNode.m] Make sure node is loaded before enter visible. [Max Wang](https://github.com/wsdwsd0829). [#886](https://github.com/TextureGroup/Texture/pull/886)

diff --git a/Source/Details/ASPINRemoteImageDownloader.h b/Source/Details/ASPINRemoteImageDownloader.h
@@ -16,6 +16,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @class PINRemoteImageManager;
+@protocol PINRemoteImageCaching;
 
 @interface ASPINRemoteImageDownloader : NSObject <ASImageCacheProtocol, ASImageDownloaderProtocol>
 
@@ -28,7 +29,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (ASPINRemoteImageDownloader *)sharedDownloader NS_RETURNS_RETAINED;
 
-
 /**
  * Sets the default NSURLSessionConfiguration that will be used by @c ASNetworkImageNodes and @c ASMultiplexImageNodes
  * while loading images off the network. This must be specified early in the application lifecycle before
@@ -39,15 +39,27 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (void)setSharedImageManagerWithConfiguration:(nullable NSURLSessionConfiguration *)configuration;
 
+/**
+ * Sets the default NSURLSessionConfiguration that will be used by @c ASNetworkImageNodes and @c ASMultiplexImageNodes
+ * while loading images off the network. This must be specified early in the application lifecycle before
+ * `sharedDownloader` is accessed.
+ *
+ * @param configuration The session configuration that will be used by `sharedDownloader`
+ * @param imageCache The cache to be used by PINRemoteImage - nil will set up a default cache: PINCache
+ * if it is available, PINRemoteImageBasicCache (NSCache) if not.
+ *
+ */
++ (void)setSharedImageManagerWithConfiguration:(nullable NSURLSessionConfiguration *)configuration
+                                    imageCache:(nullable id<PINRemoteImageCaching>)imageCache;
+
 /**
  * Sets a custom preconfigured PINRemoteImageManager that will be used by @c ASNetworkImageNodes and @c ASMultiplexImageNodes
  * while loading images off the network. This must be specified early in the application lifecycle before
- * `sharedDownloader` is accessed. If nil is passed in as the PINRemoteImageManager, it will create
- * a default image manager with a nil session configuration.
+ * `sharedDownloader` is accessed.
  *
  * @param preconfiguredPINRemoteImageManager The preconfigured remote image manager that will be used by `sharedDownloader`
  */
-+ (void)setSharedPreconfiguredRemoteImageManager:(nullable PINRemoteImageManager *)preconfiguredPINRemoteImageManager;
++ (void)setSharedPreconfiguredRemoteImageManager:(PINRemoteImageManager *)preconfiguredPINRemoteImageManager;
 
 /**
  * The shared instance of a @c PINRemoteImageManager used by all @c ASPINRemoteImageDownloaders

diff --git a/Source/Details/ASPINRemoteImageDownloader.mm b/Source/Details/ASPINRemoteImageDownloader.mm
@@ -75,7 +75,7 @@ @interface ASPINRemoteImageManager : PINRemoteImageManager
 @implementation ASPINRemoteImageManager
 
 //Share image cache with sharedImageManager image cache.
-- (id <PINRemoteImageCaching>)defaultImageCache
++ (id <PINRemoteImageCaching>)defaultImageCache
 {
   static dispatch_once_t onceToken;
   static id <PINRemoteImageCaching> cache = nil;
@@ -106,7 +106,6 @@ @implementation ASPINRemoteImageDownloader
 
 + (ASPINRemoteImageDownloader *)sharedDownloader NS_RETURNS_RETAINED
 {
-
   static dispatch_once_t onceToken = 0;
   dispatch_once(&onceToken, ^{
     sharedDownloader = [[ASPINRemoteImageDownloader alloc] init];
@@ -116,56 +115,68 @@ + (ASPINRemoteImageDownloader *)sharedDownloader NS_RETURNS_RETAINED
 
 + (void)setSharedImageManagerWithConfiguration:(nullable NSURLSessionConfiguration *)configuration
 {
-  NSAssert(sharedDownloader == nil, @"Singleton has been created and session can no longer be configured.");
-  NSAssert1(sharedPINRemoteImageManager == nil, @"An instance of %@ has been set. Either configuration or preconfigured image manager can be set at a time and only once.", [[sharedPINRemoteImageManager class] description]);
-  __unused PINRemoteImageManager *sharedManager = [self sharedPINRemoteImageManagerWithConfiguration:configuration preconfiguredPINRemoteImageManager:nil];
+  PINRemoteImageManager *sharedManager = [self PINRemoteImageManagerWithConfiguration:configuration imageCache:nil];
+  [self setSharedPreconfiguredRemoteImageManager:sharedManager];
+}
+
++ (void)setSharedImageManagerWithConfiguration:(nullable NSURLSessionConfiguration *)configuration
+                                    imageCache:(nullable id<PINRemoteImageCaching>)imageCache
+{
+  PINRemoteImageManager *sharedManager = [self PINRemoteImageManagerWithConfiguration:configuration imageCache:imageCache];
+  [self setSharedPreconfiguredRemoteImageManager:sharedManager];
 }
 
-+ (void)setSharedPreconfiguredRemoteImageManager:(nullable PINRemoteImageManager *)preconfiguredPINRemoteImageManager
+static dispatch_once_t shared_init_predicate;
+
++ (void)setSharedPreconfiguredRemoteImageManager:(PINRemoteImageManager *)preconfiguredPINRemoteImageManager
 {
+  NSAssert(preconfiguredPINRemoteImageManager != nil, @"setSharedPreconfiguredRemoteImageManager requires a non-nil parameter");
   NSAssert(sharedDownloader == nil, @"Singleton has been created and session can no longer be configured.");
   NSAssert1(sharedPINRemoteImageManager == nil, @"An instance of %@ has been set. Either configuration or preconfigured image manager can be set at a time and only once.", [[sharedPINRemoteImageManager class] description]);
-  __unused PINRemoteImageManager *sharedManager = [self sharedPINRemoteImageManagerWithConfiguration:nil preconfiguredPINRemoteImageManager:preconfiguredPINRemoteImageManager];
+
+  dispatch_once(&shared_init_predicate, ^{
+    sharedPINRemoteImageManager = preconfiguredPINRemoteImageManager;
+  });
 }
 
-+ (PINRemoteImageManager *)sharedPINRemoteImageManagerWithConfiguration:(NSURLSessionConfiguration *)configuration preconfiguredPINRemoteImageManager:(PINRemoteImageManager *)preconfiguredPINRemoteImageManager
++ (PINRemoteImageManager *)PINRemoteImageManagerWithConfiguration:(nullable NSURLSessionConfiguration *)configuration imageCache:(nullable id<PINRemoteImageCaching>)imageCache
 {
-  NSAssert(!(configuration != nil && preconfiguredPINRemoteImageManager != nil), @"Either configuration or preconfigured image manager can be set at a time.");
-  static dispatch_once_t onceToken;
-  dispatch_once(&onceToken, ^{
-
-    if (preconfiguredPINRemoteImageManager) {
-      sharedPINRemoteImageManager = preconfiguredPINRemoteImageManager;
-    } else {
+  PINRemoteImageManager *manager = nil;
+#if DEBUG
+  // Check that Carthage users have linked both PINRemoteImage & PINCache by testing for one file each
+  if (!(NSClassFromString(@"PINRemoteImageManager"))) {
+    NSException *e = [NSException
+                      exceptionWithName:@"FrameworkSetupException"
+                      reason:@"Missing the path to the PINRemoteImage framework."
+                      userInfo:nil];
+    @throw e;
+  }
+  if (!(NSClassFromString(@"PINCache"))) {
+    NSException *e = [NSException
+                      exceptionWithName:@"FrameworkSetupException"
+                      reason:@"Missing the path to the PINCache framework."
+                      userInfo:nil];
+    @throw e;
+  }
+#endif
 #if PIN_ANIMATED_AVAILABLE
-      // Check that Carthage users have linked both PINRemoteImage & PINCache by testing for one file each
-      if (!(NSClassFromString(@"PINRemoteImageManager"))) {
-        NSException *e = [NSException
-                          exceptionWithName:@"FrameworkSetupException"
-                          reason:@"Missing the path to the PINRemoteImage framework."
-                          userInfo:nil];
-        @throw e;
-      }
-      if (!(NSClassFromString(@"PINCache"))) {
-        NSException *e = [NSException
-                          exceptionWithName:@"FrameworkSetupException"
-                          reason:@"Missing the path to the PINCache framework."
-                          userInfo:nil];
-        @throw e;
-      }
-      sharedPINRemoteImageManager = [[ASPINRemoteImageManager alloc] initWithSessionConfiguration:configuration
-                                                                alternativeRepresentationProvider:[self sharedDownloader]];
+    manager = [[ASPINRemoteImageManager alloc] initWithSessionConfiguration:configuration
+                                                                   alternativeRepresentationProvider:[self sharedDownloader]
+                                                                   imageCache:imageCache];
 #else
-      sharedPINRemoteImageManager = [[ASPINRemoteImageManager alloc] initWithSessionConfiguration:configuration];
+    manager = [[ASPINRemoteImageManager alloc] initWithSessionConfiguration:configuration
+                                                                 alternativeRepresentationProvider:nil
+                                                                 imageCache:imageCache];
 #endif
-    }
-  });
-  return sharedPINRemoteImageManager;
+  return manager;
 }
 
 - (PINRemoteImageManager *)sharedPINRemoteImageManager
 {
-  return [ASPINRemoteImageDownloader sharedPINRemoteImageManagerWithConfiguration:nil preconfiguredPINRemoteImageManager:nil];
+  dispatch_once(&shared_init_predicate, ^{
+    sharedPINRemoteImageManager = [ASPINRemoteImageDownloader PINRemoteImageManagerWithConfiguration:nil imageCache:nil];
+  });
+  return sharedPINRemoteImageManager;
 }
 
 - (BOOL)sharedImageManagerSupportsMemoryRemoval