polymer 1.0.0.beta.3

data/lib/polymer/source.rb

@@ -0,0 +1,55 @@
+module Polymer
+  # Represents a single source file used in a sprite.
+  #
+  class Source
+
+    # @return [String] The sprite name; the filename sans-extension.
+    attr_reader :name
+
+    # @return [Pathname] The path to the source file on disk.
+    attr_reader :path
+
+    # Creates a new Source instance.
+    #
+    # @param [Pathname] path
+    #   The path the the source image.
+    #
+    def initialize(path)
+      @path = Pathname.new(path)
+      @name = @path.basename(@path.extname).to_s
+    end
+
+    # Returns the RMagick image instance representing the source.
+    #
+    # @return [Magick::Image]
+    #
+    def image
+      assert_file!
+      @image ||= Magick::Image.read(@path).first
+    end
+
+    # Returns a digest which represents the sprite name and file contents.
+    #
+    # @return [String]
+    #
+    def digest
+      assert_file!
+      Digest::SHA256.hexdigest(@name + Digest::SHA256.file(@path).to_s)
+    end
+
+    #######
+    private
+    #######
+
+    # Checks that the source file exists and is a file.
+    #
+    # @raise [Polymer::MissingSource]
+    #   Raised if the source file is not present, or is not a file.
+    #
+    def assert_file!
+      raise MissingSource,
+        "Couldn't find the source file `#{@path}'" unless @path.file?
+    end
+
+  end # Source
+end # Polymer

data/lib/polymer/sprite.rb

