sprite 0.2.0 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sprite (0.2.0)
+    sprite (0.2.1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -80,9 +80,9 @@ Configuration of `sprite` is done via `config/sprite.yml`. It allows you to set
   - `default_spacing:` defines the default pixel spacing between sprites (defaults to 0)
   - `resize_to:` width and height (in the format "120x60") to resize all source images to before composition. (defaults to no nil, or no resizing)
   - `class_separator:` used to generated the class name by separating the image name and sprite name (defaults to `-`)
-  - `add_datestamps`: whether or not to add datestamps to the generated background image urls. this will allow proper cache versioning (defaults to `true`)
+  - `add_datestamps`: whether or not to add datestamps to the generated background image urls. this will allow proper cache versioning (defaults to `true`).
   - `external_base`: change the base path for your images. (defaults to `/`)
-  - `url_helper`: css helper used to specify the url (defaults to `url`). For compass, you can set this to image-url instead
+  - `url_formatter`: allows you to specify the format of the background-url. The sprite background is passed in via sprintf formatting. (defaults to nil). This setting overrides external_base. If you use compass, you should set this value to "image-url('%s')"
 
 * `images:` section provides an array of configurations which define which image files are built, and where they get their sprites from. each image setup provides the following config options:
   - `name:` name of image (required)
@@ -176,6 +176,18 @@ Additional style generators are very easy to add. We have one for `style: sass`
 
 You can also easily script it out via capistrano. You could also run `sprite` on application start, or just about anywhere. Let me know what limitations you run into.
 
+## Configuring Sprite with Compass ##
+
+Sprite now works well with Compass with a few config tweaks. Since compass provides its own image-url helper which handles file versioning, it's useful to configure sprite to use that instead. Here's how to do it:
+
+    config:
+      # use the image-url helper with compass
+      url_formatter: "image-url('sprites/%s')"
+
+      # turn off datestamps as they will break compass's image-url helper
+      add_datestamps: false
+
+
 ## ABOUT `sprite` ##
 
 `sprite` was originally based off of Richard Huang's excellent Rails plugin: [css_sprite](http://github.com/flyerhzm/css_sprite)

data/lib/sprite/builder.rb

@@ -63,7 +63,11 @@ module Sprite
     end
 
     def background_url(name)
-      "#{@config['url_helper']}('#{@config['external_base']}#{@config['image_output_path']}#{name}')"
+      if @config["url_formatter"]
+        sprintf(@config["url_formatter"], name)
+      else
+        "url('#{@config['external_base']}#{@config['image_output_path']}#{name}')"
+      end
     end
 
   protected
@@ -133,7 +137,6 @@ module Sprite
       @config['class_separator']    ||= '-'
       @config["sprites_class"]      ||= 'sprites'
       @config["default_spacing"]    ||= 0
-      @config['url_helper']      ||= 'url'
 
       unless @config.has_key?("add_datestamps")
         @config["add_datestamps"] = true

data/sprite.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "sprite"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.default_executable = "sprite"
   s.executables = ["sprite"]

metadata

@@ -2,7 +2,7 @@
 name: sprite
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jacques Crocker
@@ -122,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 754007334119260414
+      hash: -2972357079777028663
       segments: 
       - 0
       version: "0"
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 754007334119260414
+      hash: -2972357079777028663
       segments: 
       - 0
       version: "0"