Merge pull request #217 from onevcat/change-log

Change log

.gitignore

@@ -76,3 +76,4 @@ fastlane/screenshots/screenshots.html
 # scan temporary files
 fastlane/test_output
 test_output
+fastlane/.env

CHANGELOG.md

@@ -0,0 +1,252 @@
+# Change Log
+
+-----
+
+## [1.9.2 - IOIOIO](https://github.com/onevcat/Kingfisher/releases/tag/1.9.2) (2016-01-14)
+
+#### Fix
+* A potential issue causes image cache checking method not working when the image just stored.
+* Better performance and image quality when storing images with original data.
+
+---
+
+## [1.9.1 - You happy, I happy](https://github.com/onevcat/Kingfisher/releases/tag/1.9.1) (2016-01-04)
+
+#### Fix
+* Making SwiftLint happy when building with Carthage. #189
+
+---
+
+## [1.9.0 - What a Task](https://github.com/onevcat/Kingfisher/releases/tag/1.9.0) (2015-12-31)
+
+#### Add
+* Download methods in `ImageDownloader` now returns a cancelable task. So you can cancel the downloading process when using downloader separately.
+* Add a cancelling method in image view extension for easier cancel operation.
+* Mark some properties of downloading task as public.
+
+#### Fix
+* Cancelling of image downloading now triggers completion handler with `NSURLErrorCancelled` correctly now.
+
+---
+
+## [1.8.5 - Single Dog](https://github.com/onevcat/Kingfisher/releases/tag/1.8.5) (2015-12-16)
+
+#### Fix
+* Use single url session to download images.
+* Ignore and return error immediately for empty URL.
+* Internal update for testing stability and code style.
+
+---
+
+## [1.8.4 - GIF is GIF](https://github.com/onevcat/Kingfisher/releases/tag/1.8.4) (2015-12-12)
+
+#### Fix
+* Opt out the normalization and decoding for GIF, which would lead an issue that the GIF images missing.
+* Proper cost count for GIF image.
+
+
+---
+
+## [1.8.3 - Internal beauty](https://github.com/onevcat/Kingfisher/releases/tag/1.8.3) (2015-12-05)
+
+#### Fix
+* Fix for code base styles and formats.
+
+---
+
+## [1.8.2 - Path matters](https://github.com/onevcat/Kingfisher/releases/tag/1.8.2) (2015-11-19)
+
+#### Add
+* Cache path is customizable now. You can use Document folder to cache user generated images (But be caution that the disk cache files might be removed if limitation condition met).
+
+
+---
+
+## [1.8.1 - Transition needs rest](https://github.com/onevcat/Kingfisher/releases/tag/1.8.1) (2015-11-13)
+
+#### Fix
+* Only apply transition when images are downloaded. It will not show transition animation now if images loaded from either memory or disk cache now.
+* Code style.
+
+---
+
+## [1.8.0 - Bigger is Better](https://github.com/onevcat/Kingfisher/releases/tag/1.8.0) (2015-11-07)
+
+#### Add
+* Support for tvOS. Now enjoy downloading and cacheing images in the tvOS.
+
+#### Fix
+* An issue which causes images not stored properly if the original data is not supplied. #142
+
+---
+
+## [1.7.1 - EXIF is JPEG!](https://github.com/onevcat/Kingfisher/releases/tag/1.7.1) (2015-10-27)
+
+#### Fix
+* EXIF JPEG support which was broken in 1.7.0.
+* Correct timing of completion handler for use case with transition of UIImageView extension.
+
+---
+
+## [1.7.0 - Kingfisher with animation](https://github.com/onevcat/Kingfisher/releases/tag/1.7.0) (2015-10-25)
+
+#### Add
+* GIF support. Now you can download and show an animated GIF by Kingfisher `UIImageView` extension.
+
+#### Fix
+* Type safe options.
+* A potential retain of cache in loading task.
+
+---
+
+## [1.6.1 - No More Blinking](https://github.com/onevcat/Kingfisher/releases/tag/1.6.1) (2015-10-09)
+
+#### Fix
+* The blinking when reloading images in a cell.
+* Indicator is now in center of image view.
+
+---
+
+## [1.6.0 - Transition](https://github.com/onevcat/Kingfisher/releases/tag/1.6.0) (2015-09-19)
+
+#### Add
+* Add transition option. You can now use some view transition (like fade in) easier.
+
+#### Fix
+* Image data presenting when storing in disk.
+
+---
+
+## [1.5.0 - Swift 2.0](https://github.com/onevcat/Kingfisher/releases/tag/1.5.0) (2015-09-10)
+
+#### Add
+* Support for Swift 2.0.
+
+#### Fix
+* Remove the disk retrieve task canceling temporarily since there is an issue in Xcode 7 beta.
+* Remove support for watchOS since it now requires a separated framework. It will be added later as a standalone library instead a fat one.
+
+---
+
+## [1.4.5 - Key decoupling](https://github.com/onevcat/Kingfisher/releases/tag/1.4.5) (2015-08-14)
+
+#### Fix
+* Added resource APIs so you can specify a cacheKey for an image. The default implementation will use the URL string as key.
+
+---
+
+## [1.4.4 - Bug fix release](https://github.com/onevcat/Kingfisher/releases/tag/1.4.4) (2015-08-07)
+
+#### Fix
+* Explicitly type casting in ImageCache. #86
+
+---
+
+## [1.4.3](https://github.com/onevcat/Kingfisher/releases/tag/1.4.0) (2015-08-06)
+
+#### Fix
+* Fix orientation of PNG files.
+* Indicator hiding logic.
+
+---
+
+## [1.4.2 - Scaling](https://github.com/onevcat/Kingfisher/releases/tag/1.4.0) (2015-07-09)
+
+#### Add
+* Support for store and decode with scale parameter.
+
+#### Fix
+* A retain cycle which prevents image retrieving task releasing.
+
+---
+
+## [1.4.1](https://github.com/onevcat/Kingfisher/releases/tag/1.4.1) (2015-05-12)
+
+#### Fix
+* Fix library dependency to weak link for WatchKit.
+
+---
+
+## [1.4.0 - Hello, Apple Watch](https://github.com/onevcat/Kingfisher/releases/tag/1.4.0) (2015-05-11)
+
+#### Add
+* Apple Watch support and category on `WKInterfaceImage`.
+
+---
+
+## [1.3.1](https://github.com/onevcat/Kingfisher/releases/tag/1.3.1) (2015-05-06)
+
+#### Fix
+* Fix tests for CI.
+
+---
+
+## [1.3.0 - 304? What is 304?](https://github.com/onevcat/Kingfisher/releases/tag/1.3.0) (2015-05-01)
+
+#### Add
+* ImageDownloaderDelegate for getting information from response.
+* A cacheType key in completion handler to let you know which does the image come from.
+* A notification when disk images are cleaned due to image expired or size exceeded.
+
+#### Fix
+* Changed `ForceRefresh` behavior to respect server response when got a 304.
+* Documentation and test coverage.
+
+---
+
+## [1.2.0 - More, I need more!](https://github.com/onevcat/Kingfisher/releases/tag/1.2.0) (2015-04-24)
+
+#### Add
+* Multiple cache/downloader system. You can know specify the cache/downloader you need to use for each image request. It will be useful if you need different cache or download policy for different images.
+* Changed `Options` to `OptionsInfo` for flexible options passing.
+
+#### Fix
+* An issue which preventing image downloading when modifying the url of request.
+
+### Deprecate
+* All extension methods with `KingfisherOptions` are deprecated now. Use `KingfisherOptionsInfo` instead.
+
+---
+
+## [1.1.3 - Internal is Important](https://github.com/onevcat/Kingfisher/releases/tag/1.1.3) (2015-04-23)
+
+#### Fix
+* Update the naming convention used in internal queues, for easier debug purpose.
+* Fix some tests.
+
+---
+
+## [1.1.2 - Who cares disk size](https://github.com/onevcat/Kingfisher/releases/tag/1.1.1) (2015-04-21)
+
+#### Add
+* API for calculation total disk cache size.
+* API for modifying request before sending it.
+* Handle challenge when accessing a server trust site.
+
+#### Fix
+* Fix grammar in README.
+* Fix demo project to make it simpler.
+
+---
+
+## [1.1.1](https://github.com/onevcat/Kingfisher/releases/tag/1.1.1) (2015-04-17)
+
+#### Fix
+* Update PodSpec version
+
+---
+
+## [1.1.0 - Not only image](https://github.com/onevcat/Kingfisher/releases/tag/1.1.0) (2015-04-17)
+
+#### Add
+* UIButton extension.
+
+#### Fix
+* Fix typo in project.
+* Improve documentation.
+
+---
+
+## [1.0.0 - Kingfisher, take off](https://github.com/onevcat/Kingfisher/releases/tag/1.0.0) (2015-04-13)
+
+First public release.