@@ -0,0 +1,130 @@
+module Polymer
+  # Represents a collection of images which will be used to make a sprite.
+  #
+  class Sprite
+    attr_reader :name, :save_path, :url, :padding, :sources
+
+    # Creates a new Sprite instance.
+    #
+    # @param [String] name
+    #   The name of the sprite.
+    # @param [Array<Pathname>] sources
+    #   An array of Pathname instances to be used as sources.
+    # @param [Pathname] save_path
+    #   The location at which the sprite should be saved.
+    # @param [Integer] padding
+    #   The amount of transparent space, in pixels, to be inserted between
+    #   each source image.
+    # @param [String] url
+    #   The URL at which the sprite can be requested by a browser.
+    #
+    def initialize(name, sources, save_path, padding, url)
+      @name      = name
+      @sources   = sources.map { |path| Source.new(path) }
+      @save_path = save_path
+      @padding   = padding
+      @url       = url
+    end
+
+    # @return [Polymer::Source]
+    #   Returns the source whose name matches +name+.
+    # @return [nil]
+    #   Returns nil if no source with +name+ exists.
+    #
+    def source(name)
+      sources.detect { |source| source.name == name }
+    end
+
+    # Returns the y-position of a given source.
+    #
+    # @param [String, Polymer::Source] name
+    #   The name of the source whose position is to be returned, or the
+    #   Polymer::Source instance itself.
+    #
+    # @return [Integer, Source]
+    #   The vertical position of the source image.
+    #
+    def position_of(name)
+      name = name.name if name.is_a?(Polymer::Source)
+
+      unless self.source(name)
+        raise MissingSource,
+          "Source image `#{name}' is not present in the `#{@name}' sprite"
+      end
+
+      unless @positions
+        # Rather than calculate each time we call position_of, cache the
+        # position of each image the first time it is called. Since we almost
+        # always want the position of each image at some point (when
+        # generating CSS), it works out faster to fetch each source height
+        # just once.
+        @positions = {}
+        @sources.inject(0) do |offset, src|
+          @positions[src.name] = offset
+          offset + src.image.rows + @padding
+        end
+      end
+
+      @positions[name]
+    end
+
+    # Returns a digest which represents the sprite and it's contents. If any
+    # of the file _contents_ or source names change, so will the hash.
+    #
+    # @return [Digest::SHA256]
+    #
+    def digest
+      Digest::SHA256.hexdigest(sources.map { |source| source.digest }.join)
+    end
+
+    # Saves the composited sprite to disk.
+    #
+    # In the event that the sprite has no sources, +save+ will return false
+    # and the existing file will be left untouched.
+    #
+    # @return [Boolean]
+    #
+    def save
+      @save_path.dirname.mkpath
+
+      unless @save_path.dirname.writable?
+        raise Polymer::TargetNotWritable, <<-ERROR
+          Polymer can't save the #{@name} sprite in
+          `#{@save_path.dirname.to_s}' as it isn't writable.
+        ERROR
+      end
+
+      list = Magick::ImageList.new
+
+      @sources.each do |source|
+        list << source.image
+
+        if @padding and @padding > 0
+          list << Magick::Image.new(1, @padding) do
+            self.background_color = '#F000'
+          end
+        end
+      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)
+      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}")
+
+      true
+    end
+
+  end # Sprite
+end # Polymer

data/lib/polymer/templates/polymer.tt

@@ -0,0 +1,28 @@
+# This file is used by the Polymer application to generate and optimise sprite
+# image files for use in web applications. You may alter any part of it in
+# order to customise the way Polymer works.
+#
+# For a detailed overview of the .polymer file syntax, run
+#
+#   $ polymer help .polymer
+
+# --- CONFIGURATION ----------------------------------------------------------
+
+# The config section allows you to set options which affect all of your
+# sprites; you may override any of these on a sprite-by-sprite basis by
+# specifying your custom value in the sprite section below.
+
+<% if config[:windows] %>
+config.cache 'polymer.cache'
+config.sass  'public/stylesheets/sass'
+config.url   '/images/:filename'
+<% else %>
+config.sass 'public/stylesheets/sass'
+config.url  '/images/:filename'
+<% end %>
+
+# --- SPRITES ----------------------------------------------------------------
+
+sprites '<%= config[:sources] %>/:name/*' => '<%= config[:sprites] %>/:name.png'
+
+# vim: set filetype=ruby :

data/lib/polymer/templates/sass_mixins.erb

@@ -0,0 +1,29 @@
+// The mixins in this file are automatically generated by the 'polymer'
+// command provided by the polymer gem. Don't edit this file directly;
+// change the polymer.rb configuration file, then re-run 'polymer'.
+
+@mixin polymer($source, $x-offset: 0px, $y-offset: 0px)
+<% project.sprites.each_with_index do |sprite, sprite_index| %>
+<% sprite.sources.each_with_index do |source, source_index| %>
+<% if sprite_index == 0 and source_index == 0 %>
+  @if $source == "<%= sprite.name %>/<%= source.name %>"
+<% else %>
+  @else if $source == "<%= sprite.name %>/<%= source.name %>"
+<% end %>
+    $y-offset: $y-offset - <%= sprite.position_of(source) %>px
+    background: url(<%= sprite.url %>) $x-offset $y-offset no-repeat
+<% end %>
+<% end %>
+
+@mixin polymer-pos($source, $x-offset: 0px, $y-offset: 0px)
+<% project.sprites.each_with_index do |sprite, sprite_index| %>
+<% sprite.sources.each_with_index do |source, source_index| %>
+<% if sprite_index == 0 and source_index == 0 %>
+  @if $source == "<%= sprite.name %>/<%= source.name %>"
+<% else %>
+  @else if $source == "<%= sprite.name %>/<%= source.name %>"
+<% end %>
+    $y-offset: $y-offset - <%= sprite.position_of(source) %>px
+    background-position: $x-offset $y-offset
+<% end %>
+<% end %>

data/lib/polymer/version.rb

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

data/lib/polymer.rb

@@ -0,0 +1,49 @@
+require 'digest/sha2'
+require 'erb'
+require 'pathname'
+require 'yaml'
+
+# Gems.
+require 'rmagick'
+
+# On with the library...
+require 'polymer/cache'
+require 'polymer/core_ext'
+require 'polymer/css_generator'
+require 'polymer/deviant_finder'
+require 'polymer/dsl'
+require 'polymer/optimisation'
+require 'polymer/project'
+require 'polymer/sass_generator'
+require 'polymer/source'
+require 'polymer/sprite'
+require 'polymer/version'
+
+module Polymer
+  # Generic exception for all Polymer exception classes.
+  PolymerError = Class.new(StandardError)
+
+  # Raised when a project directory couldn't be found.
+  MissingProject = Class.new(PolymerError)
+
+  # Raised when a creating a new project in an existing project directory.
+  ProjectExists = Class.new(PolymerError)
+
+  # Raised when a sprite set expects a source image, but none could be found.
+  MissingSource = Class.new(PolymerError)
+
+  # Raised when a sprite can't be saved due to incorrect permissions.
+  TargetNotWritable = Class.new(PolymerError)
+
+  # Raised when an error happens using the DSL.
+  DslError = Class.new(PolymerError)
+
+  # Raised when a sprite definition is lacking a { source => sprite } pair.
+  MissingMap = Class.new(DslError)
+
+  # Raised when a sprite defintion doesn't include a name.
+  MissingName = Class.new(DslError)
+
+  # Raised when sprite is defined with a name which has already been used.
+  DuplicateName = Class.new(DslError)
+end

data/polymer.gemspec

@@ -0,0 +1,94 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.required_rubygems_version = '>= 1.3.6'
+
+  # The following four lines are automatically updates by the "gemspec"
+  # 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.3'
+  s.date              = '2010-09-24'
+  s.rubyforge_project = 'polymer'
+
+  # You may safely edit the section below.
+
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ['Anthony Williams']
+  s.email        = ['hi@antw.me']
+  s.homepage     = 'http://github.com/antw/polymer'
+  s.summary      = 'Creates sprites for web applications'
+  s.description  = 'Polymer simplifies the creation of sprite images for ' \
+                   'web applications, while also generating nifty Sass ' \
+                   'mixins. CSS files are available for non-Sass users.'
+
+  s.rdoc_options     = ['--charset=UTF-8']
+  s.extra_rdoc_files = %w[History.md LICENSE README.md]
+
+  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'
+
+  # 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.
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    History.md
+    LICENSE
+    README.md
+    Rakefile
+    bin/polymer
+    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
+    lib/polymer/optimisation.rb
+    lib/polymer/project.rb
+    lib/polymer/sass_generator.rb
+    lib/polymer/source.rb
+    lib/polymer/sprite.rb
+    lib/polymer/templates/polymer.tt
+    lib/polymer/templates/sass_mixins.erb
+    lib/polymer/templates/sources/one/book.png
+    lib/polymer/templates/sources/one/box-label.png
+    lib/polymer/templates/sources/one/calculator.png
+    lib/polymer/templates/sources/one/calendar-month.png
+    lib/polymer/templates/sources/one/camera.png
+    lib/polymer/templates/sources/one/eraser.png
+    lib/polymer/templates/sources/two/inbox-image.png
+    lib/polymer/templates/sources/two/magnet.png
+    lib/polymer/templates/sources/two/newspaper.png
+    lib/polymer/templates/sources/two/television.png
+    lib/polymer/templates/sources/two/wand-hat.png
+    lib/polymer/templates/sources/two/wooden-box-label.png
+    lib/polymer/version.rb
+    polymer.gemspec
+    lib/polymer/man/polymer-bond.1
+    lib/polymer/man/polymer-bond.1.txt
+    lib/polymer/man/polymer-init.1
+    lib/polymer/man/polymer-init.1.txt
+    lib/polymer/man/polymer-optimise.1
+    lib/polymer/man/polymer-optimise.1.txt
+    lib/polymer/man/polymer-position.1
+    lib/polymer/man/polymer-position.1.txt
+    lib/polymer/man/polymer.1
+    lib/polymer/man/polymer.1.txt
+    lib/polymer/man/polymer.5
+    lib/polymer/man/polymer.5.txt
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^spec\/.*\.rb/ }
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification 
+name: polymer
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0
+  - beta
+  - 3
+  version: 1.0.0.beta.3
+platform: ruby
+authors: 
+- Anthony Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 13
+        version: "2.13"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 14
+        - 0
+        version: 0.14.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 5
+        version: 0.8.5
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 18
+        version: 3.0.18
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ronn
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 3
+        version: 0.7.3
+  type: :development
+  version_requirements: *id006
+description: Polymer simplifies the creation of sprite images for web applications, while also generating nifty Sass mixins. CSS files are available for non-Sass users.
+email: 
+- hi@antw.me
+executables: 
+- polymer
+extensions: []
+
+extra_rdoc_files: 
+- History.md
+- LICENSE
+- README.md
+files: 
+- Gemfile
+- History.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/polymer
+- 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
+- lib/polymer/optimisation.rb
+- lib/polymer/project.rb
+- lib/polymer/sass_generator.rb
+- lib/polymer/source.rb
+- lib/polymer/sprite.rb
+- lib/polymer/templates/polymer.tt
+- lib/polymer/templates/sass_mixins.erb
+- lib/polymer/templates/sources/one/book.png
+- lib/polymer/templates/sources/one/box-label.png
+- lib/polymer/templates/sources/one/calculator.png
+- lib/polymer/templates/sources/one/calendar-month.png
+- lib/polymer/templates/sources/one/camera.png
+- lib/polymer/templates/sources/one/eraser.png
+- lib/polymer/templates/sources/two/inbox-image.png
+- lib/polymer/templates/sources/two/magnet.png
+- lib/polymer/templates/sources/two/newspaper.png
+- lib/polymer/templates/sources/two/television.png
+- lib/polymer/templates/sources/two/wand-hat.png
+- lib/polymer/templates/sources/two/wooden-box-label.png
+- lib/polymer/version.rb
+- polymer.gemspec
+- lib/polymer/man/polymer-bond.1
+- lib/polymer/man/polymer-bond.1.txt
+- lib/polymer/man/polymer-init.1
+- lib/polymer/man/polymer-init.1.txt
+- lib/polymer/man/polymer-optimise.1
+- lib/polymer/man/polymer-optimise.1.txt
+- lib/polymer/man/polymer-position.1
+- lib/polymer/man/polymer-position.1.txt
+- lib/polymer/man/polymer.1
+- lib/polymer/man/polymer.1.txt
+- lib/polymer/man/polymer.5
+- lib/polymer/man/polymer.5.txt
+has_rdoc: true
+homepage: http://github.com/antw/polymer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: polymer
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Creates sprites for web applications
+test_files: []
+