spriter 0.6.0 → 0.7.0

data/README.markdown

@@ -0,0 +1,69 @@
+# Spriter #
+
+[CSS sprites][1] are a simple way of combining lots of small images into a single large image and reducing the number of HTTP requests a web page has to make.  Spriter makes it easy to create and maintain CSS sprites in Ruby apps.
+
+You just write some modified CSS rules in a `.spriter` file:
+
+    span.icon {
+      color: red;
+      -spriter-background: 'example.png';
+    }
+
+And then run all your `.spriter` files through Spriter to get some `.css` files and a shared sprite image:
+
+    span.icon {
+      color: red;
+      background: url(/images/sprites.png) no-repeat 0 -98px; /* example.png */
+    }
+
+The conversion can take place dynamically whenever the CSS files are requested using a handy [Rack][2] middleware (useful for development) or static files can be generated using a few lines of Ruby (as part of your deploy scripts, for example).
+
+## Dependancies ##
+
+You must have [Image Magick][3] installed, and the `convert` command must be in the path of the user or app that is using Spriter.
+
+## Usage ##
+
+### Middleware ###
+
+Just add the `Rack::Spriter` middleware to your rack stack. For example, in a Rails app you would add this line to your `environment.rb`:
+
+    config.middleware.use 'Rack::Spriter'
+
+You can pass a hash of options to the middleware, using these keys:
+
+* `:sprite_image_path` - the path to write the sprite image to (Rails default: `'RAILS_ROOT/public/images/sprites.png'`)
+* `:sprite_image_url` - the URL of the sprite image that will be used in the generated CSS files (default: `'/images/sprites.png'`)
+* `:stylesheets_url_pattern` - URLs matching this pattern will trigger the middleware (default: `/stylesheets\/(.+)\.css$/`)
+* `:stylesheets_path` - the directory to look for .spriter files in (Rails default: `'RAILS_ROOT/pubic/stylesheets'`)
+* `:assets_path` - the directory to look for source images in (Rails default: `'RAILS_ROOT/public/images/sprite_assets'`)
+
+### Generating static CSS files ###
+
+To generate static CSS files, you can pass an array of paths to `.spriter` files into the `transform_files` method. A `.css` equivalent for each `.spriter` file and a shared sprites image will be created.
+
+The CSS files will be created in the same directories as the `.spriter` source files. The paths for the source images and generated sprite image should be set using the following options before calling `transform_files`:
+
+* `Spriter.assets_path` - the directory to look for source images in
+* `Spriter.sprite_image_path` - the path to write the sprite image to
+* `Spriter.sprite_image_url` - the URL of the sprite image that will be used in the generated CSS files
+
+For example:
+
+    Spriter.assets_path = '/example_app/public/images/sprite_assets'
+    Spriter.sprite_image_path = '/example_app/public/images/sprites.png'
+    Spriter.sprite_image_url = '/images/sprites.png'
+    
+    paths = Dir.glob('/my/example/app/public/stylesheets/*.spriter').sort
+    Spriter.transform_files(*paths)
+
+## License ##
+
+Copyright Revieworld Ltd. 2010
+
+You may use, copy and redistribute this library under the same terms as [Ruby itself][4] or under the MIT license.
+
+[1]: http://www.alistapart.com/articles/sprites/
+[2]: http://rack.rubyforge.org/
+[3]: http://www.imagemagick.org/
+[4]: http://www.ruby-lang.org/en/LICENSE.txt

data/Rakefile

@@ -14,17 +14,15 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "spriter"
-  s.version           = "0.6.0"
+  s.version           = "0.7.0"
   s.summary           = "Managers sprites and your css in a mega way."
   s.author            = "Reevoo"
   s.homepage          = "http://www.reevoo.com"
 
-  s.has_rdoc          = true
-  s.extra_rdoc_files  = %w(README)
-  s.rdoc_options      = %w(--main README)
+  s.has_rdoc          = false
 
   # Add any extra files to include in the gem (like your README)
-  s.files             = %w(Rakefile) + Dir.glob("{test,lib/**/*}")
+  s.files             = %w(Rakefile) + Dir.glob("{README*,test,lib/**/*}")
   s.require_paths     = ["lib"]
 
   s.add_development_dependency("shoulda")

data/lib/rack/spriter.rb

@@ -6,10 +6,30 @@ module Rack
     File = ::File
 
     def initialize(app, options = {})
+      options = default_options.merge(options)
       @app = app
-      ::Spriter.assets_path = options[:assets_path] || File.join(Rails.root, *%w[ public images sprite_assets ])
-      ::Spriter.sprite_image_path = options[:sprite_image_path] || File.join(Rails.root, *%w[ public images sprites.png ])
-      ::Spriter.sprite_image_url = options[:sprite_image_url] || '/images/sprites.png'
+      @stylesheets_path = options[:stylesheets_path]
+      @stylesheets_url_pattern = options[:stylesheets_url_pattern]
+      ::Spriter.assets_path = options[:assets_path]
+      ::Spriter.sprite_image_path = options[:sprite_image_path]
+      ::Spriter.sprite_image_url = options[:sprite_image_url]
+    end
+
+    def default_options
+      defaults = {
+        :sprite_image_url => '/images/sprites.png',
+        :stylesheets_url_pattern => %r{stylesheets\/(.+)\.css$}
+      }
+
+      if defined? Rails
+        defaults.merge(
+          :stylesheets_path => File.join(Rails.root, *%w[ public stylesheets ]),
+          :assets_path => File.join(Rails.root, *%w[ public images sprite_assets ]),
+          :sprite_image_path => File.join(Rails.root, *%w[ public images sprites.png ])
+        )
+      else
+        defaults
+      end
     end
 
     def call(env)
@@ -22,20 +42,20 @@ module Rack
     
     private
     def generate_css(env)
-      if Rack::Request.new(env).path =~ %r{stylesheets\/(.+)\.css$}
+      if Rack::Request.new(env).path =~ @stylesheets_url_pattern
         name = $1
-        spriter_path = File.join(Rails.root, 'public', 'stylesheets', "#{name}.spriter")
+        spriter_path = File.join(@stylesheets_path, "#{name}.spriter")
         generated_css($1) if File.exist? spriter_path
       end
     end
 
     def generated_css(name)
-      paths = Dir.glob(File.join(Rails.root, 'public', 'stylesheets', '*.spriter'))
+      paths = Dir.glob(File.join(@stylesheets_path, '*.spriter'))
       paths.sort!
       files = paths.map{ |p| File.new(p, 'r') }
 
       if @generated_css.nil? or files.max{ |a,b| a.mtime <=> b.mtime }.mtime > @generated_at
-        names = paths.map{ |p| p =~ %r{stylesheets/(.+)\.spriter$}; $1 }
+        names = paths.map{ |p| p =~ %r{([^/]+)\.spriter$}; $1 }
         css = ::Spriter.transform(*files)
         css = [css] unless css.is_a? Array
         @generated_at = Time.now

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spriter
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Reevoo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-26 00:00:00 +00:00
+date: 2010-02-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,21 +28,20 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
 - Rakefile
+- README.markdown
 - lib/rack/spriter.rb
 - lib/spriter.rb
-- README
 has_rdoc: true
 homepage: http://www.reevoo.com
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement