ios_icon_generator 0.1

data/lib/ios_icon_generator/cli/commands/version.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Fueled Digital Media, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'hanami/cli'
+
+module IOSIconGenerator
+  module CLI
+    module Commands
+      class Version < Hanami::CLI::Command
+        desc 'Print version'
+        def call(*)
+          puts IOSIconGenerator::VERSION
+        end
+      end
+
+      register 'version', Version, aliases: ['v', '-v', '--version']
+    end
+  end
+end

data/lib/ios_icon_generator/helpers/generate_icon.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Fueled Digital Media, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require 'fileutils'
+require 'ios_icon_generator/helpers/images_sets_definition'
+
+module IOSIconGenerator
+  module Helpers
+    def self.generate_icon(icon_path:, output_folder:, types:, parallel_processes: nil, generate_icon: nil, progress: nil)
+      if icon_path
+        matches = /(\d+)x(\d+)/.match(`magick identify "#{icon_path}"`)
+        raise 'There is no icon at the path specified.' unless File.exist?(icon_path)
+
+        raise 'The icon specified must be .pdf.' if File.extname(icon_path) != '.pdf'
+
+        raise 'Unable to verify icon. Please make sure it\'s a valid pdf file and try again.' if matches.nil?
+
+        width, height = matches.captures
+        raise 'Invalid pdf specified.' if width.nil? || height.nil?
+
+        raise "The icon must at least be 1024x1024, it currently is #{width}x#{height}." unless width.to_i >= 1024 && height.to_i >= 1024
+      end
+      appiconset_path = File.join(output_folder, "#{types.include?(:imessage) ? 'iMessage App Icon' : 'AppIcon'}.#{types.include?(:imessage) ? 'stickersiconset' : 'appiconset'}")
+
+      FileUtils.mkdir_p(appiconset_path)
+
+      get_icon_path = lambda { |width, height|
+        return File.join(appiconset_path, "Icon-#{width.to_i}x#{height.to_i}.png")
+      }
+
+      generate_icon ||= lambda { |base_path, target_path, width, height|
+        size = [width, height].max
+        system(
+          'magick',
+          'convert',
+          '-density',
+          '400',
+          base_path,
+          '-colorspace',
+          'sRGB',
+          '-type',
+          'truecolor',
+          '-resize', "#{size}x#{size}",
+          '-gravity',
+          'center',
+          '-crop',
+          "#{width}x#{height}+0+0",
+          '+repage',
+          target_path
+        )
+      }
+
+      types.each do |type1|
+        types.each do |type2|
+          raise "Incompatible types used together: #{type1} and #{type2}. These types cannot be added to the same sets; please call the command twice with each different type." if Helpers.type_incompatible?(type1, type2)
+        end
+      end
+
+      images_sets = Helpers.images_sets(types)
+
+      smaller_sizes = []
+      images_sets.each do |image|
+        width, height = /(\d+(?:\.\d)?)x(\d+(?:\.\d)?)/.match(image['size'])&.captures
+        scale, = /(\d+(?:\.\d)?)x/.match(image['scale'])&.captures
+        raise "Invalid size parameter in Contents.json: #{image['size']}" if width.nil? || height.nil? || scale.nil?
+
+        scale = scale.to_f
+        width = width.to_f * scale
+        height = height.to_f * scale
+
+        target_path = get_icon_path.call(width, height)
+        image['filename'] = File.basename(target_path)
+        if width > 512 || height > 512
+          generate_icon.call(
+            icon_path,
+            target_path,
+            width,
+            height
+          )
+        else
+          smaller_sizes << [width, height]
+        end
+      end
+
+      total = smaller_sizes.count + 2
+      progress&.call(nil, total)
+
+      max_size = smaller_sizes.flatten.max
+      temp_icon_path = File.join(output_folder, '.temp_icon.pdf')
+      begin
+        system('magick', 'convert', '-density', '400', icon_path, '-colorspace', 'sRGB', '-type', 'truecolor', '-scale', "#{max_size}x#{max_size}", temp_icon_path) if icon_path
+        progress&.call(1, total)
+        Parallel.each(
+          smaller_sizes,
+          in_processes: parallel_processes,
+          finish: lambda do |_item, i, _result|
+            progress&.call(i + 1, total)
+          end
+        ) do |width, height|
+          generate_icon.call(
+            temp_icon_path,
+            get_icon_path.call(width, height),
+            width,
+            height
+          )
+        end
+      ensure
+        FileUtils.rm(temp_icon_path) if File.exist?(temp_icon_path)
+      end
+
+      contents_json = {
+        images: images_sets,
+        info: {
+          version: 1,
+          author: 'xcode',
+        },
+      }
+
+      File.write(File.join(appiconset_path, 'Contents.json'), JSON.generate(contents_json))
+
+      progress&.call(total - 1, total)
+    end
+  end
+end

