Prepare 4.3.0 (#470)

* Update CHANGELOG. * Match Alamofire default. * Update Gems. * Update version. * Update Jazzy docs.
Alamofire · Sep 13, 2023 · 1eaf3b6 · 1eaf3b6
1 parent 14cf4a0
commit 1eaf3b6
Show file tree

Hide file tree

Showing 107 changed files with 1,804 additions and 1,557 deletions.
diff --git a/AlamofireImage.podspec b/AlamofireImage.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'AlamofireImage'
-  s.version = '4.2.0'
+  s.version = '4.3.0'
   s.license = 'MIT'
   s.summary = 'AlamofireImage is an image component library for Alamofire'
   s.homepage = 'https://github.com/Alamofire/AlamofireImage'

diff --git a/AlamofireImage.xcodeproj/project.pbxproj b/AlamofireImage.xcodeproj/project.pbxproj
@@ -3335,7 +3335,7 @@
 				INFOPLIST_FILE = Source/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				MACOSX_DEPLOYMENT_TARGET = 10.12;
-				MARKETING_VERSION = 4.2.0;
+				MARKETING_VERSION = 4.3.0;
 				ONLY_ACTIVE_ARCH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = org.alamofire.AlamofireImage;
 				PRODUCT_NAME = AlamofireImage;
@@ -3400,7 +3400,7 @@
 				INFOPLIST_FILE = Source/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				MACOSX_DEPLOYMENT_TARGET = 10.12;
-				MARKETING_VERSION = 4.2.0;
+				MARKETING_VERSION = 4.3.0;
 				PRODUCT_BUNDLE_IDENTIFIER = org.alamofire.AlamofireImage;
 				PRODUCT_NAME = AlamofireImage;
 				SDKROOT = iphoneos;

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -3,7 +3,7 @@ GEM
   specs:
     CFPropertyList (3.0.6)
       rexml
-    activesupport (7.0.6)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -77,7 +77,7 @@ GEM
     json (2.6.3)
     liferaft (0.0.6)
     mini_portile2 (2.8.4)
-    minitest (5.19.0)
+    minitest (5.20.0)
     molinillo (0.8.0)
     mustache (1.1.1)
     nanaimo (0.3.0)
@@ -91,7 +91,7 @@ GEM
     ruby-macho (2.5.1)
     sassc (2.4.0)
       ffi (~> 1.9)
-    sqlite3 (1.6.3)
+    sqlite3 (1.6.6)
       mini_portile2 (~> 2.8.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)

diff --git a/[email protected] b/[email protected]
@@ -32,7 +32,7 @@ let package = Package(name: "AlamofireImage",
                                   .watchOS(.v3)],
                       products: [.library(name: "AlamofireImage", targets: ["AlamofireImage"])],
                       dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git",
-                                              from: "5.7.0")],
+                                              from: "5.8.0")],
                       targets: [.target(name: "AlamofireImage",
                                         dependencies: ["Alamofire"],
                                         path: "Source",

diff --git a/[email protected] b/[email protected]
@@ -32,7 +32,7 @@ let package = Package(name: "AlamofireImage",
                                   .watchOS(.v3)],
                       products: [.library(name: "AlamofireImage", targets: ["AlamofireImage"])],
                       dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git",
-                                              from: "5.7.0")],
+                                              from: "5.8.0")],
                       targets: [.target(name: "AlamofireImage",
                                         dependencies: ["Alamofire"],
                                         path: "Source",

diff --git a/[email protected] b/[email protected]
@@ -32,7 +32,7 @@ let package = Package(name: "AlamofireImage",
                                   .watchOS(.v4)],
                       products: [.library(name: "AlamofireImage", targets: ["AlamofireImage"])],
                       dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git",
-                                              from: "5.7.0")],
+                                              from: "5.8.0")],
                       targets: [.target(name: "AlamofireImage",
                                         dependencies: ["Alamofire"],
                                         path: "Source",

diff --git a/[email protected] b/[email protected]
@@ -32,7 +32,7 @@ let package = Package(name: "AlamofireImage",
                                   .watchOS(.v4)],
                       products: [.library(name: "AlamofireImage", targets: ["AlamofireImage"])],
                       dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git",
-                                              from: "5.7.0")],
+                                              from: "5.8.0")],
                       targets: [.target(name: "AlamofireImage",
                                         dependencies: ["Alamofire"],
                                         path: "Source",

diff --git a/README.md b/README.md
@@ -54,15 +54,15 @@ AlamofireImage is an image component library for Alamofire.
 [CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate AlamofireImage into your Xcode project using CocoaPods, specify it in your `Podfile`:
 
 ```ruby
-pod 'AlamofireImage', '~> 4.1'
+pod 'AlamofireImage', '~> 4.3'
 ```
 
 ### Carthage
 
 [Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate AlamofireImage into your Xcode project using Carthage, specify it in your `Cartfile`:
 
 ```ogdl
-github "Alamofire/AlamofireImage" ~> 4.1
+github "Alamofire/AlamofireImage" ~> 4.3
 ```
 
 ### Swift Package Manager
@@ -73,7 +73,7 @@ Once you have your Swift package set up, adding AlamofireImage as a dependency i
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/Alamofire/AlamofireImage.git", .upToNextMajor(from: "4.2.0"))
+    .package(url: "https://github.com/Alamofire/AlamofireImage.git", .upToNextMajor(from: "4.3.0"))
 ]
 ```
 
@@ -126,33 +126,38 @@ import Alamofire
 import AlamofireImage
 
 AF.request("https://httpbin.org/image/png").responseImage { response in
-	debugPrint(response)
+  debugPrint(response)
 
-	print(response.request)
-	print(response.response)
-	debugPrint(response.result)
+  print(response.request)
+  print(response.response)
+  debugPrint(response.result)
 
-    if case .success(let image) = response.result {
-		print("image downloaded: \(image)")
-	}
+  if case .success(let image) = response.result {
+    print("image downloaded: \(image)")
+  }
 }
 ```
 
 The AlamofireImage response image serializers support a wide range of image types including:
 
-- `image/png`
-- `image/jpeg`
-- `image/tiff`
+- `application/octet-stream` - As a fallback for things like AWS which provide no real type.
+- `image/avif` - On 2022 OS versions and later, except watchOS.
+- `image/bmp`
 - `image/gif`
+- `image/heic`, `image/heif` - On 2017 OS versions and later.
 - `image/ico`
-- `image/x-icon`
-- `image/bmp`
+- `image/jp2`
+- `image/jpeg`
+- `image/jpg`
+- `image/jxl` - On 2023 OS versions and later.
+- `image/png`
+- `image/tiff`
+- `image/webp` - On 2020 OS versions and later, except tvOS and watchOS.
 - `image/x-bmp`
-- `image/x-xbitmap`
+- `image/x-icon`
 - `image/x-ms-bmp`
 - `image/x-win-bitmap`
-- `image/heic`
-- `application/octet-stream` (added for iOS 13 support)
+- `image/x-xbitmap`
 
 > If the image you are attempting to download is an invalid MIME type not in the list, you can add custom acceptable content types using the `addAcceptableImageContentTypes` extension on the `DataRequest` type.
 

diff --git a/Source/Request+AlamofireImage.swift b/Source/Request+AlamofireImage.swift
@@ -273,7 +273,7 @@ extension DataRequest {
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
 extension DataRequest {
-    public func serializingImage(automaticallyCancelling shouldAutomaticallyCancel: Bool = false,
+    public func serializingImage(automaticallyCancelling shouldAutomaticallyCancel: Bool = true,
                                  imageScale: CGFloat = DataRequest.imageScale,
                                  inflateResponseImage: Bool = true,
                                  emptyResponseCodes: Set<Int> = ImageResponseSerializer.defaultEmptyResponseCodes,

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -21,35 +21,35 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          AlamofireImage 4.2.0 Docs
+          AlamofireImage 4.3.0 Docs
         </a>
-         (77% documented)
+         (76% documented)
       </p>
 
-      <p class="header-col--secondary">
+      <div class="header-col--secondary">
         <form role="search" action="search.json">
           <input type="text" placeholder="Search documentation" data-typeahead>
         </form>
-      </p>
+      </div>
 
         <p class="header-col header-col--secondary">
           <a class="header-link" href="https://github.com/Alamofire/AlamofireImage">
-            <img class="header-icon" src="img/gh.png"/>
+            <img class="header-icon" src="img/gh.png" alt="GitHub"/>
             View on GitHub
           </a>
         </p>
 
         <p class="header-col header-col--secondary">
           <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofireImage%2Fdocsets%2FAlamofireImage.xml">
-            <img class="header-icon" src="img/dash.png"/>
+            <img class="header-icon" src="img/dash.png" alt="Dash"/>
             Install in Dash
           </a>
         </p>
     </header>
 
     <p class="breadcrumbs">
       <a class="breadcrumb" href="index.html">AlamofireImage Reference</a>
-      <img class="carat" src="img/carat.png" />
+      <img class="carat" src="img/carat.png" alt=""/>
       Classes  Reference
     </p>
 
@@ -332,7 +332,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">ImageResponseSerializer</span> <span class="p">:</span> <span class="kt">ResponseSerializer</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ImageResponseSerializer</span> <span class="p">:</span> <span class="kt">ResponseSerializer</span></code></pre>
 
                         </div>
                       </div>
@@ -347,9 +347,8 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2021-04-03)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-09-13)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>
-</div>
 </html>
diff --git a/docs/Classes/AutoPurgingImageCache.html b/docs/Classes/AutoPurgingImageCache.html
@@ -21,35 +21,35 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          AlamofireImage 4.2.0 Docs
+          AlamofireImage 4.3.0 Docs
         </a>
-         (77% documented)
+         (76% documented)
       </p>
 
-      <p class="header-col--secondary">
+      <div class="header-col--secondary">
         <form role="search" action="../search.json">
           <input type="text" placeholder="Search documentation" data-typeahead>
         </form>
-      </p>
+      </div>
 
         <p class="header-col header-col--secondary">
           <a class="header-link" href="https://github.com/Alamofire/AlamofireImage">
-            <img class="header-icon" src="../img/gh.png"/>
+            <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
             View on GitHub
           </a>
         </p>
 
         <p class="header-col header-col--secondary">
           <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofireImage%2Fdocsets%2FAlamofireImage.xml">
-            <img class="header-icon" src="../img/dash.png"/>
+            <img class="header-icon" src="../img/dash.png" alt="Dash"/>
             Install in Dash
           </a>
         </p>
     </header>
 
     <p class="breadcrumbs">
       <a class="breadcrumb" href="../index.html">AlamofireImage Reference</a>
-      <img class="carat" src="../img/carat.png" />
+      <img class="carat" src="../img/carat.png" alt=""/>
       AutoPurgingImageCache Class Reference
     </p>
 
@@ -230,7 +230,7 @@ <h1>AutoPurgingImageCache</h1>
                 <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
                 <div class="section-name-container">
                   <a class="section-name-link" href="#/Properties"></a>
-                  <h3 class="section-name"><p>Properties</p>
+                  <h3 class="section-name"><span>Properties</span>
 </h3>
                 </div>
               </div>
@@ -325,7 +325,7 @@ <h4>Declaration</h4>
                 <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
                 <div class="section-name-container">
                   <a class="section-name-link" href="#/Initialization"></a>
-                  <h3 class="section-name"><p>Initialization</p>
+                  <h3 class="section-name"><span>Initialization</span>
 </h3>
                 </div>
               </div>
@@ -403,7 +403,7 @@ <h4>Return Value</h4>
                 <a name="//apple_ref/swift/Section/Add Image to Cache" class="dashAnchor"></a>
                 <div class="section-name-container">
                   <a class="section-name-link" href="#/Add%20Image%20to%20Cache"></a>
-                  <h3 class="section-name"><p>Add Image to Cache</p>
+                  <h3 class="section-name"><span>Add Image to Cache</span>
 </h3>
                 </div>
               </div>
@@ -544,7 +544,7 @@ <h4>Parameters</h4>
                 <a name="//apple_ref/swift/Section/Remove Image from Cache" class="dashAnchor"></a>
                 <div class="section-name-container">
                   <a class="section-name-link" href="#/Remove%20Image%20from%20Cache"></a>
-                  <h3 class="section-name"><p>Remove Image from Cache</p>
+                  <h3 class="section-name"><span>Remove Image from Cache</span>
 </h3>
                 </div>
               </div>
@@ -755,7 +755,7 @@ <h4>Return Value</h4>
                 <a name="//apple_ref/swift/Section/Fetch Image from Cache" class="dashAnchor"></a>
                 <div class="section-name-container">
                   <a class="section-name-link" href="#/Fetch%20Image%20from%20Cache"></a>
-                  <h3 class="section-name"><p>Fetch Image from Cache</p>
+                  <h3 class="section-name"><span>Fetch Image from Cache</span>
 </h3>
                 </div>
               </div>
@@ -880,7 +880,7 @@ <h4>Return Value</h4>
                 <a name="//apple_ref/swift/Section/Image Cache Keys" class="dashAnchor"></a>
                 <div class="section-name-container">
                   <a class="section-name-link" href="#/Image%20Cache%20Keys"></a>
-                  <h3 class="section-name"><p>Image Cache Keys</p>
+                  <h3 class="section-name"><span>Image Cache Keys</span>
 </h3>
                 </div>
               </div>
@@ -955,9 +955,8 @@ <h4>Return Value</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2021-04-03)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-09-13)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>
-</div>
 </html>