polymer 1.0.0.beta.6 → 1.0.0.beta.7

data/History.md

@@ -4,6 +4,9 @@ v1.0.0 / HEAD (Unreleased)
 * Montage has been renamed to Polymer and is now released under the BSD
   three-clause license.
 
+* RMagick has been replaced with ChunkyPNG; any GIF or JPEG source files
+  should be converted to PNG.
+
 * The Polymer configuration must now be located at the project root and
   should be named either ".polymer" or, for Windows users, "polymer.yml".
   You should rename your existing ".montage" file to ".polymer", and

data/README.md

@@ -26,15 +26,10 @@ The recommended way to install Polymer is with Rubygems:
 
     $ [sudo] gem install polymer
 
-Polymer currently uses RMagick/ImageMagick in order to read and write
-images. Eventually, I want to offer support for ChunkyPNG also, which
-should substantially ease installation.
-
-Most Linux and BSD distributions include ImageMagick in their packaging
-system; while Mac OS X users can install it with [Homebrew][homebrew]:
-
-    $ brew install ghostscript
-    $ brew install imagemagick
+Polymer uses ChunkyPNG to read source files, and write the final
+sprites; as a pure-Ruby library it is much easier to install than
+RMagick, while not being so much slower as to pose a problem
+(optimisation with PNGOut takes far longer than creating the sprite).
 
 If you wish to install Polymer from source:
 
@@ -60,7 +55,7 @@ running `polymer init`.
    supported options. `polymer init` also places some example source
    images into your project.
 
-2. Run `polymer bond`: this is the main task which converts the source
+2. Run `polymer bon)`: this is the main task which converts the source
    images into the final sprites. If you have PNGOUT, OptiPNG, or
    PNGCrush installed, Polymer will also optimise the generates sprites
    to reduce them to the smallest possible filesize.

data/Rakefile

@@ -21,7 +21,7 @@ end
 
 desc 'Build the gem, and push to Github'
 task :release => :build do
-  unless system('git branch') =~ /^\* master$/
+  unless `git branch` =~ /^\* master$/
     puts "You must be on the master branch to release!"
     exit!
   end

data/lib/polymer.rb

@@ -4,11 +4,15 @@ require 'pathname'
 require 'yaml'
 
 # Gems.
-require 'rmagick'
+
+begin
+  require 'oily_png' # Load the C version of ChunkyPNG when available.
+rescue LoadError
+  require 'chunky_png' # Fall back to pure-Ruby.
+end
 
 # On with the library...
 require 'polymer/cache'
-require 'polymer/core_ext'
 require 'polymer/css_generator'
 require 'polymer/deviant_finder'
 require 'polymer/dsl'
@@ -46,4 +50,14 @@ module Polymer
 
   # Raised when sprite is defined with a name which has already been used.
   DuplicateName = Class.new(DslError)
+
+  # A utility method; given a string, removes leading and trailing whitespace
+  # from each line, then joins all the lines into one.
+  #
+  # @param  [String] str A string
+  # @return [String]
+  #
+  def self.compress_lines(str)
+    str.split($/).map { |line| line.strip }.join(' ')
+  end
 end

data/lib/polymer/cli.rb

@@ -86,8 +86,13 @@ module Polymer
       # Finish by writing the new cache.
       project.cache.write
 
+      # Clean up temporary directories from data URI sprites.
+      if project.data_uri_sprites.any?
+        FileUtils.remove_entry_secure(project.tmpdir)
+      end
+
     rescue Polymer::MissingSource, Polymer::TargetNotWritable => e
-      say e.message.compress_lines, :red
+      say Polymer.compress_lines(e.message), :red
       exit 1
     end
 
@@ -302,7 +307,7 @@ module Polymer
     def find_project!
       find_project
     rescue Polymer::MissingProject
-      say <<-ERROR.compress_lines, :red
+      say Polymer.compress_lines(<<-ERROR), :red
         Couldn't find a Polymer project in the current directory, or any of
         the parent directories. Run "polymer init" if you want to create a new
         project here.

data/lib/polymer/deviant_finder.rb

