Final code cleanup and polish.

Example/KFSwiftImageLoader/UI/Base.lproj/Main.storyboard

@@ -27,7 +27,7 @@
                                             <frame key="frameInset" width="375" height="187"/>
                                             <autoresizingMask key="autoresizingMask"/>
                                             <subviews>
-                                                <imageView opaque="NO" clipsSubviews="YES" userInteractionEnabled="NO" contentMode="scaleAspectFit" horizontalHuggingPriority="251" verticalHuggingPriority="251" translatesAutoresizingMaskIntoConstraints="NO" id="60y-FW-Ju1"/>
+                                                <imageView opaque="NO" clipsSubviews="YES" userInteractionEnabled="NO" contentMode="scaleAspectFit" horizontalHuggingPriority="251" verticalHuggingPriority="251" translatesAutoresizingMaskIntoConstraints="NO" id="60y-FW-Ju1" userLabel="Featured Image"/>
                                             </subviews>
                                             <constraints>
                                                 <constraint firstAttribute="bottom" secondItem="60y-FW-Ju1" secondAttribute="bottom" id="4pE-UM-BNM"/>
@@ -47,7 +47,7 @@
                                             <frame key="frameInset" width="375" height="187"/>
                                             <autoresizingMask key="autoresizingMask"/>
                                             <subviews>
-                                                <button opaque="NO" clipsSubviews="YES" userInteractionEnabled="NO" contentMode="scaleAspectFit" contentHorizontalAlignment="center" contentVerticalAlignment="center" adjustsImageWhenHighlighted="NO" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="z7R-wX-Uvl" userLabel="Button Image"/>
+                                                <button opaque="NO" clipsSubviews="YES" userInteractionEnabled="NO" contentMode="scaleAspectFit" contentHorizontalAlignment="center" contentVerticalAlignment="center" adjustsImageWhenHighlighted="NO" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="z7R-wX-Uvl" userLabel="Featured Button"/>
                                             </subviews>
                                             <constraints>
                                                 <constraint firstAttribute="bottom" secondItem="z7R-wX-Uvl" secondAttribute="bottom" id="2bt-O9-ZuO"/>
@@ -57,7 +57,7 @@
                                             </constraints>
                                         </tableViewCellContentView>
                                         <connections>
-                                            <outlet property="featuredButtonView" destination="z7R-wX-Uvl" id="IV0-NZ-aT8"/>
+                                            <outlet property="featuredButton" destination="z7R-wX-Uvl" id="m9B-86-dOx"/>
                                         </connections>
                                     </tableViewCell>
                                 </prototypes>

Example/KFSwiftImageLoader/View Controllers/MainViewController.swift

@@ -116,7 +116,7 @@ extension MainViewController: UITableViewDataSource {
 
             // Notice that the completion closure can be ommitted, since it defaults to nil. The `controlState` and `isBackgroundImage` parameters can also be ommitted, as they default to `.normal` and `false`, respectively.
             // Please read the documentation for more information.
-            cell.featuredButtonView.loadImage(urlString: self.imageURLStringsArray[indexPath.row], placeholderImage: UIImage(named: "KiavashFaisali"), forState: .normal, isBackgroundImage: false)
+            cell.featuredButton.loadImage(urlString: self.imageURLStringsArray[indexPath.row], placeholderImage: UIImage(named: "KiavashFaisali"), controlState: .normal, isBackgroundImage: false)
 
             return cell
         }

Example/KFSwiftImageLoader/Views/ButtonImageTableViewCell.swift

