ios_icon_generator 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f852400e4c7991cb98356bac374aaf2b94c47af
-  data.tar.gz: d0d52e7ba57b37506f51412a54a1868f9709561f
+  metadata.gz: 0b46b6ba358fea7257956c5b604814fab0e6357d
+  data.tar.gz: ff34cdecebb146b1a0bd77785a42128181587d44
 SHA512:
-  metadata.gz: 485b9f3d19409c684ffa7062dc3a81ba0aa25331dc20475dc3aa6ecdb09393379c7c997ff2fed94cc9240b5a058607ed74c036b1343710b26ef9496abb5482b8
-  data.tar.gz: ab152df1fe540e28a284c45be891cf67c9e9c9113f5b3381773799e6ae69ff680483d160bf17b3aff39d26af4467a7153a30fdb07217e2be64b969fa4a608120
+  metadata.gz: 4ee3aa9f28014df742b90153ab9920f47d92c0f5eefbb90ff33a27e13a5774feed4a769c8ec17e67ab58487ca52096b8546479c2ce3a2184a19688b4c4527782
+  data.tar.gz: 592077858ad24fff1f632c2aab47022f55e86d9ec97e660021f8be11d60af33811aafd95d7dd55e773afc2971f9d834bedb227e648cce71d43b6b1e224221ae2

data/.yardopts

@@ -0,0 +1,4 @@
+--output-dir docs
+--readme README.md
+--no-private
+lib/ios_icon_generator/version.rb lib/ios_icon_generator.rb lib/ios_icon_generator/helpers/**/*.rb

data/README.md

@@ -33,7 +33,7 @@ For now, the CLI supports generating app icon sets for all supported platforms:
 - Mac
 - Carplay
 
-> Please note that the Display P3 is not supported yet
+> Please note that the Display P3 color space is not supported yet
 
 And supports generating sticker packs icons for iMessage apps.
 

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

@@ -33,7 +33,7 @@ module IOSIconGenerator
         option :parallel_processes, type: :integer, default: -1, desc: 'Number of processes to use to process the files. Defaults to -1, meaning the number of cores the machine. \
           Set to 0 to disable parallel processing.'
         def call(icon_path:, xcasset_folder:, type:, **options)
-          raise "#{'ImageMagick'.blue.bold} is required. It can be installed via #{'homebrew'.bold.underlined} using #{'brew install imagemagick'.blue.bold.underlined}" unless Library.which('magick')
+          raise "#{'ImageMagick'.blue.bold} is required. It can be installed via #{'homebrew'.bold.underlined} using #{'brew install imagemagick'.blue.bold.underlined}" unless Helpers.which('magick')
 
           types = type.map(&:to_sym)
 

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

@@ -39,8 +39,8 @@ module IOSIconGenerator
           option :symbol_color, default: '#7F0000', desc: 'The color of the symbol to use to generate the mask.'
           option :font, default: 'Helvetica', desc: 'The font to use to generate the symbol.'
           option :file, default: nil, desc: 'The path to an image representing the symbol to use to generate the mask.'
-          option :x_size_ratio, type: :float, default: 0.46, desc: 'The x offset of the size of the mask.'
-          option :y_size_ratio, type: :float, default: 0.46, desc: 'The y offset of the size of the mask.'
+          option :x_size_ratio, type: :float, default: 0.54, desc: 'The x offset of the size of the mask.'
+          option :y_size_ratio, type: :float, default: 0.54, desc: 'The y offset of the size of the mask.'
           option :size_offset, type: :float, default: 0.12, desc: 'The size offset to use when applying the symbol. 0.0 means it\'s scale to the full image, 1.0 means the symbol has the full size of the logo.'
           option :x_offset, type: :float, default: 0.11, desc: 'The x offset to use when applying the symbol. 0.0 means bottom, 1.0 means top.'
           option :y_offset, type: :float, default: 0.11, desc: 'The y offset to use when applying the symbol. 0.0 means left, 1.0 means top.'
@@ -48,7 +48,7 @@ module IOSIconGenerator
           option :parallel_processes, type: :integer, default: -1, desc: 'Number of processes to use to process the files. Defaults to -1, meaning the number of cores the machine. \
             Set to 0 to disable parallel processing.'
           def call(appiconset_path:, output_path:, **options)
