compass 0.12.4 → 1.0.0

data/lib/compass/sass_extensions/sprites.rb

@@ -8,6 +8,8 @@ module Compass
   end
 end
 
+require 'compass/sass_extensions/sprites/images'
+require 'compass/sass_extensions/sprites/layout'
 require 'compass/sass_extensions/sprites/image_row'
 require 'compass/sass_extensions/sprites/row_fitter'
 require 'compass/sass_extensions/sprites/image'

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

@@ -12,22 +12,24 @@ 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
-
+        end    
+        
         def save(filename)
           if canvas.nil?
             construct_sprite
           end
-
-          Sass::Util.atomic_create_and_write_file(filename) do |file|
-            canvas.write(file, Compass.configuration.chunky_png_options)
-          end
+          
+          canvas.save(filename,  Compass.configuration.chunky_png_options)
         end
-
+        
       end
     end
   end
-end
+end  

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

@@ -2,29 +2,33 @@ module Compass
   module SassExtensions
     module Sprites
       class Image
+        include Sass::Script::Value::Helpers
         ACTIVE = %r{[_-]active$}
         TARGET = %r{[_-]target$}
         HOVER = %r{[_-]hover$}
+        FOCUS = %r{[_-]focus$}
         PARENT = %r{(.+)[-_](.+)$}
 
         REPEAT_X = 'repeat-x'
+        REPEAT_Y = 'repeat-y'
         NO_REPEAT = 'no-repeat'
 
-        VALID_REPEATS = [REPEAT_X, NO_REPEAT]
-        
-        attr_reader :relative_file, :options, :base
+        VALID_REPEATS = [REPEAT_Y, REPEAT_X, NO_REPEAT]
+
+        attr_reader :relative_file, :options, :base, :name
         attr_accessor :top, :left
 
         def initialize(base, relative_file, options)
           @base, @relative_file, @options = base, relative_file, options
           @left = @top = 0
+          @name = File.basename(relative_file, '.png')
         end
-        
+
         # The Full path to the image
         def file
           @file ||= find_file
         end
-        
+
         def find_file
           Compass.configuration.sprite_load_path.compact.each do |path|
             f = File.join(path, relative_file)
@@ -33,34 +37,29 @@ module Compass
             end
           end
         end
-        
+
         # Width of the image
         def width
           dimensions.first
         end
-        
+
         def size
           @size ||= File.size(file)
         end
-        
+
         # Height of the image
         def height
           dimensions.last
         end
-        
-        # Basename of the image
-        def name
-          File.basename(relative_file, '.png')
-        end
 
         def get_var_file(var)
           options.get_var "#{base.name}_#{name}_#{var}"
         end
 
         # Value of <tt> $#{name}-repeat </tt> or <tt> $repeat </tt>
-        def repeat 
-          @repeat ||= begin 
-            rep = (get_var_file("repeat") || options.get_var("repeat") || Sass::Script::String.new(NO_REPEAT)).value
+        def repeat
+          @repeat ||= begin
+            rep = (get_var_file("repeat") || options.get_var("repeat") || identifier(NO_REPEAT)).value
             unless VALID_REPEATS.include? rep
               raise SpriteException, "Invalid option for repeat \"#{rep}\" - valid options are #{VALID_REPEATS.join(', ')}"
             end
@@ -73,77 +72,89 @@ module Compass
           repeat == REPEAT_X
         end
 
+        def repeat_y?
+          repeat == REPEAT_Y
+        end
+
         def no_repeat?
           repeat == NO_REPEAT
         end
 
         # Value of <tt> $#{name}-position </tt> or <tt> $position </tt> defaults to <tt>0px</tt>
         def position
-          @position||= get_var_file("position") || options.get_var("position") || Sass::Script::Number.new(0, ["px"])
+          @position ||= get_var_file("position") || options.get_var("position") || number(0, "px")
         end
-        
+
         # Offset within the sprite
         def offset
           @offset ||= (position.unitless? || position.unit_str == "px") ? position.value : 0
         end
-               
+
         # Spacing between this image and the next
         def spacing
-          @spacing ||= (get_var_file("spacing") || options.get_var("spacing") || Sass::Script::Number.new(0, ['px'])).value
+          @spacing ||= (get_var_file("spacing") || options.get_var("spacing") || number(0, 'px')).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?
           name =~ HOVER
         end
-        
+
         # Hover selector Image object if exsists
         def hover
-          base.image_for("#{name}_hover")
+          base.get_magic_selector_image(name, 'hover')
         end
-        
+
         # Is target selector
         def target?
           name =~ TARGET
         end
-        
+
         # Target selector Image object if exsists
         def target
-          base.image_for("#{name}_target")
+          base.get_magic_selector_image(name, 'target')
         end
-        
+
         # Is active selector
         def active?
           name =~ ACTIVE
         end
-        
+
         # Active selector Image object if exsists
         def active
-          base.image_for("#{name}_active")
+          base.get_magic_selector_image(name, 'active')
         end
-        
-        
+
+        # Is active selector
+        def focus?
+          name =~ FOCUS
+        end
+
+        # Active selector Image object if exsists
+        def focus
+          base.get_magic_selector_image(name, 'focus')
+        end
+
         def parent
-          if [hover?, target?, active?].any?
+          if [hover?, target?, active?, focus?].any?
             PARENT.match name
             base.image_for($1)
           end
         end
-        
-                
+
         private
           def dimensions
-            @dimensions ||= Compass::SassExtensions::Functions::ImageSize::ImageProperties.new(file).size
+            @dimensions ||= Compass::Core::SassExtensions::Functions::ImageSize::ImageProperties.new(file).size
           end
       end
     end

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

@@ -4,24 +4,44 @@ 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::Value::String)
+            name = name.value
+          end
+          name = name.to_s
+          @images.detect { |img| img.name.downcase == name.downcase}
          end
 
          # Returns true if the image name has a hover selector image
          def has_hover?(name)
-           !image_for("#{name}_hover").nil?
+           !get_magic_selector_image(name, 'hover').nil?
          end
 
          # Returns true if the image name has a target selector image
          def has_target?(name)
-           !image_for("#{name}_target").nil?
+           !get_magic_selector_image(name, 'target').nil?
+         end
+
+         # Returns true if the image name has a focus selector image
+         def has_focus?(name)
+           !get_magic_selector_image(name, 'focus').nil?
          end
 
          # Returns true if the image name has an active selector image
          def has_active?(name)
-           !image_for("#{name}_active").nil?
+           !get_magic_selector_image(name, 'active').nil?
          end
 
+         SEPERATORS = ['_', '-']
+
+         def get_magic_selector_image(name, selector)
+          SEPERATORS.each do |seperator|
+            file = image_for("#{name}#{seperator}#{selector}")
+            return file if !file.nil?
+          end
+
+          nil
+        end
+
          # Return and array of image names that make up this sprite
          def sprite_names
            image_names.map { |f| File.basename(f, '.png') }
@@ -29,4 +49,4 @@ module Compass
       end
     end
   end
-end
+end

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.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

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