@@ -7,12 +7,12 @@ import UIKit
 
 final class ButtonImageTableViewCell: UITableViewCell {
     // MARK: - Properties
-    @IBOutlet weak var featuredButtonView: UIButton!
+    @IBOutlet weak var featuredButton: UIButton!
 
     // MARK: - View Recycling
     override func prepareForReuse() {
-        self.featuredButtonView.setImage(nil, for: UIControlState())
-        self.featuredButtonView.setBackgroundImage(nil, for: UIControlState())
+        self.featuredButton.setImage(nil, for: UIControlState())
+        self.featuredButton.setBackgroundImage(nil, for: UIControlState())
 
         super.prepareForReuse()
     }

KFSwiftImageLoader/Classes/MKAnnotationViewExtensions.swift

@@ -30,8 +30,8 @@ public extension MKAnnotationView {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(urlString: String,
-                                placeholderImage: UIImage? = nil,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                         placeholderImage: UIImage? = nil,
+                               completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         guard let url = URL(string: urlString) else {
             DispatchQueue.main.async {
@@ -52,8 +52,8 @@ public extension MKAnnotationView {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(url: URL,
-                                placeholderImage: UIImage? = nil,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                   placeholderImage: UIImage? = nil,
+                         completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         let cacheManager = KFImageCacheManager.sharedInstance
 
@@ -71,8 +71,8 @@ public extension MKAnnotationView {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(request: URLRequest,
-                                placeholderImage: UIImage? = nil,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                       placeholderImage: UIImage? = nil,
+                             completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         self.completionHolder = CompletionHolder(completion: completion)
 

KFSwiftImageLoader/Classes/UIButtonExtensions.swift

@@ -61,10 +61,10 @@ public extension UIButton {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(urlString: String,
-                                placeholderImage: UIImage? = nil,
-                                forState controlState: UIControlState = .normal,
-                                isBackgroundImage: Bool = false,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                         placeholderImage: UIImage? = nil,
+                             controlState: UIControlState = .normal,
+                        isBackgroundImage: Bool = false,
+                               completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         guard let url = URL(string: urlString) else {
             DispatchQueue.main.async {
@@ -74,7 +74,7 @@ public extension UIButton {
             return
         }
 
-        loadImage(url: url, placeholderImage: placeholderImage, forState: controlState, isBackgroundImage: isBackgroundImage, completion: completion)
+        loadImage(url: url, placeholderImage: placeholderImage, controlState: controlState, isBackgroundImage: isBackgroundImage, completion: completion)
     }
 
     /**
@@ -87,17 +87,17 @@ public extension UIButton {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(url: URL,
-                                placeholderImage: UIImage? = nil,
-                                forState controlState: UIControlState = .normal,
-                                isBackgroundImage: Bool = false,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                   placeholderImage: UIImage? = nil,
+                       controlState: UIControlState = .normal,
+                  isBackgroundImage: Bool = false,
+                         completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         let cacheManager = KFImageCacheManager.sharedInstance
 
         var request = URLRequest(url: url, cachePolicy: cacheManager.session.configuration.requestCachePolicy, timeoutInterval: cacheManager.session.configuration.timeoutIntervalForRequest)
         request.addValue("image/*", forHTTPHeaderField: "Accept")
 
-        loadImage(request: request, placeholderImage: placeholderImage, forState: controlState, isBackgroundImage: isBackgroundImage, completion: completion)
+        loadImage(request: request, placeholderImage: placeholderImage, controlState: controlState, isBackgroundImage: isBackgroundImage, completion: completion)
     }
 
     /**
@@ -110,10 +110,10 @@ public extension UIButton {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(request: URLRequest,
-                                placeholderImage: UIImage? = nil,
-                                forState controlState: UIControlState = UIControlState(),
-                                isBackgroundImage: Bool = false,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                       placeholderImage: UIImage? = nil,
+                           controlState: UIControlState = UIControlState(),
+                      isBackgroundImage: Bool = false,
+                             completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         self.completionHolder = CompletionHolder(completion: completion)
         self.indexPathIdentifier = -1

KFSwiftImageLoader/Classes/UIImageViewExtensions.swift

@@ -39,8 +39,8 @@ public extension UIImageView {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(urlString: String,
-                                placeholderImage: UIImage? = nil,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                         placeholderImage: UIImage? = nil,
+                               completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         guard let url = URL(string: urlString) else {
             DispatchQueue.main.async {
@@ -61,8 +61,8 @@ public extension UIImageView {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
      */
     final public func loadImage(url: URL,
-                                placeholderImage: UIImage? = nil,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                   placeholderImage: UIImage? = nil,
+                         completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         let cacheManager = KFImageCacheManager.sharedInstance
 
@@ -80,8 +80,8 @@ public extension UIImageView {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
      */
     final public func loadImage(request: URLRequest,
-                                placeholderImage: UIImage? = nil,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                       placeholderImage: UIImage? = nil,
+                             completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         self.completionHolder = CompletionHolder(completion: completion)
         self.indexPathIdentifier = -1

KFSwiftImageLoader/Classes/WKInterfaceImageExtensions.swift

@@ -61,9 +61,9 @@ public extension WKInterfaceImage {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(urlString: String,
-                                placeholderImageName: String? = nil,
-                                shouldUseDeviceCache: Bool = false,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                     placeholderImageName: String? = nil,
+                     shouldUseDeviceCache: Bool = false,
+                               completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         guard let url = URL(string: urlString) else {
             DispatchQueue.main.async {
@@ -85,9 +85,9 @@ public extension WKInterfaceImage {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(url: URL,
-                                placeholderImageName: String? = nil,
-                                shouldUseDeviceCache: Bool = false,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+               placeholderImageName: String? = nil,
+               shouldUseDeviceCache: Bool = false,
+                         completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         let cacheManager = KFImageCacheManager.sharedInstance
 
@@ -106,9 +106,9 @@ public extension WKInterfaceImage {
         - parameter completion: An optional closure that is called to indicate completion of the intended purpose of this method. It returns two values: the first is a `Bool` indicating whether everything was successful, and the second is `NSError?` which will be non-nil should an error occur. The default value is `nil`.
     */
     final public func loadImage(request: URLRequest,
-                                placeholderImageName: String? = nil,
-                                shouldUseDeviceCache: Bool = false,
-                                completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+                   placeholderImageName: String? = nil,
+                   shouldUseDeviceCache: Bool = false,
+                             completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
     {
         self.completionHolder = CompletionHolder(completion: completion)
 

README.md

@@ -63,17 +63,17 @@ imageView.loadImage(urlString: urlString, placeholderImage: UIImage(named: "Kiav
 For flexibility, there are several different methods for loading images.
 Below are the method signatures for all of them:
 ``` swift
-func loadImage(urlString urlString: String,
-                  placeholderImage: UIImage? = nil,
-                        completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+func loadImage(urlString: String,
+        placeholderImage: UIImage? = nil,
+              completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
 
-func loadImage(url url: URL,
+func loadImage(url: URL,
+  placeholderImage: UIImage? = nil,
+        completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+
+func loadImage(request: URLRequest,
       placeholderImage: UIImage? = nil,
             completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
-
-func loadImage(request request: URLRequest,
-              placeholderImage: UIImage? = nil,
-                    completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
 ```
 
 ### WKInterfaceImage
@@ -100,14 +100,14 @@ Again, KFSwiftImageLoader makes it very easy to load images.
 In this case, the button uses mostly the same method signature as UIImageView, but it includes two more optional parameters: "isBackgroundImage" and "forState".
 
 ``` swift
-func loadImage(urlString urlString: String,
-                  placeholderImage: UIImage? = nil,
-             forState controlState: UIControlState = .normal,
-                 isBackgroundImage: Bool = false,
-                        completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
+func loadImage(urlString: String,
+        placeholderImage: UIImage? = nil,
+            controlState: UIControlState = .normal,
+       isBackgroundImage: Bool = false,
+              completion: ((_ success: Bool, _ error: NSError?) -> Void)? = nil)
 ```
 
-"forState" takes a UIControlState value that is required when setting images for buttons.
+"controlState" takes a UIControlState value that is required when setting images for buttons.
 "isBackgroundImage" simply indicates whether or not the button should use "setBackgroundImage:for:" or "setImage:for:" for image loading.
 
 ### MKAnnotationView