css_sprite 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Richard Huang (flyerhzm@gmail.com)]
+
+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.textile

@@ -0,0 +1,84 @@
+h1. css_sprite
+
+A rails plugin/gem to generate css sprite automatically.
+
+**************************************************************************
+
+h2. Install
+
+install rmagick gem first:
+<pre><code>
+sudo gem install rmagick
+</code></pre>
+
+install it as a gem:
+<pre><code>
+sudo gem sources -a http://gemcutter.org
+sudo gem install css_sprite
+</code></pre>
+
+or install it as a plugin:
+<pre><code>
+script/plugin install git@github.com:flyerhzm/css_sprite.git
+</code></pre>
+
+**************************************************************************
+
+h2. Configuration
+
+add <code>config/css_sprite.yml</code>, define about compositing what images.
+<pre><code>
+forum_icon_vertical.gif:
+  sources:
+    - good_topic.gif
+    - mid_topic.gif
+    - unread_topic.gif
+    - sticky_topic.gif
+  orient: vertical
+  span: 20
+</code></pre>
+
+first line defines the destination image filename.
+<code>sources</code> is a list of source image filenames what want to composite. They are parsed by <code>Dir.glob</code>.
+<code>orient</code> defines the composite gravity type, horizontal or vertical. Default is 'vertical'.
+<code>span</code> defines the span between two images. Default is 0.
+
+**************************************************************************
+
+h2. Usage
+
+if you use it as a gem, add a task <code>lib/tasks/css_sprite.rake</code> first:
+<pre><code>
+require 'css_sprite'
+</code></pre>
+if you use it as a plugin, ignore the step above.
+
+then just run rake task:
+<pre><code>
+rake css_sprite_build
+</code></pre>
+
+the result css is generated at <code>tmp/css_sprite.css</code>
+<pre><code>
+.good_topic
+    backgound: url('/images/forum_icon_vertical.gif') no-repeat 0px 0px
+    width: 20px
+    height: 19px
+.mid_topic
+    backgound: url('/images/forum_icon_vertical.gif') no-repeat 0px 39px
+    width: 20px
+    height: 19px
+.unread_topic
+    backgound: url('/images/forum_icon_vertical.gif') no-repeat 0px 78px
+    width: 19px
+    height: 18px
+.sticky_topic
+    backgound: url('/images/forum_icon_vertical.gif') no-repeat 0px 116px
+    width: 19px
+    height: 18px
+</code></pre>
+
+**************************************************************************
+
+
+Copyright (c) 2009 [Richard Huang (flyerhzm@gmail.com)], released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'jeweler'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "css_sprite"
+  gemspec.summary = "css_sprite is a rails plugin/gem to generate css sprite image automatically."
+  gemspec.description = "css_sprite is a rails plugin/gem to generate css sprite image automatically."
+  gemspec.email = "flyerhzm@gmail.com"
+  gemspec.homepage = "" 
+  gemspec.authors = ["Richard Huang"]
+  gemspec.files.exclude '.gitignore'
+end
+Jeweler::GemcutterTasks.new
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/css_sprite/sprite.rb

@@ -0,0 +1,76 @@
+require 'RMagick'
+
+class Sprite  
+  CONFIG_PATH = RAILS_ROOT + '/config/'
+  IMAGE_PATH = RAILS_ROOT + '/public/images/'
+  TEMP_PATH = RAILS_ROOT + '/tmp/'
+  
+  def initialize
+    @output = {}
+  end
+  
+  def build
+    sprite_config = File.open(CONFIG_PATH + 'css_sprite.yml') {|f| YAML::load(f)}
+    sprite_config.each do |dest, configs|
+      output_image(dest, configs)
+    end
+    
+    output_css
+  end
+  
+  def output_image(dest, configs)
+    results = []
+    sources = configs['sources'].collect {|source| Dir.glob(IMAGE_PATH + source)}.flatten
+    span = configs['span'] || 0
+    dest_image = get_image(sources.shift)
+    results << image_properties(dest_image).merge(:x => 0, :y => 0)
+    sources.each do |source|
+      source_image = get_image(source)
+      if configs['orient'] == 'horizontal'
+        gravity = Magick::EastGravity
+        x = dest_image.columns + span
+        y = 0
+      else
+        gravity = Magick::SouthGravity
+        x = 0
+        y = dest_image.rows + span
+      end
+      results << image_properties(source_image).merge(:x => x, :y => y)
+      dest_image = composite_images(dest_image, source_image, x, y)
+    end
+    @output[dest] = results
+    dest_image.write(IMAGE_PATH + dest)
+  end
+  
+  def output_css
+    File.open(TEMP_PATH + 'css_sprite.css', 'w') do |f|
+      @output.each do |dest, results|
+        results.each do |result|
+          f.puts ".#{result[:name]}"
+          f.puts "\tbackgound: url('/images/#{dest}') no-repeat #{result[:x]}px #{result[:y]}px"
+          f.puts "\twidth: #{result[:width]}px"
+          f.puts "\theight: #{result[:height]}px"
+          f.puts ""
+        end
+      end
+    end
+  end
+  
+  def composite_images(dest_image, src_image, x, y)
+    width = [src_image.columns + x, dest_image.columns].max
+    height = [src_image.rows + y, dest_image.rows].max
+    image = Magick::Image.new(width, height)
+    image.composite!(dest_image, 0, 0, Magick::AddCompositeOp)
+    image.composite!(src_image, x, y, Magick::AddCompositeOp)
+    image
+  end
+  
+  def get_image(image_filename)
+    image = Magick::Image::read(image_filename).first
+  end
+  
+  def image_properties(image)
+    {:name => File.basename(image.filename).split('.')[0], :width => image.columns, :height => image.rows}
+  end
+    
+end

data/lib/css_sprite.rb

@@ -0,0 +1,4 @@
+unless Rake::Task.task_defined? "css_sprite:build"
+  load File.join(File.dirname(__FILE__), '..', 'tasks', 'css_sprite_tasks.rake')
+end
+

data/spec/css_sprite_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe CssSprite do
+  before(:all) do
+    @sprite = CssSprite.new
+  end
+  
+  context "get_image" do
+    it "should get a image" do
+      @sprite.get_image(File.join(File.dirname(__FILE__), 'resources/good_topic.gif')).class.should == Magick::Image
+    end
+  end
+  
+  context "image_properties" do
+    it "should get image properties" do
+      image = @sprite.get_image(File.join(File.dirname(__FILE__), 'resources/good_topic.gif'))
+      @sprite.image_properties(image).should == {:name => 'good_topic', :width => 20, :height => 19}
+    end
+  end
+  
+  context "composite_images" do
+    it "should composite two images into one horizontally" do
+      image1 = @sprite.get_image(File.join(File.dirname(__FILE__), 'resources/good_topic.gif'))
+      image2 = @sprite.get_image(File.join(File.dirname(__FILE__), 'resources/mid_topic.gif'))
+      image = @sprite.composite_images(image1, image2, image1.columns, 0)
+      @sprite.image_properties(image).should == {:name => nil, :width => 40, :height => 19}
+    end
+    
+    it "should composite two images into one verically" do
+      image1 = @sprite.get_image(File.join(File.dirname(__FILE__), 'resources/good_topic.gif'))
+      image2 = @sprite.get_image(File.join(File.dirname(__FILE__), 'resources/mid_topic.gif'))
+      image = @sprite.composite_images(image1, image2, 0, image1.rows)
+      @sprite.image_properties(image).should == {:name => nil, :width => 20, :height => 38}
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,8 @@
+--colour
+--format
+specdoc
+--reverse
+--timeout
+20
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'spec/autorun'
+require 'date'
+
+RAILS_ROOT = '.'
+require File.join(File.dirname(__FILE__), '/../lib/css_sprite.rb')

data/tasks/css_sprite_tasks.rake

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), '../lib/css_sprite/sprite.rb')
+
+namespace :css_sprite do  
+  desc "buid css sprite image"
+  task :build do
+    Sprite.new.build
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: css_sprite
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-30 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: css_sprite is a rails plugin/gem to generate css sprite image automatically.
+email: flyerhzm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/css_sprite.rb
+- lib/css_sprite/sprite.rb
+- spec/css_sprite_spec.rb
+- spec/resources/good_topic.gif
+- spec/resources/mid_topic.gif
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/css_sprite_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: css_sprite is a rails plugin/gem to generate css sprite image automatically.
+test_files: 
+- spec/spec_helper.rb
+- spec/css_sprite_spec.rb