@@ -21,13 +21,13 @@ module Polymer
       return false if sprite.sources.size < 2
 
       mean, std_dev = standard_deviation(sprite.sources.map do |source|
-        source.image.columns
+        source.image.width
       end)
 
       return false if std_dev < 100 # Skip images with a < 100px deviation.
 
       deviants = sprite.sources.select do |source|
-        width = source.image.columns
+        width = source.image.width
         width > mean + std_dev || width < mean - std_dev
       end
 
@@ -37,7 +37,7 @@ module Polymer
     # Print a warning if the sprite contains wide sources.
     def self.format_ui_message(sprite, deviants)
       if deviants
-        <<-MESSAGE.compress_lines
+        Polymer.compress_lines(<<-MESSAGE)
           Your "#{sprite.name}" sprite contains one or more source images
           which deviate significantly from the average source width. You might
           want to consider removing these sources from the sprite in order to

data/lib/polymer/dsl.rb

@@ -250,7 +250,7 @@ module Polymer
         definition[:name],
         definition[:sources],
         definition[:save_path],
-        definition.fetch(:padding, project_config[:padding]),
+        definition.fetch(:padding, project_config[:padding]) || 0,
         url || ''
     end
 

data/lib/polymer/man/polymer-bond.1

@@ -2,7 +2,7 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .ad l
 .
-.TH "POLYMER\-BOND" "1" "November 2010" "POLYMER 1.0.0.BETA.6" "Polymer Manual"
+.TH "POLYMER\-BOND" "1" "February 2011" "POLYMER 1.0.0.BETA.7" "Polymer Manual"
 .
 .SH "NAME"
 \fBpolymer\-bond\fR \- Create sprite images defined in your \.polymer file

data/lib/polymer/man/polymer-bond.1.txt

@@ -63,4 +63,4 @@ SEE ALSO
 
 
 
-POLYMER 1.0.0.BETA.6		 November 2010		       POLYMER-BOND(1)
+POLYMER 1.0.0.BETA.7		 February 2011		       POLYMER-BOND(1)

data/lib/polymer/man/polymer-init.1

@@ -2,7 +2,7 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .ad l
 .
-.TH "POLYMER\-INIT" "1" "November 2010" "POLYMER 1.0.0.BETA.6" "Polymer Manual"
+.TH "POLYMER\-INIT" "1" "February 2011" "POLYMER 1.0.0.BETA.7" "Polymer Manual"
 .
 .SH "NAME"
 \fBpolymer\-init\fR \- Create a new Polymer project in the current directory

data/lib/polymer/man/polymer-init.1.txt

@@ -39,4 +39,4 @@ OPTIONS
 
 
 
-POLYMER 1.0.0.BETA.6		 November 2010		       POLYMER-INIT(1)
+POLYMER 1.0.0.BETA.7		 February 2011		       POLYMER-INIT(1)

data/lib/polymer/man/polymer-optimise.1

@@ -2,7 +2,7 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .ad l
 .
-.TH "POLYMER\-OPTIMISE" "1" "November 2010" "POLYMER 1.0.0.BETA.6" "Polymer Manual"
+.TH "POLYMER\-OPTIMISE" "1" "February 2011" "POLYMER 1.0.0.BETA.7" "Polymer Manual"
 .
 .SH "NAME"
 \fBpolymer\-optimise\fR \- Optimise PNG images

data/lib/polymer/man/polymer-optimise.1.txt

@@ -27,4 +27,4 @@ DESCRIPTION
 
 
 
-POLYMER 1.0.0.BETA.6		 November 2010		   POLYMER-OPTIMISE(1)
+POLYMER 1.0.0.BETA.7		 February 2011		   POLYMER-OPTIMISE(1)

data/lib/polymer/man/polymer-position.1

@@ -2,7 +2,7 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .ad l
 .
-.TH "POLYMER\-POSITION" "1" "November 2010" "POLYMER 1.0.0.BETA.6" "Polymer Manual"
+.TH "POLYMER\-POSITION" "1" "February 2011" "POLYMER 1.0.0.BETA.7" "Polymer Manual"
 .
 .SH "NAME"
 \fBpolymer\-position\fR \- Information about your sprite sources

data/lib/polymer/man/polymer-position.1.txt

