compass 0.11.beta.3 → 0.11.beta.4

data/lib/compass/sass_extensions/sprites.rb

@@ -0,0 +1,14 @@
+require 'digest/md5'
+require 'compass/sass_extensions/sprites/sprites'
+require 'compass/sass_extensions/sprites/sprite_map'
+require 'compass/sass_extensions/sprites/image'
+require 'compass/sass_extensions/sprites/base'
+require 'compass/sass_extensions/sprites/engines'
+
+module Compass
+  module SassExtensions
+    module Sprites
+      
+    end
+  end
+end

data/lib/compass/sass_extensions/sprites/base.rb

@@ -0,0 +1,183 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      class Base < Sass::Script::Literal
+        def self.from_uri(uri, context, kwargs)
+          sprite_map = ::Compass::SpriteMap.new(uri.value, {})
+
+          sprites = sprite_map.files.map do |sprite|
+            sprite.gsub(Compass.configuration.images_path+"/", "")
+          end
+          new(sprites, sprite_map.path, sprite_map.name, context, kwargs)
+        end
+
+        def require_engine!
+          self.class.send(:include, eval("::Compass::SassExtensions::Sprites::#{modulize}Engine"))
+        end
+      
+        # Changing this string will invalidate all previously generated sprite images.
+        # We should do so only when the packing algorithm changes
+        SPRITE_VERSION = "1"
+
+        attr_accessor :image_names, :path, :name, :options
+        attr_accessor :images, :width, :height
+
+
+        def initialize(image_names, path, name, context, options)
+          require_engine!
+          @image_names, @path, @name, @options = image_names, path, name, options
+          @images = nil
+          @width = nil
+          @height = nil
+          @evaluation_context = context
+          validate!
+          compute_image_metadata!
+        end
+
+        # Calculate the size of the sprite
+        def size
+          [width, height]
+        end
+      
+        # Calculates the overal image dimensions
+        # collects image sizes and input parameters for each sprite
+        def compute_image_metadata!
+          @width = 0
+          init_images
+          compute_image_positions!
+          @height = @images.last.top + @images.last.height
+        end
+
+        def init_images
+          @images = image_names.collect do |relative_file|
+            image = Compass::SassExtensions::Sprites::Image.new(self, relative_file, options)
+            @width = [ @width, image.width + image.offset ].max
+            image
+          end
+        end
+        
+        # Calculates the overal image dimensions
+        # collects image sizes and input parameters for each sprite
+        def compute_image_positions!
+          @images.each_with_index do |image, index|
+            image.left = image.position.unit_str == "%" ? (@width - image.width) * (image.position.value / 100) : image.position.value
+            next if index == 0
+            last_image = @images[index-1]
+            image.top = last_image.top + last_image.height + [image.spacing,  last_image.spacing].max
+          end
+        end
+
+        def image_for(name)
+          @images.detect { |img| img.name == name}
+        end
+        
+        def has_hover?(name)
+          !image_for("#{name}_hover").nil?
+        end
+        
+        def has_target?(name)
+          !image_for("#{name}_target").nil?
+        end
+        
+        def has_active?(name)
+          !image_for("#{name}_active").nil?
+        end
+        
+        def sprite_names
+          image_names.map { |f| File.basename(f, '.png') }
+        end
+
+        def validate!
+          for sprite_name in sprite_names
+            unless sprite_name =~ /\A#{Sass::SCSS::RX::IDENT}\Z/
+              raise Sass::SyntaxError, "#{sprite_name} must be a legal css identifier"
+            end
+          end
+        end
+
+        # The on-the-disk filename of the sprite
+        def filename
+          File.join(Compass.configuration.images_path, "#{path}-#{uniqueness_hash}.png")
+        end
+
+        # Generate a sprite image if necessary
+        def generate
+          if generation_required?
+            sprite_data = construct_sprite
+            save!(sprite_data)
+            Compass.configuration.run_callback(:sprite_generated, sprite_data)
+          end
+        end
+
+        def generation_required?
+          !File.exists?(filename) || outdated?
+        end
+
+        def uniqueness_hash
+          @uniqueness_hash ||= begin
+            sum = Digest::MD5.new
+            sum << SPRITE_VERSION
+            sum << path
+            images.each do |image|
+              [:relative_file, :height, :width, :repeat, :spacing, :position, :digest].each do |attr|
+                sum << image.send(attr).to_s
+              end
+            end
+            sum.hexdigest[0...10]
+          end
+          @uniqueness_hash
+        end
+
+        def save!(output_png)
+          saved = output_png.save filename
+          Compass.configuration.run_callback(:sprite_saved, filename)
+          saved
+        end
+
+        # All the full-path filenames involved in this sprite
+        def image_filenames
+          @images.map(&:file)
+        end
+
+        # Checks whether this sprite is outdated
+        def outdated?
+          if File.exists?(filename)
+            return @images.map(&:mtime).any? { |mtime| mtime > self.mtime }
+          end
+          true
+        end
+
+        def mtime
+          File.mtime(filename)
+        end
+
+        def inspect
+          to_s
+        end
+
+        def to_s(options = self.options)
+          sprite_url(self).value
+        end
+
+        def respond_to?(meth)
+          super || @evaluation_context.respond_to?(meth)
+        end
+
+        def method_missing(meth, *args, &block)
+          if @evaluation_context.respond_to?(meth)
+            @evaluation_context.send(meth, *args, &block)
+          else
+            super
+          end
+        end
+        
+        private 
+        
+        def modulize
+          @modulize ||= Compass::configuration.sprite_engine.to_s.scan(/([^_.]+)/).flatten.map {|chunk| "#{chunk[0].chr.upcase}#{chunk[1..-1]}" }.join
+        end
+        
+      end
+    end
+  end
+end

