sprites 0.0.1.pre3 → 0.0.1.rc1

data/README.md

@@ -0,0 +1,18 @@
+# Sprites
+
+Sprites is a library that let's you define the sprites for your application with configuration or convention.  Sprites will generate your sprites, and a corresponding stylesheet for each using either the cli or from within a Rails application.
+
+## Project Structure
+
+    |
+    |\_config
+    |   \_sprites.rb
+     \_public
+        \_images
+          \_sprite_images
+            |\_sprite_name1
+            | |\_blue_icon.png
+            |  \_green_icon.png
+             \_sprite_name2
+               |\_blue_icon.png
+                \_green_icon.png

data/features/step_definitions/common_steps.rb

@@ -15,7 +15,7 @@ Given(/^it contains sprite images$/) do
 end
 
 When(/^I run the executable "([^"]*)"$/) do |bin|
-  `#{Sprites.gem_root}/bin/#{bin}`
+  `#{GEM_ROOT}/bin/#{bin}`
   $?.to_i.should be(0)
 end
 

data/lib/sprites/application.rb

@@ -18,8 +18,7 @@ module Sprites
     # === Example
     #  sprites = Sprites.new
     def initialize(configuration = ::Sprites.configuration)
-      @configuration = configuration
-      @sprites = Sprites.new
+      @sprites = Sprites.new(configuration)
     end
 
     # The +define+ method provides access to the dsl
@@ -33,12 +32,29 @@ module Sprites
 
 
     # The +sprite+ method adds sprites to the application
+    #
     # === Example
     # Sprites.application.define do
-    #   ...
+    #   sprite :foo
     # end
-    def sprite(*args, &blk)
-      sprites.add(*args, &blk)
+    #
+    # options:
+    # => :orientation - sprite orientation
+    #       default:  :vertical
+    # => :path - path to sprite relative to config.sprites_path
+    #       default:  public/images/sprites/{name}.png
+    # => :stylesheet_path - path to stylesheet
+    #       default:  public/stylesheets/sprites/{name}.css
+    # => :url - path to use in background attribute in stylesheet
+    #       default:  /images/sprites/{name}.png
+    # => :auto_define - whether or not to auto-define the sprite based on directory contents
+    #       default: true
+    # => :class_prefix - a css string to prepend to all css classes define or autogenerated
+    #       examples: '.icon', '.contacts '
+    #       default: ''
+    #
+    def sprite(name, options = {}, &blk)
+      sprites.add(name, options, &blk)
     end
   end
 end

data/lib/sprites/autoload.rb

@@ -0,0 +1 @@
+::Sprites::Autoloader.new.autoload

data/lib/sprites/autoloader.rb

@@ -0,0 +1,16 @@
+require 'sprites/sprite'
+
+module Sprites
+  class Autoloader
+    def initialize(configuration = ::Sprites.configuration)
+      @configuration = configuration
+    end
+
+    def autoload
+      Dir[File.join(@configuration.sprite_pieces_path, '*')].each do |sprite_path|
+        sprite = Sprite.new(File.basename(sprite_path).intern).configure
+        ::Sprites.application.sprites.add(sprite) if File.directory?(sprite_path)
+      end
+    end
+  end
+end

data/lib/sprites/configuration.rb

@@ -8,8 +8,14 @@ module Sprites
       'sprite_pieces_path' => 'public/images/sprite_images'
     }
 
+    attr_accessor *FIELDS
+
     def initialize
-      DEFAULT_CONFIGURATION.each {|k,v| self.send(k, v)}
+      DEFAULT_CONFIGURATION.each {|k,v| self.send(:"#{k}=", v)}
+    end
+
+    def config
+      self
     end
 
     def configure(&blk)
@@ -23,26 +29,11 @@ module Sprites
       end
     end
 
-    FIELDS.each do |meth|
-      eval <<-EVAL
-        def #{meth}(*args)
-          val, *_ = args
-
-          if val
-            @#{meth} = val
-            return self
-          end
-
-          @#{meth}
-        end
-      EVAL
-    end
-
     def self.new_for_command_line_options(options)
       config = new
       options.each do |k, v|
         if FIELDS.include?(k.to_s)
