icon-banner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9efce0274be7532b108c0374f84021b8f5fed3d
+  data.tar.gz: 2dcc37968b8978d58989627daa69a69899156dbc
+SHA512:
+  metadata.gz: 452fa34575ab520f92d453d0740767cbda45152de535e5fc1bb2a7a23e3bd19811bbd40383b7f415c5d63e81d221ccc25c30a2975458180f3e76f95483601088
+  data.tar.gz: 56234725fd3f474b8ad7c0edd48e454b77cfd2a0051026e5a789afe134b732dc85d5df11f93b55af4c9ea1e61f36fa81a2a344c284de746ad4ba5d611c3d8715

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Émile Bélair
+
+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,133 @@
+<h3 align="center">
+  <a href="https://github.com/ebelair/icon-banner/blob/master/.assets/icon_banner.png">
+  <img src="https://github.com/ebelair/icon-banner/blob/master/.assets/icon_banner.png?raw=true" alt="IconBanner" width="400">
+  </a>
+</h3>
+
+[![GitHub: @ebelair](https://img.shields.io/badge/author-@ebelair-blue.svg?style=flat)](https://github.com/ebelair)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/icon-banner.svg?style=flat)](https://rubygems.org/gems/icon-banner)
+[![Fastlane](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-icon_banner)
+
+**IconBanner** adds custom nice-looking banners over your mobile app icons.
+
+It is available both as a **command-line tool** and as a **Fastlane plugin**.
+
+> Currently **iOS-only**, but Android is in the works.
+
+## Introduction
+
+**IconBanner** is inspired by the great [HazAT/badge](https://github.com/HazAT/badge). It provides custom banner creation on-the-fly, allowing to create different text banners for different build contexts.
+
+It allows to create these kind of icons:
+
+|Original|Daily|QA|Staging|Production|
+|---|---|---|---|---|
+|![FaceTime Regular](https://github.com/ebelair/icon-banner/raw/master/spec/Sample.appiconset/facetime.png)|![FaceTime Daily](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/facetime_Daily.png)|![FaceTime QA](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/facetime_QA.png)|![FaceTime Staging](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/facetime_Staging.png)|![FaceTime Production](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/facetime_Production.png)|
+|![iBooks Regular](https://github.com/ebelair/icon-banner/raw/master/spec/Sample.appiconset/ibooks.png)|![iBooks Daily](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/ibooks_Daily.png)|![iBooks QA](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/ibooks_QA.png)|![iBooks Staging](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/ibooks_Staging.png)|![iBooks Production](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/ibooks_Production.png)|
+|![Podcasts Regular](https://github.com/ebelair/icon-banner/raw/master/spec/Sample.appiconset/podcasts.png)|![Podcasts Daily](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/podcasts_Daily.png)|![Podcasts QA](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/podcasts_QA.png)|![Podcasts Staging](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/podcasts_Staging.png)|![Podcasts Production](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/podcasts_Production.png)|
+|![TestFlight Regular](https://github.com/ebelair/icon-banner/raw/master/spec/Sample.appiconset/testflight.png)|![TestFlight Daily](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/testflight_Daily.png)|![TestFlight QA](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/testflight_QA.png)|![TestFlight Staging](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/testflight_Staging.png)|![TestFlight Production](https://github.com/ebelair/icon-banner/raw/master/spec/Reference/testflight_Production.png)|
+
+## Setup
+
+### 🚀 Fastlane
+
+Start by running this command in your project repository:
+
+```bash
+fastlane add_plugin fastlane-plugin-icon_banner
+```
+
+Then simply add the following actions in your Fastfile:
+
+```ruby
+lane :sample do
+  icon_banner([options])
+  # [build_ios_app and other actions]
+  icon_banner_restore()
+end
+```
+
+For more details, see the [Usage](https://github.com/ebelair/icon-banner#options) section below.
+
+### 💻 Standalone
+
+First install the gem:
+
+```bash
+gem install icon-banner
+```
+
+Then use it directly:
+
+```bash
+icon-banner generate [options]
+icon-banner restore
+```
+
+For more details, see the [Usage](https://github.com/ebelair/icon-banner#options) section below.
+
+## Usage
+
+### Generate
+
+Generates banners and adds them to app icons. Available via:
+
+- The `icon_banner()` Fastlane action
+- The `icon-banner generate` terminal command
+
+| Key     | Description                        | Default |
+|--------|------------------------------------|---------|
+| label  | Sets the text to display inside the banner    | BETA    |
+| color  | Sets the text color (when not set, the script uses the dominant icon color)      |         |
+| font   | Sets the text font with a _direct link_ to a TTF file (when not set, the script uses the embedded LilitaOne font) |         |
+| backup | Creates a backup of icons before applying banners (only set to `false` if you are under source-control)  | true     |
+
+Sample usages:
+
+```ruby
+# fastlane
+icon_banner(label: 'QA')
+icon_banner(label: 'QA', color: '#ff000088', font: '/Users/johndoe/Documents/mybestfont.ttf')
+```
+
+```bash
+# command-line
+icon-banner generate --label QA
+icon-banner generate --label QA --color '#ff000088' --font '/Users/johndoe/Documents/mybestfont.ttf'
+```
+
+### Restore
+
+Restores app icons without banners (if backups are available). Available via:
+
+- The `icon_banner_restore()` Fastlane action
+- The `icon-banner restore` terminal command
+
+No options are required – if backup files are available, they are automatically restored.
+
+Sample usage:
+
+```ruby
+# fastlane
+icon_banner_restore()
+```
+
+```bash
+# command-line
+icon-banner restore
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ebelair/icon-banner.
+
+## License
+
+IconBanner is ©2019 [ebelair](https://github.com/ebelair) and may be freely distributed under the [MIT license](https://opensource.org/licenses/MIT). See the [`LICENSE`](https://github.com/ebelair/icon-banner/blob/master/LICENSE.md) file.
+
+The project is highly inspired by [`badge` by HazAT](https://github.com/HazAT/badge). Used also under the [MIT license](https://opensource.org/licenses/MIT). Thanks again. 🙏
+
+## About ebelair
+
+[Émile Bélair](https://github.com/ebelair) acts as a Product Owner @ [Mirego](https://www.mirego.com). He enjoys creating great products and works hard with his team to deliver some of the greatest.

data/bin/icon-banner

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'icon_banner'
+
+IconBanner::IconBanner.start

data/lib/icon_banner.rb

@@ -0,0 +1,96 @@
+require 'icon_banner/appiconset'
+require 'commander'
+
+module IconBanner
+  VERSION = '0.1.0'
+  DESCRIPTION = 'IconBanner adds custom nice-looking banners over your mobile app icons'
+
+  UI = FastlaneCore::UI
+
+  class IconBanner
+    include Commander::Methods
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :name, 'IconBanner'
+      program :version, VERSION
+      program :description, DESCRIPTION
+
+      global_option('--verbose', 'Shows a more verbose output') { FastlaneCore::Globals.verbose = true }
+
+      command :generate do |c|
+        c.syntax = 'icon-banner generate [path] [options]'
+        c.description = 'Generates banners and adds them to app icons'
+        FastlaneCore::CommanderGenerator.new.generate(IconBanner::available_options, command: c)
+
+        c.action do |args, options|
+          path = args[0] || '.'
+          options = FastlaneCore::Configuration.create(IconBanner::available_options, options.__hash__)
+          IconBanner.generate(path, options)
+        end
+      end
+
+      command :restore do |c|
+        c.syntax = 'icon-banner restore [path]'
+        c.description = 'Restores app icons without banners (if backups are available)'
+
+        c.action do |args|
+          path = args[0] || '.'
+          IconBanner.restore(path)
+        end
+      end
+
+      run!
+    end
+
+    def self.generate(path, options)
+      AppIconSet.new.generate(path, options)
+    end
+
+    def self.restore(path)
+      AppIconSet.new.restore(path)
+    end
+
+    def self.available_options
+      [
+          FastlaneCore::ConfigItem.new(key: :label,
+                                       description: 'Sets the text to display inside the banner',
+                                       default_value: 'BETA',
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :color,
+                                       description: 'Sets the text color (when not set, the script uses the dominant icon color)',
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :font,
+                                       description: 'Sets the text font with a _direct link_ to a TTF file (when not set, the script uses the embedded LilitaOne font)',
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :backup,
+                                       description: 'Creates a backup of icons before applying banners (only set to `false` if you are under source-control)',
+                                       is_string: false,
+                                       default_value: true,
+                                       optional: true)
+      ]
+    end
+
+    def self.validate_libs!
+      begin
+        UI.error('ImageMagick was not found on your system. To install it, run the following command:')
+        UI.command('brew install imagemagick')
+        UI.user_error!('IconBanner is missing requirements.')
+      end unless `which convert`.include?('convert')
+    end
+
+    def self.base_path
+      File.dirname __dir__ + '/../../'
+    end
+
+    def self.font_path
+      File.join base_path, 'assets', 'LilitaOne.ttf'
+    end
+  end
+end

data/lib/icon_banner/appiconset.rb

@@ -0,0 +1,132 @@
+require 'fastlane_core'
+require 'mini_magick'
+
+module IconBanner
+  class AppIconSet
+    BASE_ICON_PATH = '/**/*.appiconset/*.{png,PNG}'
+    BACKUP_EXTENSION = '.bak'
+
+    def generate(path, options)
+      IconBanner.validate_libs!
+
+      restore(path) # restore in case it was already run before
+
+      app_icons = get_app_icons(path)
+
+      label = options[:label]
+      font = options[:font] || IconBanner.font_path
+
+      if app_icons.count > 0
+        UI.message 'Starting banner process...'
+
+        app_icons.each do |icon_path|
+          UI.verbose "Processing #{icon_path}"
+          create_backup icon_path if options[:backup]
+
+          color = options[:color]
+          begin
+            color = find_base_color(icon_path)
+            UI.verbose "Color: #{color}"
+          end unless color
+
+          banner_file = Tempfile.new %w[banner .png]
+          generate_banner banner_file.path, color, label, font
+          process_icon icon_path, banner_file.path
+          banner_file.close
+
+          UI.verbose "Completed processing #{File.basename icon_path}"
+          UI.verbose ''
+        end
+
+        UI.message 'Completed banner process.'
+      else
+        UI.error('No icon found.')
+      end
+    end
+
+    def restore(path)
+      app_icons = get_app_icons(path)
+
+      if app_icons.count > 0
+        UI.message 'Starting restore...'
+
+        app_icons.each do |icon_path|
+          UI.verbose "Restoring #{icon_path}"
+          restore_backup icon_path
+        end
+
+        UI.message 'Completed restore.'
+      end
+    end
+
+    def get_app_icons(path)
+      app_icons = Dir.glob("#{path}#{BASE_ICON_PATH}")
+      app_icons.reject { |i| i[/\/Carthage\//] || i[/\/Pods\//] ||i[/\/Releases\//] }
+    end
+
+    def find_base_color(path)
+      color = MiniMagick::Tool::Convert.new do |convert|
+        convert << path
+        convert.colors 3
+        convert << '-unique-colors'
+        convert.format '%[pixel:u]'
+        convert << 'xc:transparent'
+        convert << 'info:-'
+      end
+      color[/rgba?\([^)]*\)/]
+    end
+
+    def generate_banner(path, color, label, font)
+      MiniMagick::Tool::Convert.new do |convert|
+        convert.size '1024x1024'
+        convert << 'xc:transparent'
+        convert << path
+      end
+
+      banner = MiniMagick::Image.new path
+
+      banner.combine_options do |combine|
+        combine.fill 'rgba(0,0,0,0.25)'
+        combine.draw 'polygon 0,306 0,590 590,0 306,0'
+        combine.blur '0x10'
+      end
+
+      banner.combine_options do |combine|
+        combine.fill 'white'
+        combine.draw 'polygon 0,306 0,590 590,0 306,0'
+      end
+
+      banner.combine_options do |combine|
+        combine.font font
+        combine.fill color
+        combine.gravity 'Center'
+        combine.pointsize 150 - ([label.length - 8, 0].max * 8)
+        combine.draw "affine 0.5,-0.5,0.5,0.5,-286,-286 text 0,0 \"#{label}\""
+      end
+    end
+
+    def process_icon(icon_path, banner_path)
+      icon = MiniMagick::Image.open(icon_path)
+      banner = MiniMagick::Image.open(banner_path)
+      banner.resize "#{icon.width}x#{icon.height}"
+      icon.composite(banner).write(icon_path)
+    end
+
+    def create_backup(icon_path)
+      FileUtils.cp(icon_path, backup_path(icon_path))
+    end
+
+    def restore_backup(icon_path)
+      restore_path = backup_path(icon_path)
+      if File.exists?(restore_path)
+        FileUtils.cp(restore_path, icon_path)
+        File.delete restore_path
+      end
+    end
+
+    def backup_path(path)
+      ext = File.extname path
+      path.gsub(ext, BACKUP_EXTENSION + ext)
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: icon-banner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Émile Bélair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.100'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.100'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: IconBanner adds custom nice-looking banners over your mobile app icons
+email:
+- ebelair@me.com
+executables:
+- icon-banner
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- assets/LilitaOne.ttf
+- bin/icon-banner
+- lib/icon_banner.rb
+- lib/icon_banner/appiconset.rb
+homepage: https://github.com/ebelair/icon-banner
+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.11
+signing_key: 
+specification_version: 4
+summary: Banners for your app icons
+test_files: []