compass-sass37 1.1.0

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

@@ -0,0 +1,162 @@
+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_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)
+            if File.exist?(f)
+              return f
+            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
+
+        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") || identifier(NO_REPEAT)).value
+            unless VALID_REPEATS.include? rep
+              raise SpriteException, "Invalid option for repeat \"#{rep}\" - valid options are #{VALID_REPEATS.join(', ')}"
+            end
+
+            rep
+          end
+        end
+
+        def repeat_x?
+          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") || 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") || 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.get_magic_selector_image(name, 'hover')
+        end
+
+        # Is target selector
+        def target?
+          name =~ TARGET
+        end
+
+        # Target selector Image object if exsists
+        def 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.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?, focus?].any?
+            PARENT.match name
+            base.image_for($1)
+          end
+        end
+
+        private
+          def dimensions
+            @dimensions ||= Compass::Core::SassExtensions::Functions::ImageSize::ImageProperties.new(file).size
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module ImageMethods
+        # Fetches the Sprite::Image object for the supplied name
+         def image_for(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)
+           !get_magic_selector_image(name, 'hover').nil?
+         end
+
+         # Returns true if the image name has a target selector image
+         def has_target?(name)
+           !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)
+           !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') }
+         end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'forwardable'
+
+module Compass
+  module SassExtensions
+    module Sprites
+      class ImageRow
+        extend Forwardable
+
+        attr_reader :images, :max_width
+        def_delegators :@images, :last, :delete, :empty?, :length
+        
+        def initialize(max_width)
+          @images = []
+          @max_width = max_width
+        end
+        
+        def add(image)
+          return false if !will_fit?(image)
+          @images << image
+          true
+        end
+
+        alias :<< :add
+        
+        def height
+          images.map(&:height).max
+        end
+        
+        def width
+          images.map(&:width).max
+        end
+
+        def total_width
+          images.inject(0) {|sum, img| sum + img.width }
+        end
+        
+        def efficiency
+          1 - (total_width.to_f / max_width.to_f)
+        end
+
+        def will_fit?(image)
+          (total_width + image.width) <= max_width
+        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/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

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

@@ -0,0 +1,53 @@
+module Compass
+  module SassExtensions
+    module Sprites
+      module LayoutMethods
+        HORIZONTAL = 'horizontal'
+        DIAGONAL = 'diagonal'
+        SMART = 'smart'
+        VERTICAL = 'vertical'
+        
+        def smart?
+          layout == SMART
+        end
+        
+        def horizontal?
+          layout == HORIZONTAL
+        end
+        
+        def diagonal?
+          layout == DIAGONAL
+        end
+
+        def vertical?
+          layout == VERTICAL
+        end
+        
+        def layout
+          @layout ||= @kwargs.get_var('layout').value
+        end
+        
+        # Calculates the overal image dimensions
+        # collects image sizes and input parameters for each sprite
+        def compute_image_positions!
+          case layout
+          when SMART
+            require 'compass/sass_extensions/sprites/layout/smart'
+            @images, @width, @height = Layout::Smart.new(@images, @kwargs).properties
+          when DIAGONAL
+            require 'compass/sass_extensions/sprites/layout/diagonal'
+            @images, @width, @height = Layout::Diagonal.new(@images, @kwargs).properties
+          when HORIZONTAL
+            require 'compass/sass_extensions/sprites/layout/horizontal'
+            @images, @width, @height = Layout::Horizontal.new(@images, @kwargs).properties
+          else
+            require 'compass/sass_extensions/sprites/layout/vertical'
+            @images, @width, @height = Layout::Vertical.new(@images, @kwargs).properties
+          end
+        end
+        
+      end
+    end
+  end
+end
+  

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

@@ -0,0 +1,92 @@
+require 'forwardable'
+
+module Compass
+  module SassExtensions
+    module Sprites
+      class RowFitter
+        extend Forwardable
+
+        attr_reader :images, :rows
+        def_delegators :rows, :[]
+
+        def initialize(images)
+          @images = images.sort do |a,b|
+            if a.height == b.height
+              b.width <=> a.width
+            else
+              a.height <=> b.height
+            end
+          end
+          @rows = []
+        end
+
+        def fit!(style = :scan)
+          send("#{style}_fit")
+          @rows
+        end
+
+        def width
+          @width ||= @images.collect(&:width).max
+        end
+        
+        def height
+          @height ||= @rows.inject(0) {|sum, row| sum += row.height}
+        end
+
+        def efficiency
+          @rows.inject(0) { |sum, row| sum += row.efficiency } ** @rows.length
+        end
+
+        private
+        def new_row(image = nil)
+          row = Compass::SassExtensions::Sprites::ImageRow.new(width)
+          row.add(image) if image
+          row
+        end
+
+        def fast_fit
+          row = new_row
+          @images.each do |image|
+            if !row.add(image)
+              @rows << row
+              row = new_row(image)
+            end
+          end
+
+          @rows << row
+        end
+
+        def scan_fit
+          fast_fit
+
+          moved_images = []
+
+          begin
+            removed = false
+
+            catch :done do
+              @rows.each do |row|
+                (@rows - [ row ]).each do |other_row|
+                  other_row.images.each do |image|
+                    if !moved_images.include?(image)
+                      if row.will_fit?(image)
+                        other_row.delete(image)
+                        row << image
+
+                        @rows.delete(other_row) if other_row.empty?
+                        removed = true
+
+                        moved_images << image
+                        throw :done
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end while removed
+        end
+      end
+    end
+  end
+end