data/lib/compass/sass_extensions/sprites/engines.rb

@@ -0,0 +1 @@
+require 'compass/sass_extensions/sprites/engines/chunky_png_engine'

data/lib/compass/sass_extensions/sprites/engines/chunky_png_engine.rb

@@ -0,0 +1,33 @@
+begin
+  require 'oily_png'
+rescue LoadError
+  require 'chunky_png'
+end
+
+module Compass
+  module SassExtensions
+    module Sprites
+      module ChunkyPngEngine
+        
+        # Returns a PNG object
+        def construct_sprite
+          #require_png_library!
+          output_png = ChunkyPNG::Image.new(width, height, ChunkyPNG::Color::TRANSPARENT)
+          images.each do |image|
+            input_png  = ChunkyPNG::Image.from_file(image.file)
+            if image.repeat == "no-repeat"
+              output_png.replace! input_png, image.left, image.top
+            else
+              x = image.left - (image.left / image.width).ceil * image.width
+              while x < width do
+                output_png.replace! input_png, x, image.top
+                x += image.width
+              end
+            end
+          end
+          output_png
+        end
+      end
+    end
+  end
+end

data/lib/compass/sass_extensions/sprites/image.rb

@@ -0,0 +1,89 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      class Image
+        attr_reader :relative_file, :options, :base
+        attr_accessor :top, :left
+
+        def initialize(base, relative_file, options)
+          @base, @relative_file, @options = base, relative_file, options
+          @left = @top = 0
+        end
+
+        def file
+          File.join(Compass.configuration.images_path, relative_file)
+        end
+
+        def width
+          dimensions.first
+        end
+
+        def height
+          dimensions.last
+        end
+
+        def name
+          File.basename(relative_file, '.png')
+        end
+
+        def repeat
+          [ "#{name}-repeat", "repeat" ].each { |which|
+            if var = options.get_var(which)
+              return var.value
+            end
+          }
+          "no-repeat"
+        end
+
+        def position
+          options.get_var("#{name}-position") || options.get_var("position") || Sass::Script::Number.new(0, ["px"])
+        end
+
+        def offset
+          (position.unitless? || position.unit_str == "px") ? position.value : 0
+        end
+
+        def spacing
+          (options.get_var("#{name}-spacing") || options.get_var("spacing") || Sass::Script::Number.new(0)).value
+        end
+
+        def digest
+          Digest::MD5.file(file).hexdigest
+        end
+
+        def mtime
+          File.mtime(file)
+        end
+        
+        def hover?
+          base.has_hover?(name)
+        end
+        
+        def hover
+          base.image_for("#{name}_hover")
+        end
+        
+        def target?
+          base.has_target?(name)
+        end
+        
+        def target
+          base.image_for("#{name}_target")
+        end
+        
+        def active?
+          base.has_active?(name)
+        end
+        
+        def active
+          base.image_for("#{name}_active")
+        end
+                
+        private
+          def dimensions
+            @dimensions ||= Compass::SassExtensions::Functions::ImageSize::ImageProperties.new(file).size
+          end
+      end
+    end
+  end
+end

data/lib/compass/{sprites.rb → sass_extensions/sprites/sprite_map.rb}

@@ -1,41 +1,51 @@
 module Compass
-  class Sprites < Sass::Importers::Base
-    attr_accessor :name
-    attr_accessor :path
-    
-    class << self
-      def path_and_name(uri)
-        if uri =~ %r{((.+/)?(.+))/(.+?)\.png}
-          [$1, $3, $4]
-        end
-      end
-    
-      def discover_sprites(uri)
-        glob = File.join(Compass.configuration.images_path, uri)
-        Dir.glob(glob).sort
-      end
+  class SpriteMap
+    attr_reader :uri, :options
 
-      def sprite_name(file)
-        File.basename(file, '.png')
-      end
+    def initialize(uri, options)
+      @uri, @options = uri, options
+    end
+
+    def name
+      ensure_path_and_name!
+      @name
+    end
 
+    def path
+      ensure_path_and_name!
+      @path
     end
 
-    def find_relative(*args)
-      nil
+    def files
+      @files ||= Dir[File.join(Compass.configuration.images_path, uri)].sort
     end
 
-    def find(uri, options)
-      if uri =~ /\.png$/
-        self.path, self.name = Compass::Sprites.path_and_name(uri)
-        options.merge! :filename => name, :syntax => :scss, :importer => self
-        sprite_files = Compass::Sprites.discover_sprites(uri)
-        image_names = sprite_files.map {|i| Compass::Sprites.sprite_name(i) }
-        Sass::Engine.new(content_for_images(uri, name, image_names), options)
+    def sprite_names
+      @sprite_names ||= files.collect { |file| File.basename(file, '.png') }
+    end
+
+    def sass_options
+      @sass_options ||= options.merge(:filename => name, :syntax => :scss, :importer => self)
+    end
+
+    def mtime
+      Compass.quick_cache("mtime:#{uri}") do
+        files.collect { |file| File.mtime(file) }.max
       end
     end
 
-    def content_for_images(uri, name, images, skip_overrides = false)
+    def sass_engine
+      Sass::Engine.new(content_for_images, options)
+    end
+
+    private
+    def ensure_path_and_name!
+      return if @path && @name
+      uri =~ %r{((.+/)?(.+))/(.+?)\.png}
+      @path, @name = $1, $3
+    end
+
+    def content_for_images(skip_overrides = false)
       <<-SCSS
 @import "compass/utilities/sprites/base";
 
@@ -46,8 +56,9 @@ $#{name}-sprite-dimensions: false !default;
 $#{name}-position: 0% !default;
 $#{name}-spacing: 0 !default;
 $#{name}-repeat: no-repeat !default;
+$#{name}-prefix: '' !default;
 
-#{skip_overrides ? "$#{name}-sprites: sprite-map(\"#{uri}\");" : generate_overrides(uri, name, images) }
+#{skip_overrides ? "$#{name}-sprites: sprite-map(\"#{uri}\");" : generate_overrides }
 
 // All sprites should extend this class
 // The #{name}-sprite mixin will do so for you.
@@ -79,44 +90,26 @@ $#{name}-repeat: no-repeat !default;
 
 // Generates a class for each sprited image.
 @mixin all-#{name}-sprites($dimensions: $#{name}-sprite-dimensions, $prefix: sprite-map-name($#{name}-sprites)) {
-  @include #{name}-sprites(#{images.join(" ")}, $dimensions, $prefix);
+  @include #{name}-sprites(#{sprite_names.join(" ")}, $dimensions, $prefix);
 }
 SCSS
     end
 
-    def key(uri, options)
-      [self.class.name + ":" + File.dirname(File.expand_path(uri)),
-        File.basename(uri)]
-    end
-
-    def mtime(uri, options)
-      Compass.quick_cache("mtime:#{uri}") do
-        self.path, self.name = Compass::Sprites.path_and_name(uri)
-        glob = File.join(Compass.configuration.images_path, uri)
-        Dir.glob(glob).inject(Time.at(0)) do |max_time, file|
-          (t = File.mtime(file)) > max_time ? t : max_time
-        end
-      end
-    end
-    
-    def to_s
-      ""
-    end
-
-    def generate_overrides(uri, name,images)
+    def generate_overrides
       content = <<-TXT
 // These variables control the generated sprite output
 // You can override them selectively before you import this file.
       TXT
-      images.map do |sprite_name| 
+      sprite_names.map do |sprite_name| 
         content += <<-SCSS
 $#{name}-#{sprite_name}-position: $#{name}-position !default;
 $#{name}-#{sprite_name}-spacing: $#{name}-spacing !default;
 $#{name}-#{sprite_name}-repeat: $#{name}-repeat !default;
         SCSS
       end.join
+
       content += "\n$#{name}-sprites: sprite-map(\"#{uri}\",\n"
-      content += images.map do |sprite_name| 
+      content += sprite_names.map do |sprite_name| 
 %Q{  $#{sprite_name}-position: $#{name}-#{sprite_name}-position,
   $#{sprite_name}-spacing: $#{name}-#{sprite_name}-spacing,
   $#{sprite_name}-repeat: $#{name}-#{sprite_name}-repeat}
@@ -125,3 +118,4 @@ $#{name}-#{sprite_name}-repeat: $#{name}-repeat !default;
     end
   end
 end
+