icon_generator 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6046805bbad4ef704dfaa1b770c534ad0fc59dc6
-  data.tar.gz: 495f5934ef66bed4fe63ed0e936258c5acc8d407
+  metadata.gz: 6fd55e81501e3d69f09714856de6621e390954b3
+  data.tar.gz: c1d2a7023ad65497252f5bc861c4e8191ad44654
 SHA512:
-  metadata.gz: 4b1403b1fb6ab043c66792415eb4d48421ff66816928c777fce14eca6e4da013240aa9d41958aed4e6d78d8ffae5e7ae48eeec8dc11b5a10908c9aa6c98dca1d
-  data.tar.gz: aed27c04824785c4c49b8271ec2188a0510af00bbd3d4ad846017a3ac81ffc644dc9fbef449422e6c9710dfa825f9c458b794821bace223a9b821ebf4896bf47
+  metadata.gz: 93256fb28455b40d33c82a130fc0443472eaf1eedc3202465329c57ed51e3819191d55791887949f9e6e7f7e2e06ea55cf0b3ba206dc5dfa7e412017f2a76ac6
+  data.tar.gz: 2a5bd66d56b478f46460491370bb28bea1735dc962beb7f5c188f4df776c147720fc03e12bd19ffd544d61a523f2b2a51086d49b176a28d9858dd76706e87af5

data/README.md

@@ -1,5 +1,6 @@
 # IconGenerator
 
+[![Gem Version](https://badge.fury.io/rb/icon_generator.png)](http://badge.fury.io/rb/icon_generator)
 [![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)
 

data/icon_generator.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "thor", "0.18.1"
+  spec.add_runtime_dependency "thor", "0.18.1"
 
   spec.requirements << 'imagemagick'
 end

data/lib/icon_generator/builder.rb

@@ -2,12 +2,20 @@ module IconGenerator
     class Builder
         include IconGenerator::Validator
 
+        # Sets up the source and destination instance variables, and
+        # ensures they validate.
+        #
+        # @param source [String] the source image file
+        # @param destination [String] the output directory
         def initialize(source, destination)
             @source = source
             @destination = destination
             validate_arguments @source, @destination
         end
 
+        # Requests a build of the given image type.
+        #
+        # @param type [Symbol] the image type, `:touch` or `:favicon`
         def build(type)
             if type == :touch
                 IconGenerator::TouchBuilder.new.build(@source, @destination)

data/lib/icon_generator/error.rb

@@ -1,5 +1,9 @@
 module IconGenerator
     class Error < Thor::Error
+        # Colors the given error message red and sends it up to
+        # Thor::Error's initialize method.
+        #
+        # @param message [String] the message for the current Error
         def initialize(message = "Icon generation failed")
             super(Thor::Shell::Color.new.set_color message, :red)
         end

data/lib/icon_generator/favicon_builder.rb

@@ -2,6 +2,12 @@ module IconGenerator
     class FaviconBuilder
         include IconGenerator::Validator
 
+        # Builds a multi-resolution favicon image by first generating
+        # two temporary pngs—a 16x16 and a 32x32, and then shoving them
+        # into a favicon.
+        #
+        # @param source [String] the source image file
+        # @param destination [String] the output directory
         def build(source, destination)
             new_image = "#{destination}/favicon.ico"
             temp_16 = Tempfile.new('16x16')

data/lib/icon_generator/touch_builder.rb

@@ -2,6 +2,7 @@ module IconGenerator
     class TouchBuilder
         include IconGenerator::Validator
 
+        # Initializes the default image sizes.
         def initialize
             @sizes = [
                 '144x144',
@@ -11,6 +12,10 @@ module IconGenerator
             ]
         end
 
+        # Builds apple-touch-icons from the given source file.
+        #
+        # @param source [String] the source image file
+        # @param destination [String] the output directory
         def build(source, destination)
             @sizes.each do |size|
                 new_image = "#{destination}/apple-touch-icon-#{size}-precomposed.png"
@@ -22,6 +27,12 @@ module IconGenerator
             end
         end
 
+
+        # Builds a given size of apple-touch-icon.
+        #
+        # @param source [String] the source image file
+        # @param size [String] the requested image size, in WxH format
+        # @param new_image [String] the output image
         def build_size(source, size, new_image)
             %x[convert '#{source}' -resize #{size}! #{new_image}]
             validate_file_status new_image

data/lib/icon_generator/validator.rb

@@ -1,12 +1,27 @@
 module IconGenerator
+    # Module intended to be used as a convenient mixin.
+    #
+    # @example Including the validator in a class
+    #    class Foo
+    #        include IconGenerator::Validator
+    #        # Now you can use validate_arguments and
+    #        # validate_file_status as if they were your very own.
+    #    end
     module Validator
+        # Validates the given source image file and the destination
+        # directory for correctness.
+        #
+        # @param source [String] the source image file
+        # @param destination [String] the output directory
         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
 
-
+        # Validates the existence of the given file.
+        #
+        # @param filename [String] the file being tested for existence
         def validate_file_status(filename)
             raise IconGenerator::Error unless File.exists? filename
         end

data/lib/icon_generator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icon_generator
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Adam Bowen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.18.1
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -106,3 +106,4 @@ summary: Make apple-touch-icons and favicon.ico files
 test_files:
 - spec/icon_generator_spec.rb
 - spec/spec_helper.rb
+has_rdoc: