compass 0.12.2 → 0.13.alpha.4

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

@@ -1,5 +1,6 @@
 module Compass::SassExtensions::Functions::Sprites
   ZERO = Sass::Script::Number::new(0)
+  BOOL_FALSE = Sass::Script::Bool::new(false)
   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
@@ -10,15 +11,37 @@ module Compass::SassExtensions::Functions::Sprites
     end
   end
 
-  #Returns a list of all sprite names
+  # Returns the width of the generated sprite map
+  def sprite_width(map, sprite=nil)
+    verify_map(map, 'sprite-width')
+    file = get_sprite_file(map, sprite)
+    width, _ = image_dimensions(file)
+    Sass::Script::Number.new(width, ["px"])
+  end
+  Sass::Script::Functions.declare :sprite_width, [:map]
+  Sass::Script::Functions.declare :sprite_width, [:map, :sprite]
+  
+  # Returns the height of the generated sprite map
+  def sprite_height(map, sprite=nil)
+    verify_map(map, 'sprite-height')
+    file = get_sprite_file(map, sprite)
+    _, height = image_dimensions(file)
+    Sass::Script::Number.new(height, ["px"])
+  end
+  Sass::Script::Functions.declare :sprite_height, [:map]
+  Sass::Script::Functions.declare :sprite_height, [:map, :sprite]
+
+  # Returns a list of all sprite names
   def sprite_names(map)
+    verify_map(map, 'sprite-names')
     Sass::Script::List.new(map.sprite_names.map { |f| Sass::Script::String.new(f) }, ' ')
   end
   Sass::Script::Functions.declare :sprite_names, [:map]
 
   # Returns the system path of the sprite file
   def sprite_path(map)
-    Sass::Script::String.new(map.name_and_hash)
+    verify_map(map, 'sprite-path')
+    Sass::Script::String.new(map.filename)
   end
   Sass::Script::Functions.declare :sprite_path, [:map]
 
@@ -30,7 +53,8 @@ module Compass::SassExtensions::Functions::Sprites
   def inline_sprite(map)
     verify_map(map, "sprite-url")
     map.generate
-    inline_image(sprite_path(map))
+    path = map.filename
+    inline_image_string(data(path), compute_mime_type(path))
   end
   Sass::Script::Functions.declare :inline_sprite, [:map]
 
@@ -57,19 +81,24 @@ module Compass::SassExtensions::Functions::Sprites
   # Becomes:
   #
   #     background: url('/images/icons.png?12345678') 0 -24px no-repeat;
-  def sprite(map, sprite, offset_x = ZERO, offset_y = ZERO)
-    sprite = convert_sprite_name(sprite)    
+  #
+  # If the `use_percentages` parameter is passed as true, percentages will be
+  # used to position the sprite. Example output:
+  #     
+  #     background: url('/images/icons.png?12345678') 0 50% no-repeat;
+  #
+  def sprite(map, sprite, offset_x = ZERO, offset_y = ZERO, use_percentages = BOOL_FALSE)
+    sprite = convert_sprite_name(sprite)
     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
+    verify_sprite(sprite)
     url = sprite_url(map)
-    position = sprite_position(map, sprite, offset_x, offset_y)
+    position = sprite_position(map, sprite, offset_x, offset_y, use_percentages)
     Sass::Script::List.new([url] + position.value, :space)
   end
   Sass::Script::Functions.declare :sprite, [:map, :sprite]
   Sass::Script::Functions.declare :sprite, [:map, :sprite, :offset_x]
   Sass::Script::Functions.declare :sprite, [:map, :sprite, :offset_x, :offset_y]
+  Sass::Script::Functions.declare :sprite, [:map, :sprite, :offset_x, :offset_y, :use_percentages]
 
   # Returns the name of a sprite map
   # The name is derived from the folder than contains the sprites.
@@ -115,6 +144,13 @@ module Compass::SassExtensions::Functions::Sprites
   
   Sass::Script::Functions.declare :sprite_has_selector, [:map, :sprite, :selector]
 
