fastlane-plugin-icon_versioning 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af2fe2215c9a6960451b947740164d389b17117b
+  data.tar.gz: c4b6fbbce95d470bcee7162b8d91f8feb4ad8fa1
+SHA512:
+  metadata.gz: 229ab7bda6fbad805756bfcbc7c059d5ecc2c204324e9e4b70405453c8394d4260d9b677ffe88a7b2902990cdf09bd05f603181614c110d3cfcaf06fa003c597
+  data.tar.gz: 53591f678340f55755aa926c51bac51706a3d21fba775a7ccaec25b320d0b9aa0cf4813c54fbd909c59fd5e1bbbfd8aad745aa5a9c133ff09e9b30121a4b65b0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Iulian Onofrei <6d0847b9@opayq.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# 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)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-icon_versioning`, add it to your project by running:
+
+```bash
+fastlane add_plugin icon_versioning
+```
+
+## About icon_versioning
+
+Overlay build information on top of your app icon. Based on original work by Krzysztof Zabłocki (https://github.com/krzysztofzablocki/Bootstrap).
+
+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:
+
+![Run script](./assets/run_script.jpg)
+
+_(Having a script file instead of the actual plugin call makes it easier to debug, change and review it, as explained in [this article](http://www.mokacoding.com/blog/better-build-phase-scripts/))_
+
+```sh
+#!/usr/bin/env bash
+
+# optional, to prevent versioning for release builds
+if [[ $CONFIGURATION == "Release" ]]; then
+    exit 0
+fi
+
+# optional, to fix fastlane warnings that show up in the Report navigator
+export LC_ALL=en_US.UTF-8
+export LANG=en_US.UTF-8
+
+# make sure Bundler is found
+export GEM_HOME=~/.gems
+export PATH=$PATH:$GEM_HOME/bin
+
+export FASTLANE_DISABLE_COLORS=1 # optional, to remove from the build log the ANSI escape sequences that enables colors in terminal
+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'
+```
+
+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)
+
+Lastly, you should ignore the `-Versioned` folders using:
+
+```ini
+/path/to/*-Versioned.appiconset/*
+```
+
+In the end, it should look like this:
+
+![App icon](./assets/app_icon.jpg)
+
+## Example
+
+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`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/icon_versioning.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/icon_versioning/version'
+
+module Fastlane
+  module IconVersioning
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::IconVersioning.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,92 @@
+require 'fastlane/action'
+require_relative '../helper/icon_versioning_helper'
+
+module Fastlane
+  module Actions
+    class IconVersioningAction < Action
+      def self.run(params)
+        icon_versioning_helper = Helper::IconVersioningHelper.new(params)
+
+        return icon_versioning_helper.run()
+      end
+
+      def self.description
+        'Overlay build information on top of your app icon. Based on original work by Krzysztof Zabłocki (https://github.com/krzysztofzablocki/Bootstrap).'
+      end
+
+      def self.authors
+        ['Iulian Onofrei', 'Krzysztof Zabłocki']
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :appiconset_path,
+            env_name: 'ICON_VERSIONING_APPICONSET_PATH',
+            description: 'The path to the `.appiconset` directory containing the icon images',
+            verify_block: proc do |value|
+              path = File.expand_path(value.to_s)
+
+              UI.user_error!('Appiconset not found') unless File.exist?(path)
+              UI.user_error!('Appiconset is not a directory') unless File.directory?(path)
+              UI.user_error!('Appiconset does not end with .appiconset') unless path.end_with?('.appiconset')
+            end,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :text,
+            env_name: 'ICON_VERSIONING_TEXT',
+            description: 'The text to overlay over the icon images',
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :band_height_percentage,
+            env_name: 'ICON_VERSIONING_BAND_HEIGHT_PERCENTAGE',
+            description: 'The percentage of the text band height relative to the image\'s height. A float number between 0 and 1',
+            default_value: 0.5,
+            verify_block: proc do |value|
+              UI.user_error!('Band height percentage is less than 0') if value < 0
+              UI.user_error!('Band height percentage is greater than 1') if value > 1
+            end,
+            optional: true,
+            type: Float
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :band_blur_radius_percentage,
+            env_name: 'ICON_VERSIONING_BAND_BLUR_RADIUS_PERCENTAGE',
+            description: 'The blur radius percentage of the text band. The default value behaves like an automatic setting which produces the best results. More details: http://www.imagemagick.org/Usage/blur/#blur_args',
+            default_value: 0,
+            verify_block: proc do |value|
+              UI.user_error!('Band blur radius percentage is less than 0') if value < 0
+            end,
+            optional: true,
+            type: Float
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :band_blur_sigma_percentage,
+            env_name: 'ICON_VERSIONING_BAND_BLUR_SIGMA_PERCENTAGE',
+            description: 'The blur sigma percentage of the text band. More details: http://www.imagemagick.org/Usage/blur/#blur_args',
+            default_value: 0.05,
+            verify_block: proc do |value|
+              UI.user_error!('Band blur sigma percentage is less than 0') if value < 0
+              UI.user_error!('Band blur sigma percentage is greater than 65355') if value > 65_355
+            end,
+            optional: true,
+            type: Float
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :ignored_icons_regex,
+            env_name: 'ICON_VERSIONING_IGNORED_ICONS_REGEX',
+            description: 'An optional regex that causes the icons that match agains it not to be versioned',
+            optional: true,
+            type: Regexp
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+require 'fastlane_core/ui/ui'
+require 'mini_magick'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
+
+  module Helper
+    class IconVersioningHelper
+      attr_accessor :appiconset_path
+      attr_accessor :text
+
+      attr_accessor :band_height_percentage
+      attr_accessor :band_blur_radius_percentage
+      attr_accessor :band_blur_sigma_percentage
+
+      attr_accessor :ignored_icons_regex
+
+      def initialize(params)
+        self.appiconset_path = File.expand_path(params[:appiconset_path])
+        self.text = params[:text]
+
+        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]
+
+        self.ignored_icons_regex = params[:ignored_icons_regex]
+      end
+
+      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.glob("#{versioned_appiconset_path}/*.png").each do |icon_path|
+          next if self.ignored_icons_regex && !(icon_path =~ self.ignored_icons_regex).nil?
+
+          version_icon(icon_path)
+        end
+      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)
+
+        width = image[:width]
+        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_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')
+
+        MiniMagick::Tool::Convert.new do |convert|
+          convert << icon_path
+          convert << '-blur' << "#{band_blur_radius}x#{band_blur_sigma}"
+          convert << blurred_icon_path
+        end
+
+        MiniMagick::Tool::Convert.new do |convert|
+          convert << blurred_icon_path
+          convert << '-gamma' << '0'
+          convert << '-fill' << 'white'
+          convert << '-draw' << "rectangle 0, #{band_top_position}, #{width}, #{height}"
+          convert << mask_icon_path
+        end
+
+        MiniMagick::Tool::Convert.new do |convert|
+          convert << '-size' << "#{width}x#{band_height}"
+          convert << 'xc:none'
+          convert << '-fill' << 'rgba(0, 0, 0, 0.2)'
+          convert << '-draw' << "rectangle 0, 0, #{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 << '-fill' << 'white'
+          convert << '-gravity' << 'center'
+          # using label instead of caption prevents wrapping long lines
+          convert << "label:#{self.text}"
+          convert << text_icon_path
+        end
+
+        MiniMagick::Tool::Convert.new do |convert|
+          convert << icon_path
+          convert << blurred_icon_path
+          convert << mask_icon_path
+          convert << '-composite'
+          convert << temp_icon_path
+        end
+
+        File.delete(blurred_icon_path, mask_icon_path)
+
+        MiniMagick::Tool::Convert.new do |convert|
+          convert << temp_icon_path
+          convert << text_base_icon_path
+          convert << '-geometry' << "+0+#{band_top_position}"
+          convert << '-composite'
+          convert << text_icon_path
+          convert << '-geometry' << "+0+#{band_top_position}"
+          convert << '-composite'
+          convert << icon_path
+        end
+
+        File.delete(text_base_icon_path, text_icon_path, temp_icon_path)
+      end
+
+      private def suffix(path, text)
+        extension = File.extname(path)
+
+        return path.gsub(extension, "_#{text}#{extension}")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-icon_versioning
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Iulian Onofrei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.84.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.84.0
+description: 
+email: 6d0847b9@opayq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/icon_versioning.rb
+- lib/fastlane/plugin/icon_versioning/actions/icon_versioning_action.rb
+- lib/fastlane/plugin/icon_versioning/helper/icon_versioning_helper.rb
+- lib/fastlane/plugin/icon_versioning/version.rb
+homepage: https://github.com/revolter/fastlane-plugin-icon_versioning
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Overlay build information on top of your app icon
+test_files: []