-          config.send(k, v)
+          config.send(:"#{k}=", v)
         end
       end
       config

data/lib/sprites/rails/autoload.rb

@@ -0,0 +1,13 @@
+require 'sprites/autoloader'
+
+module Sprites
+  unless defined?(Sprites::Railtie)
+    raise 'Require "sprites/rails" before requiring "sprites/rails/autoload"'
+  end
+
+  class Railtie
+    initializer 'sprites.autoload' do
+      Sprites::Autoloader.new.autoload
+    end
+  end
+end

data/lib/sprites/rails/sprites.rake

@@ -5,14 +5,6 @@ include Sprites
 
 desc "Generate sprites and stylesheets"
 task :sprites => :environment do
-  assets_root = Rails.application.config.assets[:enabled] ? 'app/assets' : 'public'
-
-  ::Sprites.configure do
-    sprites_path Rails.root.join(assets_root, 'images/sprites')
-    sprite_stylesheets_path Rails.root.join(assets_root, 'stylesheets/sprites')
-    sprite_pieces_path Rails.root.join(assets_root, 'images/sprite_images')
-  end unless ::Sprites.configuration.configured?
-
   unless (def_file_path = Rails.root.join('config/sprites.rb')).exist?
     raise CliApplication::DefinitionFileNotFound
   end

data/lib/sprites/rails.rb

@@ -1,3 +1,19 @@
-module Sprites
-  require 'sprites/rails/railtie'
+require 'rails/railtie'
+
+module Sprites  
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../rails/sprites.rake', __FILE__)
+    end
+
+    initializer 'sprites._rails-configuration' do
+      assets_root = Rails.application.config.assets[:enabled] ? 'app/assets' : 'public'
+
+      ::Sprites.configure do
+        config.sprites_path = Rails.root.join(assets_root, 'images/sprites')
+        config.sprite_stylesheets_path = Rails.root.join(assets_root, 'stylesheets/sprites')
+        config.sprite_pieces_path = Rails.root.join(assets_root, 'images/sprite_images')
+      end unless ::Sprites.configuration.configured?
+    end
+  end
 end

data/lib/sprites/sprite.rb

@@ -1,6 +1,5 @@
 require 'fileutils'
-require 'active_support/core_ext/array/extract_options'
-require 'active_support/core_ext/object/try'
+require 'active_support/core_ext'
 require 'sprites/sprite_pieces'
 require 'sprites/sprite_piece'
 require 'sprites/stylesheet'
@@ -13,48 +12,56 @@ module Sprites
       HORIZONTAL = 2
     end
 
-    OPTIONS = [:orientation]
-
     DEFAULT_OPTIONS = {
-      :orientation => Orientations::VERTICAL
+      :orientation => Orientations::VERTICAL,
+      :path => lambda {|sprite| "#{sprite.name}.png" },
+      :stylesheet_path => lambda {|sprite| sprite.stylesheet.path },
+      :url => lambda {|sprite| sprite.stylesheet.url },
+      :auto_define => true,
+      :css_prefix => ''
     }
 
     attr_reader :name, :sprite_pieces, :stylesheet
+    attr_writer :path, :stylesheet_path, :url, :auto_define, :css_prefix
 
-    def initialize(name)
-      @name = name
+    def initialize(name, configuration = ::Sprites.configuration)
+      @name, @configuration = name, configuration
       @sprite_pieces = SpritePieces.new
-      @options = DEFAULT_OPTIONS.dup
-      set_options
+      @stylesheet = Stylesheet.new(self)
     end
 
-    def define(*args, &blk)
-      @options = @options.merge args.extract_options!
-      @path ||= Pathname(path_for_arguments(@options, *args))
-      @stylesheet ||= Stylesheet.new(css_path, self)
-      @options.delete(@path.to_s)
-      set_options
-
-      instance_eval(&blk) if block_given?
-      self
+    def orientation=(val)
+      raise InvalidOrientation unless [Orientations::VERTICAL, Orientations::HORIZONTAL].include?(val)
+      @orientation = val
     end
 
