favicon_maker 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5060beb595085399132ea1b324f4746153e142a1
-  data.tar.gz: b1037564b82ab94cad83b1616c0fab17c7c95390
+  metadata.gz: 0b0f7f9177f94233cb3f9ce947c6c0f406a0d0bf
+  data.tar.gz: 43f23170c8ad6ebea1d2152faf444edadc5af74d
 SHA512:
-  metadata.gz: 5dc5392d5193014f9e8a307ddaf17154d5dcfdd43f2a9b38606655e81bc34dd3badfffafd75d5964e3d853d64ebae2d9d86dc5cf976a0bfc93cf818480fe579a
-  data.tar.gz: c3fedf492456d8f9c8c3a945835610469118a95de51e441c70f65c4d515628463ae334218812e76436af469357a05d1898f4a86773723ea39d60c4b9df6abd4d
+  metadata.gz: 983cf479778d797d678fab44f353aea49e3b5cd8c62ae8b95a7714f0eda18dffdb7a6bdd9a6fdea5e30092e154f9a735b6a4922e7121aeade2fea0cfa21743d0
+  data.tar.gz: 1de929387d739d9a16a42eb8dd143443228f6110910e4613ac0ae5bf0fa3e88907d3ef9b7f770e24c2e32e8aad629687533c07070c20da02b1b149c6de11b88b

data/.travis.yml

@@ -1,5 +1,5 @@
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 script: "bundle exec rspec spec"

data/Guardfile

@@ -3,7 +3,6 @@
 
 guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
-  # watch(%r{^lib/(.+)\.rb$})     { |m| ["spec/lib/#{m[1]}_spec.rb", "spec/favicon_maker_spec.rb"] }
   watch(%r{^lib/favicon_maker/(.+)\.rb$})     { |m| ["spec/lib/#{m[1]}_spec.rb", "spec/favicon_maker_spec.rb"] }
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/OLD_INSTRUCTIONS.md