+  # Determines if the CSS selector is valid
+  def sprite_has_valid_selector(selector)
+    unless selector.value =~ /\A#{Sass::SCSS::RX::IDENT}\Z/
+      raise Sass::SyntaxError, "#{selector} must be a legal css identifier"
+    end
+    Sass::Script::Bool.new true
+  end
 
   # Returns a url to the sprite image.
   def sprite_url(map)
@@ -143,39 +179,63 @@ module Compass::SassExtensions::Functions::Sprites
   # Would change the above output to:
   #
   #     background-position: 3px -36px;
-  def sprite_position(map, sprite = nil, offset_x = ZERO, offset_y = ZERO)
+  #
+  # If you set the `use_percentages` parameter to true, the position will be
+  # expressed in percentages. An example:
+  #
+  #     background-position: sprite-position($icons, new, 0, 0, true);
+  #
+  # Would result in something like this:
+  #
+  #     background-position: 0 42%;
+  # 
+  def sprite_position(map, sprite = nil, offset_x = ZERO, offset_y = ZERO, use_percentages = BOOL_FALSE)
     assert_type offset_x, :Number
     assert_type offset_y, :Number
     sprite = convert_sprite_name(sprite)
     verify_map(map, "sprite-position")
-    unless sprite && sprite.is_a?(Sass::Script::String)
+    unless sprite.is_a?(Sass::Script::String) || sprite.is_a?(Sass::Script::Number)
       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
     image = map.image_for(sprite.value)
     unless image
       missing_image!(map, sprite)
     end
-    if offset_x.unit_str == "%"
-      x = offset_x # CE: Shouldn't this be a percentage of the total width?
+    if use_percentages.value
+      xdivis = map.width - image.width;
+      x = (offset_x.value + image.left.to_f) / (xdivis.nonzero? || 1) * 100
+      x = Sass::Script::Number.new(x, x == 0 ? [] : ["%"])
+      ydivis = map.height - image.height;
+      y = (offset_y.value + image.top.to_f) / (ydivis.nonzero? || 1) * 100
+      y = Sass::Script::Number.new(y, y == 0 ? [] : ["%"])
     else
-      x = offset_x.value - image.left
-      x = Sass::Script::Number.new(x, x == 0 ? [] : ["px"])
+      if offset_x.unit_str == "%"
+        x = offset_x # CE: Shouldn't this be a percentage of the total width?
+      else
+        x = offset_x.value - image.left
+        x = Sass::Script::Number.new(x, x == 0 ? [] : ["px"])
+      end
+      y = offset_y.value - image.top
+      y = Sass::Script::Number.new(y, y == 0 ? [] : ["px"])
     end
-    y = offset_y.value - image.top
-    y = Sass::Script::Number.new(y, y == 0 ? [] : ["px"])
     Sass::Script::List.new([x, y],:space)
   end
   Sass::Script::Functions.declare :sprite_position, [:map]
   Sass::Script::Functions.declare :sprite_position, [:map, :sprite]
   Sass::Script::Functions.declare :sprite_position, [:map, :sprite, :offset_x]
   Sass::Script::Functions.declare :sprite_position, [:map, :sprite, :offset_x, :offset_y]