@@ -39,4 +39,4 @@ DESCRIPTION
 
 
 
-POLYMER 1.0.0.BETA.6		 November 2010		   POLYMER-POSITION(1)
+POLYMER 1.0.0.BETA.7		 February 2011		   POLYMER-POSITION(1)

data/lib/polymer/man/polymer.1

@@ -2,7 +2,7 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .ad l
 .
-.TH "POLYMER" "1" "November 2010" "POLYMER 1.0.0.BETA.6" "Polymer Manual"
+.TH "POLYMER" "1" "February 2011" "POLYMER 1.0.0.BETA.7" "Polymer Manual"
 .
 .SH "NAME"
 \fBpolymer\fR \- Image spriting for web applications

data/lib/polymer/man/polymer.1.txt

@@ -57,4 +57,4 @@ SEE ALSO
 
 
 
-POLYMER 1.0.0.BETA.6		 November 2010			    POLYMER(1)
+POLYMER 1.0.0.BETA.7		 February 2011			    POLYMER(1)

data/lib/polymer/man/polymer.5

@@ -2,7 +2,7 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .ad l
 .
-.TH "\.POLYMER" "5" "November 2010" "POLYMER 1.0.0.BETA.6" "Polymer Manual"
+.TH "\.POLYMER" "5" "February 2011" "POLYMER 1.0.0.BETA.7" "Polymer Manual"
 .
 .SH "NAME"
 \fB\.polymer\fR \- a format for describing image sprites and their sources

data/lib/polymer/man/polymer.5.txt

@@ -156,4 +156,4 @@ SEE ALSO
 
 
 
-POLYMER 1.0.0.BETA.6		 November 2010			   .POLYMER(5)
+POLYMER 1.0.0.BETA.7		 February 2011			   .POLYMER(5)

data/lib/polymer/optimisation.rb

@@ -20,7 +20,7 @@ module Polymer
     # @param [Pathname] path
     #   Path to the file to be optimised.
     #
-    # @return [Integer, false]
+    # @return [Integer]
     #   Returns the number of bytes by which the filesize was reduced.
     # @return [false]
     #   Returns false if the current machine has no optimisers available.

data/lib/polymer/project.rb

@@ -23,7 +23,7 @@ module Polymer
     #
     attr_reader :root
 
-    # @return [Pathname, false]
+    # @return [Pathname]
     #   The path to the Sass mixin file.
     # @return [false]
     #   False if Sass has been disabled.
@@ -87,6 +87,10 @@ module Polymer
       @css       = extract_path :css,   options
       @cachefile = extract_path :cache, options
 
+      if @sass and @sass.to_s[-5..-1] != '.sass'
+        @sass = @sass + '_polymer.sass'
+      end
+
       # Sprites which are to be saved as a data URI need to have a save
       # path explicitly set.
       @data_uri_sprites = @sprites.select do |sprite|

data/lib/polymer/sass_generator.rb

@@ -19,18 +19,12 @@ module Polymer
     def self.generate(project)
       return false unless project.sass
 
-      if project.sass.to_s[-5..-1] == '.sass'
-        project.sass.dirname.mkpath
-        save_to = project.sass
-      else
-        project.sass.mkpath
-        save_to = project.sass + '_polymer.sass'
-      end
+      project.sass.dirname.mkpath
 
       # We need to keep track of any existing data URI values since, if the
       # sprite is unchanged, we won't have access to it.
       existing_data_uris = extract_existing_data_uris(
-        save_to, project.data_uri_sprites)
+        project.sass, project.data_uri_sprites)
 
       data_uris = project.data_uri_sprites.inject({}) do |memo, sprite|
         if sprite.save_path.file?
@@ -48,7 +42,7 @@ module Polymer
         memo
       end
 
-      File.open(save_to, 'w') do |file|
+      File.open(project.sass, 'w') do |file|
         file.puts ERB.new(File.read(TEMPLATE), nil, '<>').result(binding)
       end
 

data/lib/polymer/source.rb

@@ -19,13 +19,13 @@ module Polymer
       @name = @path.basename(@path.extname).to_s
     end
 
