dohmoose_auto_sprite 1.1.1.pre

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,84 @@
+
+=AutoSprite 1.1.0
+
+An easy, automated CSS image sprite creator.
+
+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
+
+1. Install auto_sprite and RMagick.
+
+    gem install RMagick 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.  
+
+4. Use your images like you normally would:
+
+    <%= image_tag 'sprites/icon1.jpg' %>
+
+    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.
+
+==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
+
+When rails starts, it checks whether or not the CSS or Sprite file is stale or missing.  
+
+If so, it will create:
+
+    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" />
+
+
+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
+
+*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

@@ -0,0 +1,16 @@
+spec = Gem::Specification.new do |s|
+
+require 'fileutils'
+  s.name = "dohmoose_auto_sprite"
+  s.version = "1.1.1.pre"
+  s.authors = ["Stephen Blackstone", "Don Buchanan"]
+  s.email = ["sblackstone@gmail.com", "mail@donaldbuchanan.com"]
+  s.homepage = "http://fargle.org/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"
+  s.files = ["./README.rdoc", "./auto_sprite.gemspec", "./MIT-LICENSE", "./rails", "./rails/init.rb", "./lib", "./lib/auto_sprite.rb"]
+  s.require_path = "lib"
+  s.has_rdoc = false
+end
+

data/lib/auto_sprite.rb

@@ -0,0 +1,83 @@
+require 'RMagick'
+require 'fileutils'
+
+module AutoSprite
+  SPRITE_ASSETS_PATH = File.join(RAILS_ROOT, 'public', 'images',      'sprites')
+  CSS_FILE_PATH      = File.join(RAILS_ROOT, 'public', 'stylesheets', 'auto_sprite.css')
+  SPRITE_IMG_PATH    = File.join(RAILS_ROOT, 'public', 'images',      'auto_sprite.png')
+  SPRITE_IMG_URL     = '/images/auto_sprite.png'
+
+  class << self
+    def sprite_file_paths
+      @sprite_file_paths ||= sprite_file_names.map {|f| File.join(SPRITE_ASSETS_PATH, f) }
+    end
+
+    def sprite_file_names
+      @sprite_file_names ||= Dir.entries(SPRITE_ASSETS_PATH).reject { |f| 
+        !File.file?(File.join(SPRITE_ASSETS_PATH,f))
+      }
+    end
+
+    def generate_css_name(f)
+      filename = File.basename(f).gsub(/\?.*$/, "")
+      filename.tr!('.', "_")
+      "_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!
+      return if @@skip_setup
+      puts "setting up"
+      FileUtils::mkdir_p(SPRITE_ASSETS_PATH)
+      if stale?      
+        FileUtils::rm_f(CSS_FILE_PATH)   
+        FileUtils::rm_f(SPRITE_IMG_PATH)
+        write_new_assets
+      end
+    end
+
+    def write_new_assets
+      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
+      end
+    end
+    
+    def skip_setup_on(*environments)
+      @@skip_setup = environments.map(&:to_s).include?(RAILS_ENV)
+    end
+  end
+end
+
+
+module AutoSprite::Helpers 
+  def self.included(base)
+    base.class_eval do
+      def image_tag(source, options = {})
+        src = path_to_image(source)
+        title = (options[:title].nil? or options[:title].empty?) ? "" : "title='#{options[:title]}'"
+        if src =~ /\/images\/sprites/
+          "<span #{title} class='#{AutoSprite.generate_css_name(src)}'></span>"
+        else
+          super(source,options)
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,7 @@
+require 'auto_sprite'
+config.to_prepare do
+  AutoSprite.setup!
+  ActionView::Helpers.send(:include, AutoSprite::Helpers)
+end
+
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: dohmoose_auto_sprite
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 1
+  - 1
+  - 1
+  - pre
+  version: 1.1.1.pre
+platform: ruby
+authors: 
+- Stephen Blackstone
+- Don Buchanan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-05 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+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
+- mail@donaldbuchanan.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- ./README.rdoc
+- ./auto_sprite.gemspec
+- ./MIT-LICENSE
+- ./rails/init.rb
+- ./lib/auto_sprite.rb
+has_rdoc: true
+homepage: http://fargle.org/auto_sprite
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A fully-Automagic Sprite Builder
+test_files: []
+