compass-rails31 0.12.0.alpha.0.91a748a

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

@@ -0,0 +1,32 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module ImageMethods
+        # Fetches the Sprite::Image object for the supplied name
+         def image_for(name)
+           @images.detect { |img| img.name == name}
+         end
+
+         # Returns true if the image name has a hover selector image
+         def has_hover?(name)
+           !image_for("#{name}_hover").nil?
+         end
+
+         # Returns true if the image name has a target selector image
+         def has_target?(name)
+           !image_for("#{name}_target").nil?
+         end
+
+         # Returns true if the image name has an active selector image
+         def has_active?(name)
+           !image_for("#{name}_active").nil?
+         end
+
+         # Return and array of image names that make up this sprite
+         def sprite_names
+           image_names.map { |f| File.basename(f, '.png') }
+         end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module LayoutMethods
+        HORIZONTAL = 'horizontal'
+        
+        def horizontal?
+          @kwargs.get_var('layout').value == HORIZONTAL
+        end
+        
+        # Calculates the overal image dimensions
+        # collects image sizes and input parameters for each sprite
+        def compute_image_positions!
+          if horizontal?
+            calculate_height
+            calculate_horizontal_positions
+            calculate_width
+          else
+            @images.sort! {|a,b| File.size(b.file) <=> File.size(a.file)} #put small images first
+            calculate_width
+            calulate_vertical_postions
+            calculate_height
+          end
+        end
+        
+        def calculate_horizontal_positions
+          @images.each_with_index do |image, index|
+            image.top = image.position.unit_str == '%' ? (@height - image.height) * (image.position.value / 100.0) : image.position.value
+            next if index == 0
+            last_image = @images[index-1]
+            image.left = last_image.left + last_image.width + [image.offset, last_image.offset].max
+          end
+        end
+        
+        def calulate_vertical_postions
+          @images.each_with_index do |image, index|
+            image.left = image.position.unit_str == "%" ? (@width - image.width) * (image.position.value / 100.0) : 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 calculate_dimensions!
+          calculate_width
+          calculate_height
+        end
+        
+        def calculate_height
+          @height = if horizontal?
+            height_for_horizontal_layout
+          else
+            height_for_vertical_layout
+          end
+        end
+        
+        def height_for_vertical_layout
+          last = @images.last
+          last.top + last.height
+        end
+        
+        def height_for_horizontal_layout
+          @height = @images.map {|image| image.height + image.spacing}.max
+        end
+        
+        def calculate_width
+          @width = if horizontal?
+            width_for_horizontal_layout
+          else
+            width_for_vertical_layout
+          end
+        end
+        
+        def width_for_horizontal_layout
+          @images.inject(0) { |sum, image| sum += (image.width + image.offset) }
+        end
+        
+        def width_for_vertical_layout
+          @images.map { |image| image.width + image.offset }.max
+        end
+      end
+    end
+  end
+end
+  

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

@@ -0,0 +1,70 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      class SpriteMap < Sass::Script::Literal
+        attr_accessor :image_names, :path, :name, :map, :kwargs
+        attr_accessor :images, :width, :height, :engine
+
+        include SpriteMethods
+        include ImageMethods
+        include LayoutMethods
+
+
+        # Initialize a new sprite object from a relative file path
+        # the path is relative to the <tt>images_path</tt> confguration option
+        def self.from_uri(uri, context, kwargs)
+          uri = uri.value
+          name, path = Compass::SpriteImporter.path_and_name(uri)
+          files = Compass::SpriteImporter.files(uri)
+          sprites = files.map do |sprite|
+            sprite.gsub("#{Compass.configuration.images_path}/", "")
+          end
+          new(sprites, path, name, context, kwargs)
+        end
+
+        def initialize(sprites, path, name, context, kwargs)
+          @image_names = sprites
+          @path = path
+          @name = name
+          @kwargs = kwargs
+          @kwargs['cleanup'] ||= Sass::Script::Bool.new(true)
+          @kwargs['layout'] ||= Sass::Script::String.new('vertical')
+          @images = nil
+          @width = nil
+          @height = nil
+          @engine = nil
+          @evaluation_context = context
+          validate!
+          compute_image_metadata!
+        end
+
+        def inspect
+          to_s
+        end
+
+        def to_s(kwargs = self.kwargs)
+          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/sprite_methods.rb