fastlane/Fastfile

@@ -5,30 +5,42 @@ default_platform :ios
 
 platform :ios do
   before_all do
-    
+
   end
 
   desc "Runs all the tests"
   lane :test do
     scan
   end
-  
+
   desc "Release new version"
   lane :release do |options|
       target_version = options[:version]
       raise "The version is missed. Use `fastlane release version:{version_number}`.`" if target_version.nil?
-      
+
       ensure_git_branch
       ensure_git_status_clean
       scan
       sync_build_number_to_git
       increment_version_number(version_number: target_version)
       version_bump_podspec(path: "Kingfisher.podspec", version_number: target_version)
-      
+
+      log = extract_current_change_log(version: options[:version])
+      release_log = update_change_log(log: log)
+
       git_commit_all(message: "Bump version to #{target_version}")
       add_git_tag tag: target_version
-      
+
       push_to_git_remote
+
+      set_github_release(
+      repository_name: "onevcat/Kingfisher",
+      api_token: ENV['GITHUB_TOKEN'],
+      name: release_log[:title],
+      tag_name: target_version,
+      description: release_log[:text]
+      )
+
       pod_push
   end
 
@@ -37,10 +49,10 @@ platform :ios do
   end
 
   after_all do |lane|
-    
+
   end
 
   error do |lane, exception|
