Merge pull request #52 from jathu/rename-struct

Rename struct

Author: jathu

README.md

@@ -14,10 +14,10 @@ Asynchronous example:
 let image = UIImage(named: "yeezus.png")
 
 image.getColors { colors in
-  backgroundView.backgroundColor = colors.backgroundColor
-  mainLabel.textColor = colors.primaryColor
-  secondaryLabel.textColor = colors.secondaryColor
-  detailLabel.textColor = colors.detailColor
+  backgroundView.backgroundColor = colors.background
+  mainLabel.textColor = colors.primary
+  secondaryLabel.textColor = colors.secondary
+  detailLabel.textColor = colors.detail
 }
 ```
 
@@ -26,10 +26,10 @@ Synchronous example:
 ```swift
 let colors = UIImage(named: "yeezus.png").getColors()
 
-backgroundView.backgroundColor = colors.backgroundColor
-mainLabel.textColor = colors.primaryColor
-secondaryLabel.textColor = colors.secondaryColor
-detailLabel.textColor = colors.detailColor
+backgroundView.backgroundColor = colors.background
+mainLabel.textColor = colors.primary
+secondaryLabel.textColor = colors.secondary
+detailLabel.textColor = colors.detail
 ```
 
 ## UIImage Methods
@@ -58,17 +58,23 @@ getColors(scaleDownSize: CGSize, completionHandler: (UIImageColors) -> Void) ->
 
 Passes a `UIImageColors` object into the closure, with a custom image rescale. Use smaller sizes for better performance at the cost of quality colors. Use larger sizes for better color sampling and quality at the cost of performance. This runs on the background thread.
 
-## UIImageColors
+## UIImageColors Object
 
-`UIImageColors` is struct that contains four different `UIColor`s.
+`UIImageColors` is struct that contains four different `UIColor` variables.
 
 ```swift
