favicon_maker 0.0.6 → 0.0.7

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+script: "bundle exec rspec spec"

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-gemspec
-gem 'rspec'
+gemspec

data/README.md

@@ -1,4 +1,4 @@
-FaviconMaker
+FaviconMaker [![Build Status](https://secure.travis-ci.org/follmann/favicon_maker.png)](http://travis-ci.org/[follmann]/[favicon_maker])
 ============
 
 Tired of creating a gazillion different favicons to satisfy all kinds of devices and resolutions in different file formats? 
@@ -19,8 +19,29 @@ The basic idea is to have one image file as source for all the different sizes a
 ## 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)
-### Rails
-Soon to come... Have a look on the basic usage for now.
+### Capistrano
+1. Edit your Capfile and add the following line
+
+        require "favicon_maker"
+
+2. Add the following snippet to your deploy.rb
+
+        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**
 
 ## Basic Usage
 ### Simple
@@ -46,16 +67,18 @@ Uses the following defaults:
 
     options = {
       :versions => [:apple_114, :apple_57, :apple, :fav_png, :fav_ico],
-      :custom_versions => {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}}
+      :custom_versions => {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}},
       :root_dir => Rails.root,
-      :input_dir => File.join(Rails.root, "app", "assets", "public"),
+      :input_dir => File.join("app", "assets", "public"),
       :base_image => "favico.png",
       :output_dir => "public",
       :copy => true
     }
+    
     FaviconMaker::Generator.create_versions(options) do |filepath|
-      Rails.logger.info "Created favicon: #{filepath}"
+      puts "Created favicon: #{filepath}"
     end
+    
 ## Base Image Guideline
 Choose the version with the biggest dimension as your base image. Currently the size 114x114 for newer iOS devices marks the upper limit. So just create a PNG with 24 or 32 Bit color depth and 114x114 document size. Downscaling of images always works better than upscaling.
 

data/favicon_maker.gemspec

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path("../lib", __FILE__)
-require "version"
+require "favicon_maker/version"
 
 Gem::Specification.new do |s|
   s.name        = "favicon_maker"
@@ -12,12 +13,12 @@ Gem::Specification.new do |s|
   s.summary     = %q{Create favicon files in various sizes from a base image}
   s.description = %q{Create favicon files in various sizes from a base image}
 
-  s.rubyforge_project = "favicon_maker"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
   s.add_runtime_dependency("mini_magick", ["~> 3.0"])
+  
+  s.add_development_dependency("rspec", ["~> 2.6.0"])
 end

data/lib/favicon_maker.rb

@@ -1,64 +1,9 @@
 module FaviconMaker
-  require "mini_magick"
-  require 'fileutils'
   
-  class Generator
-    VERSION = "0.0.1"
-    
-    ICON_VERSIONS = {
-      :apple_114 => {:filename => "apple-touch-icon-114x114-precomposed.png", :dimensions => "114x114", :format => "png"},
-      :apple_72 => {:filename => "apple-touch-icon-72x72-precomposed.png", :dimensions => "72x72", :format => "png"},
-      :apple_57 => {:filename => "apple-touch-icon-57x57-precomposed.png", :dimensions => "57x57", :format => "png"},
-      :apple_pre => {:filename => "apple-touch-icon-precomposed.png", :dimensions => "57x57", :format => "png"},
-      :apple => {:filename => "apple-touch-icon.png", :dimensions => "57x57", :format => "png"},
-      :fav_png => {:filename => "favicon.png", :dimensions => "16x16", :format => "png"},
-      :fav_ico => {:filename => "favicon.ico", :dimensions => "16x16", :format => "ico"}
-    }
-    
-    class << self
-    
-      def create_versions(options={}, &block)
-        options = {
-          :versions => ICON_VERSIONS.keys,
-          :custom_versions => {},
-          :root_dir => File.dirname(__FILE__),
-          :input_dir => "favicons",
-          :base_image => "favicon_base.png",
-          :output_dir => "favicons_output",
-          :copy => false
-        }.merge(options)
-      
-        raise ArgumentError unless options[:versions].is_a? Array
-        base_path = File.join(options[:root_dir], options[:input_dir])
-        input_path = File.join(base_path, options[:base_image])
-        
-        icon_versions = ICON_VERSIONS.merge(options[:custom_versions])
-        (options[:versions] + options[:custom_versions].keys).uniq.each do |version|
-          version = icon_versions[version]
-          composed_path = File.join(base_path, version[:filename])
-          output_path = File.join(options[:root_dir], options[:output_dir], version[:filename])
-        
-          created = false
-          # check for self composed icon file
-          if File.exist?(composed_path)
-            if options[:copy]
-              FileUtils.cp composed_path, output_path
-              created = true
-            end
-          else
-            image = MiniMagick::Image.open(input_path)
-            image.resize version[:dimensions]
-            image.format version[:format]
-            image.write output_path
-            created = true
-          end
-        
-          if block_given? && created
-            yield output_path
-          end
-        end
-      end
-      
-    end
-  end
+  libdir = File.dirname(__FILE__)
+  $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+  
+  # Auto-load modules on-demand
+  autoload :Generator, "favicon_maker/generator"
+  
 end