-            raise "#{'ImageMagick'.blue.bold} is required. It can be installed via #{'homebrew'.bold.underlined} using #{'brew install imagemagick'.blue.bold.underlined}" unless Library.which('magick')
+            raise "#{'ImageMagick'.blue.bold} is required. It can be installed via #{'homebrew'.bold.underlined} using #{'brew install imagemagick'.blue.bold.underlined}" unless Helpers.which('magick')
 
             raise 'There is no App icon set at the path specified.' unless Dir.exist?(appiconset_path)
 

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

@@ -34,15 +34,15 @@ module IOSIconGenerator
         option :font, default: 'Helvetica', desc: 'The font to use to generate the symbol.'
         option :symbol_color, default: '#7F0000', desc: 'The color of the symbol to use to generate the mask.'
         option :stroke_color, default: '#000000', desc: 'The stroke color of the mask'
-        option :stroke_width_offset, type: :float, default: 0.1, desc: 'The width of the stroke used when generating the symbol.'
+        option :stroke_width_offset, type: :float, default: 0.0, desc: 'The width of the stroke used when generating the symbol.'
         option :size_offset, type: :float, default: 0.5, desc: 'The point size used for the symbol, relative to the height of the icon. Values over 0.5 are not recommended.'
         option :x_offset, type: :float, default: 0.0, desc: 'The x offset to use when applying the symbol. 0.0 means bottom, 1.0 means top.'
-        option :y_offset, type: :float, default: 0.0, desc: 'The y offset to use when applying the symbol. 0.0 means left, 1.0 means top.'
+        option :y_offset, type: :float, default: -0.05, desc: 'The y offset to use when applying the symbol. 0.0 means left, 1.0 means top.'
         option :type, type: :array, default: %w[iphone], desc: 'Which target to generate the icons for. Can be "iphone", "ipad", "watch", "mac" or "carplay" or a combination of any of them, or "imessage"'
         option :parallel_processes, type: :integer, default: -1, desc: 'Number of processes to use to process the files. Defaults to -1, meaning the number of cores the machine. \
           Set to 0 to disable parallel processing.'
         def call(text:, xcasset_folder:, type:, **options)
-          raise "#{'ImageMagick'.blue.bold} is required. It can be installed via #{'homebrew'.bold.underlined} using #{'brew install imagemagick'.blue.bold.underlined}" unless Library.which('magick')
+          raise "#{'ImageMagick'.blue.bold} is required. It can be installed via #{'homebrew'.bold.underlined} using #{'brew install imagemagick'.blue.bold.underlined}" unless Helpers.which('magick')
 
           types = type.map(&:to_sym)
 

data/lib/ios_icon_generator/helpers/generate_icon.rb

@@ -16,23 +16,51 @@
 
 require 'json'
 require 'fileutils'
-require 'ios_icon_generator/helpers/images_sets_definition'
+require 'ios_icon_generator/helpers/image_sets_definition'
 
 module IOSIconGenerator
   module Helpers
+    ##
+    # Generate an icon using the base icon provided.
+    #
+    # If +icon_path+ is set to +nil+, the function expects +generate_icon+ to be set or the function will raise.
+    #
+    # @param [String, #read] icon_path The path to the icon to use as the base icon.
+    #        If specified, it must point to a valid pdf file (with a .pdf extension), with a resolution over 1024x1024.
+    #        If not specified, +generate_icon+ must be specified.
+    # @param [String, #read] output_folder The folder to create the app icon set in.
+    # @param [Array<Symbol>, #read] types The types to generate the sets of images for. Each type must be one of +:iphone+, +:ipad+, +:watch+, +mac+ or +carplay+, or it can be an array of just +:imessage+.
+    # @param [Symbol, #read] parallel_processes The number of processes to use when generating the icons.
+    #        +nil+ means it'll use as many processes as they are cores on the machine.
+    #        +0+ will disables spawning any processes.
+    # @param [Lambda(base_path [String], target_path [String], width [Float], height [Float]), #read] generate_icon The lambda that actually generates the icon.
+    #        If none is specified, and default one will be used.
+    #        It should take four parameters:
+    #        - +base_path+: The base path to the reference image to use to generate the new icon. If +icon_path+ is set to +nil+, the +base_path+ parameter will +nil+ as well.
+    #        - +target_path+: The path to generate the icon at.
+    #        - +width+: The width of the icon to generate.
+    #        - +height+: The height of the icon to generate.
+    # @param [Lambda(progress [Int], total [Int]), #read] progress An optional progress block called when progress has been made generating the icons.
+    #        It should take two parameters:
+    #        - +progress+: An integer indicating the current progress out of +total+
+    #        - +total+: An integer indicating the total progress
+    #
+    # @return [String] Return the path to the generated app icon set.
     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'
 
