css-spriter 0.9.2

data/.gitignore

@@ -0,0 +1,12 @@
+Manifest
+.DS_Store
+pkg/*
+doc/*
+coverage/*
+html/*
+rdoc/*
+examples/pic_data/out.png
+examples/pic_data/sprite_test.png
+examples/pic_data/test.png
+examples/pic_data/animal.png
+*.swp

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Colin Harris & Tyler Jennings
+
+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,81 @@
+= CSS Spriter, a sprite generator
+
+  [ PNG, PNG, PNG ]  (°_°)
+  [ PNG, PNG, PNG ]  (° )
+  [ PNG, PNG, PNG ] )°)
+  [ PNG, PNG, )°)
+  [ PNG, )°)
+  [ )°)
+
+   \(°_°)/ -> SPRITES!!!
+
+== Description
+
+It takes your PNG's, chews them up and spits out sprites!
+
+point bin/css-spriter at a directory, and watch it sprite away!
+
+== Installation - standalone
+
+  sudo gem install css-spriter
+
+=== Usage - standalone
+
+  css-spriter <directory>
+
+If you point the sprite command at a directory tree by default it will construct sprites for each of the sub directories and generate a single css to access all of the sprites which is placed in the root of the directory tree
+
+For a full list of options:
+
+  css-spriter -h
+
+== Installation - Rails plugin
+
+  script/plugin install git://github.com/aberant/css-spriter.git
+
+=== 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:
+
+  sprites /
+    cars /
+      ford.png
+      chevy.png
+    planes /
+      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.
+
+== Limitations
+
+- does not support color profiles (can cause a slight change in color from the source image)
+- does not support reading interlaced PNGs.
+
+== Features
+
+- automatically generates sprites from a set of PNG images
+- automatically generates css classes to access images within the sprite
+- customizable css templates
+- 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
+
+== Authors
+
+- aberant - Colin Harris
+- tjennings - Tyler Jennings
+
+== Credits
+
+- thanks to mattpuchlerz[http://github.com/mattpuchlerz] for the socially acceptable project name

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  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.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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+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']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec #=> :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "spittle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.2

data/bin/css-spriter

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require File.dirname(__FILE__) + "/../lib/css-spriter.rb"
+
+
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: css-spriter [options] directory"
+
+  opts.on("-c", "--cleanup", "Remove all generated files") do |file|
+    options[:cleanup] = true
+  end
+
+  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]
+
+unless dir
+  puts opts.help
+  exit
+end
+
+options[:source] = dir
+processor = CssSpriter::Processor.new(options)
+
+if options[:cleanup]
+  processor.cleanup
+else
+  processor.write
+end

data/bin/png_info

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require File.join( File.dirname( __FILE__ ), '..', 'lib', 'css-spriter' )
+
+module PNG
+  class Parser
+    def go!( file )
+      check_header( file )
+
+      while(! file.eof?) do
+        parse_chunk(file)
+      end
+    end
+
+  private
+    def check_header( file )
+      header = file.read(8)
+      raise "Invalid PNG file header" unless ( header == FileHeader.new.encode)
+    end
+
+    def parse_chunk(f)
+      len = f.read(4).unpack("N")
+      type = f.read(4)
+      data = f.read(len[0])
+      crc = f.read(4)
+      handle(type, len, data )
+    end
+
+    def handle( type, len, data )
+      case type
+      when "IHDR"
+        attrs = data.unpack("N2C5")
+        puts "PNG width: #{attrs[0]}"
+        puts "PNG height: #{attrs[1]}"
+        puts "PNG depth: #{attrs[2]}"
+        puts "PNG color type: #{attrs[3]}"
+        puts "PNG compression method: #{attrs[4]}"
+        puts "PNG filter method: #{attrs[5]}"
+        puts "PNG interlace method: #{attrs[6]}"
+      end
+
+      puts "PNG block #{type}"
+      puts "length: #{len}"
+    end
+  end
+
+
+  class Info
+    def self.open( file_name )
+      @parser = Parser.new
+
+      name = File.basename( file_name, ".png" )
+
+      File.open(file_name, "r") do |f|
+        @parser.go!( f )
+      end
+    end
+  end
+end
+
+
+PNG::Info.open( ARGV[0] )

data/examples/filter_util.rb

@@ -0,0 +1,17 @@
+# horrible place for this.  just a sanity check for filtering
+
+require File.join( File.dirname( __FILE__ ), '..', 'lib', 'css-spriter' )
+
+image = PNG::Image.open( "sprites/many_sized_cats/darth_cat.png")
+
+5.times do |i|
+  puts i
+  image.write("bob-filter-#{i}.png", :filter_type => i)
+end
+
+5.times do |i|
+  filename = "bob-filter-#{i}.png"
+  puts "filter #{i}: #{File.size( filename )}"
+  File.delete( filename )
+end
+

data/examples/sprites/.mtimes

@@ -0,0 +1,12 @@
+./many_sized_cats/music-keyboard-cat.png	1258479430
+./words/set.png	1258120615
+./many_sized_cats/cat-on-keyboard.png	1258479384
+./many_sized_cats	1261105635
+./words/latitude.png	1258120615
+./words/specified.png	1258120615
+./server.rb	1258120560
+./many_sized_cats/darth_cat.png	1258678472
+./words/of.png	1258120615
+./README	1258164457
+./words	1261105635
+./index.html	1261104700

data/examples/sprites/README

@@ -0,0 +1,5 @@
+The sprites here are pre generated.  If you want to see it work yourself delete the the two sprite.png files and all the *.css.  Then simply run '../bin/spittle' and it should regenreate the sprites. 
+
+The server script will start a WEBrick server on port 3000 and serve from this directory.  If everything worked out you should see the two sprite samples displayed in index.html. 
+
+. 

data/examples/sprites/index.html

@@ -0,0 +1,26 @@
+<html>
+  <head>
+    <title>A simple sprite test</title>
+    <link href="/sprite.css" type="text/css" rel="stylesheet" />
+  </head>
+  <body>
+    <style>
+      .float_left {float:left}
+      .menu {height: 100px}
+      .clear {clear:both}
+    </style>
+    <div>
+      Hello.  See css-spriter run:
+      <div class="words_of">of</div>
+      <div class="words_latitude">latitude</div>
+      <div class="words_set">set</div>
+    </div>
+
+    OMG Cats!!!! (of varying sizes, in one sprite)
+    <div>
+      <div class="many_sized_cats_cat-on-keyboard"></div>
+      <div class="many_sized_cats_darth_cat"></div>
+      <div class="many_sized_cats_music-keyboard-cat"></div>
+    </div>
+  </body>
+</html>

data/examples/sprites/many_sized_cats/.mtimes

@@ -0,0 +1,3 @@
+./many_sized_cats/music-keyboard-cat.png	1258479430
+./many_sized_cats/cat-on-keyboard.png	1258479384
+./many_sized_cats/darth_cat.png	1258678472

data/examples/sprites/many_sized_cats/fragment.css

@@ -0,0 +1,21 @@
+  .many_sized_cats_cat-on-keyboard {
+    background: transparent url(/many_sized_cats/sprite.png) 0px 0px no-repeat;
+    width:64;
+    height:48;
+    text-indent:-5000px;
+  }
+
+  .many_sized_cats_music-keyboard-cat {
+    background: transparent url(/many_sized_cats/sprite.png) -304px 0px no-repeat;
+    width:225;
+    height:166;
+    text-indent:-5000px;
+  }
+
+  .many_sized_cats_darth_cat {
+    background: transparent url(/many_sized_cats/sprite.png) -64px 0px no-repeat;
+    width:240;
+    height:320;
+    text-indent:-5000px;
+  }
+

data/examples/sprites/many_sized_cats/sprite.css

@@ -0,0 +1,21 @@
+  .._cat-on-keyboard {
+    background: transparent url(/spritepng) 0px 0px no-repeat;
+    width:64;
+    height:48;
+    text-indent:-5000px;
+  }
+
+  .._music-keyboard-cat {
+    background: transparent url(/spritepng) -304px 0px no-repeat;
+    width:225;
+    height:166;
+    text-indent:-5000px;
+  }
+
+  .._darth_cat {
+    background: transparent url(/spritepng) -64px 0px no-repeat;
+    width:240;
+    height:320;
+    text-indent:-5000px;
+  }
+

data/examples/sprites/server.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'webrick'
+
+Socket.do_not_reverse_lookup = true # patch for OS X
+params = { :Port => 3000, :DocumentRoot => '.'}
+
+server = WEBrick::HTTPServer.new(params)
+trap("INT") { server.shutdown }
+server.start
+

data/examples/sprites/sprite.css

@@ -0,0 +1,49 @@
+  .many_sized_cats_cat-on-keyboard {
+    background: transparent url(/many_sized_cats/sprite.png) 0px 0px no-repeat;
+    width:64;
+    height:48;
+    text-indent:-5000px;
+  }
+
+  .many_sized_cats_music-keyboard-cat {
+    background: transparent url(/many_sized_cats/sprite.png) -304px 0px no-repeat;
+    width:225;
+    height:166;
+    text-indent:-5000px;
+  }
+
+  .many_sized_cats_darth_cat {
+    background: transparent url(/many_sized_cats/sprite.png) -64px 0px no-repeat;
+    width:240;
+    height:320;
+    text-indent:-5000px;
+  }
+
+  .words_latitude {
+    background: transparent url(/words/sprite.png) 0px 0px no-repeat;
+    width:66;
+    height:21;
+    text-indent:-5000px;
+  }
+
+  .words_of {
+    background: transparent url(/words/sprite.png) -66px 0px no-repeat;
+    width:19;
+    height:21;
+    text-indent:-5000px;
+  }
+
+  .words_set {
+    background: transparent url(/words/sprite.png) -85px 0px no-repeat;
+    width:26;
+    height:21;
+    text-indent:-5000px;
+  }
+
+  .words_specified {
+    background: transparent url(/words/sprite.png) -111px 0px no-repeat;
+    width:70;
+    height:21;
+    text-indent:-5000px;
+  }
+