-    def define!
-      define unless is_defined?
-    end
-
-    def is_defined?
-      !@stylesheet.nil?
+    [:path, :stylesheet_path, :url].each do |attribute|
+      eval <<-EVAL
+        def #{attribute}
+          val = @#{attribute} || DEFAULT_OPTIONS[:#{attribute}]
+          if val.respond_to?(:call)
+            val.call(self)
+          else
+            val
+          end
+        end
+      EVAL
     end
 
-    def path
-      define!
-      @path
+    def method_missing(meth, *args)
+      unless [:orientation, :auto_define?, :css_prefix].include?(meth)
+        super
+      else
+        instance_variable_get(:"@#{meth.to_s.chomp('?')}") || DEFAULT_OPTIONS[:"#{meth.to_s.chomp('?')}"]
+      end
     end
 
-    def stylesheet
-      define!
-      @stylesheet
+    def configure(options = {}, &blk)
+      options.symbolize_keys!.assert_valid_keys(*DEFAULT_OPTIONS.keys)
+      options.each {|k,v| send(:"#{k}=", v)}
+      auto_define! if auto_define?
+      instance_eval(&blk) if block_given?
+      self
     end
 
     def write_stylesheet(configuration, sprite_pieces = @sprite_pieces)
@@ -65,26 +72,8 @@ module Sprites
       end
     end
 
-    def stylesheet_path
-      define!
-      @stylesheet.path
-    end
-
-    def sprite_piece(options)
-      @sprite_pieces.add(options)
-    end
-
-    def orientation(*args)
-      val, *_ = args
-      if val
-        unless [Orientations::VERTICAL, Orientations::HORIZONTAL].include?(val)
-          raise InvalidOrientation
-        end
-        @orientation = val
-        return self
-      end
-
-      @orientation
+    def sprite_piece(path, css_class, options = {})
+      @sprite_pieces.add(path, css_class, options)
     end
 
     def self.sprite_full_path(configuration, sprite)
@@ -95,31 +84,14 @@ module Sprites
       "/#{sprite_full_path(configuration, sprite)}"
     end
 
-    private
-
-    def css_path
-      @paths && @paths.last || @path.to_s.gsub(/png$/, 'css')
-    end
-
-    def paths_for_options(options)
-      @paths ||= options.find {|k,v| k.is_a?(String) }
-    end
-
-    def path_for_arguments(options, *args)
-      if args.first.is_a?(Symbol) || (args.empty? && !paths_for_options(options).try(:first))
-        "#{args.first || @name}.png"
-      elsif args.first.is_a?(String)
-        args.first
-      else
-        path = paths_for_options(options).first
-        raise ArgumentError, "Path is not a string.  See usage." unless path.is_a?(String)
-        path
+    def auto_define!
+      Dir[File.join(@configuration.sprite_pieces_path, name.to_s, '*.png')].each do |path|
+        sprite_piece "#{name}/#{File.basename(path)}", ".#{File.basename(path, File.extname(path))}"
       end
     end
 
-    def set_options
-      return unless @options
-      @options.each {|k,v| send(k,v) if Sprite::OPTIONS.include?(k) }
+    def stylesheet_path
+      @stylesheet_path || path.to_s.gsub(/png$/, 'css')
     end
   end
 end

data/lib/sprites/sprite_generators/chunky_png_generator.rb

@@ -79,8 +79,8 @@ module Sprites
       image_list = sprite_pieces.map do |sp|
         sprite_piece_path = SpritePiece.sprite_piece_full_path(@configuration, sp)
         sp_image =  ChunkyPNG::Image.from_file(sprite_piece_path)
-        sp.x = orientation == Sprite::Orientations::VERTICAL ? 0 : width
-        sp.y = orientation == Sprite::Orientations::VERTICAL ? height : 0
+        sp.left = orientation == Sprite::Orientations::VERTICAL ? 0 : width
+        sp.top = orientation == Sprite::Orientations::VERTICAL ? height : 0
         sp.width = sp_image.width
         sp.height = sp_image.height
 
