icon_generator 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6046805bbad4ef704dfaa1b770c534ad0fc59dc6
+  data.tar.gz: 495f5934ef66bed4fe63ed0e936258c5acc8d407
+SHA512:
+  metadata.gz: 4b1403b1fb6ab043c66792415eb4d48421ff66816928c777fce14eca6e4da013240aa9d41958aed4e6d78d8ffae5e7ae48eeec8dc11b5a10908c9aa6c98dca1d
+  data.tar.gz: aed27c04824785c4c49b8271ec2188a0510af00bbd3d4ad846017a3ac81ffc644dc9fbef449422e6c9710dfa825f9c458b794821bace223a9b821ebf4896bf47

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in icon_generator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Bowen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# IconGenerator
+
+[![Code Climate](https://codeclimate.com/github/adamnbowen/icon_generator.png)](https://codeclimate.com/github/adamnbowen/icon_generator)
+[![Build Status](https://travis-ci.org/adamnbowen/icon_generator.png)](https://travis-ci.org/adamnbowen/icon_generator)
+
+Generates Apple Touch Icons or a multiresolution (32x32 and 16x16)
+favicon given a square image.
+
+## Installation
+
+    $ gem install icon_generator
+
+## Dependencies
+
+* Ruby 1.9.3 and up
+* ImageMagick
+* [Thor](http://whatisthor.com/)
+
+## Usage
+
+    $ icon_generator touch my/source/file.png my/output/directory
+
+## Testing
+
+    $ rake test
+
+## 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

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.libs.push 'spec'
+    t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :test

data/bin/icon_generator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "thor"
+
+require 'icon_generator'
+
+IconGenerator::Thor.start(ARGV)

data/icon_generator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'icon_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "icon_generator"
+  spec.version       = IconGenerator::VERSION
+  spec.authors       = ["Adam Bowen"]
+  spec.email         = ["adambowen@group360.com"]
+  spec.description   = %q{Generates Apple Touch Icons or a favicon given a square image.}
+  spec.summary       = %q{Make apple-touch-icons and favicon.ico files}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = ["icon_generator"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "thor", "0.18.1"
+
+  spec.requirements << 'imagemagick'
+end

data/lib/icon_generator.rb

@@ -0,0 +1,10 @@
+require "icon_generator/version"
+require "icon_generator/error"
+require "icon_generator/validator"
+require "icon_generator/builder"
+require "icon_generator/favicon_builder"
+require "icon_generator/touch_builder"
+require "icon_generator/thor"
+
+module IconGenerator
+end

data/lib/icon_generator/builder.rb

@@ -0,0 +1,19 @@
+module IconGenerator
+    class Builder
+        include IconGenerator::Validator
+
+        def initialize(source, destination)
+            @source = source
+            @destination = destination
+            validate_arguments @source, @destination
+        end
+
+        def build(type)
+            if type == :touch
+                IconGenerator::TouchBuilder.new.build(@source, @destination)
+            elsif type == :favicon
+                IconGenerator::FaviconBuilder.new.build(@source, @destination)
+            end
+        end
+    end
+end

data/lib/icon_generator/error.rb

@@ -0,0 +1,7 @@
+module IconGenerator
+    class Error < Thor::Error
+        def initialize(message = "Icon generation failed")
+            super(Thor::Shell::Color.new.set_color message, :red)
+        end
+    end
+end

data/lib/icon_generator/favicon_builder.rb

@@ -0,0 +1,16 @@
+module IconGenerator
+    class FaviconBuilder
+        include IconGenerator::Validator
+
+        def build(source, destination)
+            new_image = "#{destination}/favicon.ico"
+            temp_16 = Tempfile.new('16x16')
+            temp_32 = Tempfile.new('32x32')
+            %x[convert '#{source}' -resize 16x16 -alpha on #{temp_16.path}]
+            %x[convert '#{source}' -resize 32x32 -alpha on #{temp_32.path}]
+            %x[convert #{temp_16.path} #{temp_32.path} #{new_image}]
+            validate_file_status new_image
+            puts Thor::Shell::Color.new.set_color("Built #{new_image}", :green)
+        end
+    end
+end

data/lib/icon_generator/thor.rb

@@ -0,0 +1,13 @@
+module IconGenerator
+    class Thor < Thor
+        desc 'touch', 'Generate apple-touch-icons'
+        def touch(source, destination)
+            IconGenerator::Builder.new(source, destination).build(:touch)
+        end
+
+        desc 'favicon', 'Generate favicon'
+        def favicon(source, destination)
+            IconGenerator::Builder.new(source, destination).build(:favicon)
+        end
+    end
+end

data/lib/icon_generator/touch_builder.rb

@@ -0,0 +1,31 @@
+module IconGenerator
+    class TouchBuilder
+        include IconGenerator::Validator
+
+        def initialize
+            @sizes = [
+                '144x144',
+                '114x114',
+                '72x72',
+                '57x57',
+            ]
+        end
+
+        def build(source, destination)
+            @sizes.each do |size|
+                new_image = "#{destination}/apple-touch-icon-#{size}-precomposed.png"
+                build_size(source, size, new_image)
+                if size == '57x57'
+                    build_size(source, '57x57', "#{destination}/apple-touch-icon-precomposed.png")
+                    build_size(source, '57x57', "#{destination}/apple-touch-icon.png")
+                end
+            end
+        end
+
+        def build_size(source, size, new_image)
+            %x[convert '#{source}' -resize #{size}! #{new_image}]
+            validate_file_status new_image
+            puts Thor::Shell::Color.new.set_color("Built #{new_image}", :green)
+        end
+    end
+end

data/lib/icon_generator/validator.rb

@@ -0,0 +1,14 @@
+module IconGenerator
+    module Validator
+        def validate_arguments(source, destination)
+            raise IconGenerator::Error, '1st argument must be a valid image' unless source.match /\.gif$|\.jpg$|\.png$/
+            raise IconGenerator::Error, '1st argument must be an existing file' unless File.exists? source
+            raise IconGenerator::Error, '2nd argument must be an existing directory' unless Dir.exists? destination
+        end
+
+
+        def validate_file_status(filename)
+            raise IconGenerator::Error unless File.exists? filename
+        end
+    end
+end

data/lib/icon_generator/version.rb

@@ -0,0 +1,3 @@
+module IconGenerator
+    VERSION = "0.8.0"
+end

data/spec/icon_generator_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe IconGenerator do
+    let (:tmp) { Dir.tmpdir }
+
+    it "requires the source file to exist" do
+        fake_file = -> { IconGenerator::Builder.new('missing.png', tmp) }
+        raised_error = fake_file.must_raise IconGenerator::Error
+        raised_error.to_s.must_match '1st argument must be an existing file'
+    end
+
+    it "requires the source file to have a supported extension" do
+        html = -> { IconGenerator::Builder.new('index.html', tmp) }
+        raised_error = html.must_raise IconGenerator::Error
+        raised_error.to_s.must_match '1st argument must be a valid image'
+    end
+
+    it "requires the output directory to exist" do
+        tempfile = Tempfile.new ['test', '.png']
+        %x[convert -size 1x1 canvas:khaki #{tempfile.path}]
+        missing = -> { IconGenerator::Builder.new(tempfile.path, 'missing') }
+        raised_error = missing.must_raise IconGenerator::Error
+        raised_error.to_s.must_match '2nd argument must be an existing directory'
+    end
+
+    it "creates a favicon when requested" do
+        tempfile = Tempfile.new ['test', '.png']
+        %x[convert -size 1x1 canvas:khaki #{tempfile.path}]
+        builder = IconGenerator::Builder.new(tempfile.path, tmp)
+        stdout = capture_io { builder.build(:favicon) }.to_s
+        File.exists?("#{tmp}/favicon.ico").must_be :==, true
+        stdout.must_include "Built #{tmp}/favicon.ico"
+    end
+
+    it "creates apple-touch-icons when requested" do
+        tempfile = Tempfile.new ['test', '.png']
+        %x[convert -size 1x1 canvas:khaki #{tempfile.path}]
+        builder = IconGenerator::Builder.new(tempfile.path, tmp)
+        stdout = capture_io { builder.build(:touch) }.to_s
+
+        files = [
+            "#{tmp}/apple-touch-icon.png",
+            "#{tmp}/apple-touch-icon-precomposed.png",
+            "#{tmp}/apple-touch-icon-144x144-precomposed.png",
+            "#{tmp}/apple-touch-icon-114x114-precomposed.png",
+            "#{tmp}/apple-touch-icon-72x72-precomposed.png",
+            "#{tmp}/apple-touch-icon-57x57-precomposed.png",
+        ]
+
+        files.each do |file|
+            File.exists?(file).must_be :==, true
+            stdout.must_include "Built #{file}"
+        end
+    end
+
+    it "works with jpgs as a source file" do
+        tempfile = Tempfile.new ['test', '.jpg']
+        %x[convert -size 1x1 canvas:khaki #{tempfile.path}]
+        builder = IconGenerator::Builder.new(tempfile.path, tmp)
+        stdout_favicon = capture_io { builder.build(:favicon) }.to_s
+        stdout_favicon.must_include "Built #{tmp}/favicon.ico"
+        stdout_touch = capture_io { builder.build(:touch) }.to_s
+        stdout_touch.must_include "Built #{tmp}/apple-touch-icon.png"
+    end
+
+    it "works with gifs as a source file" do
+        tempfile = Tempfile.new ['test', '.gif']
+        %x[convert -size 1x1 canvas:khaki #{tempfile.path}]
+        builder = IconGenerator::Builder.new(tempfile.path, tmp)
+        stdout_favicon = capture_io { builder.build(:favicon) }.to_s
+        stdout_favicon.must_include "Built #{tmp}/favicon.ico"
+        stdout_touch = capture_io { builder.build(:touch) }.to_s
+        stdout_touch.must_include "Built #{tmp}/apple-touch-icon.png"
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'thor'
+require 'tmpdir'
+require 'tempfile'
+
+require 'icon_generator'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: icon_generator
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Adam Bowen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: Generates Apple Touch Icons or a favicon given a square image.
+email:
+- adambowen@group360.com
+executables:
+- icon_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/icon_generator
+- icon_generator.gemspec
+- lib/icon_generator.rb
+- lib/icon_generator/builder.rb
+- lib/icon_generator/error.rb
+- lib/icon_generator/favicon_builder.rb
+- lib/icon_generator/thor.rb
+- lib/icon_generator/touch_builder.rb
+- lib/icon_generator/validator.rb
+- lib/icon_generator/version.rb
+- spec/icon_generator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- imagemagick
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Make apple-touch-icons and favicon.ico files
+test_files:
+- spec/icon_generator_spec.rb
+- spec/spec_helper.rb