@@ -0,0 +1,111 @@
+## DEPRECATED - FaviconMaker v0.x
+### Integration
+#### Middleman
+In order to integrate the FaviconMaker effortless into your [Middleman](https://github.com/tdreyno/middleman) project use the following gem: [middleman-favicon-maker](https://github.com/follmann/middleman-favicon-maker) till version v3.4
+
+#### Capistrano
+1. Edit your Capfile and add the following line
+``` ruby
+require "favicon_maker"
+```
+2. Add the following snippet to your deploy.rb
+
+``` ruby
+namespace :favicon do
+  task :create_versions do
+    options = {
+      :root_dir => release_path,
+      :input_dir => File.join("app", "assets", "public"),
+      :output_dir => "public"
+    }
+    FaviconMaker::Generator.create_versions(options) do |filepath|
+      puts "Created favicon: #{filepath}"
+    end
+  end
+end
+
+after "deploy:update_code", "favicon:create_versions"
+```
+
+**Note: This snippet is untested but should work**
+
+### v0.x Usage
+#### Simple
+
+``` ruby
+require "rubygems"
+require "favicon_maker"
+
+FaviconMaker::Generator.create_versions
+```
+Uses the following defaults:
+``` ruby
+options = {
+  :versions => [
+    :apple_152,
+    :apple_144,
+    :apple_120,
+    :apple_114,
+    :apple_76,
+    :apple_72,
+    :apple_60,
+    :apple_57,
+    :apple,
+    :fav_196,
+    :fav_160,
+    :fav_96,
+    :fav_32,
+    :fav_16,
+    :fav_png,
+    :fav_ico,
+    :mstile_144
+  ],
+  :custom_versions => {},
+  :root_dir => File.dirname(__FILE__),
+  :input_dir => "favicons",
+  :base_image => "favicon_base.png",
+  :output_dir => "favicons_output",
+  :copy => false
+}
+```
+#### Advanced
+(untested attempted Rails integration, using all available options. Could be used in a Rake task or Capistrano recipe)
+``` ruby
+options = {
+  :versions => [
+    :apple_152,
+    :apple_144,
+    :apple_120,
+    :apple_114,
+    :apple_76,
+    :apple_72,
+    :apple_60,
+    :apple_57,
+    :apple,
+    :fav_196,
+    :fav_160,
+    :fav_96,
+    :fav_32,
+    :fav_16,
+    :fav_png,
+    :fav_ico,
+    :mstile_144
+  ],
+  :custom_versions => {
+    :apple_extreme_retina => {
+      :filename => "apple-touch-icon-228x228-precomposed.png",
+      :dimensions => "228x228",
+      :format => "png"
+    }
+  },
+  :root_dir => Rails.root,
+  :input_dir => File.join("app", "assets", "public"),
+  :base_image => "favicon.png",
+  :output_dir => "public",
+  :copy => true
+}
+
+FaviconMaker::Generator.create_versions(options) do |filepath|
+  puts "Created favicon: #{filepath}"
+end
+```

data/README.md

@@ -4,9 +4,7 @@ FaviconMaker [![Build Status](https://secure.travis-ci.org/follmann/favicon_make
 
 Tired of creating a gazillion different favicons to satisfy all kinds of devices and resolutions in different file formats?
 
-I know I was, so I created FaviconMaker to ease the tedious process of creating multiple versions of your favicon.
-
-The basic idea is to have a template image file as source for all the different sizes and or formats (png/ico). From v1.x on it is possible to use multiple template files 
+I know I was, so I created FaviconMaker to ease the tedious process of creating multiple versions of your favicon. The basic idea is to have a template image file as source for all the different sizes and or formats (png/ico). From v1.x on it is possible to use multiple template files.
 
 ## Installation
 Using Bundler
@@ -16,12 +14,12 @@ gem "favicon_maker"
 ```
 ## Using the DSL 
 ### Definition
-* ```setup``` takes the directory config
-* ```from```  defines the template to be used
-* ```icon```  needs at least a filename. Usually the size and the file format are encoded in that name e.g. ```apple-touch-icon-152x152-precomposed.png```, if that is the case FaviconMaker tries to extract that information. It takes an options hash as the second argument where ```size:  "16x16"``` and ```format: :ico``` can be specified. Only .ico and .png are supported. The options passed take precedence over information extracted from the filename.
-* ```each_icon``` is called for every generated file with the fully qualified output filepath
+* `setup` takes the directory config
+* `from`  defines the template to be used
+* `icon`  needs at least a filename. Usually the size and the file format are encoded in that name e.g. `apple-touch-icon-152x152-precomposed.png`, if that is the case FaviconMaker tries to extract that information. It takes an options hash as the second argument where `size` e.g. "16x16" and `format` e.g. :ico can be specified. Only .ico and .png are supported. The options passed take precedence over information extracted from the filename.
+* `each_icon` is called for every generated file with the fully qualified output filepath
 
-### Complete example:
+### Complete example
 ``` ruby
 FaviconMaker.generate do
  
@@ -73,117 +71,16 @@ In order to integrate the FaviconMaker effortless into your [Middleman](https://
 ## Template Image Guideline
 Choose the version with the biggest dimension as your base image. Currently the size 152x152 for newer iOS devices marks the upper limit. So just create a PNG with 24 or 32 Bit color depth and 152x152 document size. Downscaling of images always works better than upscaling. Use more than one template file to improve lower resolutions.
 
-## DEPRECATED - FaviconMaker v0.x
-### Integration
-#### Middleman
-In order to integrate the FaviconMaker effortless into your [Middleman](https://github.com/tdreyno/middleman) project use the following gem: [middleman-favicon-maker](https://github.com/follmann/middleman-favicon-maker) till version v3.4
-
-#### Capistrano
-1. Edit your Capfile and add the following line
-``` ruby
-require "favicon_maker"
-```
-2. Add the following snippet to your deploy.rb
-
-``` ruby
-namespace :favicon do
-  task :create_versions do
-    options = {
-      :root_dir => release_path,
-      :input_dir => File.join("app", "assets", "public"),
-      :output_dir => "public"
-    }
-    FaviconMaker::Generator.create_versions(options) do |filepath|
-      puts "Created favicon: #{filepath}"
-    end
-  end
-end
-
-after "deploy:update_code", "favicon:create_versions"
-```
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
-**Note: This snippet is untested but should work**
+## FaviconMaker v0.x - DEPRECATED
+[Old instructions for versions till v0.3](OLD_INSTRUCTIONS.md)
 
-### v0.x Usage
-#### Simple
-
-``` ruby
-require "rubygems"
-require "favicon_maker"
-
-FaviconMaker::Generator.create_versions
-```
-Uses the following defaults:
-``` ruby
-options = {
-  :versions => [
-    :apple_152,
-    :apple_144,
-    :apple_120,
-    :apple_114,
-    :apple_76,
-    :apple_72,
-    :apple_60,
-    :apple_57,
-    :apple,
-    :fav_196,
-    :fav_160,
-    :fav_96,
-    :fav_32,
-    :fav_16,
-    :fav_png,
-    :fav_ico,
-    :mstile_144
-  ],
-  :custom_versions => {},
-  :root_dir => File.dirname(__FILE__),
-  :input_dir => "favicons",
-  :base_image => "favicon_base.png",
-  :output_dir => "favicons_output",
-  :copy => false
-}
-```
-#### Advanced
-(untested attempted Rails integration, using all available options. Could be used in a Rake task or Capistrano recipe)
-``` ruby
-options = {
-  :versions => [
-    :apple_152,
-    :apple_144,
-    :apple_120,
-    :apple_114,
-    :apple_76,
-    :apple_72,
-    :apple_60,
-    :apple_57,
-    :apple,
-    :fav_196,
-    :fav_160,
-    :fav_96,
-    :fav_32,
-    :fav_16,
-    :fav_png,
-    :fav_ico,
-    :mstile_144
-  ],
-  :custom_versions => {
-    :apple_extreme_retina => {
-      :filename => "apple-touch-icon-228x228-precomposed.png",
-      :dimensions => "228x228",
-      :format => "png"
-    }
-  },
-  :root_dir => Rails.root,
-  :input_dir => File.join("app", "assets", "public"),
-  :base_image => "favicon.png",
-  :output_dir => "public",
-  :copy => true
-}
-
-FaviconMaker::Generator.create_versions(options) do |filepath|
-  puts "Created favicon: #{filepath}"
-end
-```
 ## Copyright
 
 © 2011-2014 Andreas Follmann. See LICENSE for details.

data/lib/favicon_maker/creator.rb

@@ -41,6 +41,8 @@ module FaviconMaker
       size    = options[:size]    || extract_size(output_filename)
       output_file_path = File.join(output_path, output_filename)
 
+      validate_input(format, size)
+
       generate_file(template_file_path, output_file_path, size, format)
 
       finished_block.call(output_file_path, template_file_path) if finished_block
@@ -48,6 +50,18 @@ module FaviconMaker
 
     private
 
+    def validate_input(format, size)
+      unless InputValidator.valid_format?(format)
+        raise ArgumentError, "FaviconMaker: Unknown icon format."
+      end
+
+      format_multi_res = InputValidator.format_multi_resolution?(format)
+
+      unless InputValidator.valid_size?(size, format_multi_res)
+        raise ArgumentError, "FaviconMaker: Size definition can't be decoded."
+      end
+    end
+
     def fetch_image_magick_version
       version = (`convert --version`).scan(/ImageMagick (\d\.\d\.\d)/).flatten.first
     end
@@ -68,6 +82,11 @@ module FaviconMaker
         image.define "png:include-chunk=none,trns,gama"
         image.colorspace colorspace_in
         image.resize size
+        image.combine_options do |c|
+          c.background "none"
+          c.gravity "center"
+          c.extent size
+        end unless InputValidator.size_square?(size)
         image.format "png"
         image.strip
         image.colorspace colorspace_out
@@ -84,7 +103,7 @@ module FaviconMaker
     end
 
     def print_image_magick_ancient_version_warning
-      puts "FaviconMaker: WARNING! Your installed ImageMagick version #{IM_VERSION} is not up-to-date and might produce suboptimal output!"
+      puts "FaviconMaker: WARNING! Your installed ImageMagick version #{RECENT_IM_VERSION} is not up-to-date and might produce suboptimal output!"
     end
 
 

data/lib/favicon_maker/input_validator.rb

@@ -0,0 +1,27 @@
+module FaviconMaker
+
+  module InputValidator
+
+    def self.valid_size?(size, multiple=false)
+      matches = size =~ /^(\d+)/ && size.scan(/(\d+x\d+)/)
+      return false if matches.nil? || matches.empty?
+      return true if multiple && matches.size >= 1
+      return true if matches.size == 1
+      false
+    end
+
+    def self.format_multi_resolution?(format)
+      format.to_s == "ico"
+    end
+
+    def self.valid_format?(format)
+      ["ico", "png"].include?(format.to_s)
+    end
+
+    def self.size_square?(size)
+      width, height = *size.split('x').map(&:to_i)
+      width == height
+    end
+  end
+
+end

data/lib/favicon_maker/version.rb

@@ -1,3 +1,8 @@
-module FaviconMaker
-  VERSION = "1.0"
-end
+  module FaviconMaker
+    MAJOR = 1
+    MINOR = 1
+    PATCH = nil
+    BUILD = nil
+
+    VERSION = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end

data/lib/favicon_maker.rb

@@ -1,3 +1,4 @@
 require "favicon_maker/maker_config"
 require "favicon_maker/generator"
-require "favicon_maker/creator"
+require "favicon_maker/creator"
+require "favicon_maker/input_validator"

data/spec/favicon_maker_spec.rb

@@ -9,6 +9,8 @@ describe FaviconMaker, '#create_versions' do
 
   let(:output_path) { File.join(absolute_root_dir, relative_output_dir) }
 
+  let(:total_count) { 19 }
+
   def cleanup(output_dir)
     if Dir.exists?(output_dir)
       Dir[File.join(output_dir, "*")].each do |file|
@@ -60,6 +62,7 @@ describe FaviconMaker, '#create_versions' do
           icon "favicon.png",                             size:  "16x16"
           icon "favicon.ico",                             size:  "64x64,32x32,24x24,16x16"
           icon "mstile-144x144",                          format: "png"
+          icon "mstile-310x150",                          format: "png"
         end
 
         each_icon do |filepath, template_filepath|
@@ -70,9 +73,9 @@ describe FaviconMaker, '#create_versions' do
       return files, template_files
     end
 
-    it "creates 18 files" do
+    it "creates multiple files" do
       files, template_files = subject
-      expect(files.size).to eql(18)
+      expect(files.size).to eql(total_count)
       files.each do |file|
         expect(File.exists?(file)).to be_true
       end
@@ -123,6 +126,7 @@ describe FaviconMaker, '#create_versions' do
           icon "favicon.png",     size:  "16x16"
           icon "favicon.ico",     size:  "64x64,32x32,24x24,16x16"
           icon "mstile-144x144",  format: "png"
+          icon "mstile-310x150",  format: "png"
         end
 
         each_icon do |filepath|
@@ -132,9 +136,9 @@ describe FaviconMaker, '#create_versions' do
       files
     end
 
-    it "creates 18 files" do
+    it "creates multiple files" do
       files = subject
-      expect(files.size).to eql(18)
+      expect(files.size).to eql(total_count)
       files.each do |file|
         expect(File.exists?(file)).to be_true
       end

data/spec/input_validator_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe FaviconMaker::InputValidator do
+
+  describe '.valid_size?' do
+
+    context 'with valid size' do
+      subject { "64x64" }
+
+      it "returns true" do
+        expect(FaviconMaker::InputValidator.valid_size?(subject)).to be_true
+      end
+    end
+
+    context 'with valid sizes and multiple flag' do
+      subject { "64x64,32x32,16x16" }
+
+      it "returns true" do
+        expect(FaviconMaker::InputValidator.valid_size?(subject, true)).to be_true
+      end
+    end
+
+    context 'with invalid sizes' do
+      subject { ["x64x64", "ABx64", "16x", "x64,32x32,16x16"] }
+
+      it "returns false" do
+        subject.each do |s|
+          expect(FaviconMaker::InputValidator.valid_size?(s)).to be_false
+        end
+        subject.each do |s|
+          expect(FaviconMaker::InputValidator.valid_size?(s, true)).to be_false
+        end
+      end
+    end
+
+  end
+
+  describe '.valid_format?' do
+
+    context 'with valid formats' do
+      subject { ["png", "ico"] }
+
+      it "returns true" do
+        subject.each do |s|
+          expect(FaviconMaker::InputValidator.valid_format?(s)).to be_true
+        end
+      end
+    end
+
+    context 'with invalid format' do
+      subject { "jpg" }
+
+      it "returns false" do
+        expect(FaviconMaker::InputValidator.valid_format?(subject)).to be_false
+      end
+    end
+
+  end
+
+  describe '.format_multi_resolution?' do
+
+    context 'with multi-res format' do
+      subject { "ico" }
+
+      it "returns true" do
+        expect(FaviconMaker::InputValidator.format_multi_resolution?(subject)).to be_true
+      end
+    end
+
+    context 'with single-res format' do
+      subject { "png" }
+
+      it "returns false" do
+        expect(FaviconMaker::InputValidator.format_multi_resolution?(subject)).to be_false
+      end
+    end
+
+  end
+
+  describe '.size_square?' do
+
+    context 'with square size' do
+      subject { "64x64" }
+
+      it "returns true" do
+        expect(FaviconMaker::InputValidator.size_square?(subject)).to be_true
+      end
+    end
+
+    context 'with non-square size' do
+      subject { "64x32" }
+
+      it "returns false" do
+        expect(FaviconMaker::InputValidator.size_square?(subject)).to be_false
+      end
+    end
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: favicon_maker
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Andreas Follmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-12 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -78,14 +78,17 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
+- OLD_INSTRUCTIONS.md
 - README.md
 - favicon_maker.gemspec
 - lib/favicon_maker.rb
 - lib/favicon_maker/creator.rb
 - lib/favicon_maker/generator.rb
+- lib/favicon_maker/input_validator.rb
 - lib/favicon_maker/maker_config.rb
 - lib/favicon_maker/version.rb
 - spec/favicon_maker_spec.rb
+- spec/input_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/favicon base.png
 - spec/support/favicon_base.png
@@ -115,6 +118,7 @@ specification_version: 4
 summary: Create favicon files in various sizes from one or multiple base images
 test_files:
 - spec/favicon_maker_spec.rb
+- spec/input_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/favicon base.png
 - spec/support/favicon_base.png