css-spriter 0.9.2 → 1.0.1

data/README.rdoc

@@ -15,6 +15,10 @@ It takes your PNG's, chews them up and spits out sprites!
 
 point bin/css-spriter at a directory, and watch it sprite away!
 
+CSS-Spriter uses Chunky PNG for it's PNG manipulation.  Not only is it super fast, but the library is a great example of fast, efficient ruby programming.
+
+Chunky PNG is written in pure ruby, this means you can sprite up anything using MRI, JRuby, or Rubinius.
+
 == Installation - standalone
 
   sudo gem install css-spriter
@@ -35,7 +39,7 @@ For a full list of options:
 
 === Usage - Rails plugin
 
-Spittle assumes all of your sprites are located in the directory public/images/sprites.  This directory should contain sub-directories for each sprite you wish to create.  The css class names for an image in a sprite will take the form <directory_name>_<image_name>.  Here is an example:
+CSS-Spriter assumes all of your sprites are located in the directory public/images/sprites.  This directory should contain sub-directories for each sprite you wish to create.  The css class names for an image in a sprite will take the form <directory_name>_<image_name>.  Here is an example:
 
   sprites /
     cars /
@@ -45,14 +49,10 @@ Spittle assumes all of your sprites are located in the directory public/images/s
       boeing.png
       cesna.png
 
-Running sprite:generate does all the work. Each sprite directory (cars, planes) will now contain a sprite.png.  Spittle will also generate a sprites.css stylesheet in public/stylesheets/ that you should include in your layout.  If you wished to use the ford image from the cars sprite you would give the 'cars_ford' class to the desired element in the view.  That's it!
-
-Check out examples/sprites if you want to see what spriter can do without doing any work.
+Running the sprite:generate task does all the work. Each sprite directory (cars, planes) will now contain a sprite.png.  Spittle will also generate a sprites.css stylesheet in public/stylesheets/ that you should include in your layout.  If you wished to use the ford image from the cars sprite you would give the 'cars_ford' class to the desired element in the view.  That's it!
 
-== Limitations
+Check out examples/sprites if you want to see what CSS-Spriter can do without doing any work.
 
-- does not support color profiles (can cause a slight change in color from the source image)
-- does not support reading interlaced PNGs.
 
 == Features
 
@@ -62,12 +62,10 @@ Check out examples/sprites if you want to see what spriter can do without doing
 - Rails plugin & rake tasks (sprite:generate & sprite:cleanup)
 - Supports varying dimensions in source images
 - Does not regenerate sprites that have not changed
-- Supports all PNG filter types to improve image compression
 - supports mixing RGB and RGBA color types
 
 == Roadmap - by priority
 
-- Reading interlaced images
 - allow a global css template override
 - allow per-sprite and global configuration
 

data/Rakefile

@@ -6,11 +6,12 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "css-spriter"
     gem.summary = %Q{pure ruby PNG spriting library}
-    gem.description = %Q{Css Spriter is a pure ruby PNG spriting library. It can be used standalone or as a Rails plugin, see the readme for details.}
+    gem.description = %Q{CSS-Spriter is a pure ruby PNG spriting library. It can be used standalone or as a Rails plugin, see the readme for details.}
     gem.email = ["qzzzq1@gmail.com", "tyler.jennings@gmail.com"]
     gem.homepage = "http://github.com/aberant/css-spriter"
     gem.authors = ["aberant", "tjennings"]
     gem.add_development_dependency "rspec" #, ">= 1.2.9"
+    gem.add_dependency "chunky_png", "~> 1.1.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -18,14 +19,12 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = 'spec/**/*_spec.rb'
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
 end
@@ -39,7 +38,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "spittle #{version}"
+  rdoc.title = "css-spriter #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.9.2
+1.0.1

data/bin/css-spriter

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require File.dirname(__FILE__) + "/../lib/css-spriter.rb"
+require File.dirname(__FILE__) + "/../lib/css-spriter"
 
 
 options = {}