@@ -0,0 +1,121 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module SpriteMethods
+        
+        # Changing this string will invalidate all previously generated sprite images.
+        # We should do so only when the packing algorithm changes
+        SPRITE_VERSION = "1"
+        
+        # Calculates the overal image dimensions
+        # collects image sizes and input parameters for each sprite
+        # Calculates the height
+        def compute_image_metadata!
+          @width = 0
+          init_images
+          compute_image_positions!
+          init_engine
+        end
+        
+        def init_engine
+          @engine = eval("::Compass::SassExtensions::Sprites::#{modulize}Engine.new(nil, nil, nil)")
+          @engine.width = @width
+          @engine.height = @height
+          @engine.images = @images
+        end
+        
+        # Creates the Sprite::Image objects for each image and calculates the width
+        def init_images
+          @images = image_names.collect do |relative_file|
+            image = Compass::SassExtensions::Sprites::Image.new(self, relative_file, kwargs)
+            image
+          end
+        end
+        
+        # Validates that the sprite_names are valid sass
+        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}-s#{uniqueness_hash}.png")
+        end
+
+        # Generate a sprite image if necessary
+        def generate
+          if generation_required?
+            if kwargs.get_var('cleanup').value
+              cleanup_old_sprites
+            end
+            engine.construct_sprite
+            Compass.configuration.run_callback(:sprite_generated, engine.canvas)
+            save!
+          end
+        end
+        
+        def cleanup_old_sprites
+          Dir[File.join(Compass.configuration.images_path, "#{path}-*.png")].each do |file|
+            FileUtils.rm file
+          end
+        end
+        
+        # Does this sprite need to be generated
+        def generation_required?
+          !File.exists?(filename) || outdated?
+        end
+
+        # Returns the uniqueness hash for this sprite object
+        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
+
+        # Saves the sprite engine
+        def save!
+          saved = engine.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? { |imtime| imtime.to_i > self.mtime.to_i }
+          end
+          true
+        end
+
+        # Mtime of the sprite file
+        def mtime
+          @mtime ||= File.mtime(filename)
+        end
+        
+       # Calculate the size of the sprite
+        def size
+          [width, height]
+        end
+
+      end
+    end
+  end
+end

data/lib/compass/sprite_importer.rb

@@ -0,0 +1,178 @@
+module Compass
+  class SpriteImporter < Sass::Importers::Base
+    VAILD_FILE_NAME = /\A#{Sass::SCSS::RX::IDENT}\Z/
+    SPRITE_IMPORTER_REGEX = %r{((.+/)?([^\*.]+))/(.+?)\.png}
+    VALID_EXTENSIONS = ['.png']
+
+    # finds all sprite files
+    def self.find_all_sprite_map_files(path)
+      hex = "[0-9a-f]"
+      glob = "*-{,s}#{hex*10}{#{VALID_EXTENSIONS.join(",")}}"
+      Dir.glob(File.join(path, "**", glob))
+    end
+    
+    def find(uri, options)
+      if uri =~ SPRITE_IMPORTER_REGEX
+        return self.class.sass_engine(uri, self.class.sprite_name(uri), self, options)
+      end
+      nil
+    end
+    
+    def find_relative(uri, base, options)
+      find(File.join(base, uri), options)
+    end
+    
+    def to_s
+      self.class.name
+    end
+    
+    def hash
+      self.class.name.hash
+    end
+	
+    def eql?(other)
+      other.class == self.class
+    end
+    
+    def mtime(uri, options)
+      self.class.files(uri).sort.inject(Time.at(0)) do |max_time, file|
+        (t = File.mtime(file)) > max_time ? t : max_time
+      end
+    end
+    
+    def key(uri, options={})
+      [self.class.name + ":sprite:" + File.dirname(File.expand_path(uri)), File.basename(uri)]
+    end
+    
+    def self.path_and_name(uri)
+      if uri =~ SPRITE_IMPORTER_REGEX
+        [$1, $3]
+      else
+        raise Compass::Error, "invalid sprite path"
+      end
+    end
+
+    # Name of this spite
+    def self.sprite_name(uri)
+      _, name = path_and_name(uri)
+      name
+    end
+
+    # The on-disk location of this sprite
+    def self.path(uri)
+      path, _ = path_and_name(uri)
+      path
+    end
+    
+    # Returns the Glob of image files for the uri
+    def self.files(uri)
+      Compass.configuration.sprite_search_path.each do |folder|
+        files = Dir[File.join(folder, uri)].sort
+        next if files.empty?
+        return files
+      end
+    end
+
+    # Returns an Array of image names without the file extension
+    def self.sprite_names(uri)
+      files(uri).collect do |file|
+        filename = File.basename(file, '.png')
+        unless VAILD_FILE_NAME =~ filename
+          raise Compass::Error, "Sprite file names must be legal css identifiers. Please rename #{File.basename(file)}"
+        end
+        filename
+      end
+    end
+    
+    # Returns the sass_options for this sprite
+    def self.sass_options(name, importer, options)
+      options.merge!(:filename => name, :syntax => :scss, :importer => importer)
+    end
+    
+    # Returns a Sass::Engine for this sprite object
+    def self.sass_engine(uri, name, importer, options)
+      Sass::Engine.new(content_for_images(uri, name, options[:skip_overrides]), sass_options(name, importer, options))
+    end
+
+    # Generates the Sass for this sprite file
+    def self.content_for_images(uri, name, skip_overrides = false)
+      <<-SCSS
+@import "compass/utilities/sprites/base";
+
+// General Sprite Defaults
+// You can override them before you import this file.
+$#{name}-sprite-base-class: ".#{name}-sprite" !default;
+$#{name}-sprite-dimensions: false !default;
+$#{name}-position: 0% !default;
+$#{name}-spacing: 0 !default;
+$#{name}-repeat: no-repeat !default;
+$#{name}-prefix: '' !default;
+$#{name}-clean-up: true !default;
+$#{name}-layout:vertical !default;
+
+#{skip_overrides ? "$#{name}-sprites: sprite-map(\"#{uri}\", $layout: $#{name}-layout, $cleanup: $#{name}-clean-up);" : generate_overrides(uri, name) }
+
+// All sprites should extend this class
+// The #{name}-sprite mixin will do so for you.
+\#{$#{name}-sprite-base-class} {
+  background: $#{name}-sprites no-repeat;
+}
+
+// Use this to set the dimensions of an element
+// based on the size of the original image.
+@mixin #{name}-sprite-dimensions($name) {
+  @include sprite-dimensions($#{name}-sprites, $name)
+}
+
+// Move the background position to display the sprite.
+@mixin #{name}-sprite-position($name, $offset-x: 0, $offset-y: 0) {
+  @include sprite-background-position($#{name}-sprites, $name, $offset-x, $offset-y)
+}
+
+// Extends the sprite base class and set the background position for the desired sprite.
+// It will also apply the image dimensions if $dimensions is true.
+@mixin #{name}-sprite($name, $dimensions: $#{name}-sprite-dimensions, $offset-x: 0, $offset-y: 0) {
+  @extend \#{$#{name}-sprite-base-class};
+  @include sprite($#{name}-sprites, $name, $dimensions, $offset-x, $offset-y)
+}
+
+@mixin #{name}-sprites($sprite-names, $dimensions: $#{name}-sprite-dimensions, $prefix: sprite-map-name($#{name}-sprites), $offset-x: 0, $offset-y: 0) {
+  @include sprites($#{name}-sprites, $sprite-names, $#{name}-sprite-base-class, $dimensions, $prefix, $offset-x, $offset-y)
+}
+
+// Generates a class for each sprited image.
+@mixin all-#{name}-sprites($dimensions: $#{name}-sprite-dimensions, $prefix: sprite-map-name($#{name}-sprites), $offset-x: 0, $offset-y: 0) {
+  @include #{name}-sprites(#{sprite_names(uri).join(" ")}, $dimensions, $prefix, $offset-x, $offset-y);
+}
+SCSS
+    end
+    
+    # Generates the override defaults for this Sprite
+    # <tt>$#{name}-#{sprite_name}-position </tt>
+    # <tt> $#{name}-#{sprite_name}-spacing </tt>
+    # <tt> #{name}-#{sprite_name}-repeat: </tt>
+    def self.generate_overrides(uri, name)
+      sprites = sprite_names(uri)
+      content = <<-TXT
+// These variables control the generated sprite output
+// You can override them selectively before you import this file.
+      TXT
+      sprites.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$layout: $#{name}-layout, \n$cleanup: $#{name}-clean-up,\n"
+      content += sprites.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}
+      end.join(",\n")
+      content += ");"
+    end
+  end
+end
+