fastlane-plugin-appicon 0.12.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 638ee204f30b9aa9cea411e2ef03ff371a7b642a
-  data.tar.gz: 8d5313d9a5d87b2ae4f27231d35337758eb4be53
+SHA256:
+  metadata.gz: 34a5a40f00f66babf8d35487344ed174c6413cb93a7436a4b2b1db448d1f139d
+  data.tar.gz: cbd32bd140fca377d4da0d05616234a51e9b4765fcb90b4d0f09c6b965dc4320
 SHA512:
-  metadata.gz: f0058b646b2e9ec09692bba049690f81da92656dd4e7f9bdf8d3381877ed1fd1e280fba4b62035e7e412f032f9511a33ba10b3173205f5ec23583c9c802e500b
-  data.tar.gz: df1cfd5369ebd1c956e0ca6357192c29e02babe323c37c8e82385160b65da9c0a44d532be5c7c784278af2f8636fae093439d9f92be4eb992ec2208779bf1b66
+  metadata.gz: 6188bd3df216a12c1d075f47005362f47519f0214355b87af6bae097f232048aed91901dff69635120d7b010d042f5d368f31bd5f4be6c0dc01c59a248219095
+  data.tar.gz: 55a65329ca48a57857a0db29c9ea9967fa909e65f2cd4f69d95e47f7bf87cdeb6b1523756fe91cb0cb1b2a57bac6e8ed7d8b0eff7062f9eca64fd9d146f82ffa

data/README.md

@@ -12,6 +12,20 @@ This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To ge
 fastlane add_plugin appicon
 ```
 
+
+Please note that this plugin uses [minimagick](https://github.com/minimagick/minimagick), which requires either GraphicsMagick or ImageMagick library. If you have neither, you can install either via Homebrew:
+
+
+```
+brew install graphicsmagick
+```
+or
+```
+brew install imagemagick
+```
+
+The default CLI for the `mini_magick` gem is set to auto pick. It will first try to use `GraphicsMagick` (if you have it installed) otherwise it will use `ImageMagick`. If you want to be explicit about which CLI you use, set the `minimagick_cli` option to `graphicsmagick` or `imagemagick`. Not specifying this option will set `MiniMagick` to use auto which will choose what's available.
+
 ## About appicon
 
 Generate required icon sizes and iconset from a master application icon.
@@ -22,9 +36,20 @@ Since many apps use a single 1024x1024 icon to produce all the required sizes fr
 
 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`.
 
-Just specify the source image using the `appicon_image_file`. Optionally specify the devices  using `appicon_devices` and the destination path using `appicon_path`.
+Just specify the source image using the `appicon_image_file`. Optionally specify the devices using `appicon_devices` and the destination path using `appicon_path`.
+
+We recommend storing the full-size picture at `fastlane/metadata/app_icon.png` so it can be picked up by _deliver_, as well as this plugin.
+
+If you want to use this plugin to generate a app icon for Messages(sticker) extension, set `messages_extension` to `true` and add `messages` to the `appicon_devices`.
 
 ```ruby
+lane :basic do
+  appicon(
+    appicon_devices: [:ipad, :iphone, :ios_marketing],
+    appicon_path: "MajorKey/Assets.xcassets"
+  )
+end
+
 lane :test1 do
   appicon(appicon_image_file: 'spec/fixtures/Themoji.png',
              appicon_devices: [:ipad, :iphone, :ios_marketing])
@@ -39,11 +64,34 @@ end
 lane :test3 do
   # `appicon_image_file` defaults to "fastlane/metadata/app_icon.png"
   appicon(
-    appicon_devices: [:iphone], 
+    appicon_devices: [:iphone],
     appicon_path: 'wwdcfamily/Images.xcassets' # output path
   )
 end
 
+lane :test4 do
+  appicon(appicon_image_file: 'spec/fixtures/Themoji.png',
+             appicon_devices: [:macos])
+end
+
+lane :splash_screen do
+  appicon(
+    appicon_image_file: 'spec/fixtures/splash_screen.png',
+    appicon_devices: [:universal],
+    appicon_path: "ios/App/App/Assets.xcassets",
+    appicon_name: 'Splash.imageset'
+  )
+end
+
+lane :messages_extension do
+  appicon(
+    appicon_image_file: "fastlane/metadata/iMessageAppIcon.png",
+    appicon_devices: [:iphone, :ipad, :ios_marketing, :messages],
+    appicon_path: 'iMessageStickers/Stickers.xcassets',
+    messages_extension: true
+  )
+end
+
 # or
 
 lane :android do
@@ -56,7 +104,14 @@ lane :android do
     appicon_image_file: 'spec/fixtures/ThemojiNotification.png',
     appicon_icon_types: [:notification],
     appicon_path: 'app/res/drawable',
-    appicon_name: 'ic_notification'
+    appicon_filename: 'ic_notification',
+    generate_rounded: true
+  )
+  android_appicon(
+    appicon_image_file: 'spec/fixtures/splash_base_image.png',
+    appicon_icon_types: [:splash_port, :splash_land],
+    appicon_path: 'app/res/drawable',
+    appicon_filename: 'splash'
   )
 end
 ```
