compass 0.12.4 → 1.0.0

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

@@ -32,128 +32,22 @@ module Compass
         def compute_image_positions!
           case layout
           when SMART
-            calculate_smart_positions
+            require 'compass/sass_extensions/sprites/layout/smart'
+            @images, @width, @height = Layout::Smart.new(@images, @kwargs).properties
           when DIAGONAL
-            calculate_diagonal_dimensions
-            calculate_diagonal_positions
+            require 'compass/sass_extensions/sprites/layout/diagonal'
+            @images, @width, @height = Layout::Diagonal.new(@images, @kwargs).properties
           when HORIZONTAL
-            @height = height_for_horizontal_layout
-            calculate_horizontal_positions
-            @width = width_for_horizontal_layout
+            require 'compass/sass_extensions/sprites/layout/horizontal'
+            @images, @width, @height = Layout::Horizontal.new(@images, @kwargs).properties
           else
-            @images.sort! do |a,b| 
-              if (b.size <=> a.size) === 0
-                a.name <=> b.name
-              else
-                b.size <=> a.size
-              end
-            end
-
-            @width = width_for_vertical_layout
-            calulate_vertical_postions
-            @height = height_for_vertical_layout
-            if @images.any?(&:repeat_x?)
-              calculate_repeat_extra_width!
-              tile_images_that_repeat
-             end
-          end
-        end
-
-        def tile_images_that_repeat
-          @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
-              end
-            end
-        end
-
-        def calculate_repeat_extra_width!
-          require 'rational' #for ruby 1.8.7
-          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_smart_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
-        
-        
-        def calculate_diagonal_dimensions
-          @width = @images.inject(0) {|sum, img| sum + img.width}
-          @height = @images.inject(0) {|sum, img| sum + img.height}
-        end
-        
-        def calculate_diagonal_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
+            require 'compass/sass_extensions/sprites/layout/vertical'
+            @images, @width, @height = Layout::Vertical.new(@images, @kwargs).properties
           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.spacing, last_image.spacing].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).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
-        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.offset}.max
-        end
-        
-        def width_for_horizontal_layout
-          @images.inject(0) { |sum, image| sum += (image.width + image.spacing) }
-        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

@@ -1,13 +1,14 @@
 module Compass
   module SassExtensions
     module Sprites
-      class SpriteMap < Sass::Script::Literal
+      class SpriteMap < Sass::Script::Value::Base
         attr_accessor :image_names, :path, :name, :map, :kwargs
         attr_accessor :images, :width, :height, :engine
 
         include SpriteMethods
         include ImageMethods
         include LayoutMethods
+        include Sass::Script::Value::Helpers
 
 
         # Initialize a new sprite object from a relative file path
@@ -25,9 +26,10 @@ module Compass
         def self.relative_name(sprite)
           sprite = File.expand_path(sprite)
           Compass.configuration.sprite_load_path.each do |path|
-            path = File.expand_path(path)
-            if sprite.include?(path)
-              return sprite.gsub("#{path}/", "")
+            path_with_slash = "#{File.expand_path(path)}/"
+            
+            if sprite.include?(path_with_slash)
+              return sprite.gsub(path_with_slash, '')
             end
           end
         end
@@ -37,17 +39,21 @@ module Compass
           @path = path
           @name = name
           @kwargs = kwargs
-          @kwargs['cleanup'] ||= Sass::Script::Bool.new(true)
-          @kwargs['layout'] ||= Sass::Script::String.new('vertical')
+          @kwargs['cleanup'] ||= bool(true)
+          @kwargs['layout'] ||= identifier('vertical')
+          @kwargs['sort_by'] ||= identifier('none')
           @images = nil
           @width = nil
           @height = nil
           @engine = nil
           @evaluation_context = context
-          validate!
           compute_image_metadata!
         end
 
+        def sort_method
+          @kwargs['sort_by'].value
+        end
+
         def inspect
           puts 'images'
           @images.each do |img|
@@ -84,4 +90,4 @@ module Compass
       end
     end
   end
-end
+end

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