-
-  def sprite_image(*args)
-    raise Sass::SyntaxError, %Q(The sprite-image() function has been replaced by sprite(). See http://compass-style.org/help/tutorials/spriting/ for more information.)
-  end
+  Sass::Script::Functions.declare :sprite_position, [:map, :sprite, :offset_x, :offset_y, :use_percentages]
 
 protected
 
+  def get_sprite_file(map, sprite=nil)
+    if sprite
+      map.image_for(sprite).file
+    else
+      map.filename
+    end
+  end
+
   def reversed_color_names
     if Sass::Script::Color.const_defined?(:HTML4_COLORS_REVERSE)
       Sass::Script::Color::HTML4_COLORS_REVERSE
@@ -202,7 +262,7 @@ protected
   end
 
   def verify_sprite(sprite)
-    unless sprite.is_a?(Sass::Script::String)
+    unless sprite.is_a?(Sass::Script::String) || sprite.is_a?(Sass::Script::Number)
       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

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

@@ -44,9 +44,10 @@ module Compass::SassExtensions::Functions::Urls
       if base.respond_to?(:declare)
         base.declare :font_url,       [:path]
         base.declare :font_url,       [:path, :only_path]
+        base.declare :font_url,       [:path, :only_path, :cache_buster]
       end
     end
-    def font_url(path, only_path = Sass::Script::Bool.new(false))
+    def font_url(path, only_path = Sass::Script::Bool.new(false), cache_buster = Sass::Script::Bool.new(false))
       path = path.value # get to the string value of the literal.
 
       # Short curcuit if they have provided an absolute url.
@@ -62,7 +63,33 @@ module Compass::SassExtensions::Functions::Urls
                           Compass.configuration.http_fonts_path
                         end
 
-      path = "#{http_fonts_path}/#{path}"
+      # Compute the real path to the font on the file system if the fonts_dir is set.
+      real_path = if Compass.configuration.fonts_dir
+        File.join(Compass.configuration.project_path, Compass.configuration.fonts_dir, path)
+      end
+
+      # prepend the path to the font if there's one
+      if http_fonts_path
+        http_fonts_path = "#{http_fonts_path}/" unless http_fonts_path[-1..-1] == "/"
+        path = "#{http_fonts_path}#{path}"
+      end
+
+      # Compute the asset host unless in relative mode.
+      asset_host = if !relative? && Compass.configuration.asset_host
+        Compass.configuration.asset_host.call(path)
+      end
+
+      # Compute and append the cache buster if there is one.
+      if cache_buster.to_bool
+        if cache_buster.is_a?(Sass::Script::String)
+          path += "?#{cache_buster.value}"
+        else
+          path = cache_busted_path(path, real_path)
+        end
+      end
+
+      # prepend the asset host if there is one.
+      path = "#{asset_host}#{'/' unless path[0..0] == "/"}#{path}" if asset_host
 
       if only_path.to_bool
         Sass::Script::String.new(clean_path(path))
@@ -103,8 +130,10 @@ module Compass::SassExtensions::Functions::Urls
       end
 
       # Compute the real path to the image on the file stystem if the images_dir is set.
-      real_path = if Compass.configuration.images_dir
-        File.join(Compass.configuration.project_path, Compass.configuration.images_dir, path)
+      real_path = if Compass.configuration.images_path
+        File.join(Compass.configuration.images_path, path)
+      else
+        File.join(Compass.configuration.project_path, path)
       end
 
       # prepend the path to the image if there's one
@@ -168,8 +197,10 @@ module Compass::SassExtensions::Functions::Urls
       end
 
       # Compute the real path to the image on the file stystem if the generated_images_dir is set.
-      real_path = if Compass.configuration.generated_images_dir
-        File.join(Compass.configuration.project_path, Compass.configuration.generated_images_dir, path)
+      real_path = if Compass.configuration.images_path
+        File.join(Compass.configuration.images_path, path)
+      else
+        File.join(Compass.configuration.project_path, path)
       end
 
       # prepend the path to the image if there's one

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

@@ -0,0 +1,10 @@
+module Compass::SassExtensions::Functions::Utility
+
+  def file_exists(path_to_file)
+    path = path_to_file.respond_to?(:value) ? path_to_file.value : path_to_file
+    Sass::Script::Bool.new(File.exists?(path));
+  end
+
+  Sass::Script::Functions.declare :file_exists, [:path_to_file]
+
+end

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

@@ -12,7 +12,11 @@ module Compass
         def construct_sprite
           @canvas = ChunkyPNG::Image.new(width, height, ChunkyPNG::Color::TRANSPARENT)
           images.each do |image|
-            input_png  = ChunkyPNG::Image.from_file(image.file)
+            input_png = begin
+              ChunkyPNG::Image.from_file(image.file)
+            rescue ChunkyPNG::SignatureMismatch
+              raise Compass::SpriteException, "You have provided a file that does not have a PNG signature. Only PNG files are supported by the default sprite engine"
+            end
             canvas.replace! input_png, image.left, image.top
           end
         end    

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

@@ -9,11 +9,11 @@ module Compass
         end
         
         def construct_sprite
-          raise ::Compass::Error, "You must impliment construct_sprite"
+          raise ::Compass::Error, "You must implement construct_sprite"
         end
         
         def save(filename)
-          raise ::Compass::Error, "You must impliment save(filename)"
+          raise ::Compass::Error, "You must implement save(filename)"
         end
         
       end
@@ -22,4 +22,4 @@ module Compass
 end
 
 
-require 'compass/sass_extensions/sprites/engines/chunky_png_engine'
+require 'compass/sass_extensions/sprites/engines/chunky_png_engine'

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

@@ -8,9 +8,10 @@ module Compass
         PARENT = %r{(.+)[-_](.+)$}
 
         REPEAT_X = 'repeat-x'
+        REPEAT_Y = 'repeat-y'
         NO_REPEAT = 'no-repeat'
 
-        VALID_REPEATS = [REPEAT_X, NO_REPEAT]
+        VALID_REPEATS = [REPEAT_Y, REPEAT_X, NO_REPEAT]
         
         attr_reader :relative_file, :options, :base
         attr_accessor :top, :left
@@ -50,7 +51,7 @@ module Compass
         
         # Basename of the image
         def name
-          File.basename(relative_file, '.png')
+          @name ||= File.basename(relative_file, '.png')
         end
 
         def get_var_file(var)
@@ -73,6 +74,10 @@ module Compass
           repeat == REPEAT_X
         end
 
+        def repeat_y?
+          repeat == REPEAT_Y
+        end
+
         def no_repeat?
           repeat == NO_REPEAT
         end

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

@@ -4,7 +4,11 @@ module Compass
       module ImageMethods
         # Fetches the Sprite::Image object for the supplied name
          def image_for(name)
-           @images.detect { |img| img.name == name}
+          if name.is_a?(Sass::Script::String)
+            name = name.value
+          end
+          name = name.to_s
+          @images.detect { |img| img.name == name}
          end
 
          # Returns true if the image name has a hover selector image

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

@@ -0,0 +1,29 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      class Images < Array
+
+        def sort_by!(method)
+          invert = false
+          if method.to_s[0] == '!'[0] # have todo this for 1.8.7 compat
+            method = method.to_s[1..-1]
+            invert = true
+          end
+          method = method.to_sym
+          self.sort! do |a, b|
+            unless a.send(method) == b.send(method)
+              a.send(method) <=> b.send(method)
+            else
+              other = ([:size, :name] - [method]).first
+              a.send(other) <=> b.send(other)
+            end
+          end
+          self.reverse! if invert
+        end
+
+
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module Layout
+        class Diagonal < SpriteLayout
+
+          def layout!
+            calculate_width!
+            calculate_height!
+            calculate_positions!
+          end
+
+        private # ===========================================================================================>
+
+          def calculate_width!
+            @width = @images.inject(0) {|sum, img| sum + img.width}
+          end
+
+          def calculate_height!
+            @height = @images.inject(0) {|sum, img| sum + img.height}
+          end
+
+          def calculate_positions!
+            previous = nil
+            @images.each_with_index do |image, index|
+              if previous.nil?
+                previous = image
+                image.top = @height - image.height
+                image.left = 0
+                next
+              end
+              image.top = previous.top - image.height
+              image.left = previous.left + previous.width
+              previous = image
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module Layout
+        class Horizontal < SpriteLayout
+
+          def layout!
+            calculate_height!
+            calculate_width!
+            calculate_positions!
+            tile_images_that_repeat!
+          end
+
+        private # ===========================================================================================>
+
+          def calculate_height!
+            @height = @images.map {|image| image.height + image.offset}.max
+            if repeating_images?
+              calculate_repeat_extra_height!
+            end
+            @height
+          end
+
+          def calculate_width!
+            @width = @images.inject(0) { |sum, image| sum += (image.width + image.spacing) }
+          end
+
+          def repeating_images?
+            @repeating_images ||= @images.any?(&:repeat_y?)
+          end
+
+          def calculate_repeat_extra_height!
+            m = @images.inject(1) {|m,img| img.repeat_y? ? m.lcm(img.height) : m }
+            remainder = @height % m
+            @height += (m - remainder) unless remainder.zero?
+          end
+
+          def calculate_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.spacing, last_image.spacing].max
+            end
+          end
+
+          def tile_images_that_repeat!
+            return unless repeating_images?
+            @images.map {|img| img if img.repeat_y?}.compact.each do |image|
+              y = (image.top + image.height)
+              while y < @height do
+                begin
+                  img = image.dup
+                  img.top = y.to_i
+                  @images << img
+                  y += image.height
+                end 
+              end #while
+            end 
+          end 
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module Layout
+        class Smart < SpriteLayout
+
+          def layout!
+            calculate_positions!
+          end
+
+        private # ===========================================================================================>
+
+          def calculate_positions!
+            fitter = ::Compass::SassExtensions::Sprites::RowFitter.new(@images)
+            current_y = 0
+            fitter.fit!.each do |row|
+              current_x = 0
+              row.images.each_with_index do |image, index|
+                image.left = current_x
+                image.top = current_y
+                current_x += image.width
+              end
+              current_y += row.height
+            end
+            @width = fitter.width
+            @height = fitter.height
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module Layout
+        class Vertical < SpriteLayout
+
+          def layout!
+            calculate_width!
+            calculate_positions!
+            calculate_height!
+            tile_images_that_repeat!
+          end
+
+        private # ===========================================================================================>
+
+          def calculate_width!
+            @width = @images.map { |image| image.width + image.offset }.max
+            if repeating_images?
+              calculate_repeat_extra_width!
+            end
+
+            @width
+          end
+
+          def calculate_height!
+            last    = @images.last
+            @height = last.top + last.height
+          end
+
+          def repeating_images?
+            @repeating_images ||= @images.any?(&:repeat_x?)
+          end
+
+          def calculate_repeat_extra_width!
+            m = @images.inject(1) {|m,img| img.repeat_x? ? m.lcm(img.width) : m }
+            remainder = @width % m
+            @width += (m - remainder) unless remainder.zero?
+          end
+
+          def calculate_positions!
+            @images.each_with_index do |image, index|
+            image.left = (image.position.unit_str == "%" ? (@width - image.width) * (image.position.value / 100.0) : image.position.value).to_i
+            next if index == 0
+            last_image = @images[index-1]
+            image.top = last_image.top + last_image.height + [image.spacing,  last_image.spacing].max
+            end #each_with_index
+          end #method
+
+          def tile_images_that_repeat!
+            return unless repeating_images?
+            @images.map {|img| img if img.repeat_x?}.compact.each do |image|
+              x = image.left - (image.left / image.width).ceil * image.width
+              while x < @width do
+                begin
+                  img = image.dup
+                  img.top = image.top
+                  img.left = x.to_i
+                  @images << img
+                  x += image.width 
+                end #begin
+              end #while
+            end #map
+          end #method
+        end #Vertical
+      end #Layout
+    end #Sprites
+  end #SassExtensions
+end #Compass

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

@@ -0,0 +1,39 @@
+require 'rational'
+module Compass
+  module SassExtensions
+    module Sprites
+      module Layout
+        class SpriteLayout
+
+          attr_reader :images, :options
+          attr_accessor :height, :width
+
+          def initialize(images, kwargs={})
+            @images  = images
+            @options = kwargs
+            @height  = 0
+            @width   = 0
+            
+            layout!
+          end
+
+          def layout!
+            raise Compass::SpriteException, "You must impliment layout!"
+          end
+
+          def properties
+            if @width.zero?
+              raise Compass::SpriteException, "You must set the width fetching the properties"
+            end
+            if @height.zero?
+              raise Compass::SpriteException, "You must set the height fetching the properties"
+            end
+
+            [@images, @width, @height]
+          end
+
+        end
+      end
+    end
+  end
+end