Update to support the new context option from SDWebImage 5.5.0, deprecated the old one

Author: dreampiggy

Cartfile

@@ -1 +1 @@
-github "SDWebImage/SDWebImage" ~> 5.0
+github "SDWebImage/SDWebImage" ~> 5.5

Cartfile.resolved

@@ -1 +1 @@
-github "SDWebImage/SDWebImage" "5.0.2"
+github "SDWebImage/SDWebImage" "5.5.2"

Package.swift

@@ -17,7 +17,7 @@ let package = Package(
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         // .package(url: /* package url */, from: "1.0.0"),
-        .package(url: "https://github.com/SDWebImage/SDWebImage.git", from: "5.1.0")
+        .package(url: "https://github.com/SDWebImage/SDWebImage.git", from: "5.5.0")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.

SDWebImagePDFCoder.podspec

@@ -39,5 +39,5 @@ SDWebImageSVGCoder is a SVG coder plugin for SDWebImage framework, which provide
     'DERIVE_MACCATALYST_PRODUCT_BUNDLE_IDENTIFIER' => 'NO'
   }
 
-  s.dependency 'SDWebImage', '~> 5.0'
+  s.dependency 'SDWebImage', '~> 5.5'
 end

SDWebImagePDFCoder/Classes/SDImagePDFCoder.m

@@ -55,25 +55,42 @@ - (UIImage *)decodedImageWithData:(NSData *)data options:(SDImageCoderOptions *)
     BOOL prefersBitmap = NO;
     CGSize imageSize = CGSizeZero;
     BOOL preserveAspectRatio = YES;
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     // Parse args
     SDWebImageContext *context = options[SDImageCoderWebImageContext];
     if (context[SDWebImageContextPDFPageNumber]) {
         pageNumber = [context[SDWebImageContextPDFPageNumber] unsignedIntegerValue];
+    } else if (options[SDImageCoderDecodePDFPageNumber]) {
+        pageNumber = [options[SDImageCoderDecodePDFPageNumber] unsignedIntegerValue];
     }
     if (context[SDWebImageContextPDFPrefersBitmap]) {
         prefersBitmap = [context[SDWebImageContextPDFPrefersBitmap] boolValue];
+    } else if (options[SDImageCoderDecodePDFPrefersBitmap]) {
+        prefersBitmap = [options[SDImageCoderDecodePDFPrefersBitmap] boolValue];
     }
     if (context[SDWebImageContextPDFImageSize]) {
         NSValue *sizeValue = context[SDWebImageContextPDFImageSize];
 #if SD_MAC
         imageSize = sizeValue.sizeValue;
 #else
         imageSize = sizeValue.CGSizeValue;
+#endif
+    } else if (options[SDImageCoderDecodeThumbnailPixelSize]) {
+        NSValue *sizeValue = options[SDImageCoderDecodeThumbnailPixelSize];
+#if SD_MAC
+        imageSize = sizeValue.sizeValue;
+#else
+        imageSize = sizeValue.CGSizeValue;
 #endif
     }
     if (context[SDWebImageContextPDFImagePreserveAspectRatio]) {
         preserveAspectRatio = [context[SDWebImageContextPDFImagePreserveAspectRatio] boolValue];
+    } else if (options[SDImageCoderDecodePreserveAspectRatio]) {
+        preserveAspectRatio = [context[SDImageCoderDecodePreserveAspectRatio] boolValue];
     }
+#pragma clang diagnostic pop
 
     UIImage *image;
     if (!prefersBitmap && [self.class supportsVectorPDFImage]) {

SDWebImagePDFCoder/Classes/SDWebImagePDFCoderDefine.h

@@ -32,14 +32,34 @@ FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPDFPre
  @note For iOS/tvOS 11+, you don't need this option and it will be ignored. Because UIImage support built-in vector rendering and scaling for PDF. Changing imageView's contentMode and bounds instead.
  @note For macOS user. Changing imageViews' imageScaling and bounds instead.
  */
-FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPDFImageSize;
+FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPDFImageSize __attribute__((deprecated("Use the new context option (for WebCache category), or coder option (for SDImageCoder protocol) instead", "SDWebImageContextImageThumbnailPixelSize")));
 
 /**
  A BOOL value which specify the whether PDF image should keep aspect ratio during image loading. Because when you specify image size via `SDWebImageContextPDFImageSize`, we need to know whether to keep aspect ratio or not when image size is not equal to PDF cropBox size. (NSNumber)
  If you don't provide this value, use YES for default value.
  @note For iOS/tvOS 11+, you don't need this option and it will be ignored. Because UIImage support built-in vector rendering and scaling for PDF. Changing imageView's contentMode and bounds instead.
  @note For macOS user. Changing imageViews' imageScaling and bounds instead.
  */
-FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPDFImagePreserveAspectRatio;
+FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPDFImagePreserveAspectRatio __attribute__((deprecated("Use the new context option (for WebCache category), or coder option (for SDImageCoder protocol) instead", "SDWebImageContextImagePreserveAspectRatio")));
+
+#pragma mark - Coder Options
+/**
+ A unsigned interger raw value which specify the desired PDF image page number. Because PDF can contains mutiple pages. The page number index is started with 0. (NSNumber)
+ If you don't provide this value, use 0 (the first page) instead.
+ @note works for `SDImageCoder`
+ */
+FOUNDATION_EXPORT SDImageCoderOption _Nonnull const SDImageCoderDecodePDFPageNumber;
+
+/**
+ A BOOL value which specify whether we prefer the actual bitmap representation instead of vector representation for PDF image. This is because the UIImage on iOS 11+ (NSImgae on macOS) can use the vector image format, which support dynamic scale without losing any detail. However, for some image processing logic, user may need the actual bitmap representation to manage pixels. Also, for lower firmware on iOS, the `UIImage` does not support vector rendering, user may want to handle them using the same code. (NSNumber)
+ If you don't provide this value, use NO for default value and prefer the vector format when possible.
+ @note works for `SDImageCoder`
+ */
+FOUNDATION_EXPORT SDImageCoderOption _Nonnull const SDImageCoderDecodePDFPrefersBitmap;
+
+/**
+ `SDImageCoderDecodeThumnailPixelSize`: The same as context option `SDWebImageContextImageThumbnailPixelSize`
+ `SDImageCoderDecodePreserveAspectRatio`: The same as context option `SDWebImageContextImagePreserveAspectRatio`
+ */
 
 NS_ASSUME_NONNULL_END

SDWebImagePDFCoder/Classes/SDWebImagePDFCoderDefine.m

@@ -11,3 +11,6 @@
 SDWebImageContextOption _Nonnull const SDWebImageContextPDFPrefersBitmap = @"pdfPrefersBitmap";
 SDWebImageContextOption _Nonnull const SDWebImageContextPDFImageSize = @"pdfImageSize";
 SDWebImageContextOption _Nonnull const SDWebImageContextPDFImagePreserveAspectRatio = @"pdfImagePreserveAspectRatio";
+
+SDImageCoderOption _Nonnull const SDImageCoderDecodePDFPageNumber = @"decodePDFPageNumber";
+SDImageCoderOption _Nonnull const SDImageCoderDecodePDFPrefersBitmap = @"decodePDFPrefersBitmap";