@@ -26,20 +26,15 @@ module Compass
         
         # Creates the Sprite::Image objects for each image and calculates the width
         def init_images
-          @images = image_names.collect do |relative_file|
-            Image.new(self, relative_file, kwargs)
+          @images = Images.new
+          image_names.each do |relative_file|
+            @images << Image.new(self, relative_file, kwargs)
           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
+          unless sort_method == 'none'
+            @images.sort_by! sort_method
           end
         end
-        
+
         def name_and_hash
           "#{path}-s#{uniqueness_hash}.png"
         end
@@ -68,8 +63,7 @@ module Compass
         end
         
         def cleanup_old_sprites
-          Dir[File.join(Compass.configuration.generated_images_path, "#{path}-s*.png")].each do |file|
-            next if file[filename]
+          Sass::Util.glob(File.join(Compass.configuration.generated_images_path, "#{path}-s*.png")).each do |file|
             log :remove, file
             FileUtils.rm file
             Compass.configuration.run_sprite_removed(file)
@@ -78,7 +72,7 @@ module Compass
         
         # Does this sprite need to be generated
         def generation_required?
-          !File.exists?(filename) || outdated? ||  options[:force]
+          !File.exists?(filename) || outdated? || options[:force]
         end
 
         # Returns the uniqueness hash for this sprite object

data/lib/compass/sprite_importer.rb

@@ -2,13 +2,13 @@ require 'erb'
 require 'compass/sprite_importer/binding'
 module Compass
   class SpriteImporter < Sass::Importers::Base
-    VAILD_FILE_NAME = /\A#{Sass::SCSS::RX::IDENT}\Z/
+    VAILD_FILE_NAME       = /\A#{Sass::SCSS::RX::IDENT}\Z/
     SPRITE_IMPORTER_REGEX = %r{((.+/)?([^\*.]+))/(.+?)\.png}
-    VALID_EXTENSIONS = ['.png']
+    VALID_EXTENSIONS      = ['.png']
     
-    TEMPLATE_FOLDER = File.join(File.expand_path('../', __FILE__), 'sprite_importer')
+    TEMPLATE_FOLDER       = File.join(File.expand_path('../', __FILE__), 'sprite_importer')
     CONTENT_TEMPLATE_FILE = File.join(TEMPLATE_FOLDER, 'content.erb')
-    CONTENT_TEMPLATE = ERB.new(File.read(CONTENT_TEMPLATE_FILE))
+    CONTENT_TEMPLATE      = ERB.new(File.read(CONTENT_TEMPLATE_FILE))
 
 
 
@@ -16,7 +16,7 @@ module Compass
     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))
+      Sass::Util.glob(File.join(path, "**", glob))
     end
     
     def find(uri, options)
@@ -51,6 +51,11 @@ module Compass
     def key(uri, options={})
       [self.class.name + ":sprite:" + File.dirname(File.expand_path(uri)), File.basename(uri)]
     end
+
+    def public_url(*args)
+      nil
+    end
+
     
     def self.path_and_name(uri)
       if uri =~ SPRITE_IMPORTER_REGEX
@@ -75,7 +80,7 @@ module Compass
     # Returns the Glob of image files for the uri
     def self.files(uri)
       Compass.configuration.sprite_load_path.compact.each do |folder|
-        files = Dir[File.join(folder, uri)].sort
+        files = Sass::Util.glob(File.join(folder, uri)).sort
         next if files.empty?
         return files
       end
@@ -87,11 +92,7 @@ module Compass
     # 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
+        File.basename(file, '.png')
       end
     end
     

data/lib/compass/sprite_importer/content.erb

@@ -2,18 +2,21 @@
 
 // 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;
-$<%= name %>-inline: false !default;
+$<%= name %>-sprite-dimensions : false !default;
+$<%= name %>-use-percentages   : 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;
+$<%= name %>-inline            : false !default;
+$<%= name %>-sort-by           : 'none' !default;
+$<%= name %>-class-separator   : $default-sprite-separator !default;
+$<%= name %>-sprite-base-class : ".<%= name %>#{$<%= name %>-class-separator}sprite" !default;
 
 <% if skip_overrides %> 
-  $<%= name %>-sprites: sprite-map("<%= uri %>", $layout: $<%= name %>-layout, $cleanup: $<%= name %>-clean-up);
+  $<%= name %>-sprites: sprite-map("<%= uri %>", $layout: $<%= name %>-layout, $cleanup: $<%= name %>-clean-up, $spacing: $<%= name %>-spacing, $position : $<%= name %>-position);
 <% else %>  
  // These variables control the generated sprite output
  // You can override them selectively before you import this file.
@@ -29,8 +32,11 @@ $<%= name %>-inline: false !default;
    $<%= name %>-<%= sprite_name %>-spacing:  $<%= name %>-<%= sprite_name %>-spacing, 
    $<%= name %>-<%= sprite_name %>-repeat:   $<%= name %>-<%= sprite_name %>-repeat,
  <% end %>
- $layout: $<%= name %>-layout,
- $cleanup: $<%= name %>-clean-up
+ $layout   : $<%= name %>-layout,
+ $cleanup  : $<%= name %>-clean-up,
+ $spacing  : $<%= name %>-spacing,
+ $position : $<%= name %>-position,
+ $sort-by  : $<%= name %>-sort-by
  );
 <% end %>
 
@@ -42,14 +48,14 @@ $<%= name %>-inline: false !default;
   } 
 } @else {
   #{$<%= name %>-sprite-base-class} {
-    background: $<%= name %>-sprites no-repeat;
+    background-image: sprite-url($<%= name %>-sprites);
+    background-repeat: no-repeat;
   }
 }
 //sass functions to return the dimensions of a sprite image as units
 <% [:width, :height].each do |dimension| %>
   @function <%= name %>-sprite-<%= dimension %>($name) {
-    $file: sprite_file($<%= name %>-sprites, $name);
-    @return image-<%= dimension %>($file);
+    @return sprite-<%= dimension %>($<%= name %>-sprites, $name);
   }
 <% end %>
 
@@ -60,22 +66,22 @@ $<%= name %>-inline: false !default;
 }
 
 // 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)
+@mixin <%= name %>-sprite-position($name, $offset-x: 0, $offset-y: 0, $use-percentages: $<%= name %>-use-percentages) {
+  @include sprite-background-position($<%= name %>-sprites, $name, $offset-x, $offset-y, $use-percentages)
 }
 
 // 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) {
+@mixin <%= name %>-sprite($name, $dimensions: $<%= name %>-sprite-dimensions, $offset-x: 0, $offset-y: 0, $use-percentages: $<%= name %>-use-percentages, $separator: $<%= name %>-class-separator) {
   @extend #{$<%= name %>-sprite-base-class};
-  @include sprite($<%= name %>-sprites, $name, $dimensions, $offset-x, $offset-y)
+  @include sprite($<%= name %>-sprites, $name, $dimensions, $offset-x, $offset-y, $use-percentages, $separator: $separator);
 }
 
-@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)
+@mixin <%= name %>-sprites($sprite-names, $dimensions: $<%= name %>-sprite-dimensions, $prefix: sprite-map-name($<%= name %>-sprites), $offset-x: 0, $offset-y: 0, $use-percentages: $<%= name %>-use-percentages, $separator: $<%= name %>-class-separator) {
+  @include sprites($<%= name %>-sprites, $sprite-names, $<%= name %>-sprite-base-class, $dimensions, $prefix, $offset-x, $offset-y, $use-percentages, $separator: $separator)
 }
 
 // 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.join(" ") %>, $dimensions, $prefix, $offset-x, $offset-y);
-}
+@mixin all-<%= name %>-sprites($dimensions: $<%= name %>-sprite-dimensions, $prefix: sprite-map-name($<%= name %>-sprites), $offset-x: 0, $offset-y: 0, $use-percentages: $<%= name %>-use-percentages, $separator: $<%= name %>-class-separator) {
+  @include <%= name %>-sprites(<%= sprite_names.join(" ") %>, $dimensions, $prefix, $offset-x, $offset-y, $use-percentages, $separator: $separator);
+}