auto_sprite 0.0.1 → 0.0.3

data/README

@@ -1,13 +1,70 @@
 AutoSprite
 ==========
 
-Introduction goes here.
+An easy, automated CSS image sprite creator.
 
+Install
+==========
+
+ 1. Install auto_sprite and RMagick.
+
+    gem install RMagick
+    gem install auto_sprite 
+
+ 2. Edit your environement.rb add config.gem "auto_sprite"
+ 
+Usage
+==========
+ 1.  Include the stylesheet in your layout:
+
+	<%= stylesheet_link_tag "auto_sprite" %>
+
+ 2.  Create a directory called sprites in your images directory (e.g. RAILS_ROOT/public/images/sprites)
+
+ 3.  Put the images you want to link to in your public/images/sprites directory.  
+
+ 3.  Use your images like you normally would:
+
+    <%= image_tag 'sprites/logo.png'  %>
+    <%= image_tag 'sprites/icon1.jpg' %> ... etc
+
+ 4.  Enjoy your now faster website.
+
+
+Details
+==========
+
+Whenever rails reloads, it will automatically generate two files:
+
+  RAILS_ROOT/public/stylesheets/auto_sprite.css
+  RAILS_ROOT/public/images/auto_sprite.png
+
+
+The image tag will automatically generate a div tag for any images located in the sprite directory.
+
+  <div class="_as_logo_png"></div> instead of <img src="/images/sprites/logo.png" />
+
+
+Here is an exmplmple of the stylehseet that would be generated if you had two files face3.png and face4.png
+
+._as_face3_png {
+   background-position:0 0px;
+   height:16px;
+   width:16px;
+}
 
-Example
-=======
+._as_face4_png{
+  background-position:0 -16px;
+  height:16px;
+  width:16px;
+}
 
-Example goes here.
+._as_face3_png, 
+._as_face3_png {
+  display:inline-block;
+  background-image:url('/images/auto_sprite.png');
+  background-repeat:no-repeat; 
+}
 
 
-Copyright (c) 2010 [name of plugin creator], released under the MIT license
+Copyright (c) 2010 Stephen Blackstone, released under the MIT license

data/auto_sprite.gemspec

@@ -1,12 +1,13 @@
 spec = Gem::Specification.new do |s|
 require 'fileutils'
   s.name = "auto_sprite"
-  s.version = "0.0.1"
+  s.version = "0.0.3"
   s.author = "Stephen Blackstone"
   s.email = "sblackstone@gmail.com"
-  #s.homepage = "http://"
+  s.homepage = "http://gemcutter.org/gems/auto_sprite"
   s.platform = Gem::Platform::RUBY
-  s.summary = "Automagic Sprite Builer"
+  s.summary = "A fully-Automagic Sprite Builder"
+  s.description = "CSS Sprites can get you down, don't let them.  This gem automatically creates the CSS, Sprite and HTML tags so you don't have to"
   s.files = ["./README", "./auto_sprite.gemspec", "./MIT-LICENSE", "./rails", "./rails/init.rb", "./lib", "./lib/auto_sprite.rb"]
   s.require_path = "lib"
   s.has_rdoc = false

data/lib/auto_sprite.rb

@@ -32,19 +32,20 @@ module AutoSprite
     end
 
     def write_new_assets
-      image_list = Magick::ImageList.new(*sprite_file_paths)
-      image_list.append(true).write(SPRITE_IMG_PATH)
-      all_class_names = sprite_file_names.map { |x| '.' + generate_css_name(x) }
-      pos = 0
-      File.open(CSS_FILE_PATH, "w") do |f|
-        image_list.each do |img|
-          css_class = generate_css_name(img.filename)
-          f << ".#{css_class}{background-position:0 #{pos* -1}px;height:#{img.rows}px;width:#{img.columns}px;}"
-          pos = pos + img.rows;
+      unless sprite_file_paths.empty?
+        image_list = Magick::ImageList.new(*sprite_file_paths)
+        image_list.append(true).write(SPRITE_IMG_PATH)
+        all_class_names = sprite_file_names.map { |x| '.' + generate_css_name(x) }
+        pos = 0
+        File.open(CSS_FILE_PATH, "w") do |f|
+          image_list.each do |img|
+            css_class = generate_css_name(img.filename)
+            f << ".#{css_class}{background-position:0 #{pos* -1}px;height:#{img.rows}px;width:#{img.columns}px;}"
+            pos = pos + img.rows;
+          end
+          f << all_class_names.join(",")
+          f << "{display:inline-block;background-image:url('#{SPRITE_IMG_URL}');background-repeat:no-repeat;}"
         end
-        f << all_class_names.join(",")
-        f << "{display:inline-block;background-image:url('#{SPRITE_IMG_URL}');background-repeat:no-repeat;}"
-
       end
     end
   end
@@ -52,13 +53,16 @@ end
 
 
 module AutoSprite::Helpers 
-  def image_tag(source, options = {})
-    src = path_to_image(source)
-    if src =~ /\/images\/sprites/
-      "<div class='#{AutoSprite.generate_css_name(src)}'></div>"
-    else
-      super(source,options)
+  def self.included(base)
+    base.class_eval do
+      def image_tag(source, options = {})
+        src = path_to_image(source)
+        if src =~ /\/images\/sprites/
+          "<div class='#{AutoSprite.generate_css_name(src)}'></div>"
+        else
+          super(source,options)
+        end
+      end
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auto_sprite
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
 - Stephen Blackstone
@@ -13,7 +13,7 @@ date: 2010-01-09 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: 
+description: CSS Sprites can get you down, don't let them.  This gem automatically creates the CSS, Sprite and HTML tags so you don't have to
 email: sblackstone@gmail.com
 executables: []
 
@@ -29,7 +29,7 @@ files:
 - ./lib/auto_sprite.rb
 - README
 has_rdoc: true
-homepage: 
+homepage: http://gemcutter.org/gems/auto_sprite
 licenses: []
 
 post_install_message: 
@@ -55,6 +55,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Automagic Sprite Builer
+summary: A fully-Automagic Sprite Builder
 test_files: []