data/lib/ios_icon_generator/helpers/images_sets_definition.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Fueled Digital Media, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+
+module IOSIconGenerator
+  module Helpers
+    def self.images_sets(types)
+      types.flat_map do |type|
+        contents_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../vendor/Contents-#{type}.json"))
+        raise "Unknown type #{type}" unless File.exist?(contents_path)
+
+        contents_json = JSON.parse(File.read(contents_path))
+        contents_json['images']
+      end
+    end
+
+    def self.type_incompatible?(lhs, rhs)
+      (lhs == :imessage && rhs != :imessage || lhs != :imessage && rhs == :imessage)
+    end
+  end
+end

data/lib/ios_icon_generator/helpers/mask_icon.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Fueled Digital Media, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require 'base64'
+require 'fileutils'
+
+module IOSIconGenerator
+  module Helpers
+    def self.mask_icon(
+      appiconset_path:,
+      output_folder:,
+      mask: {
+        background_color: '#FFFFFF',
+        stroke_color: '#000000',
+        stroke_width_offset: 0.1,
+        suffix: 'Beta',
+        symbol: 'b',
+        symbol_color: '#7F0000',
+        font: 'Helvetica',
+        x_size_ratio: 0.5478515625,
+        y_size_ratio: 0.5478515625,
+        size_offset: 0.0,
+        x_offset: 0.0,
+        y_offset: 0.0,
+        shape: 'triangle',
+      },
+      parallel_processes: nil,
+      progress: nil
+    )
+      extension = File.extname(appiconset_path)
+      output_folder = File.join(output_folder, "#{File.basename(appiconset_path, extension)}-#{mask[:suffix]}#{extension}")
+
+      FileUtils.mkdir_p(output_folder)
+
+      contents_path = File.join(appiconset_path, 'Contents.json')
+      raise "Contents.json file not found in #{appiconset_path}" unless File.exist?(contents_path)
+
+      json_content = JSON.parse(File.read(contents_path))
+      progress&.call(nil, json_content['images'].count)
+      Parallel.each(
+        json_content['images'],
+        in_processes: parallel_processes,
+        finish: lambda do |_item, i, _result|
+          progress&.call(i, json_content['images'].count)
+        end
+      ) do |image|
+        width, height = /(\d+(?:\.\d)?)x(\d+(?:\.\d)?)/.match(image['size'])&.captures
+        scale, = /(\d+(?:\.\d)?)x/.match(image['scale'])&.captures
+        raise "Invalid size parameter in Contents.json: #{image['size']}" if width.nil? || height.nil? || scale.nil?
+
+        scale = scale.to_f
+        width = width.to_f * scale
+        height = height.to_f * scale
+
+        mask_size_width = width * mask[:x_size_ratio].to_f
+        mask_size_height = height * mask[:y_size_ratio].to_f
+
+        extension = File.extname(image['filename'])
+        icon_output = "#{File.basename(image['filename'], extension)}-#{mask[:suffix]}#{extension}"
+        icon_output_path = File.join(output_folder, icon_output)
+
+        draw_shape_parameters = "-strokewidth '#{(mask[:stroke_width_offset] || 0) * [width, height].min}' -stroke '#{mask[:stroke_width_offset].zero? ? 'none' : (mask[:stroke_color] || '#000000')}' -fill '#{mask[:background_color] || '#FFFFFF'}'"
+        draw_shape =
+          case mask[:shape]
+          when :triangle
+            "-draw \"polyline 0,#{mask_size_height} 0,#{height} #{width - mask_size_width},#{height}\""
+          when :square
+            "-draw \"rectangle -#{width},#{height * 2.0} #{mask_size_height},#{width - mask_size_width}\""
+          else
+            raise "Unknown mask shape: #{mask[:shape]}"
+          end
+
+        draw_symbol =
+          if mask[:file]
+            "\\( -background none -density 1536 -resize #{width * mask[:size_offset]}x#{height} \"#{mask[:file]}\" -geometry +#{width * mask[:x_offset]}+#{height * mask[:y_offset]} \\) -gravity southwest -composite"
+          else
+            "-strokewidth 0 -stroke none -fill '#{mask[:symbol_color] || '#7F0000'}' -font '#{mask[:font]}' -pointsize #{height * mask[:size_offset] * 2.0} -annotate +#{width * mask[:x_offset]}+#{height - height * mask[:y_offset]} '#{mask[:symbol]}'"
+          end
+        system("convert '#{File.join(appiconset_path, image['filename'])}' #{draw_shape_parameters} #{draw_shape} #{draw_symbol} '#{icon_output_path}'")
+
+        image['filename'] = icon_output
+      end
+
+      File.write(File.join(output_folder, 'Contents.json'), JSON.generate(json_content))
+    end
+  end
+end