@@ -84,7 +139,7 @@ If you have trouble using plugins, check out the [Plugins Troubleshooting](https
 
 ## Using `fastlane` Plugins
 
-For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
 
 ## About `fastlane`
 

data/lib/fastlane/plugin/appicon/actions/android_appicon_action.rb

@@ -1,6 +1,9 @@
+require 'mini_magick'
+
 module Fastlane
   module Actions
     class AndroidAppiconAction < Action
+
       def self.needed_icons
         {
           launcher: {
@@ -18,26 +21,38 @@ module Fastlane
             :xhdpi => ['48x48'],
             :xxhdpi => ['72x72'],
             :xxxhdpi => ['96x96'],
+          },
+          splash_land: {
+            'land-ldpi' => ['320x200'],
+            'land-mdpi' => ['480x320'],
+            'land-hdpi' => ['800x480'],
+            'land-xhdpi' => ['1280x720'],
+            'land-xxhdpi' => ['1600x960'],
+            'land-xxxhdpi' => ['1920x1280']
+          },
+          splash_port: {
+            'port-ldpi' => ['200x320'],
+            'port-mdpi' => ['320x480'],
+            'port-hdpi' => ['480x800'],
+            'port-xhdpi' => ['720x1280'],
+            'port-xxhdpi' => ['960x1600'],
+            'port-xxxhdpi' => ['1280x1920']
           }
         }
       end
 
       def self.run(params)
-        fname = params[:appicon_image_file]
-        custom_sizes = params[:appicon_custom_sizes]
-
-        require 'mini_magick'
-        image = MiniMagick::Image.open(fname)
 
-        Helper::AppiconHelper.check_input_image_size(image, 512)
+        Helper::AppiconHelper.set_cli(params[:minimagick_cli])
 
-        # Convert image to png
-        image.format 'png'
+        fname = params[:appicon_image_file]
+        custom_sizes = params[:appicon_custom_sizes]
 
         icons = Helper::AppiconHelper.get_needed_icons(params[:appicon_icon_types], self.needed_icons, true, custom_sizes)
         icons.each do |icon|
-          width = icon['width']
-          height = icon['height']
+          image = MiniMagick::Image.open(fname)
+
+          Helper::AppiconHelper.check_input_image_size(image, 1024, 1024)
 
           # Custom icons will have basepath and filename already defined
           if icon.has_key?('basepath') && icon.has_key?('filename')
@@ -47,15 +62,71 @@ module Fastlane
             basepath = Pathname.new("#{params[:appicon_path]}-#{icon['scale']}")
             filename = "#{params[:appicon_filename]}.png"
           end
-          FileUtils.mkdir_p(basepath)
 
-          image.resize "#{width}x#{height}"
+          width_height = [icon['width'], icon['height']].map(&:to_i)
+          width, height = width_height
+          max = width_height.max
+
+          image.format 'png'
+          image.resize "#{max}x#{max}"
+
+          unless width == height
+            offset =
+            if width > height
+              "+0+#{(width - height) / 2}"
+            elsif height > width
+              "+#{(height - width) / 2}+0"
+            end
+
+            image.crop "#{icon['size']}#{offset}"
+          end
+
+          FileUtils.mkdir_p(basepath)
           image.write basepath + filename
+
+          if basepath.to_s.match("port-")
+            default_portrait_path = basepath.to_s.gsub("port-","")
+            FileUtils.mkdir_p(default_portrait_path)
+            image.write default_portrait_path + '/' + filename
+          end
+
+          if params[:generate_rounded]
+            rounded_image = MiniMagick::Image.open(fname)
+            rounded_image.format 'png'
+            rounded_image.resize "#{width}x#{height}"
+            rounded_image = round(rounded_image)
+            rounded_image.write basepath + filename.gsub('.png', '_round.png')
+          end
         end
 
         UI.success("Successfully stored launcher icons at '#{params[:appicon_path]}'")
       end
 
+      def self.round(img)
+        require 'mini_magick'
+        img.format 'png'
+
+        width = img[:width]-2
+        radius = width/2
+
+        mask = ::MiniMagick::Image.open img.path
+        mask.format 'png'
+
+        mask.combine_options do |m|
+          m.alpha 'transparent'
+          m.background 'none'
+          m.fill 'white'
+          m.draw 'roundrectangle 1,1,%s,%s,%s,%s' % [width, width, radius, radius]
+        end
+
+        masked = img.composite(mask, 'png') do |i|
+          i.alpha "set"
+          i.compose 'DstIn'
+        end
+
+        return masked
+      end
+
       def self.get_custom_sizes(image, custom_sizes)
 
       end
@@ -97,7 +168,20 @@ module Fastlane
                                description: "Hash of custom sizes - {'path/icon.png' => '256x256'}",
                              default_value: {},
                                   optional: true,
-                                      type: Hash)
+                                      type: Hash),
+          FastlaneCore::ConfigItem.new(key: :generate_rounded,
+                               description: "Generate round icons?",
+                             default_value: false,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :minimagick_cli,
+                                  env_name: "APPICON_MINIMAGICK_CLI",
+                               description: "Set MiniMagick CLI (auto picked by default). Values are: graphicsmagick, imagemagick",
+                                  optional: true,
+                                      type: String,
+                              verify_block: proc do |value|
+                                        av = %w(graphicsmagick imagemagick)
+                                        UI.user_error!("Unsupported minimagick cli '#{value}', must be: #{av}") unless av.include?(value)
+                                      end)
         ]
       end
 

