fastlane-plugin-icon_versioning 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d1d032b7ce422d1fb0d748d3a158bd9e7dcad9
-  data.tar.gz: 0b12e1a6604c765f1e8b08dd4c930c4451db73e8
+  metadata.gz: bf27a15124530480184b11d4e63cbd67f65ca1b0
+  data.tar.gz: e7afc502693ea1df9c8a0e72895d5fdad51458c6
 SHA512:
-  metadata.gz: 969bc76c0919823f4e236232ffd4b68101b239207257affa314c5e7b8b75e8ad91776584d2336deba4c802f509f16be01e5130ae500dc1b253f5036eeae06114
-  data.tar.gz: 9f0b38c180c88bf57df4b87604be79bf4e73c897b981db30bf2777d0bcbacd0d1b486090754a63bf140f17f8b7ac5178dd49f480eca76644f0d3ee0f85ae95c6
+  metadata.gz: 74b1aff17607afb43a670c1245f50acbaa2646525bf601fd12ad7f872a439c165268b91da5fe91b6b3bdee6b7ef22988d346703791452917a01082a99efb2d6a
+  data.tar.gz: 43e9188b61677dad1fc283c86e27642957aebe9fe55502b9dc7101cb2c0b5eadef623f4f118d0da3050b9539787b05f4a27fcec325bf172b7fda8c5d3821e19c

data/README.md

@@ -54,7 +54,7 @@ export FASTLANE_DISABLE_COLORS=1 # optional, to remove from the build log the AN
 export FASTLANE_SKIP_UPDATE_CHECK=1 # optional, to make sure that the versioning finishes as fast as possible in case there is an available update
 export FASTLANE_HIDE_GITHUB_ISSUES=1 # optional, to make sure that the versioning finishes as fast as possible in case the plugin crashes
 