data/lib/favicon_maker/generator.rb

@@ -0,0 +1,63 @@
+module FaviconMaker
+  require "mini_magick"
+  require 'fileutils'
+  
+  class Generator
+    
+    ICON_VERSIONS = {
+      :apple_114 => {:filename => "apple-touch-icon-114x114-precomposed.png", :dimensions => "114x114", :format => "png"},
+      :apple_72 => {:filename => "apple-touch-icon-72x72-precomposed.png", :dimensions => "72x72", :format => "png"},
+      :apple_57 => {:filename => "apple-touch-icon-57x57-precomposed.png", :dimensions => "57x57", :format => "png"},
+      :apple_pre => {:filename => "apple-touch-icon-precomposed.png", :dimensions => "57x57", :format => "png"},
+      :apple => {:filename => "apple-touch-icon.png", :dimensions => "57x57", :format => "png"},
+      :fav_png => {:filename => "favicon.png", :dimensions => "16x16", :format => "png"},
+      :fav_ico => {:filename => "favicon.ico", :dimensions => "16x16", :format => "ico"}
+    }
+    
+    class << self
+    
+      def create_versions(options={}, &block)
+        options = {
+          :versions => ICON_VERSIONS.keys,
+          :custom_versions => {},
+          :root_dir => File.dirname(__FILE__),
+          :input_dir => "favicons",
+          :base_image => "favicon_base.png",
+          :output_dir => "favicons_output",
+          :copy => false
+        }.merge(options)
+      
+        raise ArgumentError unless options[:versions].is_a? Array
+        base_path = File.join(options[:root_dir], options[:input_dir])
+        input_path = File.join(base_path, options[:base_image])
+        
+        icon_versions = ICON_VERSIONS.merge(options[:custom_versions])
+        (options[:versions] + options[:custom_versions].keys).uniq.each do |version|
+          version = icon_versions[version]
+          composed_path = File.join(base_path, version[:filename])
+          output_path = File.join(options[:root_dir], options[:output_dir], version[:filename])
+        
+          created = false
+          # check for self composed icon file
+          if File.exist?(composed_path)
+            if options[:copy]
+              FileUtils.cp composed_path, output_path
+              created = true
+            end
+          else
+            image = MiniMagick::Image.open(input_path)
+            image.resize version[:dimensions]
+            image.format version[:format]
+            image.write output_path
+            created = true
+          end
+        
+          if block_given? && created
+            yield output_path
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/favicon_maker/version.rb

@@ -0,0 +1,3 @@
+module FaviconMaker
+  VERSION = "0.0.7"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: favicon_maker
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2011-11-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
-  requirement: &70131795630020 !ruby/object:Gem::Requirement
+  requirement: &70320442867780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,18 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70131795630020
+  version_requirements: *70320442867780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70320442865600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70320442865600
 description: Create favicon files in various sizes from a base image
 email: 
 executables: []
@@ -30,12 +41,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - favicon_maker.gemspec
 - lib/favicon_maker.rb
-- lib/version.rb
+- lib/favicon_maker/generator.rb
+- lib/favicon_maker/version.rb
 - spec/favicon_maker_spec.rb
 - spec/spec_helper.rb
 - spec/support/favicon_base.png
@@ -58,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: favicon_maker
+rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3

data/lib/version.rb

@@ -1,3 +0,0 @@
-module FaviconMaker
-  VERSION = "0.0.6"
-end