data/lib/fastlane/plugin/appicon/actions/appicon_action.rb

@@ -1,8 +1,16 @@
+require 'json'
+require 'mini_magick'
+
 module Fastlane
   module Actions
     class AppiconAction < Action
       def self.needed_icons
         {
+          universal: {
+            '1x' => ['2732x2732'],
+            '2x' => ['2732x2732'],
+            '3x' => ['2732x2732']
+          },
           iphone: {
             '2x' => ['20x20', '29x29', '40x40', '60x60'],
             '3x' => ['20x20', '29x29', '40x40', '60x60']
@@ -15,11 +23,44 @@ module Fastlane
             '1x' => ['1024x1024']
           },
           :watch => {
-            '2x' => [['24x24', 'notificationCenter', '38mm'], ['27.5x27.5', 'notificationCenter', '42mm'], ['29x29', 'companionSettings'], ['40x40', 'appLauncher', '38mm'], ['86x86', 'quickLook', '38mm'], ['98x98', 'quickLook', '42mm']],
+            '2x' => [
+                      ['24x24', 'notificationCenter', '38mm'],
+                      ['27.5x27.5', 'notificationCenter', '42mm'],
+                      ['29x29', 'companionSettings'],
+                      ['40x40', 'appLauncher', '38mm'],
+                      ['44x44', 'appLauncher', '40mm'],
+                      ['50x50', 'appLauncher', '44mm'],
+                      ['86x86', 'quickLook', '38mm'],
+                      ['98x98', 'quickLook', '42mm'],
+                      ['108x108', 'quickLook', '44mm']
+                    ],
             '3x' => [['29x29', 'companionSettings']]
           },
           :watch_marketing => {
             '1x' => ['1024x1024']
+          },
+          :macos => {
+            '1x' => ['16x16', '32x32', '128x128', '256x256', '512x512'],
+            '2x' => ['16x16', '32x32', '128x128', '256x256', '512x512'],
+          }
+        }
+      end
+
+      def self.needed_icons_messages_extension
+        {
+          iphone: {
+            '2x' => ['60x45'],
+            '3x' => ['60x45']
+          },
+          ipad: {
+            '2x' => ['67x50', '74x55']
+          },
+          messages: {
+            '2x' => ['27x20', '32x24'],
+            '3x' => ['27x20', '32x24']
+          },
+          ios_marketing: {
+            '1x' => ['1024x768']
           }
         }
       end
