sprites 0.0.1.rc2 → 0.0.1.rc3

data/lib/sprites/configuration.rb

@@ -1,11 +1,16 @@
-module Sprites
+class Sprites
   class Configuration
-    FIELDS = %w{sprites_path sprite_stylesheets_path sprite_pieces_path}
+    PATH_FIELDS = %w{definition_file sprites_path sprite_stylesheets_path sprite_pieces_path}
+    OTHER_FIELDS = %w{definition_file autoload sprite_asset_path generator}
+    FIELDS = PATH_FIELDS + OTHER_FIELDS
 
     DEFAULT_CONFIGURATION = {
       'sprites_path' => 'public/images/sprites',
       'sprite_stylesheets_path' => 'public/stylesheets/sprites',
-      'sprite_pieces_path' => 'public/images/sprite_images'
+      'sprite_pieces_path' => 'public/images/sprite_images',
+      'sprite_asset_path' => '/images/sprites',
+      'generator' => ChunkyPngGenerator,
+      'autoload' => true
     }
 
     attr_accessor *FIELDS
@@ -14,13 +19,19 @@ module Sprites
       DEFAULT_CONFIGURATION.each {|k,v| self.send(:"#{k}=", v)}
     end
 
+    def configure(options)
+      # p options
+      options.each {|k,v| self.send(:"#{k}=", v)}
+    end
+
     def config
       self
     end
 
-    def configure(&blk)
-      instance_eval(&blk)
-      self
+    def to_options
+      options = Hash.new
+      FIELDS.each {|option| options[option.intern] = send(option) }
+      options
     end
 
     def configured?
@@ -31,11 +42,19 @@ module Sprites
 
     def self.new_for_command_line_options(options)
       config = new
+
       options.each do |k, v|
-        if FIELDS.include?(k.to_s)
+        if options.has_key? :project_root
+          if PATH_FIELDS.include?(k.to_s)
+            config.send(:"#{path_field}=", File.join(options[:project_root], options[path_field.intern]))
+          elsif OTHER_FIELDS.include?(k.to_s)
+            config.send(:"#{k}=", v)
+          end
+        elsif FIELDS.include?(k.to_s)
           config.send(:"#{k}=", v)
         end
       end
+
       config
     end
   end

data/lib/sprites/railtie.rb

@@ -0,0 +1,56 @@
+class Sprites
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      desc "Generate sprites and stylesheets"
+      task :sprites => :environment do
+        Sprites::Railtie.each_sprited_engine do |engine|
+          next if engine.class.superclass == Rails::Engine && !ENV['ENGINES']
+
+          sprites = engine.config.send(Sprites::Railtie.config_field_name(engine.engine_name))
+          sprite_generator = Sprites::ChunkyPngGenerator.new(sprites)
+          sprite_generator.generate
+        end
+      end
+    end
+
+    initializer 'sprites._rails-configuration' do
+      Sprites::Railtie.each_sprited_engine do |engine|
+        assets_path = "app/assets"
+
+        sprites = Sprites.new
+
+        engine.config.send(Sprites::Railtie.config_field_name_with_equals(engine.engine_name), sprites)
+        sprites.configuration.configure(
+          :sprites_path => engine.root.join(assets_path, 'images/sprites'),
+          :sprite_stylesheets_path => engine.root.join(assets_path, 'stylesheets/sprites'),
+          :sprite_pieces_path => engine.root.join(assets_path, 'images/sprite_images'),
+          :sprite_asset_path => '/assets/sprites'
+        )
+
+        default_definition_file = File.join(engine.config.root, 'config/sprites.rb')
+        if File.exists? default_definition_file        
+          sprites.configuration.definition_file = default_definition_file
+        else
+          sprites.configuration.autoload = true
+        end
+      end
+    end
+
+    private
+
+    def self.each_sprited_engine
+      (Rails.application.railties.engines + [Rails.application]).each do |engine|
+        next unless engine.config.respond_to?(:uses_sprites) && engine.config.uses_sprites
+        yield engine
+      end
+    end
+
+    def self.config_field_name(engine_name)
+      :"sprites_for_#{engine_name}"
+    end
+
+    def self.config_field_name_with_equals(engine_name)
+      :"#{config_field_name(engine_name)}="
+    end
+  end
+end

data/lib/sprites/sprite.rb

@@ -2,9 +2,10 @@ require 'fileutils'
 require 'active_support/core_ext'
 require 'sprites/sprite_pieces'
 require 'sprites/sprite_piece'
-require 'sprites/stylesheet'
 
-module Sprites
+require 'forwardable'
+
+class Sprites
   class Sprite
     class InvalidOrientation < StandardError; end
     module Orientations
@@ -12,22 +13,24 @@ module Sprites
       HORIZONTAL = 2
     end
 
+    SUPPORTED_OPTIONS = %w{orientation path stylesheet_path url autoload css_prefix}
+
     DEFAULT_OPTIONS = {
       :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
+    extend Forwardable
+
+    attr_reader :name, :sprite_pieces
+    attr_accessor *SUPPORTED_OPTIONS
+
+    def_delegator :@sprites, :configuration
 
-    def initialize(name, configuration = ::Sprites.configuration)
-      @name, @configuration = name, configuration
-      @sprite_pieces = SpritePieces.new
-      @stylesheet = Stylesheet.new(self)
+    def initialize(name, sprites)
+      @name, @sprites = name, sprites
+
+      @sprite_pieces = SpritePieces.new(@sprites, self)
     end
 
     def orientation=(val)
@@ -35,65 +38,96 @@ module Sprites
       @orientation = val
     end
 
-    [: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
+    def sprite_file_name
+      "#{name}.png"
+    end
+
+    def stylesheet_file_name
+      sprite_file_name.gsub(/png$/, 'css')
+    end
+
+    def background_property_url
+      @url || File.join(@sprites.configuration.sprite_asset_path, sprite_file_name)
+    end
+
+    # Output file for the sprites image
+    def path
+      File.join(@sprites.configuration.sprites_path, @path || sprite_file_name)
+    end
+
+    # Output file for the sprites stylesheet
+    def stylesheet_path
+      File.join(@sprites.configuration.sprite_stylesheets_path, @stylesheet_path || stylesheet_file_name)
     end
 
-    def method_missing(meth, *args)
-      unless [:orientation, :auto_define?, :css_prefix].include?(meth)
-        super
+    def do_autolaod?
+      if autoload == false
+        false
       else
-        instance_variable_get(:"@#{meth.to_s.chomp('?')}") || DEFAULT_OPTIONS[:"#{meth.to_s.chomp('?')}"]
+        @sprites.configuration.autoload
       end
     end
 
+    def css_prefix
+      @css_prefix || DEFAULT_OPTIONS[:css_prefix]
+    end
+
+    def orientation
+      @orientation || DEFAULT_OPTIONS[:orientation]
+    end
+
     def configure(options = {}, &blk)
-      options.symbolize_keys!.assert_valid_keys(*DEFAULT_OPTIONS.keys)
+      options.symbolize_keys!.assert_valid_keys(*(SUPPORTED_OPTIONS.map(&:intern)))
+
       options.each {|k,v| send(:"#{k}=", v)}
-      auto_define! if auto_define?
+
+      autoload! if do_autolaod?
+
       instance_eval(&blk) if block_given?
+
       self
     end
 
     def write_stylesheet(configuration, sprite_pieces = @sprite_pieces)
-      path = Stylesheet.stylesheet_full_path(configuration, stylesheet)
-      FileUtils.mkdir_p(File.dirname(path))
-      File.open path, 'w+' do |f|
-        f << stylesheet.css(configuration, self, sprite_pieces)
+      FileUtils.mkdir_p(File.dirname(stylesheet_path))
+      File.open stylesheet_path, 'w+' do |f|
+        f << sprite_pieces.css
       end
     end
 
-    def sprite_piece(path, css_class, options = {})
+    ## 
+    # The +sprite_piece+ method adds sprite_piecess to the sprite
+    #
+    # === Example ===
+    # sprite :foo do
+    #   sprite_piece 'buttons/btn-black-default-28.png', 'a.black.wf_button > span, button.black.wf_submit span'
+    #
+    # Arguments:
+    # [String] the path to sprite piece relatie to config.sprite_pieces_path
+    # [String] (optional) the css selector to use for this sprite piece
+    #
+    # Options:
+    ##
+    def sprite_piece(path, css_class = nil, options = {})
+      css_class ||= File.basename(path, File.extname(path)).split('/').join('-')
       @sprite_pieces.add(path, css_class, options)
     end
 
-    def self.sprite_full_path(configuration, sprite)
-      File.join(configuration.sprites_path, sprite.path)
+    def autoload!
+      Dir[File.join(@sprites.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 self.sprite_css_path(configuration, sprite)
-      # TODO only works for rails and sprites dir is hard coded
-      # TODO what if there is another app in the path
-      "/assets/sprites/#{File.basename(sprite_full_path(configuration, sprite))}"
+    def all_sprite_pieces
+      @sprite_pieces.all
     end
 
-    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))}"
+    def all_sprite_piece_files
+      @sprite_pieces.map do |sp|
+        sp.source_path
       end
     end
 
-    def stylesheet_path
-      @stylesheet_path || path.to_s.gsub(/png$/, 'css')
-    end
   end
 end

data/lib/sprites/sprite_generators/chunky_png_generator.rb

@@ -4,15 +4,21 @@ rescue
   require 'chunky_png'
 end
 
-module Sprites
+class Sprites
   class ChunkyPngGenerator
-    attr_reader :configuration
+    attr_reader :sprites
 
-    def initialize(configuration)
-      @configuration = configuration
+    def initialize(sprites)
+      @sprites = sprites
     end
     
-    def generate(sprites)
+    def configuration
+      sprites.configuration
+    end
+
+    def generate
+      sprites.load
+
       # verbose = ENV['VERBOSE'] == 'true' || ENV['DEBUG']
       #       
       # if verbose
@@ -31,8 +37,8 @@ module Sprites
         # end
         # 
 
-        sprite_path = File.join(configuration.sprites_path, sprite.path)
-        sprite_stylesheet_path = File.join(configuration.sprite_stylesheets_path, sprite.stylesheet_path)
+        sprite_path = sprite.path
+        sprite_stylesheet_path = sprite.stylesheet_path
         
         orientation = sprite.orientation
         sprite_pieces = sprite.sprite_pieces
@@ -77,7 +83,7 @@ module Sprites
       width, height = 0, 0
 
       image_list = sprite_pieces.map do |sp|
-        sprite_piece_path = SpritePiece.sprite_piece_full_path(@configuration, sp)
+        sprite_piece_path = sp.source_path
         sp_image =  ChunkyPNG::Image.from_file(sprite_piece_path)
         sp.left = orientation == Sprite::Orientations::VERTICAL ? 0 : width
         sp.top = orientation == Sprite::Orientations::VERTICAL ? height : 0

data/lib/sprites/sprite_piece.rb

@@ -1,27 +1,38 @@
-module Sprites
+class Sprites
   class SpritePiece
-    attr_reader :path
-    attr_accessor :sprite, :css_selector, :x, :y, :width, :height, :top, :left
+    SUPPORTED_OPTIONS = %w(x y)
+
+    attr_reader :path, :sprite
+    attr_accessor :css_selector, :width, :height, :top, :left, *SUPPORTED_OPTIONS
     alias_method :selector, :css_selector
 
-    def initialize(path)
+    def initialize(sprites, sprite, path)
+      @sprites, @sprite = sprites, sprite
       @path = path
     end
 
-    def self.sprite_piece_full_path(configuration, sprite_piece)
-      File.join(configuration.sprite_pieces_path, sprite_piece.path)
+    def configure(options)
+      options.symbolize_keys!.assert_valid_keys(*(SUPPORTED_OPTIONS.map(&:intern)))
+
+      options.each {|k,v| send(:"#{k}=", v) }
     end
 
-    def css(configuration = ::Sprites.configuration, sprite = @sprite, sprite_css_path = nil)
-      raise "Sprite needed." unless sprite
+    def background_property_url
+      @sprite.background_property_url
+    end
+
+    def source_path
+      File.join(@sprites.configuration.sprite_pieces_path, path)
+    end
 
+    def css
       <<-CSS
 #{selector}
 {
   display:block;
   width:#{width}px;
   height:#{height}px;
-  background:url('#{sprite_css_path || Sprite.sprite_css_path(configuration, sprite)}') no-repeat #{x || negative_pixelize(left)} #{y || negative_pixelize(top)};
+  background:url('#{background_property_url}?#{Time.now.to_i}') no-repeat #{x || negative_pixelize(left)} #{y || negative_pixelize(top)};
 }
       CSS
     end

data/lib/sprites/sprite_pieces.rb

@@ -1,18 +1,20 @@
 require 'active_support/ordered_hash'
 
-module Sprites
+class Sprites
   class SpritePieces
     include Enumerable
 
-    def initialize
+    def initialize(sprites, sprite)
+      @sprites, @sprite = sprites, sprite
       @sprite_pieces = ActiveSupport::OrderedHash.new do |sprite_pieces, path|
-        sprite_pieces[path] = SpritePiece.new(path)
+        sprite_pieces[path] = SpritePiece.new(sprites, sprite, path)
       end
     end
 
     def add(path, css_selector, options = {})
       @sprite_pieces[path].css_selector = css_selector
-      options.each {|k,v| @sprite_pieces[path].send(:"#{k}=", v) }
+      @sprite_pieces[path].configure(options)
+      
       self
     end
 
@@ -29,17 +31,15 @@ module Sprites
     end
 
     def [](val)
-      @sprite_pieces.has_key?(val) ?
-        @sprite_pieces[val] :
-        nil
+      @sprite_pieces[val] if @sprite_pieces.has_key?(val)
     end
 
     def element_at(index)
       @sprite_pieces.values[index]
     end
 
-    def css(configuration = ::Sprites.configuration, sprite = @sprite)
-      @sprite_pieces.values.map {|sp| sp.css(configuration, sprite)}.join("\n")
+    def css
+      @sprite_pieces.values.map {|sp| sp.css}.join("\n")
     end
   end
-end
+end

data/lib/sprites/test/sprite_generator_tester.rb

@@ -6,32 +6,35 @@ rescue LoadError
   require 'RMagick'
 end
 
-module Sprites
+class Sprites
   class SpriteGeneratorTester
     include Magick
 
     Selector = Struct.new(:selector, :x, :y, :width, :height)
 
-    attr_reader :sprite, :configuration
-    private :sprite, :configuration
+    attr_reader :sprite
+    private :sprite
 
-    def initialize(sprite, configuration)
-      @sprite, @configuration = sprite, configuration
+    def initialize(sprite)
+      @sprite = sprite
     end
 
     def accurate?
       test_generate.all? {|x| x == 0}
     end
 
+    def background_property_urls
+      background_property_urls = []
+      parser.each_rule_set do |rs|
+        background_property_urls << rs['background'][%r{url\('?(.+)(?:\?\d+)(?:')\)}, 1]
+      end
+      background_property_urls
+    end
+
     private
     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 = gem_root.join(stylesheet_path)
-      parser = CssParser::Parser.new
-      parser.load_file!(File.basename(stylesheet_absolute_path), File.dirname(stylesheet_absolute_path), :screen)
+      sprite_image = Image.read(sprite.path).first
 
       sprite_pieces_with_selector_data = []
 
@@ -52,7 +55,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 = gem_root.join(SpritePiece.sprite_piece_full_path(configuration, sp))
+          sprite_piece_path = sp.source_path
           sprite_piece_image = Image.read(sprite_piece_path).first
           
           curr_sprite_image = sprite_image.crop(
@@ -75,5 +78,13 @@ module Sprites
       sprite_image.destroy! if sprite_image
       sprite_image = nil
     end
+
+    def parser
+      stylesheet_path = sprite.stylesheet_path
+      parser = CssParser::Parser.new
+      parser.load_file!(File.basename(stylesheet_path), File.dirname(stylesheet_path), :screen)
+      parser
+    end
+
   end
 end