data/lib/ios_icon_generator/helpers/which.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Fueled Digital Media, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module IOSIconGenerator
+  module Library
+    ##
+    # Cross-platform way of finding an executable in the +$PATH+.
+    #
+    # From http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+    #
+    # == Parameters:
+    # +cmd+::
+    #   The name of the command to search the path for.
+    #
+    # == Returns:
+    # The full path to the command if found, and +nil+ otherwise.
+    def self.which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/ios_icon_generator/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Fueled Digital Media, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module IOSIconGenerator
+  VERSION = '0.1'
+end

data/vendor/Contents-carplay.json

@@ -0,0 +1,18 @@
+{
+  "images" : [
+    {
+      "size" : "60x60",
+      "idiom" : "car",
+      "scale" : "2x"
+    },
+    {
+      "size" : "60x60",
+      "idiom" : "car",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}

data/vendor/Contents-imessage.json

@@ -0,0 +1,78 @@
+{
+  "images" : [
+    {
+      "size" : "29x29",
+      "idiom" : "iphone",
+      "scale" : "2x"
+    },
+    {
+      "size" : "29x29",
+      "idiom" : "iphone",
+      "scale" : "3x"
+    },
+    {
+      "size" : "60x45",
+      "idiom" : "iphone",
+      "scale" : "2x"
+    },
+    {
+      "size" : "60x45",
+      "idiom" : "iphone",
+      "scale" : "3x"
+    },
+    {
+      "size" : "29x29",
+      "idiom" : "ipad",
+      "scale" : "2x"
+    },
+    {
+      "size" : "67x50",
+      "idiom" : "ipad",
+      "scale" : "2x"
+    },
+    {
+      "size" : "74x55",
+      "idiom" : "ipad",
+      "scale" : "2x"
+    },
+    {
+      "size" : "1024x1024",
+      "idiom" : "ios-marketing",
+      "scale" : "1x"
+    },
+    {
+      "size" : "27x20",
+      "idiom" : "universal",
+      "scale" : "2x",
+      "platform" : "ios"
+    },
+    {
+      "size" : "27x20",
+      "idiom" : "universal",
+      "scale" : "3x",
+      "platform" : "ios"
+    },
+    {
+      "size" : "32x24",
+      "idiom" : "universal",
+      "scale" : "2x",
+      "platform" : "ios"
+    },
+    {
+      "size" : "32x24",
+      "idiom" : "universal",
+      "scale" : "3x",
+      "platform" : "ios"
+    },
+    {
+      "size" : "1024x768",
+      "idiom" : "ios-marketing",
+      "scale" : "1x",
+      "platform" : "ios"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}