+        matches = /(\d+)x(\d+)/.match(`magick identify "#{icon_path}"`)
         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
+      elsif generate_icon.nil?
+        raise 'icon_path has been set to nil, generate_icon must be specified'
       end
       appiconset_path = File.join(output_folder, "#{types.include?(:imessage) ? 'iMessage App Icon' : 'AppIcon'}.#{types.include?(:imessage) ? 'stickersiconset' : 'appiconset'}")
 
@@ -70,7 +98,7 @@ module IOSIconGenerator
         end
       end
 
-      images_sets = Helpers.images_sets(types)
+      images_sets = Helpers.image_sets(types)
 
       smaller_sizes = []
       images_sets.each do |image|
@@ -130,9 +158,11 @@ module IOSIconGenerator
         },
       }
 
-      File.write(File.join(appiconset_path, 'Contents.json'), JSON.generate(contents_json))
+      File.write(File.join(appiconset_path, 'Contents.json'), JSON.pretty_generate(contents_json))
 
       progress&.call(total - 1, total)
+
+      appiconset_path
     end
   end
 end

data/lib/ios_icon_generator/helpers/{images_sets_definition.rb → image_sets_definition.rb}

@@ -18,7 +18,15 @@ require 'json'
 
 module IOSIconGenerator
   module Helpers
-    def self.images_sets(types)
+    ##
+    # Get the image sets for the given types.
+    #
+    # @param [Symbol, #read] types The types to return the sets of image for.
+    #        This method won't fail if the types aren't compatible as defined by +type_incompatible?+
+    #
+    # @return [Array<Hash<String, String>>] The sets of image for the given types.
+    #         Each hash will at least contain a +size+ [String] key, that has the format +<width>x<height>+
+    def self.image_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)
@@ -28,8 +36,15 @@ module IOSIconGenerator
       end
     end
 
+    ##
+    # Check if the given types are compatible (if they can be used in the same set)
+    #
+    # @param [Symbol, #read] lhs The first type to check against the second type.
+    # @param [Symbol, #read] rhs The second type to check against the first type.
+    #
+    # @return [Boolean] +true+ if the given are compatible together, +false+ otherwise
     def self.type_incompatible?(lhs, rhs)
-      (lhs == :imessage && rhs != :imessage || lhs != :imessage && rhs == :imessage)
+      (lhs == :imessage && rhs != :imessage) || (lhs != :imessage && rhs == :imessage)
     end
   end
 end

data/lib/ios_icon_generator/helpers/mask_icon.rb

@@ -20,6 +20,39 @@ require 'fileutils'
 
 module IOSIconGenerator
   module Helpers
+    ##
+    # Mask an icon using the parameters provided.
+    #
+    # The mask is for now always generated in the bottom left corner of the image.
+    #
+    # @param [String, #read] appiconset_path The path of the original app icon set to use to generate the new one.
+    # @param [String, #read] output_folder The folder to create the new app icon set in.
+    # @param [Hash<String, Object>, #read] mask A hash representing parameters for creating the mask.
+    #        The Hash may contain the following values:
+    #        - +background_color+: The background color to use when generating the mask
+    #        - +stroke_color+: The stroke color to use when generating the mask. Used for the outline of the mask.
+    #        - +stroke_width_offset+: The stroke width of the mask, offset to the image's minimum dimension (width or height).
+    #          1.0 means the stroke will have the full width/height of the image
+    #        - +suffix+: The suffix to use when generating the new mask
+    #        - +file+: The file to use when generating the new mask. This file should be an image, and it will be overlayed over the background.
+    #        - +symbol+: The symbol to use when generating the new mask
+    #        - +symbol_color+: The color to use for the symbol
+    #        - +font+: The font to use for the symbol
+    #        - +x_size_ratio+: The size ratio (of the width of the image) to use when generating the mask. 1.0 means the full width, 0.5 means half-width.
+    #        - +y_size_ratio+: The size ratio (of the height of the image) to use when generating the mask. 1.0 means the full height, 0.5 means half-height.
+    #        - +size_offset+: The size ratio (of the width and height) to use when generating the symbol or file. 1.0 means the full width and height, 0.5 means half-width and half-height.
+    #        - +x_offset+: The X offset (of the width of the image) to use when generating the symbol or file. 1.0 means the full width, 0.5 means half-width.
+    #        - +y_offset+: The Y offset (of the width of the image) to use when generating the symbol or file. 1.0 means the full height, 0.5 means half-height.
+    #        - +shape+: The shape to use when generating the mask. Can be either +:triangle+ or +:square+.
+    # @param [Symbol, #read] parallel_processes The number of processes to use when generating the icons.
+    #        +nil+ means it'll use as many processes as they are cores on the machine.
+    #        +0+ will disables spawning any processes.
+    # @param [Lambda(progress [Int], total [Int]), #read] progress An optional progress block called when progress has been made generating the icons.
+    #        It should take two parameters:
+    #        - +progress+: An integer indicating the current progress out of +total+
+    #        - +total+: An integer indicating the total progress
+    #
+    # @return [String] Return the path to the generated app icon set.
     def self.mask_icon(
       appiconset_path:,
       output_folder:,
@@ -31,8 +64,8 @@ module IOSIconGenerator
         symbol: 'b',
         symbol_color: '#7F0000',
         font: 'Helvetica',
-        x_size_ratio: 0.5478515625,
-        y_size_ratio: 0.5478515625,
+        x_size_ratio: 0.54,
+        y_size_ratio: 0.54,
         size_offset: 0.0,
         x_offset: 0.0,
         y_offset: 0.0,
@@ -54,7 +87,8 @@ module IOSIconGenerator
       Parallel.each(
         json_content['images'],
         in_processes: parallel_processes,
-        finish: lambda do |_item, i, _result|
+        finish: lambda do |_item, i, result|
+          json_content['images'][i]['filename'] = result
           progress&.call(i, json_content['images'].count)
         end
       ) do |image|
@@ -73,11 +107,13 @@ module IOSIconGenerator
         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_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}\""