data/css-spriter.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{css-spriter}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["aberant", "tjennings"]
+  s.date = %q{2011-03-23}
+  s.default_executable = %q{css-spriter}
+  s.description = %q{CSS-Spriter is a pure ruby PNG spriting library. It can be used standalone or as a Rails plugin, see the readme for details.}
+  s.email = ["qzzzq1@gmail.com", "tyler.jennings@gmail.com"]
+  s.executables = ["css-spriter"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/css-spriter",
+    "css-spriter.gemspec",
+    "examples/sprites/.mtimes",
+    "examples/sprites/README",
+    "examples/sprites/fragment.css",
+    "examples/sprites/index.html",
+    "examples/sprites/many_sized_cats/.mtimes",
+    "examples/sprites/many_sized_cats/cat-on-keyboard.png",
+    "examples/sprites/many_sized_cats/darth_cat.png",
+    "examples/sprites/many_sized_cats/fragment.css",
+    "examples/sprites/many_sized_cats/music-keyboard-cat.png",
+    "examples/sprites/many_sized_cats/sprite.css",
+    "examples/sprites/many_sized_cats/sprite.png",
+    "examples/sprites/server.rb",
+    "examples/sprites/sprite.css",
+    "examples/sprites/words/.mtimes",
+    "examples/sprites/words/fragment.css",
+    "examples/sprites/words/latitude.png",
+    "examples/sprites/words/of.png",
+    "examples/sprites/words/set.png",
+    "examples/sprites/words/specified.png",
+    "examples/sprites/words/sprite.css",
+    "examples/sprites/words/sprite.png",
+    "init.rb",
+    "lib/css-spriter.rb",
+    "lib/css-spriter/directory_processor.rb",
+    "lib/css-spriter/image.rb",
+    "lib/css-spriter/mtime_tracker.rb",
+    "lib/css-spriter/processor.rb",
+    "lib/css-spriter/sprite.rb",
+    "lib/css-spriter/stylesheet_builder.rb",
+    "spec/builders/image_builder.rb",
+    "spec/css_fragments/deep/style/fragment.css",
+    "spec/css_fragments/some/fragment.css",
+    "spec/expected_output/merge_right_test.png",
+    "spec/expected_output/write_test.png",
+    "spec/images/lightening.png",
+    "spec/integration_spec.rb",
+    "spec/lib/css_spriter_image_spec.rb",
+    "spec/lib/sprite_spec.rb",
+    "spec/mtime_tracking_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/sprite_dirs/words/latitude.png",
+    "spec/sprite_dirs/words/of.png",
+    "spec/sprite_dirs/words/set.png",
+    "spec/sprite_dirs/words/specified.png",
+    "spec/tmp/merge_right_test.png",
+    "spec/tmp/write_test.png",
+    "tasks/spriter_tasks.rake"
+  ]
+  s.homepage = %q{http://github.com/aberant/css-spriter}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{pure ruby PNG spriting library}
+  s.test_files = [
+    "examples/sprites/server.rb",
+    "spec/builders/image_builder.rb",
+    "spec/integration_spec.rb",
+    "spec/lib/css_spriter_image_spec.rb",
+    "spec/lib/sprite_spec.rb",
+    "spec/mtime_tracking_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<chunky_png>, ["~> 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<chunky_png>, ["~> 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<chunky_png>, ["~> 1.1.0"])
+  end
+end
+

data/lib/css-spriter.rb

@@ -1,16 +1,7 @@
-require 'zlib'
-
-require 'css-spriter/png/file_header'
-require 'css-spriter/png/parser'
-require 'css-spriter/png/filters'
-require 'css-spriter/png/chunk'
-require 'css-spriter/png/ihdr'
-require 'css-spriter/png/idat'
-require 'css-spriter/png/iend'
-require 'css-spriter/png/image'
+require 'chunky_png'
 require 'css-spriter/sprite'
+require 'css-spriter/image'
 require 'css-spriter/directory_processor'
 require 'css-spriter/stylesheet_builder'
 require 'css-spriter/processor'
 require 'css-spriter/mtime_tracker'
-require 'css-spriter/image_data'

data/lib/css-spriter/directory_processor.rb

@@ -1,94 +1,98 @@
-class DirectoryProcessor
-
-  DEFAULT_TEMPLATE = <<-EOF
-  .<name>_<image_name> {
-    background: transparent url(<image_loc>) <offset>px 0px no-repeat;
-    width:<width>;
-    height:<height>;
-    text-indent:-5000px;
-  }
-
-  EOF
-
-  def initialize(dir, options = {})
-    @options = options
-    @dir = dir
-    @sprite = Sprite.new
-    @tracker = MtimeTracker.new(@dir,
-                                :exclude => ['sprite.css', 'fragment.css', 'sprite.png'])
-  end
+module CssSpriter
+  class DirectoryProcessor
 
-  def images
-    Dir.glob(@dir + "/*.png").reject{|i| i.match /sprite\.png/}
-  end
+    DEFAULT_TEMPLATE = <<-EOF
+    .<name>_<image_name> {
+      background: transparent url(<image_loc>) <offset>px 0px no-repeat;
+      width:<width>;
+      height:<height>;
+      text-indent:-5000px;
+    }
 
-  def write
-    return unless @tracker.has_changes?
-    images.each {|f| @sprite.append(PNG::Image.image_data(f))}
-    @sprite.write(sprite_file)
-    File.open(css_file, 'w') do |f|
-      f.write(css)
+    EOF
+
+    def initialize(dir, options = {})
+      @options = options
+      @dir = dir
+      @sprite = Sprite.new
+      @tracker = MtimeTracker.new(@dir,
+                                  :exclude => ['sprite.css', 'fragment.css', 'sprite.png'])
     end
-    @tracker.update
-  end
 
-  def cleanup
-    File.delete(sprite_file) rescue nil
-    File.delete(css_file) rescue nil
-    @tracker.cleanup
-  end
+    def images
+      Dir.glob(@dir + "/*.png").reject{|i| i.match /sprite\.png/}
+    end
 
-  def sprite_file
-    @dir + "/sprite.png"
-  end
+    def write
+      return unless @tracker.has_changes?
+      images.each {|f| @sprite.append_file(f)}
 
-  def css_file
-    @dir + "/fragment.css"
-  end
+      @sprite.write(sprite_file)
 
-  def dir_name
-    @dir.split('/').last
-  end
+      File.open(css_file, 'w') do |f|
+        f.write(css)
+      end
+      @tracker.update
+    end
 
-  def image_loc
-    #TODO: Lame!
+    def cleanup
+      File.delete(sprite_file) rescue nil
+      File.delete(css_file) rescue nil
+      @tracker.cleanup
+    end
 
-    dir = truncate_abs_path
-    base = ("/" + dir + "/sprite.png").gsub(/^\/.\//, "/").gsub("//", "/")
-    source = @options[:source]
-    base = base.gsub(source, "") if source && source != "."
-    base = @options[:path_prefix] + base if @options[:path_prefix]
-    base
-  end
+    def sprite_file
+      @dir + "/sprite.png"
+    end
 
-  def truncate_abs_path
-    return @dir unless @options[:source]
-    path_elements = @options[:source].split('/')
-    path_elements.pop #we want to remove everything above the root 
-    to_truncate = path_elements.join("/")
-    @dir.gsub(to_truncate, "")
-  end
+    def css_file
+      @dir + "/fragment.css"
+    end
 
-  def template_file
-    @dir + "/template.css"
-  end
+    def dir_name
+      @dir.split('/').last
+    end
+
+    def image_loc
+      #TODO: Lame!
 
-  def template
-    if File.exists?(template_file)
-      return File.read(template_file)
+      dir = truncate_abs_path
+      base = ("/" + dir + "/sprite.png").gsub(/^\/.\//, "/").gsub("//", "/")
+      source = @options[:source]
+      base = base.gsub(source, "") if source && source != "."
+      base = @options[:path_prefix] + base if @options[:path_prefix]
+      base
+    end
+
+    def truncate_abs_path
+      return @dir unless @options[:source]
+      path_elements = @options[:source].split('/')
+      path_elements.pop #we want to remove everything above the root
+      to_truncate = path_elements.join("/")
+      @dir.gsub(to_truncate, "")
+    end
+
+    def template_file
+      @dir + "/template.css"
+    end
+
+    def template
+      if File.exists?(template_file)
+        return File.read(template_file)
+      end
+      return DEFAULT_TEMPLATE
     end
-    return DEFAULT_TEMPLATE
-  end
 
-  def css
-    @sprite.locations.inject("") do |out, image|
-      image_name, properties = image
-      out << template.gsub("<name>", dir_name).
-             gsub("<image_name>", image_name.to_s).
-             gsub("<width>", properties[:width].to_s).
-             gsub("<height>", properties[:height].to_s).
-             gsub("<offset>", properties[:x].to_s).
-             gsub("<image_loc>", image_loc)
+    def css
+      @sprite.locations.inject("") do |out, image|
+        image_name, properties = image
+        out << template.gsub("<name>", dir_name).
+               gsub("<image_name>", image_name.to_s).
+               gsub("<width>", properties[:width].to_s).
+               gsub("<height>", properties[:height].to_s).
+               gsub("<offset>", properties[:x].to_s).
+               gsub("<image_loc>", image_loc)
+      end
     end
   end
-end
+end

data/lib/css-spriter/image.rb

@@ -0,0 +1,13 @@
+module CssSpriter
+  class Image < ::ChunkyPNG::Image
+    attr_accessor :name
+
+    def self.from_file( filename )
+      name = File.basename( filename, ".png" )
+
+      image = super
+      image.name = name
+      image
+    end
+  end
+end

data/lib/css-spriter/mtime_tracker.rb

@@ -1,79 +1,82 @@
-class MtimeTracker
-  def initialize(dir, options = {})
-    @dir = dir
-    @options = options
-  end
+module CssSpriter
+  class MtimeTracker
+    def initialize(dir, options = {})
+      @dir = dir
+      @options = options
+    end
 
-  def cleanup
-    File.delete(mtime_file) rescue nil
-  end
+    def cleanup
+      File.delete(mtime_file) rescue nil
+    end
 
-  def fresh?
-    not File.exists?(mtime_file)
-  end
+    def fresh?
+      not File.exists?(mtime_file)
+    end
 
-  def files
-    return @files if @files
-    @files = without_exclusions(Dir.glob(@dir + "/**/*"))
-  end
+    def files
+      @files = without_exclusions(Dir.glob(@dir + "/**/*"))
+    end
 
-  def without_exclusions(files)
-    return files unless @options[:exclude]
-    exclusions = [@options[:exclude]].flatten
-    files.select{|f| not exclusions.any?{|e| f.match e}}
-  end
+    def without_exclusions(files)
+      return files unless @options[:exclude]
+      exclusions = [@options[:exclude]].flatten
+      files.select{|f| not exclusions.any?{|e| f.match e}}
+    end
 
-  def current_mtimes
-    @current ||= files.inject({}) do |map, f|
-      map[f] = File.mtime(f).to_i; map
+    def current_mtimes
+      @current ||= files.inject({}) do |map, f|
+        map[f] = File.mtime(f).to_i; map
+      end
     end
-  end
 
-  def file_changed?(file)
-    mtimes[file] != current_mtimes[file]
-  end
+    def file_changed?(file)
+      mtimes[file] != current_mtimes[file]
+    end
 
-  def mtimes
-    return @mtimes if @mtimes
-    return {} unless File.exists?(mtime_file)
-    @mtimes = read_mtimes
-  end
+    def mtimes
+      return @mtimes if @mtimes
+      return {} unless File.exists?(mtime_file)
+      @mtimes = read_mtimes
+    end
 
-  def read_mtimes
-    mtimes = {}
-    File.open(mtime_file) do |f|
-      f.each do |line|
-        name, time = line.split("\t")
-        mtimes[name] = time.to_i
+    def read_mtimes
+      mtimes = {}
+      File.open(mtime_file) do |f|
+        f.each do |line|
+          name, time = line.split("\t")
+          mtimes[name] = time.to_i
+        end
       end
+      mtimes
     end
-    mtimes
-  end
 
-  def changeset
-    files.select{|f| file_changed?(f)}
-  end
+    def changeset
+      changed = files.select{|f| file_changed?(f)}
+      deleted = without_exclusions(mtimes.keys) - current_mtimes.keys
+      changed + deleted
+    end
 
-  def has_changes?
-    not changeset.empty?
-  end
+    def has_changes?
+      not changeset.empty?
+    end
 
-  def mtime_file
-    @dir + "/.mtimes"
-  end
+    def mtime_file
+      @dir + "/.mtimes"
+    end
 
-  def update
-    File.open(mtime_file, 'w') do |f|
-      current = current_mtimes
-      flat = current.map{|k, v| "#{k}\t#{v}\n"}.join
-      f.write flat
+    def update
+      File.open(mtime_file, 'w') do |f|
+        current = current_mtimes
+        flat = current.map{|k, v| "#{k}\t#{v}\n"}.join
+        f.write flat
+      end
+      reset
     end
-    reset
-  end
 
-  def reset
-    @mtimes = nil
-    @current = nil
-    @files = nil
+    def reset
+      @mtimes = nil
+      @current = nil
+      @files = nil
+    end
   end
-end
+end