@@ -96,10 +96,13 @@ module Sprites
       @sprite = ChunkyPNG::Image.new(width, height, ChunkyPNG::Color::TRANSPARENT)
 
       image_list.each_with_index do |image, i|
-        @sprite.replace!(image, sprite_pieces.element_at(i).x, sprite_pieces.element_at(i).y)
+        @sprite.replace!(image, sprite_pieces.element_at(i).left, sprite_pieces.element_at(i).top)
         # $stdout << '.' if verbose
       end
       # $stdout << "\n" if verbose
+    # rescue
+    #   debugger
+    #   raise
     end
 
     def write(path, quality = nil)

data/lib/sprites/sprite_piece.rb

@@ -1,7 +1,7 @@
 module Sprites
   class SpritePiece
     attr_reader :path
-    attr_accessor :sprite, :css_selector, :x, :y, :width, :height
+    attr_accessor :sprite, :css_selector, :x, :y, :width, :height, :top, :left
     alias_method :selector, :css_selector
 
     def initialize(path)
@@ -21,7 +21,7 @@ module Sprites
   display:block;
   width:#{width}px;
   height:#{height}px;
-  background:url('#{sprite_css_path || Sprite.sprite_css_path(configuration, sprite)}') no-repeat #{negative_pixelize(x)} #{negative_pixelize(y)};
+  background:url('#{sprite_css_path || Sprite.sprite_css_path(configuration, sprite)}') no-repeat #{x || negative_pixelize(left)} #{y || negative_pixelize(top)};
 }
       CSS
     end

data/lib/sprites/sprite_pieces.rb

@@ -2,26 +2,32 @@ require 'active_support/ordered_hash'
 
 module Sprites
   class SpritePieces
+    include Enumerable
+
     def initialize
       @sprite_pieces = ActiveSupport::OrderedHash.new do |sprite_pieces, path|
         sprite_pieces[path] = SpritePiece.new(path)
       end
     end
 
-    def add(options)
-      path, css_selector = options.find {|k,v| k.is_a?(String)}
+    def add(path, css_selector, options = {})
       @sprite_pieces[path].css_selector = css_selector
-      @sprite_pieces[path]
+      options.each {|k,v| @sprite_pieces[path].send(:"#{k}=", v) }
+      self
     end
 
-    def count
-      @sprite_pieces.size
+    def each(*args, &blk)
+      all.each(*args, &blk)
     end
 
     def empty?
       @sprite_pieces.empty?
     end
 
+    def all
+      @sprite_pieces.values
+    end
+
     def [](val)
       @sprite_pieces.has_key?(val) ?
         @sprite_pieces[val] :
@@ -32,14 +38,6 @@ module Sprites
       @sprite_pieces.values[index]
     end
 
-    def map(*args, &blk)
-      @sprite_pieces.values.map(*args, &blk)
-    end
-
-    def find(*args, &blk)
-      @sprite_pieces.values.find(*args, &blk)
-    end
-
     def css(configuration = ::Sprites.configuration, sprite = @sprite)
       @sprite_pieces.values.map {|sp| sp.css(configuration, sprite)}.join("\n")
     end

data/lib/sprites/sprites.rb

@@ -2,9 +2,10 @@ require 'sprites/sprite'
 
 module Sprites
   class Sprites
-    def initialize
+    def initialize(configuration)
+      @configuration = configuration
       @sprites = Hash.new do |sprites, name|
-        sprites[name] = Sprite.new(name)
+        sprites[name] = Sprite.new(name, configuration)
       end
     end
 
@@ -27,35 +28,20 @@ module Sprites
     end
 
     def count
-      @sprites.size
+      @sprites.count
     end
 
-    def add(*args, &blk)
-      if block_given?
-        name = sprite_name(*args)
-        @sprites[name].define(*args, &blk)
-      elsif args.first.is_a?(Sprite)
-        @sprites[args.first.name] = args.first
+    def add(name_or_sprite, options = {}, &blk)
+      sprite = case name_or_sprite
+      when Sprite
+        @sprites[name_or_sprite.name] = name_or_sprite
+      when Symbol, String
+        @sprites[name_or_sprite.to_sym]
       else
