auto_sprite 1.0.4 → 1.1.0

data/README.rdoc

@@ -1,16 +1,12 @@
 
-=AutoSprite 1.0.4
-
+=AutoSprite 1.1.0
 
 An easy, automated CSS image sprite creator.
 
-
-=Why do I care?
-
 Suppose you have 10 images on your homepage.  Rather than downloading 10 seperate images one at a time,  1 image is downloaded and we use CSS to show different parts of that image when we need to.  This speeds up your page load time.  It can be hard to manage this manually since you need to keep appending images to a sprite file and updating your css file with the correct offsets, etc.  Auto Sprite lets you get back to more important things.
 
 
-=Install
+==Install
 
 1. Install auto_sprite and RMagick.
 
@@ -18,73 +14,71 @@ Suppose you have 10 images on your homepage.  Rather than downloading 10 seperat
 
 2. Edit your environement.rb add config.gem "auto_sprite"
  
-=Usage
+==Usage
 1. Include the stylesheet in your layout:
 
-	<%= stylesheet_link_tag "auto_sprite" %>
+    <%= 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.  
 
-4.  Use your images like you normally would:
+4. Use your images like you normally would:
 
-    <%= image_tag 'sprites/logo.png'  %>
     <%= image_tag 'sprites/icon1.jpg' %>
 
-	As of Auto Sprite 1.0.4 image_tag can be passed a :title giving icons a hover text..
-
-	<%= image_tag "sprites/stuff.png", :title => "I like Ice Cream" %>
-
+    A :title can also be passed so your icons have tooltips:
+  
+    <%= image_tag "sprites/stuff.png", :title => "I like Ice Cream" %>
 
-5.  Reload after adding any new images to sprites/ and enjoy your now faster rendering website.
 
+5. Reload after adding any new images to sprites/ and enjoy your now faster rendering website.
 
-You'll notice that should auto_sprite be removed, your application will still work!
-
-
-=Notes
+==Notes
 - Animated images are not supported.
 - Any image format supported by RMagick should work.
 - Images of mixed sizes are not a problem.
+- Should auto_sprite be removed, your application still works!
 
+==Details
 
-=Details
+When rails starts, it checks whether or not the CSS or Sprite file is stale or missing.  
 
-Whenever rails reloads, it will automatically generate two files:
+If so, it will create:
 
-  RAILS_ROOT/public/stylesheets/auto_sprite.css
-  RAILS_ROOT/public/images/auto_sprite.png
+    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.
 
-  <span class="_as_logo_png"></span> instead of <img src="/images/sprites/logo.png" />
+    <span class="_as_logo_png"></span> 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;
-}
-
-._as_face4_png{
-  background-position:0 -16px;
-  height:16px;
-  width:16px;
-}
-
-._as_face3_png, 
-._as_face3_png {
-  display:inline-block;
-  background-image:url('/images/auto_sprite.png');
-  background-repeat:no-repeat; 
-}
-
-=Contact
-  sblackstone@gmail.com
-  http://fargle.org/auto_sprite
-
+    ._as_face3_png {
+       background-position:0 0px;
+       height:16px;
+       width:16px;
+    }
+
+    ._as_face4_png{
+      background-position:0 -16px;
+      height:16px;
+      width:16px;
+    }
+
+    ._as_face3_png, 
+    ._as_face3_png {
+      display:inline-block;
+      background-image:url('/images/auto_sprite.png');
+      background-repeat:no-repeat; 
+    }
+
+==Contact
+
+*Author*::    Stephen Blackstone (mailto:sblackstone@gmail.com)
+*Website*::   http://github.com/sblackstone/auto_sprite
+ 
 Copyright (c) 2010 Stephen Blackstone, released under the MIT license

data/auto_sprite.gemspec

@@ -2,10 +2,10 @@ spec = Gem::Specification.new do |s|
 
 require 'fileutils'
   s.name = "auto_sprite"
-  s.version = "1.0.4"
+  s.version = "1.1.0"
   s.author = "Stephen Blackstone"
   s.email = "sblackstone@gmail.com"
-  s.homepage = "http://fargle.org/auto_sprite"
+  s.homepage = "http://github.com/sblackstone/auto_sprite"
   s.platform = Gem::Platform::RUBY
   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"

data/lib/auto_sprite.rb

@@ -9,11 +9,11 @@ module AutoSprite
 
   class << self
     def sprite_file_paths
-      sprite_file_names.map {|f| File.join(SPRITE_ASSETS_PATH, f) }
+      @sprite_file_paths ||= sprite_file_names.map {|f| File.join(SPRITE_ASSETS_PATH, f) }
     end
 
     def sprite_file_names
-      Dir.entries(SPRITE_ASSETS_PATH).reject { |f| 
+      @sprite_file_names ||= Dir.entries(SPRITE_ASSETS_PATH).reject { |f| 
         !File.file?(File.join(SPRITE_ASSETS_PATH,f))
       }
     end
@@ -24,11 +24,19 @@ module AutoSprite
       "_as_#{filename}"
     end
 
+    def stale?
+      to_check = [sprite_file_paths , SPRITE_ASSETS_PATH].flatten
+      !FileUtils.uptodate?(SPRITE_IMG_PATH , to_check) ||
+      !FileUtils.uptodate?(CSS_FILE_PATH   , to_check)    
+    end
+
     def setup!
       FileUtils::mkdir_p(SPRITE_ASSETS_PATH)
-      FileUtils::rm_f(CSS_FILE_PATH)   
-      FileUtils::rm_f(SPRITE_IMG_PATH)
-      write_new_assets
+      if stale?      
+        FileUtils::rm_f(CSS_FILE_PATH)   
+        FileUtils::rm_f(SPRITE_IMG_PATH)
+        write_new_assets
+      end
     end
 
     def write_new_assets

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auto_sprite
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors: 
 - Stephen Blackstone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-26 00:00:00 -05:00
+date: 2010-02-19 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -28,7 +28,7 @@ files:
 - ./rails/init.rb
 - ./lib/auto_sprite.rb
 has_rdoc: true
-homepage: http://fargle.org/auto_sprite
+homepage: http://github.com/sblackstone/auto_sprite
 licenses: []
 
 post_install_message: