sprite 0.1.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.md

@@ -0,0 +1,111 @@
+# sprite #
+
+`sprite` is a gem that helps generate css sprite images automagically. It's aim is to support all web frameworks (Merb/Rails/Sinatra)
+
+it's a fork an extension of Richard Huang's excellent Rails plugin `css_sprite` (github.com/flyerhzm/css_sprite)
+
+****
+
+## Install ##
+
+install rmagick gem first:
+
+    gem install rmagick
+
+if you have any problems with the rmagick gem, install imagemagick via macports first:
+
+    sudo port install libxml2
+    sudo port install ImageMagick  
+
+or via installer: http://github.com/maddox/magick-installer/tree/master
+
+install it as a gem:
+
+    gem sources -a http://gemcutter.org
+    gem install sass_sprite
+
+### if using merb ###
+  
+    gem "sprite"
+  
+### if using rails ###
+
+    script/plugin install git://github.com/merbjedi/sprite.git
+
+or add to environment.rb
+    
+    config.gem "sprite"
+
+***
+
+## Configuration ##
+
+add `config/sprite.yml`, define about compositing what images.
+
+  forum_icon_vertical.gif:  # destination image file
+    sources:                # source image file list
+      - good_topic.gif
+      - mid_topic.gif
+      - unread_topic.gif
+      - sticky_topic.gif
+    orient: vertical        # composite gravity, vertical or horizontal
+    span: 5                 # span of space between two images
+
+first line defines the destination image filename.
+`sources` is a list of source image filenames what want to composite. They are parsed by <code>Dir.glob</code>.
+`orient` defines the composite gravity type, horizontal or vertical. Default is 'vertical'.
+`span` defines the span between two images. Default is 0.
+
+you can define any number of destination image files.
+
+***
+
+## Usage ##
+
+if you use it as a gem, add a task `lib/tasks/sprites.rake` first:
+
+  require 'sprites'
+
+if you use it as a plugin, ignore the step above.
+
+then just run rake task:
+  
+  rake sprites:build
+
+the result css is generated at `public/stylesheets/sprite.css`
+
+    .good_topic {
+        background: url('/images/forum_icon_vertical.gif') no-repeat 0px 0px;
+        width: 20px;
+        height: 19px;
+    }
+    .mid_topic {
+        background: url('/images/forum_icon_vertical.gif') no-repeat 0px 24px
+        width: 20px;
+        height: 19px;
+    }
+    .unread_topic {
+        background: url('/images/forum_icon_vertical.gif') no-repeat 0px 48px;
+        width: 19px;
+        height: 18px;
+    }
+    .sticky_topic {
+        background: url('/images/forum_icon_vertical.gif') no-repeat 0px 71px;
+        width: 19px;
+        height: 18px;
+    }
+
+
+***
+
+## Contributors ##
+
+merbjedi - reorganized as a general purpose ruby plugin for merb/rails/sinatra/
+
+josedelcorral - fix the style of generated css
+
+
+***
+
+
+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 = "sprite"
+  gemspec.summary = "generate your css sprites automagically"
+  gemspec.description = "sprite is a rails/merb plugin that generates sprites for css, sass"
+  gemspec.email = "merbjedi@gmail.com"
+  gemspec.homepage = "http://github.com/merbjedi/sprite" 
+  gemspec.authors = ["Jacques Crocker", "Richard Huang"]
+  gemspec.files.exclude '.gitignore'
+end
+Jeweler::GemcutterTasks.new
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/css_sprite_example_config.yml

@@ -0,0 +1,24 @@
+config:
+  base_directory: public/images
+  css_output: tmp/css_sprite.css
+  
+images:
+  - description: Stars with transparency
+    sources:
+      - sc-mcstars0.png
+      - sc-mcstars1.png
+      - sc-mcstars2.png
+      - sc-mcstars3.png
+    target: stars_png_with_transparency.png
+    align: horizontal
+    spaced_by: 50
+  
+  - description: Stars as JPEG
+    sources:
+      - sc-0.jpg
+      - sc-1.jpg
+      - sc-2.jpg
+      - sc-3.jpg
+    target: stars_as_jpg.jpg
+    align: vertical
+    spaced_by: 50

data/lib/sprite.rb

@@ -0,0 +1,6 @@
+require 'rake'
+require 'sprite/sprite'
+unless Rake::Task.task_defined? "sprite:build"
+  load File.join(File.dirname(__FILE__), '..', 'tasks', 'sprite_tasks.rake')
+end
+

data/lib/sprite/sprite.rb

@@ -0,0 +1,84 @@
+require 'RMagick'
+
+class Sprite  
+  CONFIG_PATH = RAILS_ROOT + '/config/'
+  DEFAULT_IMAGE_PATH = RAILS_ROOT + '/public/images/'
+  CSS_OUTPUT = RAILS_ROOT + '/tmp/css_sprite.css'
+  
+  def initialize
+    @image_path = DEFAULT_IMAGE_PATH
+    @config_files = Dir.glob("#{CONFIG_PATH}/css_sprite*.yml")
+  end
+  
+  def build
+    @config_files.each do |config_file|
+      @output = {}
+      sprite_config = File.open(config_file) {|f| YAML::load(f)}
+      @image_path = (sprite_config['config']['base_directory'])?RAILS_ROOT+"/"+sprite_config['config']['base_directory']+"/":DEFAULT_IMAGE_PATH
+      @css_output = (sprite_config['config']['css_output'])?RAILS_ROOT+"/"+sprite_config['config']['css_output']:CSS_OUTPUT
+      sprite_config['images'].each do |configuration|
+         output_image(configuration)
+      end
+      output_css(sprite_config)
+    end
+  end
+  
+  def output_image(configuration)
+    results = []
+    sources = configuration['sources'].collect {|source| Dir.glob(@image_path+source)}.flatten
+    dest = configuration['target'] || sources[0].gsub(/\./,"_sprite.")
+    spaced_by = configuration['spaced_by'] || 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 configuration['align'] == 'horizontal'
+        gravity = Magick::EastGravity
+        x = dest_image.columns + spaced_by
+        y = 0
+      else
+        gravity = Magick::SouthGravity
+        x = 0
+        y = dest_image.rows + spaced_by
+      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(configuration)
+    File.open(@css_output, 'w') do |f|
+      @output.each do |dest, results|
+        results.each do |result|
+          f.puts ".#{result[:name]}"
+          f.puts "\tbackground: 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.opacity = Magick::MaxRGB
+    
+    image.composite!(dest_image, 0, 0, Magick::OverCompositeOp)
+    image.composite!(src_image, x, y, Magick::OverCompositeOp)
+    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/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/sprite.rb')

data/spec/sprite_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Sprite do
+  before(:all) do
+    @sprite = Sprite.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/sprite.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sprite}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jacques Crocker", "Richard Huang"]
+  s.date = %q{2009-11-13}
+  s.description = %q{sprite is a rails/merb plugin that generates sprites for css, sass}
+  s.email = %q{merbjedi@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "config/css_sprite_example_config.yml",
+     "lib/sprite.rb",
+     "lib/sprite/sprite.rb",
+     "spec/resources/good_topic.gif",
+     "spec/resources/mid_topic.gif",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/sprite_spec.rb",
+     "sprite.gemspec",
+     "tasks/sprite_tasks.rake"
+  ]
+  s.homepage = %q{http://github.com/merbjedi/sprite}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{generate your css sprites automagically}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/sprite_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/tasks/sprite_tasks.rake

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: sprite
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jacques Crocker
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-13 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: sprite is a rails/merb plugin that generates sprites for css, sass
+email: merbjedi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- config/css_sprite_example_config.yml
+- lib/sprite.rb
+- lib/sprite/sprite.rb
+- spec/resources/good_topic.gif
+- spec/resources/mid_topic.gif
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/sprite_spec.rb
+- sprite.gemspec
+- tasks/sprite_tasks.rake
+has_rdoc: true
+homepage: http://github.com/merbjedi/sprite
+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: generate your css sprites automagically
+test_files: 
+- spec/spec_helper.rb
+- spec/sprite_spec.rb