-    
+
   end
 end

fastlane/actions/extract_current_change_log.rb

@@ -0,0 +1,57 @@
+module Fastlane
+  module Actions
+    class ExtractCurrentChangeLogAction < Action
+      require 'yaml'
+      def self.run(params)
+        yaml = File.read(params[:file])
+        data = YAML.load(yaml)
+        version = data["version"]
+        raise "The version should match in the input file".red unless (version and version == params[:version])
+
+        title = "#{version}"
+        title = title + " - #{data["name"]}" if (data["name"] and not data["name"].empty?)
+
+        return {:title => title, :version => version, :add => data["add"], :fix => data["fix"]}
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Extract change log information for a specified version."
+      end
+
+      def self.details
+        "This action will check input version and change log. If everything goes well, the change log info will be returned."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       env_name: "KF_EXTRACT_CURRENT_CHANGE_LOG_VERSION",
+                                       description: "The target version which is needed to be extract",
+                                       verify_block: proc do |value|
+                                          raise "No version number is given, pass using `version: 'version_number'`".red unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :file,
+                                       env_name: "KF_EXTRACT_CURRENT_CHANGE_LOG_PRECHANGE_FILE",
+                                       description: "Create a development certificate instead of a distribution one",
+                                       default_value: "pre-change.yml")
+        ]
+      end
+
+      def self.return_value
+        "An object contains change log infomation. {version: }"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.authors
+        ["onevcat"]
+      end
+    end
+  end
+end

fastlane/actions/update_change_log.rb

@@ -0,0 +1,60 @@
+module Fastlane
+  module Actions
+    class UpdateChangeLogAction < Action
+      def self.run(params)
+          log = params[:log]
+          raise "Invalid log object".red unless !log[:title].empty? and !log[:version].empty?
+
+          readme = File.read(params[:changelogfile])
+          log_text = "## [#{log[:title]}](https://github.com/onevcat/Kingfisher/releases/tag/#{log[:version]}) (#{Time.now.strftime("%Y-%m-%d")})\n\n"
+
+          des = ""
+          add = log[:add].map { |i| "* #{i}" }.join("\n") unless log[:add].nil?
+          des = des + "#### Add\n#{add}\n\n" unless add.nil? or add.empty?
+
+          fix = log[:fix].map { |i| "* #{i}" }.join("\n") unless log[:fix].nil?
+          des = des + "#### Fix\n#{fix}\n\n" unless fix.nil? or fix.empty?
+
+          log_text = log_text + des
+
+          File.open(params[:changelogfile], 'w') { |file| file.write(readme.sub("-----", "-----\n\n#{log_text}---")) }
+
+          return {:title => log[:title], :text => des}
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Update the change log file with the content of log"
+      end
+
+      def self.details
+        "Generally speaking, the log is return value of extract_current_change_log action"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :log,
+                                       env_name: "KF_UPDATE_CHANGE_LOG_LOG",
+                                       description: "Change log extracted by pre change log file",
+                                       is_string: false
+                                       ),
+          FastlaneCore::ConfigItem.new(key: :changelogfile,
+                                       env_name: "KF_UPDATE_CHANGE_LOG_CHANGE_LOG_FILE",
+                                       description: "The change log file, if not set, CHANGELOG.md will be used",
+                                       default_value: "CHANGELOG.md")
+        ]
+      end
+
+      def self.authors
+        ["onevcat"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

pre-change.yml

@@ -0,0 +1,5 @@
+version: 1.9.3
+name:
+add:
+fix:
+    - Stop indicator animation when loading failed. #215