spittle 0.9.0 → 0.9.1

data/README

@@ -12,8 +12,42 @@ It takes your PNG's, chews them up and spits out sprites!
 
 point bin/spittle at a directory, and watch it sprite away!
 
+INSTALLATION
 
+We're hosted at gemcutter.  I believe 'sudo gem install gemcutter' then 'gem tumble'.
+Then you can run: 
 
-currently only supports images of the same height - this will change soon.
+> sudo gem install spittle
 
-thx to tjennings for the initial spike and help
+USAGE
+
+> spittle <directory>
+
+For a full list of options:
+
+> spittle -h
+
+LIMITATIONS
+
+- only supports images of the same height and color type.
+- only supports RGB and RGBA color types
+- does not support color profiles (can cause a slight change in color from the source image)
+
+FEATURES
+
+- automatically generates PNG sprites from a set of PNG images
+- automatically generates css classes to access images within the sprite
+- customize the css template for each sprite 
+
+ROADMAP - by priority
+
+- Rails plugin & rake tasks
+- Support varying height in source images
+- Use mtime tracking to prevent regeneration of sprites that have not changed
+- Support color profiles
+- Support global css template override
+
+AUTHORS
+
+aberant - Colin Harris
+tjennings - Tyler Jennings

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.1

data/bin/spittle

@@ -1,15 +1,36 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require File.dirname(__FILE__) + "/../lib/spittle.rb"
 
+
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: spittle [options] directory"
+
+  opts.on("-o", "--out FILE", "Write css output to an alternate location") do |file|
+    options[:css_file] = file
+  end
+
+  opts.on("-p", "--path-prefix PREFIX", "prepend sprite paths with the given string") do |prefix|
+    options[:path_prefix] = prefix
+  end
+
+  opts.on_tail("-h", "--help", "Prints this message") do 
+    puts opts
+    exit
+  end
+
+  opts.parse!(ARGV)
+end
+
 dir = ARGV[0]
 
-if dir
-  Spittle::Processor.new(:source => dir).write
-else
-  puts
-  puts "spittle! it chews up your PNG's and spits out sprites!"
-  puts "useage: spittle DIRECTORY"
-  puts "eg. spittle my_images"
-  puts
-end
+unless dir
+  puts opts.help
+  exit
+end
+
+options[:source] = dir
+Spittle::Processor.new(options).write
+

data/examples/sprites/apple/fragment.css

@@ -1,61 +1,61 @@
+  .apple_iphone {
+    background: transparent url(/tacos/apple/sprite.png) -234px 0px no-repeat;
+    width:116;
+    height:38;
+    text-indent:-5000px;
+  }
+
   .apple_itunes {
-    background: transparent url(/apple/sprite.png) -350px 0px no-repeat;
+    background: transparent url(/tacos/apple/sprite.png) -350px 0px no-repeat;
     width:116;
     height:38;
     text-indent:-5000px;
   }
 
   .apple_mac {
-    background: transparent url(/apple/sprite.png) -466px 0px no-repeat;
+    background: transparent url(/tacos/apple/sprite.png) -466px 0px no-repeat;
     width:116;
     height:38;
     text-indent:-5000px;
   }
 
   .apple_apple {
-    background: transparent url(/apple/sprite.png) 0px 0px no-repeat;
+    background: transparent url(/tacos/apple/sprite.png) 0px 0px no-repeat;
     width:117;
     height:38;
     text-indent:-5000px;
   }
 
