fastlane-plugin-icon_versioning 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af2fe2215c9a6960451b947740164d389b17117b
-  data.tar.gz: c4b6fbbce95d470bcee7162b8d91f8feb4ad8fa1
+  metadata.gz: 31cce154dfee7397c16e0e1295b5c1770b3425e4
+  data.tar.gz: e30ab7f0478bf482830e97fe6aab54d2526b95e9
 SHA512:
-  metadata.gz: 229ab7bda6fbad805756bfcbc7c059d5ecc2c204324e9e4b70405453c8394d4260d9b677ffe88a7b2902990cdf09bd05f603181614c110d3cfcaf06fa003c597
-  data.tar.gz: 53591f678340f55755aa926c51bac51706a3d21fba775a7ccaec25b320d0b9aa0cf4813c54fbd909c59fd5e1bbbfd8aad745aa5a9c133ff09e9b30121a4b65b0
+  metadata.gz: 65ea28e3206d72be7d9d25a58dabb5f40971345e1df0bed1e5649052a471dafb38d92fa5bb769b763854b9d084b4ff1bfa474fb80ce862ed55d60422bd7a529f
+  data.tar.gz: af218c9e33c31c1abb032698afbeb568c614c0c16fe12c9a288ca648fd90e9f5d84754fe32afe31b5aa3b1edeb030726f2149f6e2f0d48884afe984cad8b66b2

data/README.md

@@ -1,6 +1,8 @@
 # icon_versioning plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-icon_versioning)
+[![Build Status](https://travis-ci.org/revolter/fastlane-plugin-icon_versioning.svg?branch=master)](https://travis-ci.org/revolter/fastlane-plugin-icon_versioning)
+[![Coverage Status](https://coveralls.io/repos/github/revolter/fastlane-plugin-icon_versioning/badge.svg)](https://coveralls.io/github/revolter/fastlane-plugin-icon_versioning)
 
 ## Getting Started
 
@@ -14,6 +16,15 @@ fastlane add_plugin icon_versioning
 
 Overlay build information on top of your app icon. Based on original work by Krzysztof Zabłocki (https://github.com/krzysztofzablocki/Bootstrap).
 
+### Improvements
+
+Over the original implementation by Krzysztof, I also added:
+- automatic font scaling and blur spreading that ensures a consistent look between different sized icons
+- text lines preservation that doesn't break long lines to prevent unexpected results
+- possibility to specify custom text, band height, blur spread that remain responsive to the icon sizes
+
+### Integrating
+
 This copies the specified `.appiconset` folder to a new folder named `OriginalName-Versioned.appiconset` and overlays the specified `text` over the icon images inside it.
 
 To automatically run this on every build, you can add a new `Run Script` `Build Phase` before the `Compile Sources` one and point it to a script that calls this plugin:
@@ -45,6 +56,8 @@ export FASTLANE_HIDE_GITHUB_ISSUES=1 # optional, to make sure that the versionin
 bundle exec fastlane run icon_versioning appiconset_path:'/path/to/AppIcon.appiconset' text:'1.2.3 (11.03.2018)\n[ead76f1] {Staging}\nmaster'
 ```
 
+_Make sure the script is executable by running `chmod +x /scripts/icon_versioning.sh`_
+
 In order for the new versioned icon to be actually used by the app, you have to point the `Asset Catalog App Icon Set Name` (`ASSETCATALOG_COMPILER_APPICON_NAME`) build setting to this new versioned one:
 
 ![Build setting](./assets/build_setting.jpg)
@@ -55,6 +68,8 @@ Lastly, you should ignore the `-Versioned` folders using:
 /path/to/*-Versioned.appiconset/*
 ```
 
+If running it automatically on every build is not what you need, you can also call it from wherever you want, as long as you specify the correct parameters.
+
 In the end, it should look like this:
 
 ![App icon](./assets/app_icon.jpg)
@@ -63,6 +78,8 @@ In the end, it should look like this:
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
+You can also check out the [example Xcode project](example) to see it in action, and all the required changes [here](https://github.com/revolter/fastlane-plugin-icon_versioning/compare/30f5447...aa4d743).
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/icon_versioning/helper/icon_versioning_helper.rb

@@ -1,11 +1,17 @@
-require 'fastlane_core/ui/ui'
+require 'digest'
+require 'fileutils'
 require 'mini_magick'
+require 'yaml'
+
+require 'fastlane_core/ui/ui'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
 
   module Helper
     class IconVersioningHelper
+      CACHE_FILE_NAME = 'cache.yml'.freeze
+
       attr_accessor :appiconset_path
       attr_accessor :text
 
@@ -29,22 +35,46 @@ module Fastlane
       def run()
         versioned_appiconset_path = self.class.get_versioned_path(self.appiconset_path)
 
-        FileUtils.remove_entry(versioned_appiconset_path, force: true)
-        FileUtils.copy_entry(self.appiconset_path, versioned_appiconset_path)
+        Dir.mkdir(versioned_appiconset_path) unless Dir.exist?(versioned_appiconset_path)
 
-        Dir.glob("#{versioned_appiconset_path}/*.png").each do |icon_path|
-          next if self.ignored_icons_regex && !(icon_path =~ self.ignored_icons_regex).nil?
+        cache_file_path = File.join(versioned_appiconset_path, CACHE_FILE_NAME)
 
-          version_icon(icon_path)
+        if File.exist?(cache_file_path)
+          cache = YAML.load_file(cache_file_path)
+        else
+          cache = {}
         end
+
+        Dir.glob("#{self.appiconset_path}/*.png").each do |original_icon_path|
+          versioned_icon_path = self.class.get_versioned_path(original_icon_path)
+
+          unless cache[original_icon_path].nil?
+            if File.exist?(versioned_icon_path)
+              versioned_icon_sha = Digest::SHA2.file(versioned_icon_path).hexdigest
+              cached_icon_sha = cache[original_icon_path]
+
+              next if versioned_icon_sha == cached_icon_sha
+            end
+          end
+
+          if self.ignored_icons_regex && !(original_icon_path =~ self.ignored_icons_regex).nil?
+            FileUtils.copy(original_icon_path, versioned_icon_path)
+          else
+            version_icon(original_icon_path, versioned_icon_path)
+          end
+
+          cache[original_icon_path] = Digest::SHA2.file(versioned_icon_path).hexdigest
+        end
+
+        File.open(cache_file_path, 'w') { |file| file.write(cache.to_yaml) }
       end
 
       def self.get_versioned_path(path)
         return path.gsub(/([^.]+)(\.appiconset)/, '\1-Versioned\2')
       end
 
-      private def version_icon(icon_path)
-        image = MiniMagick::Image.open(icon_path)
+      private def version_icon(original_icon_path, versioned_icon_path)
+        image = MiniMagick::Image.open(original_icon_path)
 
         width = image[:width]
         height = image[:height]
@@ -55,14 +85,14 @@ module Fastlane
 
         band_top_position = height - band_height
 
-        blurred_icon_path = suffix(icon_path, 'blurred')
-        mask_icon_path = suffix(icon_path, 'mask')
-        text_base_icon_path = suffix(icon_path, 'text_base')
-        text_icon_path = suffix(icon_path, 'text')
-        temp_icon_path = suffix(icon_path, 'temp')
+        blurred_icon_path = suffix(versioned_icon_path, 'blurred')
+        mask_icon_path = suffix(versioned_icon_path, 'mask')
+        text_base_icon_path = suffix(versioned_icon_path, 'text_base')
+        text_icon_path = suffix(versioned_icon_path, 'text')
+        temp_icon_path = suffix(versioned_icon_path, 'temp')
 
         MiniMagick::Tool::Convert.new do |convert|
-          convert << icon_path
+          convert << original_icon_path
           convert << '-blur' << "#{band_blur_radius}x#{band_blur_sigma}"
           convert << blurred_icon_path
         end
@@ -94,7 +124,7 @@ module Fastlane
         end
 
         MiniMagick::Tool::Convert.new do |convert|
-          convert << icon_path
+          convert << original_icon_path
           convert << blurred_icon_path
           convert << mask_icon_path
           convert << '-composite'
@@ -111,7 +141,7 @@ module Fastlane
           convert << text_icon_path
           convert << '-geometry' << "+0+#{band_top_position}"
           convert << '-composite'
-          convert << icon_path
+          convert << versioned_icon_path
         end
 
         File.delete(text_base_icon_path, text_icon_path, temp_icon_path)

data/lib/fastlane/plugin/icon_versioning/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module IconVersioning
-    VERSION = "1.0.0"
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-icon_versioning
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Iulian Onofrei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.84.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 6d0847b9@opayq.com
 executables: []
@@ -182,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Overlay build information on top of your app icon