@@ -27,12 +68,19 @@ module Fastlane
       def self.run(params)
         fname = params[:appicon_image_file]
         basename = File.basename(fname, File.extname(fname))
-        basepath = Pathname.new(File.join(params[:appicon_path], params[:appicon_name]))
 
-        require 'mini_magick'
+        Helper::AppiconHelper.set_cli(params[:minimagick_cli])
+
+        is_messages_extension = params[:messages_extension]
+        basepath = Pathname.new(File.join(params[:appicon_path], is_messages_extension ? params[:appicon_messages_name] : params[:appicon_name]))
+        
         image = MiniMagick::Image.open(fname)
 
-        Helper::AppiconHelper.check_input_image_size(image, 1024)
+        if is_messages_extension
+          Helper::AppiconHelper.check_input_image_size(image, 1024, 768)
+        else
+          Helper::AppiconHelper.check_input_image_size(image, 1024, 1024)
+        end
 
         # Convert image to png
         image.format 'png'
@@ -42,19 +90,25 @@ module Fastlane
           image.alpha 'remove'
         end
 
-        # Create the base path
+        # Recreate the base path
+        FileUtils.rm_rf(basepath)
         FileUtils.mkdir_p(basepath)
 
         images = []
 
-        icons = Helper::AppiconHelper.get_needed_icons(params[:appicon_devices], self.needed_icons, false)
+        icons = Helper::AppiconHelper.get_needed_icons(params[:appicon_devices], is_messages_extension ? self.needed_icons_messages_extension : self.needed_icons, false)
         icons.each do |icon|
           width = icon['width']
           height = icon['height']
-          filename = "#{basename}-#{width.to_i}x#{height.to_i}.png"
+          filename = basename
+          unless icon['device'] == 'universal'
+            filename += "-#{width.to_i}x#{height.to_i}"
+          end
+          filename += ".png"
 
           # downsize icon
-          image.resize "#{width}x#{height}"
+          # "!" resizes to exact size (needed for messages extension)
+          image.resize "#{width}x#{height}!"
 
           # Don't write change/created times into the PNG properties
           # so unchanged files don't have different hashes.
@@ -63,12 +117,27 @@ module Fastlane
           image.write basepath + filename
 
           info = {
-            'size' => icon['size'],
             'idiom' => icon['device'],
             'filename' => filename,
             'scale' => icon['scale']
           }
 
+          # if device is messages, we need to set it to universal
+          if icon['device'] == 'messages'
+            info['idiom'] = 'universal'
+            info['platform'] = 'ios'
+          end
+
+          # if device is ios_marketing but we are generating messages extension app, set the idiom correctly
+          if icon['device'] == 'ios_marketing' && is_messages_extension
+            info['platform'] = 'ios'
+          end
+          
+
+          unless icon['device'] == 'universal'
+            info['size'] = icon['size']
+          end
+
           info['role'] = icon['role'] unless icon['role'].nil?
           info['subtype'] = icon['subtype'] unless icon['subtype'].nil?
 
@@ -83,8 +152,7 @@ module Fastlane
           }
         }
 
-        require 'json'
-        File.write(File.join(basepath, 'Contents.json'), JSON.dump(contents))
+        File.write(File.join(basepath, 'Contents.json'), JSON.pretty_generate(contents))
         UI.success("Successfully stored app icon at '#{basepath}'")
       end
 
@@ -122,12 +190,33 @@ module Fastlane
                                description: "Name of the appiconset inside the asset catalogue",
                                   optional: true,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :appicon_messages_name,