-  .apple_store {
-    background: transparent url(/apple/sprite.png) -744px 0px no-repeat;
+  .apple_support {
+    background: transparent url(/tacos/apple/sprite.png) -860px 0px no-repeat;
     width:116;
     height:38;
     text-indent:-5000px;
   }
 
   .apple_search {
-    background: transparent url(/apple/sprite.png) -582px 0px no-repeat;
+    background: transparent url(/tacos/apple/sprite.png) -582px 0px no-repeat;
     width:162;
     height:38;
     text-indent:-5000px;
   }
 
   .apple_divider {
-    background: transparent url(/apple/sprite.png) -117px 0px no-repeat;
+    background: transparent url(/tacos/apple/sprite.png) -117px 0px no-repeat;
     width:1;
     height:38;
     text-indent:-5000px;
   }
 
-  .apple_support {
-    background: transparent url(/apple/sprite.png) -860px 0px no-repeat;
+  .apple_store {
+    background: transparent url(/tacos/apple/sprite.png) -744px 0px no-repeat;
     width:116;
     height:38;
     text-indent:-5000px;
   }
 
   .apple_downloads {
-    background: transparent url(/apple/sprite.png) -118px 0px no-repeat;
-    width:116;
-    height:38;
-    text-indent:-5000px;
-  }
-
-  .apple_iphone {
-    background: transparent url(/apple/sprite.png) -234px 0px no-repeat;
+    background: transparent url(/tacos/apple/sprite.png) -118px 0px no-repeat;
     width:116;
     height:38;
     text-indent:-5000px;

data/init.rb

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

data/lib/spittle/directory_spriter.rb

@@ -1,9 +1,22 @@
 class DirectoryProcessor
-  def initialize(dir)
+
+  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
     files = images
     @sprite = PNG::Sprite.new
     files.each {|f| @sprite.append(PNG::Image.open(f))}
+    #puts "#{@dir} #{files.size} files"
   end
 
   def images
@@ -36,23 +49,26 @@ class DirectoryProcessor
 
   def image_loc
     #TODO: Lame!
-    ("/" + @dir + "/sprite.png").gsub("/./", "/")
+    base = ("/" + @dir + "/sprite.png").gsub("/./", "/").gsub("//", "/")
+    base = @options[:path_prefix] + base if @options[:path_prefix]
+    base
   end
 
-  FRAG = <<-EOF
-  .<name>_<image_name> {
-    background: transparent url(<image_loc>) <offset>px 0px no-repeat;
-    width:<width>;
-    height:<height>;
-    text-indent:-5000px;
-  }
+  def template_file
+    @dir + "/template.css"
+  end
 
-  EOF
+  def template
+    if File.exists?(template_file)
+      return File.read(template_file)
+    end
+    return DEFAULT_TEMPLATE
+  end
 
   def css
     @sprite.locations.inject("") do |out, image|
       image_name, properties = image
-      out << FRAG.gsub("<name>", dir_name).
+      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).

data/lib/spittle/image.rb

@@ -32,6 +32,10 @@ module PNG
         f.write(generate_png)
       end
     end
+
+    def to_s
+      "#{@name} (#{height} x #{width})"
+    end
     
     def merge_left( other )
       l = other.rows

data/lib/spittle/processor.rb

@@ -1,6 +1,7 @@
 module Spittle
   class Processor
     def initialize(opts)
+      #puts "Processing Directory #{opts[:source]}"
       @options = opts
       @processors = dir_processors
       @css_builder = StylesheetBuilder.new(@options[:source])
@@ -17,7 +18,7 @@ module Spittle
     end
 
     def dir_processors
-      directories.map{|d| DirectoryProcessor.new(d)}
+      directories.map{|d| DirectoryProcessor.new(d, @options)}
     end
 
     def cleanup

data/spec/integration_spec.rb

@@ -22,9 +22,6 @@ describe 'PNG' do
     read("#{@expected_dir}/merge_right_test.png").should == read("#{@tmp_dir}/merge_right_test.png")
   end
 
-  def read(file_name)
-    File.read(file_name)
-  end
 end
 
 describe "Dir sprite" do 
@@ -58,9 +55,14 @@ describe "Dir sprite" do
 
   describe "CSS fragments" do 
     before :all do 
+      @template = @dir + "/template.css"
       @css = @spriter.css
     end
 
+    after do 
+      File.delete(@template) rescue {}
+    end
+
     it "should compose class names" do 
       @css.should include( ".words_latitude")
       @css.should include( ".words_of" )
@@ -73,6 +75,12 @@ describe "Dir sprite" do
     it "should write css fragments for a sprite" do 
       File.exists?(@css_file).should be_true
     end
+
+    it "can be overidden by including a template.css in the sprite directory" do 
+      File.open(@template, 'w'){|f| f.write("override")}
+      @spriter.write
+      @spriter.css.should include("override")
+    end
   end
 end
 
@@ -107,7 +115,7 @@ describe "Complete spriting process" do
   before :all do 
     @dir = File.dirname(__FILE__) + "/sprite_dirs"
     @css_file = @dir + "/sprite.css"
-    @spittle = Spittle::Processor.new(:source => @dir, :css_file => @css_file)
+    @spittle = Spittle::Processor.new(:path_prefix => "/images", :source => @dir, :css_file => @css_file)
     @spittle.write
   end
 
@@ -118,6 +126,11 @@ describe "Complete spriting process" do
     File.exists?(@dir + "/words/sprite.png").should be_false
   end
 
+  it "prepends a path prefix to all sprites in the css file" do 
+    file = read(@css_file)
+    file.should include("/images/spec/sprite_dirs/words")
+  end
+
   it "can find all the sprite directories" do 
     dirs = @spittle.directories.map{|d| d.split('/').last}
     dirs.should include( "words" )
@@ -132,3 +145,8 @@ describe "Complete spriting process" do
     File.exists?(@dir + "/words/fragment.css").should be_true
   end
 end
+
+def read(file_name)
+  File.read(file_name)
+end
+

data/spittle.gemspec

@@ -0,0 +1,118 @@
+# 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{spittle}
+  s.version = "0.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["aberant", "tjennings"]
+  s.date = %q{2009-11-16}
+  s.default_executable = %q{spittle}
+  s.description = %q{pure ruby PNG}
+  s.email = ["qzzzq1@gmail.com", "tyler.jennings@gmail.com"]
+  s.executables = ["spittle"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "bin/spittle",
+     "examples/sprites/README",
+     "examples/sprites/apple/apple.png",
+     "examples/sprites/apple/divider.png",
+     "examples/sprites/apple/downloads.png",
+     "examples/sprites/apple/fragment.css",
+     "examples/sprites/apple/iphone.png",
+     "examples/sprites/apple/itunes.png",
+     "examples/sprites/apple/mac.png",
+     "examples/sprites/apple/search.png",
+     "examples/sprites/apple/sprite.png",
+     "examples/sprites/apple/store.png",
+     "examples/sprites/apple/support.png",
+     "examples/sprites/fragment.css",
+     "examples/sprites/index.html",
+     "examples/sprites/server.rb",
+     "examples/sprites/sprite.css",
+     "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/spittle.rb",
+     "lib/spittle/chunk.rb",
+     "lib/spittle/directory_spriter.rb",
+     "lib/spittle/file_header.rb",
+     "lib/spittle/filters.rb",
+     "lib/spittle/idat.rb",
+     "lib/spittle/iend.rb",
+     "lib/spittle/ihdr.rb",
+     "lib/spittle/image.rb",
+     "lib/spittle/parser.rb",
+     "lib/spittle/processor.rb",
+     "lib/spittle/sprite.rb",
+     "lib/spittle/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/file_header_spec.rb",
+     "spec/lib/idat_spec.rb",
+     "spec/lib/ihdr_spec.rb",
+     "spec/lib/image_spec.rb",
+     "spec/lib/parser_spec.rb",
+     "spec/lib/sprite_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",
+     "spittle.gemspec",
+     "tasks/spittle_tasks.rake"
+  ]
+  s.homepage = %q{http://github.com/aberant/spittle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{pure ruby PNG}
+  s.test_files = [
+    "spec/builders/image_builder.rb",
+     "spec/integration_spec.rb",
+     "spec/lib/file_header_spec.rb",
+     "spec/lib/idat_spec.rb",
+     "spec/lib/ihdr_spec.rb",
+     "spec/lib/image_spec.rb",
+     "spec/lib/parser_spec.rb",
+     "spec/lib/sprite_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/sprites/server.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
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/tasks/spittle_tasks.rake

@@ -0,0 +1,9 @@
+ desc "Generates sprites"
+ task :sprite do
+   require File.dirname(__FILE__)  + "/../lib/spittle.rb"
+
+   opts = {:source =>  RAILS_ROOT + "/public/images/sprites", 
+           :path_prefix =>  "/images"}
+
+   Spittle::Processor.new(opts).write
+ end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spittle
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - aberant
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 -06:00
+date: 2009-11-16 00:00:00 -06:00
 default_executable: spittle
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,7 @@ files:
 - examples/sprites/words/specified.png
 - examples/sprites/words/sprite.css
 - examples/sprites/words/sprite.png
+- init.rb
 - lib/spittle.rb
 - lib/spittle/chunk.rb
 - lib/spittle/directory_spriter.rb
@@ -96,6 +97,8 @@ files:
 - spec/sprite_dirs/words/specified.png
 - spec/tmp/merge_right_test.png
 - spec/tmp/write_test.png
+- spittle.gemspec
+- tasks/spittle_tasks.rake
 has_rdoc: true
 homepage: http://github.com/aberant/spittle
 licenses: []