-        raise ArgumentError, "You need to supply a block or a Sprites::Sprite"
-      end
-    end
-
-    private
-
-    def sprite_name(*args)
-      return args.first if args.first.is_a?(Symbol)
-
-      path = case args.first
-      when String
-        args.first
-      when Hash
-        # This is for when sprite is used like,
-        # sprite 'path_to_sprite' => 'path_to_stylesheet', :option => value
-        args.first.find {|k,v| k.is_a?(String)}.first
+        raise ArgumentError
       end
 
-      File.basename(path, File.extname(path)).intern
+      sprite.configure(options, &blk)
     end
   end
 end

data/lib/sprites/stylesheet.rb

@@ -5,8 +5,12 @@ module Sprites
     attr_reader :path
     attr_accessor :sprite_pieces
 
-    def initialize(path, sprite = nil)
-      @path, @sprite = path, sprite
+    def initialize(sprite)
+      @sprite = sprite
+    end
+
+    def path
+      @sprite.stylesheet_path
     end
 
     def self.stylesheet_full_path(configuration, stylesheet)

data/lib/sprites/test/sprite_generator_tester.rb

@@ -24,12 +24,12 @@ module Sprites
     end
 
     private
-    def test_generate
+    def test_generate(gem_root = GEM_ROOT)
       sprite_pieces = @sprite.sprite_pieces
       sprite_image = Image.read(Sprite.sprite_full_path(configuration, sprite)).first
 
       stylesheet_path = Stylesheet.stylesheet_full_path(configuration, sprite.stylesheet)
-      stylesheet_absolute_path = ::Sprites.gem_root.join(stylesheet_path)
+      stylesheet_absolute_path = gem_root.join(stylesheet_path)
       parser = CssParser::Parser.new
       parser.load_file!(File.basename(stylesheet_absolute_path), File.dirname(stylesheet_absolute_path), :screen)
 
@@ -52,7 +52,7 @@ module Sprites
       percent_diferences = sprite_pieces_with_selector_data.map do |sp, selector_data|
         begin
           raise selector_data.inspect if sp.nil?
-          sprite_piece_path = ::Sprites.gem_root.join(SpritePiece.sprite_piece_full_path(configuration, sp))
+          sprite_piece_path = gem_root.join(SpritePiece.sprite_piece_full_path(configuration, sp))
           sprite_piece_image = Image.read(sprite_piece_path).first
           
           curr_sprite_image = sprite_image.crop(
@@ -61,6 +61,7 @@ module Sprites
             selector_data.width,
             selector_data.height
           )
+
           diff_iamge, pd = curr_sprite_image.compare_channel(sprite_piece_image, MeanSquaredErrorMetric)
           pd
         ensure

data/lib/sprites/version.rb

@@ -1,3 +1,3 @@
 module Sprites
-  VERSION = "0.0.1.pre3"
+  VERSION = "0.0.1.rc1"
 end

data/lib/sprites.rb

@@ -1,8 +1,17 @@
+require 'active_support'
+require 'active_support/core_ext'
 require "sprites/version"
-require 'sprites/application'
-require 'sprites/configuration'
 
 module Sprites
+  extend ActiveSupport::Autoload
+
+  autoload :Application
+  autoload :Configuration
+  autoload :Sprites
+  autoload :Sprite
+  autoload :SpritePieces
+  autoload :SpritePiece
+  autoload :Stylesheet
   autoload :ChunkyPngGenerator, 'sprites/sprite_generators/chunky_png_generator'
 
   class << self
@@ -10,15 +19,15 @@ module Sprites
       @application ||= Application.new(configuration)
     end
 
+    def define(&blk)
+      application.define(&blk)
+    end
+
     def configure(&blk)
       @configuration ||= Configuration.new
       @configuration.configure(&blk) if block_given?
       @configuration
     end
     alias_method :configuration, :configure
-
-    def gem_root
-      Pathname.new(File.expand_path('../..', __FILE__))
-    end
   end
 end