Merge pull request #21 from SDWebImage/feature_convenience_API

dreampiggy · web-flow · commit c56d532ff822 · 2021-01-21T15:30:02.000+08:00
Added the convenience API to get URL representation from PHAsset object
diff --git a/.gitignore b/.gitignore
@@ -34,6 +34,7 @@ Carthage/Build
 # `pod install` in .travis.yml
 #
 Example/Pods
+Example/Podfile.lock
 
 # SwiftPM
 .swiftpm
diff --git a/Example/Podfile.lock b/Example/Podfile.lock
diff --git a/README.md b/README.md
@@ -103,7 +103,8 @@ To start loading the Photos Library image, use the `NSURL+SDWebImagePhotosPlugin
 ```objectivec
 // Create with `PHAsset`
 PHAsset *asset;
-NSURL *photosURL = [NSURL sd_URLWithAsset:asset];
+NSURL *photosURL = asset.sd_URLRepresentation;
+// The same as `[NSURL sd_URLWithAsset:asset];`
 // Create with `localIdentifier`
 NSString *identifier;
 NSURL *potosURL = [NSURL sd_URLWithAssetLocalIdentifier:identifier];
@@ -117,10 +118,11 @@ NSURL *potosURL = [NSURL sd_URLWithAssetLocalIdentifier:identifier];
 ```swift
 // Create with `PHAsset`
 let asset: PHAsset
-let photosURL = NSURL.sd_URL(with: asset)
+let photosURL = asset.sd_URLRepresentation
+// The same as `NSURL.sd_URL(with: asset) as URL`
 // Create with `localIdentifier`
 let identifier: String
-let potosURL = NSURL.sd_URL(withAssetLocalIdentifier: identifier)
+let potosURL = NSURL.sd_URL(withAssetLocalIdentifier: identifier) as URL
 
 // Load image (assume using custom manager)
 imageView.sd_setImage(with: photosURL, placeholderImage: nil, context: [.customManager: manager])
@@ -210,7 +212,7 @@ Control query image size for individual assets:
 ```objective-c
 UIImageView *imageView;
 PHAsset *asset;
-NSURL *url = [NSURL sd_URLWithAsset:asset];
+NSURL *url = asset.sd_URLRepresentation;
 [imageView.sd_setImageWithURL:url options:0 context:@{SDWebImageContextImageThumbnailPixelSize: @(imageView.bounds.size)}]; // Fetch image based on image view size
 ```
 
@@ -219,7 +221,7 @@ NSURL *url = [NSURL sd_URLWithAsset:asset];
 ```swift
 let imageView: UIImageView
 let asset: PHAsset
-let url = URL.sd_URL(with: asset)
+let url = asset.sd_URLRepresentation
 imageView.sd_setImage(with: url, context: [.imageThumbnailPixelSize : imageView.bounds.size]) // Fetch image based on image view size
 ```
 
diff --git a/SDWebImagePhotosPlugin.xcodeproj/project.pbxproj b/SDWebImagePhotosPlugin.xcodeproj/project.pbxproj
@@ -10,6 +10,12 @@
 		3235B28021FAD1E6008668C5 /* Photos.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3235B27F21FAD1E6008668C5 /* Photos.framework */; };
 		3235B28221FAD1ED008668C5 /* Photos.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3235B28121FAD1ED008668C5 /* Photos.framework */; };
 		3235B28421FAD1F5008668C5 /* Photos.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3235B28321FAD1F5008668C5 /* Photos.framework */; };
+		32380B5425B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 32380B5225B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		32380B5525B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 32380B5225B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		32380B5625B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 32380B5225B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		32380B5725B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = 32380B5325B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m */; };
+		32380B5825B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = 32380B5325B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m */; };
+		32380B5925B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = 32380B5325B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m */; };
 		32CCEA13213E38CD00214381 /* SDWebImagePhotosPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 32CCEA12213E38CD00214381 /* SDWebImagePhotosPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		32CCEA14213E38CD00214381 /* SDWebImagePhotosPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 32CCEA12213E38CD00214381 /* SDWebImagePhotosPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		32CCEA15213E38CD00214381 /* SDWebImagePhotosPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 32CCEA12213E38CD00214381 /* SDWebImagePhotosPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -52,6 +58,8 @@
 		3235B27F21FAD1E6008668C5 /* Photos.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Photos.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.14.sdk/System/Library/Frameworks/Photos.framework; sourceTree = DEVELOPER_DIR; };
 		3235B28121FAD1ED008668C5 /* Photos.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Photos.framework; path = Platforms/AppleTVOS.platform/Developer/SDKs/AppleTVOS12.1.sdk/System/Library/Frameworks/Photos.framework; sourceTree = DEVELOPER_DIR; };
 		3235B28321FAD1F5008668C5 /* Photos.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Photos.framework; path = System/Library/Frameworks/Photos.framework; sourceTree = SDKROOT; };
+		32380B5225B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "PHAsset+SDWebImagePhotosPlugin.h"; sourceTree = "<group>"; };
+		32380B5325B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "PHAsset+SDWebImagePhotosPlugin.m"; sourceTree = "<group>"; };
 		32CCE9E8213E383E00214381 /* SDWebImagePhotosPlugin.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SDWebImagePhotosPlugin.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		32CCE9F8213E384500214381 /* SDWebImagePhotosPlugin_tvOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SDWebImagePhotosPlugin_tvOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		32CCEA05213E385A00214381 /* SDWebImagePhotosPlugin_macOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SDWebImagePhotosPlugin_macOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -145,6 +153,8 @@
 				32CCEA1D213E38F600214381 /* SDWebImagePhotosError.m */,
 				32CCEA20213E38F600214381 /* SDImagePhotosLoader.h */,
 				32CCEA1B213E38F600214381 /* SDImagePhotosLoader.m */,
+				32380B5225B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h */,
+				32380B5325B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m */,
 			);
 			path = Classes;
 			sourceTree = "<group>";
@@ -170,6 +180,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				32CCEA28213E38F600214381 /* SDWebImagePhotosDefine.h in Headers */,
+				32380B5425B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h in Headers */,
 				32CCEA31213E38F600214381 /* PHImageRequestOptions+SDWebImagePhotosPlugin.h in Headers */,
 				32CCEA40213E38F600214381 /* SDWebImagePhotosError.h in Headers */,
 				32CCEA34213E38F600214381 /* SDImagePhotosLoader.h in Headers */,
@@ -183,6 +194,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				32CCEA29213E38F600214381 /* SDWebImagePhotosDefine.h in Headers */,
+				32380B5525B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h in Headers */,
 				32CCEA32213E38F600214381 /* PHImageRequestOptions+SDWebImagePhotosPlugin.h in Headers */,
 				32CCEA41213E38F600214381 /* SDWebImagePhotosError.h in Headers */,
 				32CCEA35213E38F600214381 /* SDImagePhotosLoader.h in Headers */,
@@ -196,6 +208,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				32CCEA2A213E38F600214381 /* SDWebImagePhotosDefine.h in Headers */,
+				32380B5625B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.h in Headers */,
 				32CCEA33213E38F600214381 /* PHImageRequestOptions+SDWebImagePhotosPlugin.h in Headers */,
 				32CCEA42213E38F600214381 /* SDWebImagePhotosError.h in Headers */,
 				32CCEA36213E38F600214381 /* SDImagePhotosLoader.h in Headers */,
@@ -333,6 +346,7 @@
 				32CCEA3A213E38F600214381 /* PHImageRequestOptions+SDWebImagePhotosPlugin.m in Sources */,
 				32CCEA2B213E38F600214381 /* SDWebImagePhotosError.m in Sources */,
 				32CCEA2E213E38F600214381 /* NSURL+SDWebImagePhotosPlugin.m in Sources */,
+				32380B5725B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m in Sources */,
 				32CCEA37213E38F600214381 /* SDWebImagePhotosDefine.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -345,6 +359,7 @@
 				32CCEA3B213E38F600214381 /* PHImageRequestOptions+SDWebImagePhotosPlugin.m in Sources */,
 				32CCEA2C213E38F600214381 /* SDWebImagePhotosError.m in Sources */,
 				32CCEA2F213E38F600214381 /* NSURL+SDWebImagePhotosPlugin.m in Sources */,
+				32380B5825B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m in Sources */,
 				32CCEA38213E38F600214381 /* SDWebImagePhotosDefine.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -357,6 +372,7 @@
 				32CCEA3C213E38F600214381 /* PHImageRequestOptions+SDWebImagePhotosPlugin.m in Sources */,
 				32CCEA2D213E38F600214381 /* SDWebImagePhotosError.m in Sources */,
 				32CCEA30213E38F600214381 /* NSURL+SDWebImagePhotosPlugin.m in Sources */,
+				32380B5925B95E87002A50E1 /* PHAsset+SDWebImagePhotosPlugin.m in Sources */,
 				32CCEA39213E38F600214381 /* SDWebImagePhotosDefine.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
diff --git a/SDWebImagePhotosPlugin/Classes/NSURL+SDWebImagePhotosPlugin.h b/SDWebImagePhotosPlugin/Classes/NSURL+SDWebImagePhotosPlugin.h
@@ -33,14 +33,14 @@
  @param identifier `PHAsset` 's local identifier
  @return A Photos URL
  */
-+ (nullable instancetype)sd_URLWithAssetLocalIdentifier:(nonnull NSString *)identifier;
++ (nonnull instancetype)sd_URLWithAssetLocalIdentifier:(nonnull NSString *)identifier;
 
 /**
  Create a Photos URL with `PHAsset`
 
  @param asset `PHAsset` object
  @return A Photos URL
  */
-+ (nullable instancetype)sd_URLWithAsset:(nonnull PHAsset *)asset;
++ (nonnull instancetype)sd_URLWithAsset:(nonnull PHAsset *)asset;
 
 @end
diff --git a/SDWebImagePhotosPlugin/Classes/NSURL+SDWebImagePhotosPlugin.m b/SDWebImagePhotosPlugin/Classes/NSURL+SDWebImagePhotosPlugin.m
@@ -42,23 +42,15 @@ - (void)setSd_asset:(PHAsset * _Nullable)sd_asset {
 }
 
 + (instancetype)sd_URLWithAssetLocalIdentifier:(NSString *)identifier {
-    if (!identifier) {
-        return nil;
-    }
+    NSParameterAssert(identifier);
     // ph://F2A9F582-BA45-4308-924E-6D146B784A09/L0/001
     NSString *prefix = [NSString stringWithFormat:@"%@://", SDWebImagePhotosScheme];
     return [NSURL URLWithString:[NSString stringWithFormat:@"%@%@", prefix, identifier]];
 }
 
 + (instancetype)sd_URLWithAsset:(PHAsset *)asset {
-    if (![asset isKindOfClass:[PHAsset class]]) {
-        return nil;
-    }
+    NSParameterAssert(asset);
     NSString *localIdentifier = asset.localIdentifier;
-    if (!localIdentifier) {
-        return nil;
-    }
-    
     NSURL *url = [self sd_URLWithAssetLocalIdentifier:localIdentifier];
     url.sd_asset = asset;
     
diff --git a/SDWebImagePhotosPlugin/Classes/PHAsset+SDWebImagePhotosPlugin.h b/SDWebImagePhotosPlugin/Classes/PHAsset+SDWebImagePhotosPlugin.h
@@ -0,0 +1,17 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Photos/Photos.h>
+
+@interface PHAsset (SDWebImagePhotosPlugin)
+
+/// The convenience way to retrive the URL representation of PHAsset. The same as `+[NSURL sd_URLWithAsset:]`.
+/// @note This API always return new object in Objective-C/struct in Swift of URL.
+@property (nonatomic, strong, readonly, nonnull) NSURL *sd_URLRepresentation;
+
+@end
diff --git a/SDWebImagePhotosPlugin/Classes/PHAsset+SDWebImagePhotosPlugin.m b/SDWebImagePhotosPlugin/Classes/PHAsset+SDWebImagePhotosPlugin.m
@@ -0,0 +1,18 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "PHAsset+SDWebImagePhotosPlugin.h"
+#import "NSURL+SDWebImagePhotosPlugin.h"
+
+@implementation PHAsset (SDWebImagePhotosPlugin)
+
+- (NSURL *)sd_URLRepresentation {
+    return [NSURL sd_URLWithAsset:self];
+}
+
+@end

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ Carthage/Build`
`34`	`34`	# `pod install` in .travis.yml
`35`	`35`	`#`
`36`	`36`	`Example/Pods`
	`37`	`+Example/Podfile.lock`
`37`	`38`
`38`	`39`	`# SwiftPM`
`39`	`40`	`.swiftpm`