-    # Returns the RMagick image instance representing the source.
+    # Returns the Image instance representing the source.
     #
-    # @return [Magick::Image]
+    # @return [ChunkyPNG::Image]
     #
     def image
       assert_file!
-      @image ||= Magick::Image.read(@path).first
+      @image ||= ChunkyPNG::Image.from_file(@path)
     end
 
     # Returns a digest which represents the sprite name and file contents.

data/lib/polymer/sprite.rb

@@ -44,8 +44,10 @@ module Polymer
     #   The name of the source whose position is to be returned, or the
     #   Polymer::Source instance itself.
     #
-    # @return [Integer, Source]
+    # @return [Integer]
     #   The vertical position of the source image.
+    # @return [nil]
+    #   nil is returned if no sprite identified by +name+ exists.
     #
     def position_of(name)
       name = name.name if name.is_a?(Polymer::Source)
@@ -64,7 +66,7 @@ module Polymer
         @positions = {}
         @sources.inject(0) do |offset, src|
           @positions[src.name] = offset
-          offset + src.image.rows + @padding
+          offset + src.image.height + @padding
         end
       end
 
@@ -105,34 +107,31 @@ module Polymer
         ERROR
       end
 
-      list = Magick::ImageList.new
+      width, height = @sources.inject([1, 0]) do |dimensions, source|
+        # Determine the width of the sprite by finding the widest source.
+        source_width = source.image.width
+        dimensions[0] = source_width if source_width > dimensions[0]
 
-      @sources.each do |source|
-        list << source.image
+        # Determine the height of the sprite by summing the height of each
+        # source.
+        dimensions[1] += source.image.height
 
-        if @padding and @padding > 0
-          list << Magick::Image.new(1, @padding) do
-            self.background_color = '#F000'
-          end
-        end
+        dimensions
       end
 
-      # RMagick uses instance_eval, @set isn't available in the block below.
-      sources_length = @sources.length
-
-      montage = list.montage do
-        self.gravity = Magick::NorthWestGravity
-        # Transparent background.
-        self.background_color = '#FFF0'
-        # Allow each image to take up as much space as it needs.
-        self.geometry = '+0+0'
-        # columns=1, rows=Sources plus padding.
-        self.tile = Magick::Geometry.new(1, sources_length * 2)
+      if @padding and @padding > 0
+        # Adjust the height to account for padding.
+        height += (@sources.length - 1) * @padding
+      end
+
+      canvas = ChunkyPNG::Canvas.new(width, height)
+
+      # Add each source to the canvas.
+      @sources.each do |source|
+        canvas.compose(source.image, 0, position_of(source))
       end
 
-      # Remove the blank space from the bottom of the image.
-      montage.crop!(0, 0, 0, (montage.first.rows) - @padding)
-      montage.write("PNG32:#{@save_path}")
+      canvas.save(@save_path, :best_compression)
 
       true
     end

data/lib/polymer/version.rb

@@ -1,4 +1,4 @@
 module Polymer
   # The current version of the Polymer library.
-  VERSION = '1.0.0.beta.6'.freeze
+  VERSION = '1.0.0.beta.7'.freeze
 end

data/polymer.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   # rake task. It it completely safe to edit them, but using the rake task
   # is easier.
   s.name              = 'polymer'
-  s.version           = '1.0.0.beta.6'
-  s.date              = '2010-11-01'
+  s.version           = '1.0.0.beta.7'
+  s.date              = '2011-02-02'
   s.rubyforge_project = 'polymer'
 
   # You may safely edit the section below.
@@ -29,12 +29,12 @@ Gem::Specification.new do |s|
   s.executables  = ['polymer']
   s.require_path = 'lib'
 
-  s.add_runtime_dependency     'rmagick',  '>= 2.13'
-  s.add_runtime_dependency     'thor',     '>= 0.14.0'
-  s.add_development_dependency 'rspec',    '>= 2.0.0.beta.19'
-  s.add_development_dependency 'cucumber', '>= 0.8.5'
-  s.add_development_dependency 'haml',     '>= 3.0.18'
-  s.add_development_dependency 'ronn',     '>= 0.7.3'
+  s.add_runtime_dependency     'chunky_png', '>= 0.12'
+  s.add_runtime_dependency     'thor',       '>= 0.14.0'
+  s.add_development_dependency 'rspec',      '>= 2.0.0.beta.19'
+  s.add_development_dependency 'cucumber',   '>= 0.8.5'
+  s.add_development_dependency 'haml',       '>= 3.0.18'
+  s.add_development_dependency 'ronn',       '>= 0.7.3'
 
   # The manifest is created by the "gemspec" rake task. Do not edit it
   # directly; your changes will be wiped out when you next run the task.
@@ -50,7 +50,6 @@ Gem::Specification.new do |s|
     lib/polymer.rb
     lib/polymer/cache.rb
     lib/polymer/cli.rb
-    lib/polymer/core_ext.rb
     lib/polymer/css_generator.rb
     lib/polymer/deviant_finder.rb
     lib/polymer/dsl.rb

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: polymer
 version: !ruby/object:Gem::Version 
-  hash: 62196367
   prerelease: true
   segments: 
   - 1
   - 0
   - 0
   - beta
-  - 6
-  version: 1.0.0.beta.6
+  - 7
+  version: 1.0.0.beta.7
 platform: ruby
 authors: 
 - Anthony Williams
@@ -17,22 +16,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 +00:00
+date: 2011-02-02 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rmagick
+  name: chunky_png
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 25
         segments: 
-        - 2
-        - 13
-        version: "2.13"
+        - 0
+        - 12
+        version: "0.12"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,7 +41,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 39
         segments: 
         - 0
         - 14
@@ -59,7 +56,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 62196421
         segments: 
         - 2
         - 0
@@ -77,7 +73,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 53
         segments: 
         - 0
         - 8
@@ -93,7 +88,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 35
         segments: 
         - 3
         - 0
@@ -109,7 +103,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 0
         - 7
@@ -138,7 +131,6 @@ files:
 - lib/polymer.rb
 - lib/polymer/cache.rb
 - lib/polymer/cli.rb
-- lib/polymer/core_ext.rb
 - lib/polymer/css_generator.rb
 - lib/polymer/deviant_finder.rb
 - lib/polymer/dsl.rb
@@ -189,7 +181,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -198,7 +189,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
-      hash: 25
       segments: 
       - 1
       - 3

data/lib/polymer/core_ext.rb

@@ -1,78 +0,0 @@
-# Some simple string extensions to make things easier.
-class String
-
-  # Replace sequences of whitespace (including newlines) with either
-  # a single space or remove them entirely (according to param _spaced_)
-  #
-  #   <<QUERY.compress_lines
-  #     SELECT name
-  #     FROM users
-  #   QUERY => "SELECT name FROM users"
-  #
-  # @return [String] Receiver with whitespace (including newlines) replaced
-  #
-  def compress_lines
-    split($/).map { |line| line.strip }.join(' ')
-  end
-
-  # Removes leading whitespace from each line, such as might be added when
-  # using a HEREDOC string.
-  #
-  # @return [String] Receiver with leading whitespace removed.
-  #
-  def unindent
-    (other = dup) and other.unindent! and other
-  end
-
-  # Bang version of #unindent.
-  #
-  # @return [String] Receiver with leading whitespace removed.
-  #
-  def unindent!
-    gsub!(/^[ \t]{#{minimum_leading_whitespace}}/, '')
-  end
-
-  private
-
-  # Checks each line and determines the minimum amount of leading whitespace.
-  #
-  # @return [Integer] The number of leading whitespace characters.
-  #
-  def minimum_leading_whitespace
-    whitespace = split("\n", -1).inject(0) do |indent, line|
-      if line.strip.empty?
-        indent # Ignore completely blank lines.
-      elsif line =~ /^(\s+)/
-        (1.0 / $1.length) > indent ? 1.0 / $1.length : indent
-      else
-        1.0
-      end
-    end
-
-    whitespace == 1.0 ? 0 : (1.0 / whitespace).to_i
-  end
-
-end
-
-# String#compress_lines is extracted from the extlib gem
-# ------------------------------------------------------
-#
-# Copyright (c) 2009 Dan Kubb
-#
-# 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.