compass 0.11.beta.4 → 0.11.beta.5

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 0
 :minor: 11
 :state: beta
-:build: 4
+:build: 5

data/frameworks/compass/stylesheets/compass/utilities/sprites/_base.scss

@@ -24,6 +24,19 @@
   }
 }
 
+// Include the selectors for the `$sprite` given the `$map` and the 
+// `$full-sprite-name`
+// @private
+@mixin sprite_selectors($map, $sprite-name, $full-sprite-name) {
+  @each $selector in $sprite-selectors {
+    @if sprite_has_selector($map, $sprite-name, $selector) {
+      .#{$full-sprite-name}:#{$selector}, .#{$full-sprite-name}_#{$selector}, .#{$full-sprite-name}-#{$selector} {
+        @include sprite($map, "#{$sprite-name}_#{$selector}");
+      }
+    }
+  }
+}
+
 // Generates a class for each space separated name in `$sprite-names`.
 // The class will be of the form .<map-name>-<sprite-name>.
 //
@@ -32,10 +45,13 @@
 // If `$dimensions` is `true`, the sprite dimensions will specified.
 @mixin sprites($map, $sprite-names, $base-class: false, $dimensions: false, $prefix: sprite-map-name($map)) {
   @each $sprite-name in $sprite-names {
-    $full-sprite-name: if($prefix and $prefix != "", "#{$prefix}-#{$sprite-name}", $sprite-name);
-    .#{$full-sprite-name} {
-      @if $base-class { @extend #{$base-class}; }
-      @include sprite($map, $sprite-name, $dimensions);
+    @if sprite_does_not_have_parent($map, $sprite-name) {
+      $full-sprite-name: "#{$prefix}-#{$sprite-name}";
+      .#{$full-sprite-name} {
+        @if $base-class { @extend #{$base-class}; }
+        @include sprite($map, $sprite-name, $dimensions);
+      }
+      @include sprite_selectors($map, $sprite-name, $full-sprite-name);
     }
   }
 }

data/frameworks/compass/stylesheets/compass/utilities/sprites/_sprite-img.scss

@@ -24,6 +24,8 @@ $sprite-image-default-width: $sprite-default-size !default;
 
 $sprite-image-default-height: $sprite-default-size !default;
 
+$sprite-selectors: hover, target, active !default;
+
 // Sets all the rules for a sprite from a given sprite image to show just one of the sprites.
 // To reduce duplication use a sprite-bg mixin for common properties and a sprite-select mixin for positioning.
 @mixin sprite-img($img, $col, $row: 1, $width: $sprite-image-default-width, $height: $sprite-image-default-height, $margin: $sprite-default-margin) {

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

@@ -1,6 +1,6 @@
 module Compass::SassExtensions::Functions::Sprites
   ZERO = Sass::Script::Number::new(0)
-
+  VALID_SELECTORS = %w(hover active target)
   # Provides a consistent interface for getting a variable in ruby
   # from a keyword argument hash that accounts for underscores/dash equivalence
   # and allows the caller to pass a symbol instead of a string.
@@ -34,9 +34,7 @@ module Compass::SassExtensions::Functions::Sprites
   #
   #     background: url('/images/icons.png?12345678') 0 -24px no-repeat;
   def sprite(map, sprite, offset_x = ZERO, offset_y = ZERO)
-    unless map.is_a?(Compass::SassExtensions::Sprites::Base)
-      missing_sprite!("sprite")
-    end
+    verify_map(map)
     unless sprite.is_a?(Sass::Script::String)
       raise Sass::SyntaxError, %Q(The second argument to sprite() must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
     end
@@ -51,18 +49,15 @@ module Compass::SassExtensions::Functions::Sprites
   # Returns the name of a sprite map
   # The name is derived from the folder than contains the sprites.
   def sprite_map_name(map)
-    unless map.is_a?(Compass::SassExtensions::Sprites::Base)
-      missing_sprite!("sprite-map-name")
-    end
+    verify_map(map, "sprite-map-name")
     Sass::Script::String.new(map.name)
   end
   Sass::Script::Functions.declare :sprite_name, [:sprite]
 
   # Returns the path to the original image file for the sprite with the given name
   def sprite_file(map, sprite)
-    unless map.is_a?(Compass::SassExtensions::Sprites::Base)
-      missing_sprite!("sprite-file")
-    end
+    verify_map(map, "sprite")
+    verify_sprite(sprite)
     if image = map.image_for(sprite.value)
       Sass::Script::String.new(image.relative_file)
     else
@@ -71,11 +66,31 @@ module Compass::SassExtensions::Functions::Sprites
   end
   Sass::Script::Functions.declare :sprite_file, [:map, :sprite]
 
+  # Returns voolean if sprite has a parent
+  def sprite_does_not_have_parent(map, sprite)
+    verify_map map
+    verify_sprite sprite
+    Sass::Script::Bool.new map.image_for(sprite.value).parent.nil?
+  end
+  
+  Sass::Script::Functions.declare :sprite_does_not_have_parent, [:map, :sprite]
+
+  # Returns boolean if sprite has the selector
+  def sprite_has_selector(map, sprite, selector)
+    verify_map map
+    verify_sprite sprite
+    unless VALID_SELECTORS.include?(selector.value)
+      raise Sass::SyntaxError, "Invalid Selctor did you mean one of: #{VALID_SELECTORS.join(', ')}"
+    end
+    Sass::Script::Bool.new map.send(:"has_#{selector.value}?", sprite)
+  end
+  
+  Sass::Script::Functions.declare :sprite_has_selector, [:map, :sprite, :selector]
+
+
   # Returns a url to the sprite image.
   def sprite_url(map)
-    unless map.is_a?(Compass::SassExtensions::Sprites::Base)
-      missing_sprite!("sprite-url")
-    end
+    verify_map(map, "sprite-url")
     map.generate
     image_url(Sass::Script::String.new("#{map.path}-#{map.uniqueness_hash}.png"),
               Sass::Script::Bool.new(false),
@@ -103,9 +118,7 @@ module Compass::SassExtensions::Functions::Sprites
   #
   #     background-position: 3px -36px;
   def sprite_position(map, sprite = nil, offset_x = ZERO, offset_y = ZERO)
-    unless map.is_a?(Compass::SassExtensions::Sprites::Base)
-      missing_sprite!("sprite-position")
-    end
+    verify_map(map, "sprite-position")
     unless sprite && sprite.is_a?(Sass::Script::String)
       raise Sass::SyntaxError, %Q(The second argument to sprite-position must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
     end
@@ -134,6 +147,18 @@ module Compass::SassExtensions::Functions::Sprites
 
 protected
 
+  def verify_map(map, error = "sprite")
+    unless map.is_a?(Compass::SassExtensions::Sprites::Base)
+      missing_sprite!(error)
+    end
+  end
+
+  def verify_sprite(sprite)
+    unless sprite.is_a?(Sass::Script::String)
+      raise Sass::SyntaxError, %Q(The second argument to sprite() must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
+    end
+  end
+
   def missing_image!(map, sprite)
     raise Sass::SyntaxError, "No sprite called #{sprite} found in sprite map #{map.path}/#{map.name}. Did you mean one of: #{map.sprite_names.join(", ")}"
   end

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

@@ -2,6 +2,10 @@ module Compass
   module SassExtensions
     module Sprites
       class Base < Sass::Script::Literal
+        
+        
+        # Initialize a new aprite 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)
           sprite_map = ::Compass::SpriteMap.new(uri.value, {})
 
@@ -10,7 +14,8 @@ module Compass
           end
           new(sprites, sprite_map.path, sprite_map.name, context, kwargs)
         end
-
+        
+        # Loads the sprite engine
         def require_engine!
           self.class.send(:include, eval("::Compass::SassExtensions::Sprites::#{modulize}Engine"))
         end
@@ -41,13 +46,15 @@ module Compass
       
         # 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!
           @height = @images.last.top + @images.last.height
         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, options)
@@ -66,27 +73,34 @@ module Compass
             image.top = last_image.top + last_image.height + [image.spacing,  last_image.spacing].max
           end
         end
-
+        
+        # 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
 
+
+        # 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/
@@ -108,11 +122,13 @@ module Compass
             Compass.configuration.run_callback(:sprite_generated, sprite_data)
           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
@@ -128,6 +144,7 @@ module Compass
           @uniqueness_hash
         end
 
+        # Saves the sprite engine
         def save!(output_png)
           saved = output_png.save filename
           Compass.configuration.run_callback(:sprite_saved, filename)
@@ -142,13 +159,14 @@ module Compass
         # Checks whether this sprite is outdated
         def outdated?
           if File.exists?(filename)
-            return @images.map(&:mtime).any? { |mtime| mtime > self.mtime }
+            return @images.map(&:mtime).any? { |imtime| imtime.to_i > self.mtime.to_i }
           end
           true
         end
 
+        # Mtime of the sprite file
         def mtime
-          File.mtime(filename)
+          @mtime ||= File.mtime(filename)
         end
 
         def inspect

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

@@ -11,7 +11,6 @@ module Compass
         
         # 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)

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

@@ -2,6 +2,11 @@ module Compass
   module SassExtensions
     module Sprites
       class Image
+        ACTIVE = %r{[_-]active$}
+        TARGET = %r{[_-]target$}
+        HOVER = %r{[_-]hover$}
+        PARENT = %r{(.+)[-_](.+)$}
+        
         attr_reader :relative_file, :options, :base
         attr_accessor :top, :left
 
@@ -9,23 +14,28 @@ module Compass
           @base, @relative_file, @options = base, relative_file, options
           @left = @top = 0
         end
-
+        
+        # The Full path to the image
         def file
           File.join(Compass.configuration.images_path, relative_file)
         end
-
+        
+        # Width of the image
         def width
           dimensions.first
         end
-
+        
+        # Height of the image
         def height
           dimensions.last
         end
-
+        
+        # Basename of the image
         def name
           File.basename(relative_file, '.png')
         end
 
+        # Value of <tt> $#{name}-repeat </tt> or <tt> $repeat </tt>
         def repeat
           [ "#{name}-repeat", "repeat" ].each { |which|
             if var = options.get_var(which)
@@ -35,49 +45,69 @@ module Compass
           "no-repeat"
         end
 
+        # Value of <tt> $#{name}-position </tt> or <tt> $position </tt> defaults o <tt>0px</tt>
         def position
           options.get_var("#{name}-position") || options.get_var("position") || Sass::Script::Number.new(0, ["px"])
         end
-
+        
+        # Offset within the sprite
         def offset
           (position.unitless? || position.unit_str == "px") ? position.value : 0
         end
-
+        
+        # Spacing between this image and the next
         def spacing
           (options.get_var("#{name}-spacing") || options.get_var("spacing") || Sass::Script::Number.new(0)).value
         end
 
+        # MD5 hash of this file
         def digest
           Digest::MD5.file(file).hexdigest
         end
-
+        
+        # mtime of this file
         def mtime
           File.mtime(file)
         end
         
+        # Is hover selector
         def hover?
-          base.has_hover?(name)
+          name =~ HOVER
         end
         
+        # Hover selector Image object if exsists
         def hover
           base.image_for("#{name}_hover")
         end
         
+        # Is target selector
         def target?
-          base.has_target?(name)
+          name =~ TARGET
         end
         
+        # Target selector Image object if exsists
         def target
           base.image_for("#{name}_target")
         end
         
+        # Is active selector
         def active?
-          base.has_active?(name)
+          name =~ ACTIVE
         end
         
+        # Active selector Image object if exsists
         def active
           base.image_for("#{name}_active")
         end
+        
+        
+        def parent
+          if [hover?, target?, active?].any?
+            PARENT.match name
+            base.image_for($1)
+          end
+        end
+        
                 
         private
           def dimensions

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

@@ -2,49 +2,60 @@ module Compass
   class SpriteMap
     attr_reader :uri, :options
 
+
+    def find_relative(*args)
+      nil
+    end
+
     def initialize(uri, options)
       @uri, @options = uri, options
     end
 
+    # Name of this spite
     def name
       ensure_path_and_name!
       @name
     end
 
+    # The on-disk location of this sprite
     def path
       ensure_path_and_name!
       @path
     end
-
+    
+    # Returns the Glob of image files for this sprite
     def files
       @files ||= Dir[File.join(Compass.configuration.images_path, uri)].sort
     end
 
+    # Returns an Array of image names without the file extension
     def sprite_names
       @sprite_names ||= files.collect { |file| File.basename(file, '.png') }
     end
-
+    
+    # Returns the sass options for this sprite
     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
-
+    
+    # Returns a Sass::Engine for this sprite object
     def sass_engine
-      Sass::Engine.new(content_for_images, options)
+      Sass::Engine.new(content_for_images, sass_options)
     end
-
-    private
+    
     def ensure_path_and_name!
-      return if @path && @name
-      uri =~ %r{((.+/)?(.+))/(.+?)\.png}
-      @path, @name = $1, $3
+      @path, @name = Compass::Sprites.path_and_name(uri)
+    end
+    
+    def key(uri, options)
+      Compass::Sprites.key(uri)
     end
 
+    def mtime(uri, options)
+      Compass::Sprites.mtime(uri, options)
+    end
+
+    # Generates the Sass for this sprite file
     def content_for_images(skip_overrides = false)
       <<-SCSS
 @import "compass/utilities/sprites/base";
@@ -94,7 +105,11 @@ $#{name}-prefix: '' !default;
 }
 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 generate_overrides
       content = <<-TXT
 // These variables control the generated sprite output

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

@@ -1,24 +1,51 @@
 module Compass
   class Sprites < Sass::Importers::Base
-    def find_relative(*args)
-      nil
+    attr_accessor :name, :path
+    
+    def self.path_and_name(uri)
+      if uri =~ %r{((.+/)?(.+))/(.+?)\.png}
+        [$1, $3, $4]
+      end
     end
 
+    def self.discover_sprites(uri)
+      self.load_map(uri, options).files
+    end
+
+    def self.sprite_name(file)
+      File.basename(file, '.png')
+    end
+  
+    def self.load_map(uri, options)
+      Compass.quick_cache("spritemap:#{uri}", 5) do
+        SpriteMap.new(uri, options)
+      end
+    end
+  
+  
+    # Called by the sass engine to build a new SpriteMap
     def find(uri, options)
       if uri =~ /\.png$/
-        SpriteMap.new(uri, options).sass_engine
+        map = Compass::Sprites.load_map(uri, options)
+        self.path, self.name = map.path, map.name
+        return map.sass_engine
       end
     end
-
-    def key(uri, options)
-      [self.class.name + ":" + File.dirname(File.expand_path(uri)),
-        File.basename(uri)]
+  
+    # Called by the sass engine to identify the SpriteMap
+    def self.key(uri, options={})
+     [self.class.name + ":" + File.dirname(File.expand_path(uri)), File.basename(uri)]
     end
 
-    def mtime(uri, options)
-      SpriteMap.new(uri, options).mtime
+    def self.mtime(uri, options)
+      Compass.quick_cache("mtime:#{uri}") do
+        map = Compass::Sprites.load_map(uri, options)
+        map.files.inject(Time.at(0)) do |max_time, file|
+          (t = File.mtime(file)) > max_time ? t : max_time
+        end
+      end
     end
-    
+  
     def to_s
       ""
     end

metadata

@@ -2,7 +2,7 @@
 name: compass
 version: !ruby/object:Gem::Version 
   prerelease: 5
-  version: 0.11.beta.4
+  version: 0.11.beta.5
 platform: ruby
 authors: 
 - Chris Eppstein
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -07:00
+date: 2011-03-26 00:00:00 -07:00
 default_executable: compass
 dependencies: 
 - !ruby/object:Gem::Dependency