ios-icon-generator
+iOS Icon Generator
-A terminal tool that allows to generate an icon based from a 1024x1024 PDF file.
+
+
+
Usage
+ +The CLI currently supports 2 commands:
+ +-
+
generate: generates an iOS App Icon Set from a base PDF
+mask: generates a new iOS App Icon Sets from a base one, adding a mask at its bottom left which can be customized.
+stub: generates a default iOS App Icon Sets, using a background color, a text and its color.
+
Installation
+ +iOS Icon Generator is built using Ruby, and can be installed using its default local installation in your terminal via:
+ +sudo gem install ios_icon_generator
+If you wish not to use sudo permissions to RubyGems, you can follow the instructions of the CocoaPods guys here, by replacing all cocoapods with ios_icon_generator in the shell commands.
Generate App Icon Sets
+ +For now, the CLI supports generating app icon sets for all supported platforms:
+ +-
+
- iPhone +
- iPad +
- Apple Watch +
- Mac +
- Carplay +
++ +Please note that the Display P3 color space is not supported yet
+
And supports generating sticker packs icons for iMessage apps.
+ +You can specify iPhone and iPad at the same time, however iMessage must be specified on its own.
+ +The base syntax of the command is:
+ +icongen generate <PDF Base Icon> [XCAsset Folder] --type=<type>
+If the XCAsset Folder is not specified, then the current working is assumed to be the output folder.
+The type, if not specified, defaults to iphone.
For example, to generate icons for iPhones and iPads, and output the images set in Images.xcassets, run (assuming the path Icon PDF file is also in the current directory and is called Icon.pdf):
icongen generate Icon.pdf Images.xcassets --type=iphone,ipad
+There are more options to icongen generate which you can discover by running icongen generate --help.
Masking Existing App Icon Sets
+ +The application also supports "masking" app icons, adding a small mask at the bottom-left corner of the icons, allowing for example to convert the following icons:
+
+Into this:
+
The command used in the example was (it assumes that AppIcon.appiconset is the original App Icon Set and is in the current working directory):
icongen mask AppIcon.appiconset \
+ --mask-shape=square \
+ --x-size-ratio=0.30 \
+ --y-size-ratio=0.30 \
+ --size-offset=0.11 \
+ --x-offset=0.1 \
+ --y-offset=0.1 \
+ --background-color='#A36AE9' \
+ --stroke-width-offset=0 \
+ --font=Symbol \
+ --symbol-color='#FFFFFF'
+For now, the command only supports adding a mask into the bottom-left corner, but allowing to add it anywhere is definitely a feature we want.
+ +The command supports a lot of customization through options, and you can find more information about each option by typing icongen mask --help
Creating temporary icons
+ +The application also supports creating "temporary" icons, that you would use during development if you don't have an icon yet (for example at project creation). For example, here are some icons created using various commands:
+ +
Here's the command that were run to get each icons above:
+ +#1
+icongen stub \
+ WS \
+ --background-color='#A36AE9' \
+ --stroke-width-offset=0 \
+ --y-offset=-0.04 \
+ --size-offset=0.5 \
+ --symbol-color='#FFFFFF'
+#2
+icongen stub \
+ W \
+ --background-color='#3A7D31' \
+ --font=Symbol \
+ --stroke-width-offset=0.01 \
+ --y-offset=-0.07 \
+ --size-offset=0.5 \
+ --symbol-color='#C9C9C9'
+#3
+icongen stub \
+ A \
+ --background-color='#000000' \
+ --stroke-width-offset=0.01 \
+ --stroke-color='#FFFFFF' \
+ --font='Arial' \
+ --size-offset=0.5 \
+ --symbol-color='#000000'
+The command supports a lot of customization through options, and you can find more information about each option by typing icongen stub --help.
Development
+ +Set Up
+ +To set you up for developing on driveshaft, first make sure the repository is cloned and you're in its root folder, and then run the following:
+ +echo "BUNDLE_GEMFILE=\"`pwd`/Gemfile\" bundler exec ruby \"`pwd`/bin/icongen\" \"\${@---help}\"" > /usr/local/bin/icongen-dev
+chmod +x /usr/local/bin/icongen-dev
+All you'll be all set!
+To run the development version of icongen from anywhere, just run icongen-dev rather than icongen.
+You can then proceed on developing locally on the ios-icon-generator repository, and create a PR whenever a new piece of code is ready to be reviewed and integrated!
To run the test suite, you may run the following command from the root folder:
+ +bundler exec ruby bin/rspec -I .
+ios-icon-generator
+iOS Icon Generator
-A terminal tool that allows to generate an icon based from a 1024x1024 PDF file.
+
+
+
Usage
+ +The CLI currently supports 2 commands:
+ +-
+
generate: generates an iOS App Icon Set from a base PDF
+mask: generates a new iOS App Icon Sets from a base one, adding a mask at its bottom left which can be customized.
+stub: generates a default iOS App Icon Sets, using a background color, a text and its color.
+
Installation
+ +iOS Icon Generator is built using Ruby, and can be installed using its default local installation in your terminal via:
+ +sudo gem install ios_icon_generator
+If you wish not to use sudo permissions to RubyGems, you can follow the instructions of the CocoaPods guys here, by replacing all cocoapods with ios_icon_generator in the shell commands.
Generate App Icon Sets
+ +For now, the CLI supports generating app icon sets for all supported platforms:
+ +-
+
- iPhone +
- iPad +
- Apple Watch +
- Mac +
- Carplay +
++ +Please note that the Display P3 color space is not supported yet
+
And supports generating sticker packs icons for iMessage apps.
+ +You can specify iPhone and iPad at the same time, however iMessage must be specified on its own.
+ +The base syntax of the command is:
+ +icongen generate <PDF Base Icon> [XCAsset Folder] --type=<type>
+If the XCAsset Folder is not specified, then the current working is assumed to be the output folder.
+The type, if not specified, defaults to iphone.
For example, to generate icons for iPhones and iPads, and output the images set in Images.xcassets, run (assuming the path Icon PDF file is also in the current directory and is called Icon.pdf):
icongen generate Icon.pdf Images.xcassets --type=iphone,ipad
+There are more options to icongen generate which you can discover by running icongen generate --help.
Masking Existing App Icon Sets
+ +The application also supports "masking" app icons, adding a small mask at the bottom-left corner of the icons, allowing for example to convert the following icons:
+
+Into this:
+
The command used in the example was (it assumes that AppIcon.appiconset is the original App Icon Set and is in the current working directory):
icongen mask AppIcon.appiconset \
+ --mask-shape=square \
+ --x-size-ratio=0.30 \
+ --y-size-ratio=0.30 \
+ --size-offset=0.11 \
+ --x-offset=0.1 \
+ --y-offset=0.1 \
+ --background-color='#A36AE9' \
+ --stroke-width-offset=0 \
+ --font=Symbol \
+ --symbol-color='#FFFFFF'
+For now, the command only supports adding a mask into the bottom-left corner, but allowing to add it anywhere is definitely a feature we want.
+ +The command supports a lot of customization through options, and you can find more information about each option by typing icongen mask --help
Creating temporary icons
+ +The application also supports creating "temporary" icons, that you would use during development if you don't have an icon yet (for example at project creation). For example, here are some icons created using various commands:
+ +
Here's the command that were run to get each icons above:
+ +#1
+icongen stub \
+ WS \
+ --background-color='#A36AE9' \
+ --stroke-width-offset=0 \
+ --y-offset=-0.04 \
+ --size-offset=0.5 \
+ --symbol-color='#FFFFFF'
+#2
+icongen stub \
+ W \
+ --background-color='#3A7D31' \
+ --font=Symbol \
+ --stroke-width-offset=0.01 \
+ --y-offset=-0.07 \
+ --size-offset=0.5 \
+ --symbol-color='#C9C9C9'
+#3
+icongen stub \
+ A \
+ --background-color='#000000' \
+ --stroke-width-offset=0.01 \
+ --stroke-color='#FFFFFF' \
+ --font='Arial' \
+ --size-offset=0.5 \
+ --symbol-color='#000000'
+The command supports a lot of customization through options, and you can find more information about each option by typing icongen stub --help.
Development
+ +Set Up
+ +To set you up for developing on driveshaft, first make sure the repository is cloned and you're in its root folder, and then run the following:
+ +echo "BUNDLE_GEMFILE=\"`pwd`/Gemfile\" bundler exec ruby \"`pwd`/bin/icongen\" \"\${@---help}\"" > /usr/local/bin/icongen-dev
+chmod +x /usr/local/bin/icongen-dev
+All you'll be all set!
+To run the development version of icongen from anywhere, just run icongen-dev rather than icongen.
+You can then proceed on developing locally on the ios-icon-generator repository, and create a PR whenever a new piece of code is ready to be reviewed and integrated!
To run the test suite, you may run the following command from the root folder:
+ +bundler exec ruby bin/rspec -I .
+Method List
+ image_sets
+ IOSIconGenerator::Helpers
+
+
mask_icon
IOSIconGenerator::Helpers
@@ -60,10 +68,18 @@ -
+
+
+
-
diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html
index a6a39e4..2d6d7db 100644
--- a/docs/top-level-namespace.html
+++ b/docs/top-level-namespace.html
@@ -100,7 +100,7 @@
diff --git a/ios_icon_generator.gemspec b/ios_icon_generator.gemspec
index ffb1e9a..7207718 100644
--- a/ios_icon_generator.gemspec
+++ b/ios_icon_generator.gemspec
@@ -13,11 +13,13 @@ Gem::Specification.new do |spec|
spec.summary = 'Generates icons based and apply masks to them easily.'
spec.homepage = 'https://github.com/Fueled/ios-icon-generator'
- spec.files = Dir['lib/**/*.rb'] + Dir['vendor/**/*.json'] + %w[bin/icongen LICENSE README.md]
+ spec.files = Dir['lib/**/*.rb'] + Dir['vendor/**/*.json'] + %w[bin/icongen LICENSE README.md .yardopts]
spec.license = 'Apache-2.0'
spec.executables = %w[icongen]
spec.require_paths = ['lib']
+ spec.metadata['yard.run'] = 'yri'
+
spec.add_runtime_dependency 'colored2'
spec.add_runtime_dependency 'hanami-cli'
spec.add_runtime_dependency 'parallel'
diff --git a/lib/.yardoc/checksums b/lib/.yardoc/checksums
new file mode 100644
index 0000000..8381030
--- /dev/null
+++ b/lib/.yardoc/checksums
@@ -0,0 +1,6 @@
+ios_icon_generator/version.rb ce7d82f0b1be30d9858def51a225d6dafb93d75e
+ios_icon_generator.rb 45ea6b19c1aa3874baa79fa4082997d0b7426d5d
+ios_icon_generator/helpers/generate_icon.rb a63501ce864209c2ca2b7c011f54995d613113eb
+ios_icon_generator/helpers/image_sets_definition.rb e723c7bfc63acf388e22c6356bee903c4ec76fe6
+ios_icon_generator/helpers/mask_icon.rb 439c9ec9ce9b5d41fce8fa067b2e2b36670ad284
+ios_icon_generator/helpers/which.rb 8770c89d2fe92c51b54f3d3499cff7f93b114381
diff --git a/lib/.yardoc/complete b/lib/.yardoc/complete
new file mode 100644
index 0000000..e69de29
diff --git a/lib/.yardoc/object_types b/lib/.yardoc/object_types
new file mode 100644
index 0000000..826dcee
Binary files /dev/null and b/lib/.yardoc/object_types differ
diff --git a/lib/.yardoc/objects/root.dat b/lib/.yardoc/objects/root.dat
new file mode 100644
index 0000000..ae1c868
Binary files /dev/null and b/lib/.yardoc/objects/root.dat differ
diff --git a/lib/.yardoc/proxy_types b/lib/.yardoc/proxy_types
new file mode 100644
index 0000000..beefda1
Binary files /dev/null and b/lib/.yardoc/proxy_types differ
diff --git a/lib/ios_icon_generator.rb b/lib/ios_icon_generator.rb
index aecc069..c05729e 100644
--- a/lib/ios_icon_generator.rb
+++ b/lib/ios_icon_generator.rb
@@ -21,8 +21,10 @@
# The IOSIconGenerator module
module IOSIconGenerator
+ # @private
# :nodoc:
module CLI
+ # @private
# :nodoc:
module Commands
extend Hanami::CLI::Registry
@@ -38,3 +40,4 @@ module Helpers
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'
diff --git a/lib/ios_icon_generator/cli/commands/generate.rb b/lib/ios_icon_generator/cli/commands/generate.rb
index 3aaac76..d312a1d 100644
--- a/lib/ios_icon_generator/cli/commands/generate.rb
+++ b/lib/ios_icon_generator/cli/commands/generate.rb
@@ -33,7 +33,7 @@ class Generate < Hanami::CLI::Command
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)
diff --git a/lib/ios_icon_generator/cli/commands/mask.rb b/lib/ios_icon_generator/cli/commands/mask.rb
index 3db1c3f..f2bc963 100644
--- a/lib/ios_icon_generator/cli/commands/mask.rb
+++ b/lib/ios_icon_generator/cli/commands/mask.rb
@@ -48,7 +48,7 @@ class Icon < Hanami::CLI::Command
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)
diff --git a/lib/ios_icon_generator/cli/commands/stub.rb b/lib/ios_icon_generator/cli/commands/stub.rb
index ecd6185..fe2ca44 100644
--- a/lib/ios_icon_generator/cli/commands/stub.rb
+++ b/lib/ios_icon_generator/cli/commands/stub.rb
@@ -42,7 +42,7 @@ class Stub < Hanami::CLI::Command
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)
diff --git a/lib/ios_icon_generator/helpers/generate_icon.rb b/lib/ios_icon_generator/helpers/generate_icon.rb
index 20c7060..618c711 100644
--- a/lib/ios_icon_generator/helpers/generate_icon.rb
+++ b/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 [ArrayMethod List
+
+ type_incompatible?
+ IOSIconGenerator::Helpers
+
+