+            "-draw \"polyline -#{width},#{height - mask_size_height} 0,#{height - mask_size_height} #{mask_size_width},#{height} #{mask_size_width},#{height * 2.0} -#{width},#{height * 2.0}\""
           when :square
             "-draw \"rectangle -#{width},#{height * 2.0} #{mask_size_height},#{width - mask_size_width}\""
           else
@@ -86,16 +122,29 @@ module IOSIconGenerator
 
         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"
+            "\\( -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]}'"
+            "-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
+        next icon_output
       end
 
-      File.write(File.join(output_folder, 'Contents.json'), JSON.generate(json_content))
+      File.write(File.join(output_folder, 'Contents.json'), JSON.pretty_generate(json_content))
+
+      output_folder
     end
   end
 end

data/lib/ios_icon_generator/helpers/which.rb

@@ -15,18 +15,15 @@
 # limitations under the License.
 
 module IOSIconGenerator
-  module Library
+  module Helpers
     ##
     # 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.
+    # @param cmd [String] The name of the command to search the path for.
     #
-    # == Returns:
-    # The full path to the command if found, and +nil+ otherwise.
+    # @return [String] 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|

data/lib/ios_icon_generator/version.rb

@@ -15,5 +15,8 @@
 # limitations under the License.
 
 module IOSIconGenerator
-  VERSION = '0.1'
+  ##
+  # The current version of the gem.
+  #
+  VERSION = '0.1.1'
 end

data/lib/ios_icon_generator.rb

@@ -21,8 +21,10 @@ require 'hanami/cli'
 
 # The IOSIconGenerator module
 module IOSIconGenerator
+  # @private
   # :nodoc:
   module CLI
+    # @private
     # :nodoc:
     module Commands
       extend Hanami::CLI::Registry
@@ -38,3 +40,4 @@ end
 require 'ios_icon_generator/cli/commands/generate'
 require 'ios_icon_generator/cli/commands/mask'
 require 'ios_icon_generator/cli/commands/stub'
+require 'ios_icon_generator/cli/commands/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ios_icon_generator
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Stéphane Copin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -200,6 +200,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE
 - README.md
 - bin/icongen
@@ -209,7 +210,7 @@ files:
 - lib/ios_icon_generator/cli/commands/stub.rb
 - lib/ios_icon_generator/cli/commands/version.rb
 - lib/ios_icon_generator/helpers/generate_icon.rb
-- lib/ios_icon_generator/helpers/images_sets_definition.rb
+- lib/ios_icon_generator/helpers/image_sets_definition.rb
 - lib/ios_icon_generator/helpers/mask_icon.rb
 - lib/ios_icon_generator/helpers/which.rb
 - lib/ios_icon_generator/version.rb
@@ -222,7 +223,8 @@ files:
 homepage: https://github.com/Fueled/ios-icon-generator
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths: