fastlane-plugin-appicon 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bced1c1899f354fefda0cd562c1adfc9ed9dcda60a699ab89e669af56d76dfc7
-  data.tar.gz: cb9889f63c757b3c81334c32ee29e4c6cb7567a5ee762005488deb6a4abe84cd
+  metadata.gz: 34a5a40f00f66babf8d35487344ed174c6413cb93a7436a4b2b1db448d1f139d
+  data.tar.gz: cbd32bd140fca377d4da0d05616234a51e9b4765fcb90b4d0f09c6b965dc4320
 SHA512:
-  metadata.gz: 7d5440ea9762219b3b382515bd463dacbc83e14be779a1d01b962906cba942302d2dfed6de6d240052ab53f7da194fe19a0f5042b9ba021dda2e9f9ea70baed9
-  data.tar.gz: 8c9be79cb72d748708cdda5c60b3341c2043053a9221665763d2fea5663274e3f88b365262ae51bfd66af62ec415d47769069b90f29b9a59d3ac7ca8f319557e
+  metadata.gz: 6188bd3df216a12c1d075f47005362f47519f0214355b87af6bae097f232048aed91901dff69635120d7b010d042f5d368f31bd5f4be6c0dc01c59a248219095
+  data.tar.gz: 55a65329ca48a57857a0db29c9ea9967fa909e65f2cd4f69d95e47f7bf87cdeb6b1523756fe91cb0cb1b2a57bac6e8ed7d8b0eff7062f9eca64fd9d146f82ffa

data/README.md

@@ -12,11 +12,19 @@ This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To ge
 fastlane add_plugin appicon
 ```
 
-Please note that this plugin uses the GraphicsMagick library. If you do not have it, you can install it via Homebrew:
+
+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
 
@@ -30,7 +38,9 @@ Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plu
 
 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
+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
@@ -59,6 +69,11 @@ lane :test3 do
   )
 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',
@@ -68,6 +83,15 @@ lane :splash_screen do
   )
 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
@@ -115,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

@@ -42,6 +42,9 @@ module Fastlane
       end
 
       def self.run(params)
+
+        Helper::AppiconHelper.set_cli(params[:minimagick_cli])
+
         fname = params[:appicon_image_file]
         custom_sizes = params[:appicon_custom_sizes]
 
@@ -49,7 +52,7 @@ module Fastlane
         icons.each do |icon|
           image = MiniMagick::Image.open(fname)
 
-          Helper::AppiconHelper.check_input_image_size(image, 1024)
+          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')
@@ -169,7 +172,16 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :generate_rounded,
                                description: "Generate round icons?",
                              default_value: false,
-                                      type: Boolean)
+                                      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

@@ -38,6 +38,29 @@ module Fastlane
           },
           :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
@@ -45,11 +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]))
 
+        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'
@@ -65,7 +96,7 @@ module Fastlane
 
         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']
@@ -76,7 +107,8 @@ module Fastlane
           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.
@@ -90,6 +122,18 @@ module Fastlane
             '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
@@ -146,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 = {})

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

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appicon
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Boris Bügling
 - Felix Krause
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -129,7 +129,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.95.0
-description: 
+description:
 email: boris@icculus.org
 executables: []
 extensions: []
@@ -146,7 +146,7 @@ homepage: https://github.com/fastlane-community/fastlane-plugin-appicon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-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: []