-bundle exec fastlane run icon_versioning appiconset_path:'/path/to/AppIcon.appiconset' text:'1.2.3 (11.03.2018)\n[ead76f1] {Staging}\nmaster'
+bundle exec fastlane run version_icon 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`_

data/lib/fastlane/plugin/icon_versioning/actions/version_icon_action.rb

@@ -39,6 +39,19 @@ module Fastlane
             description: 'The text to overlay over the icon images',
             type: String
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :text_margins_percentages,
+            env_name: 'VERSION_ICON_TEXT_MARGINS_PERCENTAGES',
+            description: 'The percentages of the text margins relative to the image\'s size. The array must have all four margins: `text_margins_percentages: [top, right, bottom, left]`, two values: `text_margins_percentages: [vertical, horizontal]` or one value for all of them `text_margins: [all]`',
+            default_value: [0.06],
+            verify_block: proc do |value|
+              UI.user_error!('The number of margins is not equal to 1, 2 or 4') unless value.length == 1 || value.length == 2 || value.length == 4
+              UI.user_error!('At least one margin percentage is less than 0') if value.any? { |percentage| percentage < 0 }
+              UI.user_error!('At least one margin percentage is greater than 1') if value.any? { |percentage| percentage > 1 }
+            end,
+            optional: true,
+            type: Array
+          ),
           FastlaneCore::ConfigItem.new(
             key: :band_height_percentage,
             env_name: 'VERSION_ICON_BAND_HEIGHT_PERCENTAGE',

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

@@ -11,29 +11,31 @@ module Fastlane
   module Helper
     class VersionIconHelper
       CACHE_FILE_NAME = 'cache.yml'.freeze
+      CONTENTS_JSON_FILE_NAME = 'Contents.json'.freeze
 
-      attr_accessor :appiconset_path
-      attr_accessor :text
+      def initialize(params)
+        @appiconset_path = File.expand_path(params[:appiconset_path])
+        @text = params[:text]
 
-      attr_accessor :band_height_percentage
-      attr_accessor :band_blur_radius_percentage
-      attr_accessor :band_blur_sigma_percentage
+        text_margins_percentages = params[:text_margins_percentages]
 
-      attr_accessor :ignored_icons_regex
+        text_margins_percentages *= 4 if text_margins_percentages.length == 1
+        text_margins_percentages *= 2 if text_margins_percentages.length == 2
 
-      def initialize(params)
-        self.appiconset_path = File.expand_path(params[:appiconset_path])
-        self.text = params[:text]
+        @text_top_margin_percentage = text_margins_percentages[0]
+        @text_right_margin_percentage = text_margins_percentages[1]
+        @text_bottom_margin_percentage = text_margins_percentages[2]
+        @text_left_margin_percentage = text_margins_percentages[3]
 
-        self.band_height_percentage = params[:band_height_percentage]
-        self.band_blur_radius_percentage = params[:band_blur_radius_percentage]
-        self.band_blur_sigma_percentage = params[:band_blur_sigma_percentage]
+        @band_height_percentage = params[:band_height_percentage]
+        @band_blur_radius_percentage = params[:band_blur_radius_percentage]
+        @band_blur_sigma_percentage = params[:band_blur_sigma_percentage]
 
-        self.ignored_icons_regex = params[:ignored_icons_regex]
+        @ignored_icons_regex = params[:ignored_icons_regex]
       end
 
       def run()
-        versioned_appiconset_path = self.class.get_versioned_path(self.appiconset_path)
+        versioned_appiconset_path = self.class.get_versioned_path(@appiconset_path)
 
         Dir.mkdir(versioned_appiconset_path) unless Dir.exist?(versioned_appiconset_path)
 
@@ -45,10 +47,12 @@ module Fastlane
           cache = {}
         end
 
-        Dir.glob("#{self.appiconset_path}/*.png").each do |original_icon_path|
+        FileUtils.copy("#{@appiconset_path}/#{CONTENTS_JSON_FILE_NAME}", "#{versioned_appiconset_path}/#{CONTENTS_JSON_FILE_NAME}")
+
+        Dir.glob("#{@appiconset_path}/*.png").each do |original_icon_path|
           versioned_icon_path = self.class.get_versioned_path(original_icon_path)
 
-          text_sha = Digest::SHA2.hexdigest(self.text)
+          text_sha = Digest::SHA2.hexdigest(@text)
 
           unless cache[original_icon_path].nil?
             if File.exist?(versioned_icon_path)
@@ -61,7 +65,7 @@ module Fastlane
             end
           end
 
-          if self.ignored_icons_regex && !(original_icon_path =~ self.ignored_icons_regex).nil?
+          if @ignored_icons_regex && !(original_icon_path =~ @ignored_icons_regex).nil?
             FileUtils.copy(original_icon_path, versioned_icon_path)
           else
             version_icon(original_icon_path, versioned_icon_path)
@@ -85,14 +89,19 @@ module Fastlane
       def version_icon(original_icon_path, versioned_icon_path)
         image = MiniMagick::Image.open(original_icon_path)
 
-        width = image[:width]
-        height = image[:height]
+        image_width = image[:width]
+        image_height = image[:height]
 
-        band_height = height * self.band_height_percentage
-        band_blur_radius = width * self.band_blur_radius_percentage
-        band_blur_sigma = width * self.band_blur_sigma_percentage
+        band_height = image_height * @band_height_percentage
+        band_blur_radius = image_width * @band_blur_radius_percentage
+        band_blur_sigma = image_width * @band_blur_sigma_percentage
 
-        band_top_position = height - band_height
+        band_top_position = image_height - band_height
+
+        text_top_margin = image_height * @text_top_margin_percentage
+        text_right_margin = image_width * @text_right_margin_percentage
+        text_bottom_margin = image_height * @text_bottom_margin_percentage
+        text_left_margin = image_width * @text_left_margin_percentage
 
         blurred_icon_path = suffix(versioned_icon_path, 'blurred')
         mask_icon_path = suffix(versioned_icon_path, 'mask')
@@ -110,25 +119,25 @@ module Fastlane
           convert << blurred_icon_path
           convert << '-gamma' << '0'
           convert << '-fill' << 'white'
-          convert << '-draw' << "rectangle 0, #{band_top_position}, #{width}, #{height}"
+          convert << '-draw' << "rectangle 0, #{band_top_position}, #{image_width}, #{image_height}"
           convert << mask_icon_path
         end
 
         MiniMagick::Tool::Convert.new do |convert|
-          convert << '-size' << "#{width}x#{band_height}"
+          convert << '-size' << "#{image_width}x#{band_height}"
           convert << 'xc:none'
           convert << '-fill' << 'rgba(0, 0, 0, 0.2)'
-          convert << '-draw' << "rectangle 0, 0, #{width}, #{band_height}"
+          convert << '-draw' << "rectangle 0, 0, #{image_width}, #{band_height}"
           convert << text_base_icon_path
         end
 
         MiniMagick::Tool::Convert.new do |convert|
           convert << '-background' << 'none'
-          convert << '-size' << "#{width}x#{band_height}"
+          convert << '-size' << "#{image_width - (text_left_margin + text_right_margin)}x#{band_height - (text_top_margin + text_bottom_margin)}"
           convert << '-fill' << 'white'
           convert << '-gravity' << 'center'
           # using label instead of caption prevents wrapping long lines
-          convert << "label:#{self.text}"
+          convert << "label:#{@text}"
           convert << text_icon_path
         end
 
@@ -148,7 +157,7 @@ module Fastlane
           convert << '-geometry' << "+0+#{band_top_position}"
           convert << '-composite'
           convert << text_icon_path
-          convert << '-geometry' << "+0+#{band_top_position}"
+          convert << '-geometry' << "+#{text_left_margin}+#{band_top_position + text_top_margin}"
           convert << '-composite'
           convert << versioned_icon_path
         end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module IconVersioning
-    VERSION = '1.1.2'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-icon_versioning
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Iulian Onofrei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: fastlane
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-require_tools
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,21 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fastlane
+  name: rubocop-require_tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.84.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.84.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="