Merge pull request #4 from SDWebImage/feature_cache_metadata

Feature: Supports to cache the `LPLinkMetadata` as well as image

Author: dreampiggy

.gitignore

@@ -33,3 +33,4 @@ Carthage
 # `pod install` in .travis.yml
 #
 Pods/
+Podfile.lock

Example/Podfile.lock

@@ -21,8 +21,8 @@ @implementation LinkTableViewCell
 
 - (instancetype)initWithStyle:(UITableViewCellStyle)style reuseIdentifier:(NSString *)reuseIdentifier {
     if (self = [super initWithStyle:style reuseIdentifier:reuseIdentifier]) {
-        NSURL *url = nil;
-        _linkView = [[LPLinkView alloc] initWithURL:url]; // We must pass nil here, or will cause Cell-reusing issues on iOS 13.1.
+        LPLinkMetadata *metadata = [LPLinkMetadata new]; // We must pass empty metadata here, or will cause Cell-reusing issues on iOS 13.1.
+        _linkView = [[LPLinkView alloc] initWithMetadata:metadata];
         [self.contentView addSubview:_linkView];
     }
     return self;
@@ -37,7 +37,8 @@ - (void)layoutSubviews {
 
 @interface ImageTableViewCell : UITableViewCell
 
-@property (nonatomic, strong) UILabel *customTextLabel;
+@property (nonatomic, strong) UILabel *hostLabel;
+@property (nonatomic, strong) UILabel *titleLabel;
 @property (nonatomic, strong) UIImageView *customImageView;
 
 @end
@@ -51,17 +52,22 @@ - (instancetype)initWithStyle:(UITableViewCellStyle)style reuseIdentifier:(NSStr
         _customImageView.clipsToBounds = YES;
         _customImageView.layer.cornerRadius = 10;
         [self.contentView addSubview:_customImageView];
-        _customTextLabel = [[UILabel alloc] init];
-        [self.contentView addSubview:_customTextLabel];
+        _hostLabel = [[UILabel alloc] init];
+        _hostLabel.font = [UIFont systemFontOfSize:12];
+        [self.contentView addSubview:_hostLabel];
+        _titleLabel = [[UILabel alloc] init];
+        _titleLabel.font = [UIFont systemFontOfSize:12 weight:UIFontWeightBold];
+        [self.contentView addSubview:_titleLabel];
     }
     return self;
 }
 
 - (void)layoutSubviews {
     [super layoutSubviews];
-    self.customImageView.frame = CGRectInset(self.bounds, 20, 20);
-    [self.customTextLabel sizeToFit];
-    self.customTextLabel.frame = CGRectMake(20, self.bounds.size.height - 20, self.bounds.size.width - 40, self.customTextLabel.frame.size.height);
+    self.customImageView.frame = CGRectInset(self.bounds, 20, 40);
+    self.hostLabel.frame = CGRectMake(30, self.bounds.size.height - 20, self.bounds.size.width - 2 * 30, 20);
+    self.titleLabel.frame = CGRectMake(30, self.bounds.size.height - 40, self.bounds.size.width - 2 * 30, 20);
+    
 }
 
 @end
@@ -87,7 +93,7 @@ - (void)viewDidLoad {
                                                                             style:UIBarButtonItemStylePlain
                                                                            target:self
                                                                            action:@selector(switchView)];
-    self.useLinkView = NO;
+    self.useLinkView = YES;
     self.objects = [NSArray arrayWithObjects:
                     @"https://www.apple.com/",
                     @"https://www.apple.com/music/",
@@ -142,13 +148,24 @@ - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(N
         if (![cell isKindOfClass:LinkTableViewCell.class]) {
             cell = [[LinkTableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:CellIdentifier];
         }
+        ((LinkTableViewCell *)cell).linkView.sd_imageTransition = SDWebImageTransition.fadeTransition;
         [((LinkTableViewCell *)cell).linkView sd_setImageWithURL:url];
     } else {
         if (![cell isKindOfClass:ImageTableViewCell.class]) {
             cell = [[ImageTableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:CellIdentifier];
         }
-        ((ImageTableViewCell *)cell).customTextLabel.text = url.host;
-        [((ImageTableViewCell *)cell).customImageView sd_setImageWithURL:url];
+        ((ImageTableViewCell *)cell).hostLabel.text = url.host;
+        ((ImageTableViewCell *)cell).titleLabel.text = nil;
+        ((ImageTableViewCell *)cell).customImageView.sd_imageTransition = SDWebImageTransition.fadeTransition;
+        [((ImageTableViewCell *)cell).customImageView sd_setImageWithURL:url completed:^(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL) {
+            if (image) {
+                if ([image.sd_extendedObject isKindOfClass:LPLinkMetadata.class]) {
+                    LPLinkMetadata *metadata = (LPLinkMetadata *)image.sd_extendedObject;
+                    ((ImageTableViewCell *)cell).titleLabel.text = metadata.title;
+                    ((ImageTableViewCell *)cell).hostLabel.text = metadata.URL.host;
+                }
+            }
+        }];
     }
 
     return cell;

Example/SDWebImageLinkPlugin/SDViewController.m

@@ -83,17 +83,18 @@ self.imageView = [[UIImageView alloc] init];
 self.imageView.contentMode = UIViewContentModeScaleAspectFit;
 [self.view addSubview:self.imageView];
 [self.imageView sd_setImageWithURL:url completed:^(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL) {
-    NSLog(@"%@", @"UIImageView image load success");
+    if (image && [image.sd_extendedObject isKindOfClass:LPLinkMetadata.class]) {
+        NSLog(@"%@", @"UIImageView metadata load success");
+    }
 }];
 ```
 
 #### Load Rich Link on LPLinkView
 
 Important note on `LPLinkView`: Current iOS 13.0 contains bug that `LPLinkView` may not compatible with TableView/CollectionView cell-reusing. To workaround this issue, you can choose one of these below (one is OK):
 
-1. Cache the loaded `LPLinkMetadata` by yourself, always ensure the `sd_linkMetadata` is not nil (expect first request)
-2. Do not using cache at all. So, always pass `SDWebImageFromLoaderOnly` to load the metadata from network
-3. Using trick code, create `LPLinkView` with nil URL (important)
+1. Do not using cache at all. So, always pass `SDWebImageFromLoaderOnly` to load the metadata from network
+2. Using trick code, create `LPLinkView` with empty `LPLinkMetadata`, or nil URL (important).
 
 + Objective-C
 
@@ -102,30 +103,25 @@ NSURL *url = [NSURL URLWithString:@"https://www.apple.com/iphone/"];
 self.linkView = [[LPLinkView alloc] initWithURL:nil];
 [self.view addSubview:self.linkView];
 [self.linkView sd_setImageWithURL:url completed:^(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL) {
-    NSLog(@"%@", @"LPLinkView metadata load success");
+    if (image && [image.sd_extendedObject isKindOfClass:LPLinkMetadata.class]) {
+        NSLog(@"%@", @"LPLinkView metadata load success");
+    }
 }];
 ```
 
 #### Using LPLinkMetadata
 
-Note: You can always read and write the `LPLinkMetadata` object on the associated `NSURL` object, to provide an exist metadata from your serialization solution, or update the metadata. If the provided URL have an associated metadata, we don't do extra query with [LPMetadataProvider](https://developer.apple.com/documentation/linkpresentation/lpmetadataprovider?language=objc).
+For some cases, if you have the pre-fetched or pre-created `LPLinkMetadata` object, you can use `SDWebImageContextLinkMetadata` context option to associate it, without extra request to the original link URL. But in most cases, you don't need so, just use the `NSURL` point to the rich link, we query the `LPLinkMetadata` with [LPMetadataProvider](https://developer.apple.com/documentation/linkpresentation/lpmetadataprovider?language=objc).
+
+Remember, if you don't want the double cache (`LPLinkMetadata` archive will contains the image data as well, but not simple image URL), do not sync or cache the metadata from callback's `image.sd_extendedObject` to your own storage using `NSCoding` methods. Let the framework do this thing.
 
 + Objective-C
 
 ```objective-c
 // Decoding a metadata from your serialization solution
 LPLinkMetadata *metadata = [NSKeyedUnarchiver unarchiveObjectWithFile:@"/path/to/metadata"];
-// Bind the associated metadata
-NSURL *urlWithMetadata = metadata.originalURL;
-urlWithMetadata.sd_linkMetadata = metadata;
 // Load image without query metadata again
-[imageView sd_setImageWithURL:urlWithMetadata];
-```
-
-```objective-c
-// If URL load success, the completion block's URL also contains the metadata
-LPLinkMetadata *metadata = imageURL.sd_linkMetadata;
-NSLog(@"[title]: %@\n[url]: %@\n[image]: %@", metadata.title, metadata.URL, metadata.imageProvider);
+[imageView sd_setImageWithURL:metadata.originalURL placeholderImage:nil options:0 context:@{SDWebImageContextLinkMetadata : metadata}];
 ```
 
 Note: By default, if the image is cached, we do not send request to query new metadata. If you need to query the metadata as well, consider using SDWebImage's `SDWebImageRefreshCached` option. Or using `SDWebImageFromLoaderOnly` to avoid cache during query.

README.md

@@ -36,5 +36,5 @@ SDWebImageLinkPlugin is a plugin for SDWebImage framework, which provide the ima
     'DERIVE_MACCATALYST_PRODUCT_BUNDLE_IDENTIFIER' => 'NO'
   }
 
-  s.dependency 'SDWebImage', '~> 5.0'
+  s.dependency 'SDWebImage', '~> 5.4'
 end

SDWebImageLinkPlugin.podspec

@@ -10,16 +10,12 @@
 		3253E0BB2387DCB2007ACAD8 /* SDWebImageLinkPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0B92387DCB2007ACAD8 /* SDWebImageLinkPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3253E0CB2387E6B4007ACAD8 /* SDImageLinkLoader.m in Sources */ = {isa = PBXBuildFile; fileRef = 3253E0C22387E6B4007ACAD8 /* SDImageLinkLoader.m */; };
 		3253E0CC2387E6B4007ACAD8 /* SDWebImageLinkDefine.m in Sources */ = {isa = PBXBuildFile; fileRef = 3253E0C32387E6B4007ACAD8 /* SDWebImageLinkDefine.m */; };
-		3253E0CE2387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C52387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3253E0CF2387E6B4007ACAD8 /* SDWebImageLinkError.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C62387E6B4007ACAD8 /* SDWebImageLinkError.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3253E0D02387E6B4007ACAD8 /* SDImageLinkLoader.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C72387E6B4007ACAD8 /* SDImageLinkLoader.h */; settings = {ATTRIBUTES = (Public, ); }; };
-		3253E0D12387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = 3253E0C82387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.m */; };
 		3253E0D22387E6B4007ACAD8 /* SDWebImageLinkDefine.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C92387E6B4007ACAD8 /* SDWebImageLinkDefine.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3253E0D32387E6B4007ACAD8 /* SDWebImageLinkError.m in Sources */ = {isa = PBXBuildFile; fileRef = 3253E0CA2387E6B4007ACAD8 /* SDWebImageLinkError.m */; };
 		3253E0D62387E8C5007ACAD8 /* SDWebImage.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3253E0D52387E8C5007ACAD8 /* SDWebImage.framework */; };
 		3253E0E72387E900007ACAD8 /* SDWebImage.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3253E0E62387E900007ACAD8 /* SDWebImage.framework */; };
-		3253E0EA2387E94D007ACAD8 /* NSURL+SDWebImageLinkPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C52387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; };
-		3253E0EB2387E94D007ACAD8 /* NSURL+SDWebImageLinkPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = 3253E0C82387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.m */; };
 		3253E0EC2387E94D007ACAD8 /* SDImageLinkLoader.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C72387E6B4007ACAD8 /* SDImageLinkLoader.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3253E0ED2387E94D007ACAD8 /* SDImageLinkLoader.m in Sources */ = {isa = PBXBuildFile; fileRef = 3253E0C22387E6B4007ACAD8 /* SDImageLinkLoader.m */; };
 		3253E0EE2387E94D007ACAD8 /* SDWebImageLinkDefine.h in Headers */ = {isa = PBXBuildFile; fileRef = 3253E0C92387E6B4007ACAD8 /* SDWebImageLinkDefine.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -43,10 +39,8 @@
 		3253E0BA2387DCB2007ACAD8 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Module/Info.plist; sourceTree = "<group>"; };
 		3253E0C22387E6B4007ACAD8 /* SDImageLinkLoader.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDImageLinkLoader.m; sourceTree = "<group>"; };
 		3253E0C32387E6B4007ACAD8 /* SDWebImageLinkDefine.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDWebImageLinkDefine.m; sourceTree = "<group>"; };
-		3253E0C52387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSURL+SDWebImageLinkPlugin.h"; sourceTree = "<group>"; };
 		3253E0C62387E6B4007ACAD8 /* SDWebImageLinkError.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDWebImageLinkError.h; sourceTree = "<group>"; };
 		3253E0C72387E6B4007ACAD8 /* SDImageLinkLoader.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDImageLinkLoader.h; sourceTree = "<group>"; };
-		3253E0C82387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSURL+SDWebImageLinkPlugin.m"; sourceTree = "<group>"; };
 		3253E0C92387E6B4007ACAD8 /* SDWebImageLinkDefine.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDWebImageLinkDefine.h; sourceTree = "<group>"; };
 		3253E0CA2387E6B4007ACAD8 /* SDWebImageLinkError.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDWebImageLinkError.m; sourceTree = "<group>"; };
 		3253E0D52387E8C5007ACAD8 /* SDWebImage.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SDWebImage.framework; path = Carthage/Build/iOS/SDWebImage.framework; sourceTree = "<group>"; };
@@ -113,8 +107,6 @@
 				3253E12E23882AD5007ACAD8 /* LPLinkView+WebCache.m */,
 				3253E1252387EDE7007ACAD8 /* NSImage+SDWebImageLinkPlugin.h */,
 				3253E1242387EDE7007ACAD8 /* NSImage+SDWebImageLinkPlugin.m */,
-				3253E0C52387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.h */,
-				3253E0C82387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.m */,
 				3253E0C72387E6B4007ACAD8 /* SDImageLinkLoader.h */,
 				3253E0C22387E6B4007ACAD8 /* SDImageLinkLoader.m */,
 				3253E0C92387E6B4007ACAD8 /* SDWebImageLinkDefine.h */,
@@ -143,7 +135,6 @@
 			files = (
 				3253E1282387EDE7007ACAD8 /* NSImage+SDWebImageLinkPlugin.h in Headers */,
 				3253E0D02387E6B4007ACAD8 /* SDImageLinkLoader.h in Headers */,
-				3253E0CE2387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.h in Headers */,
 				3253E0D22387E6B4007ACAD8 /* SDWebImageLinkDefine.h in Headers */,
 				3253E13223882AD5007ACAD8 /* LPLinkView+WebCache.h in Headers */,
 				3253E0BB2387DCB2007ACAD8 /* SDWebImageLinkPlugin.h in Headers */,
@@ -158,7 +149,6 @@
 				3253E1292387EDE7007ACAD8 /* NSImage+SDWebImageLinkPlugin.h in Headers */,
 				3253E0EE2387E94D007ACAD8 /* SDWebImageLinkDefine.h in Headers */,
 				3253E0EC2387E94D007ACAD8 /* SDImageLinkLoader.h in Headers */,
-				3253E0EA2387E94D007ACAD8 /* NSURL+SDWebImageLinkPlugin.h in Headers */,
 				3253E13323882AD5007ACAD8 /* LPLinkView+WebCache.h in Headers */,
 				3253E0F02387E94D007ACAD8 /* SDWebImageLinkError.h in Headers */,
 				3253E0F22387E951007ACAD8 /* SDWebImageLinkPlugin.h in Headers */,
@@ -267,7 +257,6 @@
 				3253E13023882AD5007ACAD8 /* LPLinkView+WebCache.m in Sources */,
 				3253E1262387EDE7007ACAD8 /* NSImage+SDWebImageLinkPlugin.m in Sources */,
 				3253E0CB2387E6B4007ACAD8 /* SDImageLinkLoader.m in Sources */,
-				3253E0D12387E6B4007ACAD8 /* NSURL+SDWebImageLinkPlugin.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -276,7 +265,6 @@
 			buildActionMask = 2147483647;
 			files = (
 				3253E0F12387E94D007ACAD8 /* SDWebImageLinkError.m in Sources */,
-				3253E0EB2387E94D007ACAD8 /* NSURL+SDWebImageLinkPlugin.m in Sources */,
 				3253E13123882AD5007ACAD8 /* LPLinkView+WebCache.m in Sources */,
 				3253E1272387EDE7007ACAD8 /* NSImage+SDWebImageLinkPlugin.m in Sources */,
 				3253E0EF2387E94D007ACAD8 /* SDWebImageLinkDefine.m in Sources */,