-var backgroundColor
-var primaryColor
-var secondaryColor
-var detailColor
+public struct UIImageColors {
+    public var background: UIColor!
+    public var primary: UIColor!
+    public var secondary: UIColor!
+    public var detail: UIColor!
+}
 ```
 
+## Installation
+
+You can either directly copy [UIImageColors.swift](sources/UIImageColors.swift) into your project *or* you can use CocoaPods: [UIImageColors](https://cocoapods.org/pods/UIImageColors).
+
 ## License
 
 The [license](https://github.com/jathu/UIImageColors/blob/master/LICENSE) is provided in the project folder. Please also refer to Panic's [original license](https://github.com/panicinc/ColorArt/#license).

Sources/UIImageColors.swift

@@ -9,10 +9,10 @@
 import UIKit
 
 public struct UIImageColors {
-    public var backgroundColor: UIColor!
-    public var primaryColor: UIColor!
-    public var secondaryColor: UIColor!
-    public var detailColor: UIColor!
+    public var background: UIColor!
+    public var primary: UIColor!
+    public var secondary: UIColor!
+    public var detail: UIColor!
 }
 
 class PCCountedColor {
@@ -219,13 +219,13 @@ extension UIImage {
                 }
             }
         }
-        result.backgroundColor = proposedEdgeColor.color
+        result.background = proposedEdgeColor.color
 
         // Get foreground colors
         enumerator = imageColors.objectEnumerator()
         sortedColors.removeAllObjects()
         sortedColors = NSMutableArray(capacity: imageColors.count)
-        let findDarkTextColor = !result.backgroundColor.isDarkColor
+        let findDarkTextColor = !result.background.isDarkColor
 
         while var kolor = enumerator.nextObject() as? UIColor {
             kolor = kolor.colorWithMinimumSaturation(minSaturation: 0.15)
@@ -239,38 +239,38 @@ extension UIImage {
         for curContainer in sortedColors {
             let kolor = (curContainer as! PCCountedColor).color
 
-            if result.primaryColor == nil {
-                if kolor.isContrastingColor(compareColor: result.backgroundColor) {
-                    result.primaryColor = kolor
+            if result.primary == nil {
+                if kolor.isContrastingColor(compareColor: result.background) {
+                    result.primary = kolor
                 }
-            } else if result.secondaryColor == nil {
-                if !result.primaryColor.isDistinct(compareColor: kolor) || !kolor.isContrastingColor(compareColor: result.backgroundColor) {
+            } else if result.secondary == nil {
+                if !result.primary.isDistinct(compareColor: kolor) || !kolor.isContrastingColor(compareColor: result.background) {
                     continue
                 }
 
-                result.secondaryColor = kolor
-            } else if result.detailColor == nil {
-                if !result.secondaryColor.isDistinct(compareColor: kolor) || !result.primaryColor.isDistinct(compareColor: kolor) || !kolor.isContrastingColor(compareColor: result.backgroundColor) {
+                result.secondary = kolor
+            } else if result.detail == nil {
+                if !result.secondary.isDistinct(compareColor: kolor) || !result.primary.isDistinct(compareColor: kolor) || !kolor.isContrastingColor(compareColor: result.background) {
                     continue
                 }
 
-                result.detailColor = kolor
+                result.detail = kolor
                 break
             }
         }
 
-        let isDarkBackgound = result.backgroundColor.isDarkColor
+        let isDarkBackgound = result.background.isDarkColor
 
-        if result.primaryColor == nil {
-            result.primaryColor = isDarkBackgound ? whiteColor:blackColor
+        if result.primary == nil {
+            result.primary = isDarkBackgound ? whiteColor:blackColor
         }
 
-        if result.secondaryColor == nil {
-            result.secondaryColor = isDarkBackgound ? whiteColor:blackColor
+        if result.secondary == nil {
+            result.secondary = isDarkBackgound ? whiteColor:blackColor
         }
 
-        if result.detailColor == nil {
-            result.detailColor = isDarkBackgound ? whiteColor:blackColor
+        if result.detail == nil {
+            result.detail = isDarkBackgound ? whiteColor:blackColor
         }
 
         return result

Supporting Files/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.3.0</string>
+	<string>1.4.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

UIImageColors.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |spec|
   spec.name        = "UIImageColors"
-  spec.version     = "1.3.1"
+  spec.version     = "1.4.0"
   spec.license     = "MIT"
   spec.summary     = "iTunes style color fetcher for UIImage."
   spec.homepage    = "https://github.com/jathu/UIImageColors"

UIImageColorsPlayground.playground/Contents.swift

@@ -33,20 +33,20 @@ func makeBox(_ asynchronous: Bool, completionHandler: @escaping (UIView) -> Void
 
         if asynchronous {
             c.albumImageView.image!.getColors { colors in
-                c.backgroundColor = colors.backgroundColor
-                c.albumTitle.textColor = colors.primaryColor
-                c.artistTitle.textColor = colors.secondaryColor
-                c.yearLabel.textColor = colors.detailColor
+                c.backgroundColor = colors.background
+                c.albumTitle.textColor = colors.primary
+                c.artistTitle.textColor = colors.secondary
+                c.yearLabel.textColor = colors.detail
                 if i == maxIterations-1 {
                     completionHandler(box)
                 }
             }
         } else {
             let colors = c.albumImageView.image!.getColors()
-            c.backgroundColor = colors.backgroundColor
-            c.albumTitle.textColor = colors.primaryColor
-            c.artistTitle.textColor = colors.secondaryColor
-            c.yearLabel.textColor = colors.detailColor
+            c.backgroundColor = colors.background
+            c.albumTitle.textColor = colors.primary
+            c.artistTitle.textColor = colors.secondary
+            c.yearLabel.textColor = colors.detail
             if i == maxIterations-1 {
                 completionHandler(box)
             }

UIImageColorsPlayground.playground/timeline.xctimeline

@@ -3,37 +3,37 @@
    version = "3.0">
    <TimelineItems>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2917&amp;EndingColumnNumber=23&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=515104523.006536"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2877&amp;EndingColumnNumber=23&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=518703781.904105"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2917&amp;EndingColumnNumber=20&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=515104523.00672"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2877&amp;EndingColumnNumber=20&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=518703781.9045"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2917&amp;EndingColumnNumber=19&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=515104523.00685"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2877&amp;EndingColumnNumber=19&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=518703781.904713"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2917&amp;EndingColumnNumber=22&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=515104523.006985"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2877&amp;EndingColumnNumber=22&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=518703781.904925"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2917&amp;EndingColumnNumber=3&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=515104523.007109"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2877&amp;EndingColumnNumber=3&amp;EndingLineNumber=59&amp;StartingColumnNumber=1&amp;StartingLineNumber=59&amp;Timestamp=518703781.90513"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2917&amp;EndingColumnNumber=8&amp;EndingLineNumber=59&amp;StartingColumnNumber=5&amp;StartingLineNumber=59&amp;Timestamp=515104523.007231"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=2877&amp;EndingColumnNumber=8&amp;EndingLineNumber=59&amp;StartingColumnNumber=5&amp;StartingLineNumber=59&amp;Timestamp=518703781.905348"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=3&amp;CharacterRangeLoc=2913&amp;EndingColumnNumber=8&amp;EndingLineNumber=58&amp;StartingColumnNumber=5&amp;StartingLineNumber=58&amp;Timestamp=515104523.007466"
+         documentLocation = "#CharacterRangeLen=3&amp;CharacterRangeLoc=2873&amp;EndingColumnNumber=8&amp;EndingLineNumber=58&amp;StartingColumnNumber=5&amp;StartingLineNumber=58&amp;Timestamp=518703781.905768"
          lockedSize = "{546, 444}"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">