+                                  env_name: "APPICON_MESSAGES_NAME",
+                             default_value: 'AppIcon.stickersiconset',
+                               description: "Name of the appiconset inside the asset catalogue",
+                                  optional: true,
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :remove_alpha,
                                   env_name: "REMOVE_ALPHA",
                              default_value: false,
                                description: "Remove the alpha channel from generated PNG",
                                   optional: true,
-                                      type: Boolean)
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :messages_extension,
+                                  env_name: "APPICON_MESSAGES_EXTENSION",
+                             default_value: false,
+                               description: "App icon is generated for Messages extension",
+                                  optional: true,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :minimagick_cli,
+                                  env_name: "APPICON_MINIMAGICK_CLI",
+                               description: "Set MiniMagick CLI (auto picked by default). Values are: graphicsmagick, imagemagick",
+                                  optional: true,
+                                      type: String,
+                              verify_block: proc do |value|
+                                        av = %w(graphicsmagick imagemagick)
+                                        UI.user_error!("Unsupported minimagick cli '#{value}', must be: #{av}") unless av.include?(value)
+                                      end)
         ]
       end
 

data/lib/fastlane/plugin/appicon/helper/appicon_helper.rb

@@ -1,10 +1,26 @@
+require 'mini_magick'
+
 module Fastlane
   module Helper
     class AppiconHelper
-      def self.check_input_image_size(image, size)
-        UI.user_error!("Minimum width of input image should be #{size}") if image.width < size
-        UI.user_error!("Minimum height of input image should be #{size}") if image.height < size
-        UI.user_error!("Input image should be square") if image.width != image.height
+      def self.check_input_image_size(image, width, height)
+        UI.user_error!("Minimum width of input image should be #{width}") if image.width < width
+        UI.user_error!("Minimum height of input image should be #{height}") if image.height < height
+        UI.user_error!("Input image should be square") if image.width / image.height != width / height
+      end
+
+      def self.set_cli(minimagick_cli)
+        MiniMagick.configure do |config|
+          case minimagick_cli
+          when "graphicsmagick"
+          config.cli = :graphicsmagick
+          when "imagemagick"
+            config.cli = :imagemagick
+          else
+            config.cli = MiniMagick.cli()
+          end
+          config.timeout = 5
+        end
       end
 
       def self.get_needed_icons(devices, needed_icons, is_android = false, custom_sizes = {})
@@ -19,7 +35,8 @@ module Fastlane
               if is_android
                 width, height = size.split('x').map { |v| v.to_f }
               else
-                width, height = size.split('x').map { |v| v.to_f * scale.to_i }
+                multiple = device.match(/universal/) ? 1 : scale.to_i
+                width, height = size.split('x').map { |v| v.to_f * multiple }
               end
 
               icons << {
@@ -31,12 +48,12 @@ module Fastlane
                 'role' => role,
                 'subtype' => subtype
               }
-              
+
             end
           end
         end
-        
-        # Add custom icon sizes (probably for notifications) 
+
+        # Add custom icon sizes (probably for notifications)
         custom_sizes.each do |path, size|
           path = path.to_s
           width, height = size.split('x').map { |v| v.to_f }
@@ -49,7 +66,7 @@ module Fastlane
             'filename' => File.basename(path)
           }
         end
-        
+
         # Sort from the largest to the smallest needed icon
         icons = icons.sort_by {|value| value['width']} .reverse
       end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Appicon
-    VERSION = "0.12.0"
+    VERSION = "0.16.0"
   end
 end

metadata

@@ -1,29 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appicon
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Boris Bügling
-autorequire: 
+- Felix Krause
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.5.1
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.5.1
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +129,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.95.0
-description: 
+description:
 email: boris@icculus.org
 executables: []
 extensions: []
@@ -135,11 +142,11 @@ files:
 - lib/fastlane/plugin/appicon/actions/appicon_action.rb
 - lib/fastlane/plugin/appicon/helper/appicon_helper.rb
 - lib/fastlane/plugin/appicon/version.rb
-homepage: https://github.com/neonichu/fastlane-plugin-appicon
+homepage: https://github.com/fastlane-community/fastlane-plugin-appicon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,9 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Generate required icon sizes and iconset from a master application icon.
 test_files: []