spittle 0.9.0

data/lib/spittle/image.rb

@@ -0,0 +1,114 @@
+module PNG
+  class Image
+    
+    def self.open( file_name )
+      name = File.basename( file_name, ".png" )
+      
+      File.open(file_name, "r") do |f|
+        ihdr, idat = Parser.go!( f )
+        Image.new( ihdr, idat, name )
+      end
+      
+    end
+    
+    def initialize( ihdr, idat, name )
+      @ihdr = ihdr
+      @idat = idat
+      @name = name
+    end
+    
+    attr_reader :name
+    def width; @ihdr.width end
+    def height; @ihdr.height end
+    def depth; @ihdr.depth end
+    def color_type; @ihdr.color_type end
+
+    def compatible?(image)
+      self.height == image.height
+    end
+    
+    def write(file_name)
+      File.open(file_name, 'w') do |f|
+        f.write(generate_png)
+      end
+    end
+    
+    def merge_left( other )
+      l = other.rows
+      r = self.rows
+      
+      data = l.zip r
+      
+      #prepend the filter byte 0 = no filter
+      data.each { |row| row.unshift(0) } 
+      data.flatten!
+      
+      ihdr = IHDR.new( width + other.width, height, depth, color_type)
+      idat = IDAT.new( data )
+      img_name  = "#{name}_#{other.name}"
+      
+      Image.new( ihdr, idat, img_name )
+    end
+    
+    #color types
+    RGB = 2
+    RGBA = 3
+
+    # check for RGB or RGBA
+    def pixel_width
+      ( color_type == RGB ? 3 : 4)
+    end
+
+    def scanline_width
+      # + 1 adds filter byte
+      (width * pixel_width) + 1
+    end
+  
+    def rows
+     out = []
+     offset = 0
+     
+     height.times do |scanline|
+       end_row = scanline_width + offset
+       row = @idat.uncompressed.slice(offset, scanline_width)
+       out << decode(scanline, row, out, pixel_width)
+       offset = end_row
+     end
+     out
+    end
+    
+    def inspect
+      "color type: #{color_type}, depth: #{depth}, width: #{width}, height: #{height}"
+    end
+  private
+
+    def last_scanline(current, data)
+      (current - 1 < 0 ? [] : data[current - 1])
+    end
+      
+    def decode(current, row, data, pixel_width)
+      filter_type = row.shift
+      
+      process_row(row, last_scanline(current, data), filter_type, pixel_width)
+    end
+    
+    def process_row(row, last_scanline, filter_type, pixel_width)
+      o = []
+      row.each_with_index do |e, i|
+        o[i] = Filters.call(filter_type, e, i, o, last_scanline, pixel_width)
+      end
+      o
+    end
+    
+    def generate_png
+      file_header = PNG::FileHeader.new.encode
+      raw_data = @idat.uncompressed
+      
+      ihdr = PNG::IHDR.new( width, height, depth, color_type ).to_chunk
+      idat = PNG::IDAT.new( raw_data ).to_chunk
+      iend = PNG::IEND.new.to_chunk
+      
+      file_header + ihdr + idat + iend
+    end
+  end
+end

data/lib/spittle/parser.rb

@@ -0,0 +1,54 @@
+module PNG
+  class Parser
+    def self.go!(file)
+      #TODO: Wanted to remove instance go! and use initialize, didn't work.  
+      #Weird
+      Parser.new.go!(file)
+    end
+    def go!( file )
+      check_header( file )
+
+      while(not file.eof?) do 
+        parse_chunk(file)
+      end
+
+      [ @ihdr, @idat ]
+    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)
+
+      raise "invalid CRC for chunk type #{type}" if crc_invalid?( type, data, crc )
+
+      handle(type, data)
+    end
+
+    def handle(type, data)
+      case(type)
+      when "IHDR"
+        @ihdr = PNG::IHDR.new_from_raw( data )
+        @width, @height, @depth, @color_type = @ihdr.to_a
+      when "IDAT"
+        @idat ||= PNG::IDAT.new
+        @idat << data 
+      when "IEND"
+        # NOOP
+      else
+        #puts "Ignoring chunk type #{type}"
+      end
+    end
+
+    def crc_invalid?( type, data, crc )
+      [Zlib.crc32( type + data )] != crc.unpack("N")
+    end
+  end
+end

data/lib/spittle/processor.rb

@@ -0,0 +1,28 @@
+module Spittle
+  class Processor
+    def initialize(opts)
+      @options = opts
+      @processors = dir_processors
+      @css_builder = StylesheetBuilder.new(@options[:source])
+      @css_builder.output_file(@options[:css_file] || @options[:source] + "/sprite.css")
+    end
+
+    def write
+      @processors.each{|d| d.write}
+      @css_builder.write
+    end
+
+    def directories
+      Dir.glob(@options[:source] + "/**/").map{|d| d.gsub(/\/$/, "")}
+    end
+
+    def dir_processors
+      directories.map{|d| DirectoryProcessor.new(d)}
+    end
+
+    def cleanup
+      @processors.each{|d| d.cleanup}
+      @css_builder.cleanup
+    end
+  end
+end

data/lib/spittle/sprite.rb

@@ -0,0 +1,39 @@
+module PNG
+  class ImageFormatException < Exception; end
+  class Sprite
+    attr_reader :images
+
+    def initialize
+      @images = []
+      @locations = {}
+    end
+    
+    def append( image )
+      @images.each do |i|
+       unless i.compatible? image
+         raise ImageFormatException.new("Incompatible image #{i}")
+       end
+      end
+      @images << image
+    end
+    
+    def locations
+      @images.inject(0) do |x, image|  
+        @locations[image.name.to_sym] = { :x => -(x),
+          :width => image.width,
+          :height => image.height}
+        image.width + x
+      end
+      @locations
+    end
+
+    def write( output_filename )
+      return if @images.empty?
+
+      # head is the last image, then we merge left
+      head, *tail = @images.reverse
+      result = tail.inject( head ){ |head, image| head.merge_left( image ) }
+      result.write( output_filename )
+    end
+  end
+end

data/lib/spittle/stylesheet_builder.rb

@@ -0,0 +1,22 @@
+class StylesheetBuilder
+  def initialize(dir)
+    @dir = dir
+    @output_file = @dir + "/sprite.css"
+  end
+
+  def output_file(file)
+    @output_file = file
+  end
+
+  def css
+    @css ||= Dir.glob(@dir + "/**/fragment.css").inject("") {|acc, f| acc + File.read(f)}
+  end
+
+  def write
+    File.open(@output_file, 'w') {|f| f.write(css)}
+  end
+
+  def cleanup
+    File.delete(@output_file) rescue {}
+  end
+end

data/lib/spittle.rb

@@ -0,0 +1,16 @@
+require 'zlib'
+
+$:.unshift( File.dirname( __FILE__ ))
+
+require 'spittle/file_header'
+require 'spittle/parser'
+require 'spittle/filters'
+require 'spittle/chunk'
+require 'spittle/ihdr'
+require 'spittle/idat'
+require 'spittle/iend'
+require 'spittle/image'
+require 'spittle/sprite'
+require 'spittle/directory_spriter'
+require 'spittle/stylesheet_builder'
+require 'spittle/processor'

data/spec/builders/image_builder.rb

@@ -0,0 +1,22 @@
+class ImageBuilder
+  def initialize( general_options={} )
+     default_options = {
+       :width => 100,
+       :height => 100,
+       :data => [],
+       :name => "test"
+     }
+
+     @general_options =  default_options.merge general_options
+   end
+
+
+   def build( specific_options={} )
+     args = @general_options.merge specific_options
+     
+     ihdr = PNG::IHDR.new( args[:width], args[:height] )
+     idat = PNG::IDAT.new( args[:data] )
+     
+     PNG::Image.new( ihdr, idat, args[:name] )
+   end
+end

data/spec/css_fragments/deep/style/fragment.css

@@ -0,0 +1 @@
+.deep {}

data/spec/css_fragments/some/fragment.css

@@ -0,0 +1 @@
+.some_style {}

data/spec/integration_spec.rb

@@ -0,0 +1,134 @@
+require 'benchmark'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'PNG' do
+  before do 
+    @img_dir = File.dirname(__FILE__) + '/images'
+    @expected_dir = File.dirname(__FILE__) + '/expected_output'
+    @tmp_dir = File.dirname(__FILE__) + '/tmp'
+  end
+
+  it 'can read and write a PNG' do 
+    img = PNG::Image.open("#{@img_dir}/lightening.png")
+    img.write("#{@tmp_dir}/write_test.png")
+    read("#{@expected_dir}/write_test.png").should == read("#{@tmp_dir}/write_test.png")
+  end
+
+  it 'can merge one PNG on the left of another' do 
+    one = PNG::Image.open("#{@img_dir}/lightening.png")
+    two = PNG::Image.open("#{@img_dir}/lightening.png")
+    merged = one.merge_left two
+    merged.write("#{@tmp_dir}/merge_right_test.png")
+    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 
+  before :all do 
+    @dir = File.dirname(__FILE__) + "/sprite_dirs/words"
+    @spriter = DirectoryProcessor.new(@dir)
+    @sprite_file = @dir + "/sprite.png"
+    @css_file = @dir + "/fragment.css"
+    @spriter.write
+  end
+
+  after :all do 
+    @spriter.cleanup
+  end
+
+  describe "Sprite generation" do 
+    it "provides the correct dir name" do 
+      @spriter.dir_name.should == 'words'
+    end
+
+    it "find all the pngs in a directory" do 
+      expected = ['latitude.png', 'of.png', 'set.png', 'specified.png']
+      images = @spriter.images
+      images.map{|f| f.split('/').last}.should == expected
+    end
+
+    it "sprites all the images in a directory" do 
+      File.exists?(@sprite_file).should be_true
+    end
+  end
+
+  describe "CSS fragments" do 
+    before :all do 
+      @css = @spriter.css
+    end
+
+    it "should compose class names" do 
+      @css.should include( ".words_latitude")
+      @css.should include( ".words_of" )
+    end
+
+    it "has the correct image path" do 
+      @css.should include( "/sprite_dirs/words/sprite.png" )
+    end
+
+    it "should write css fragments for a sprite" do 
+      File.exists?(@css_file).should be_true
+    end
+  end
+end
+
+describe 'Stylesheet generator' do 
+  before :all do 
+    @dir = File.dirname(__FILE__) + "/css_fragments"
+    @out = @dir + "/complete.css"
+    @builder = StylesheetBuilder.new(@dir)
+    @builder.output_file(@out)
+    @css = @builder.css
+  end
+
+  after :all do 
+    @builder.cleanup
+  end
+
+  it "takes the css fragments and concatonates them into a single stylesheet" do 
+    @css.should include( ".some_style" )
+  end
+
+  it "can handle nested folder structures" do 
+    @css.should include( ".deep" )
+  end
+
+  it "writes the css file to the specified location" do 
+    @builder.write
+    File.exists?(@out).should be_true
+  end
+end
+
+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.write
+  end
+
+  after :all do 
+    @spittle.cleanup
+    #making sure it cleans things up - shitty place for these
+    File.exists?(@css_file).should be_false
+    File.exists?(@dir + "/words/sprite.png").should be_false
+  end
+
+  it "can find all the sprite directories" do 
+    dirs = @spittle.directories.map{|d| d.split('/').last}
+    dirs.should include( "words" )
+  end
+
+  it "generates the css file at the appropriate location" do 
+    File.exists?(@css_file).should be_true
+  end
+
+  it "creates sprites/css for all subfolders" do 
+    File.exists?(@dir + "/words/sprite.png").should be_true
+    File.exists?(@dir + "/words/fragment.css").should be_true
+  end
+end

data/spec/lib/file_header_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PNG::FileHeader do
+  # the pnd header provides sanity checks against most common file transfer errrors
+  it "outputs the PNG header" do
+    header = PNG::FileHeader.new.encode
+    header.should == [137, 80, 78, 71, 13, 10, 26, 10].pack("C*")
+  end
+end
+

data/spec/lib/idat_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PNG::IDAT do
+  before :each do
+    # it's just "Hello, World!" encoded
+    @data = "x\234\363H\315\311\311\327Q\b\317/\312IQ\004\000\037\236\004j"
+  end
+  
+  it "accepts compressed data" do
+    @idat = PNG::IDAT.new
+    
+    @idat << @data
+    
+    @idat.encode.should == @data
+  end
+  
+  it "can chunk its self" do
+    @idat = PNG::IDAT.new
+    @idat << @data
+    @chunk = chunk( "IDAT", @idat.encode )
+    
+    @idat.to_chunk.should == @chunk
+  end
+  
+  it "accepts uncompressed data for it's constructor" do
+    @idat = PNG::IDAT.new( "Hello, World!".unpack("C*") )
+    
+    @idat.encode.should == @data
+  end
+end

data/spec/lib/ihdr_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PNG::IHDR do
+  before :each do
+    @width = 40
+    @height = 40
+    @bit_depth = 8
+    @color_type = 2
+    
+    @raw = [@width, @height, @bit_depth, @color_type, 0, 0, 0].pack("N2C5")
+    @chunk = chunk( "IHDR", @raw )
+  end
+  
+  it "pulls out the width from the ihdr block" do
+    @header = PNG::IHDR.new_from_raw( @raw )
+    @header.width.should == @width  
+  end
+  
+  it "pulls out the height from the ihdr block" do
+    @header = PNG::IHDR.new_from_raw( @raw )
+    @header.height.should == @height  
+  end
+  
+  it "pulls out the bit depth from the ihdr block" do
+    @header = PNG::IHDR.new_from_raw( @raw )
+    @header.depth.should == @bit_depth  
+  end  
+  
+  it "pulls out the color type from the ihdr block" do
+    @header = PNG::IHDR.new_from_raw( @raw )
+    @header.color_type.should == @color_type  
+  end
+  
+  it "encodes it's self properly" do
+    @header = PNG::IHDR.new_from_raw( @raw )
+    @header.encode.should == @raw
+  end
+  
+  it "should be able to make a header chunk" do
+    @header = PNG::IHDR.new_from_raw( @raw )
+    @header.to_chunk.should == @chunk
+  end
+end

data/spec/lib/image_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PNG::Image do
+  before :each do
+    @sprite = PNG::Sprite.new
+    
+    @builder = ImageBuilder.new
+    
+    # 0 is the filter type for the row, then an RGB triplet since builder defaults to color type 2
+    @image1 = @builder.build( :width => 1, :height => 1, :name => "image1", :data => [0,1,2,3] )
+    @image2 = @builder.build( :width => 1, :height => 1, :name => "image2", :data => [0,4,5,6] )
+  end
+
+  it "can merge left" do
+    result = @image1.merge_left @image2
+    
+    result.rows.should == [[4,5,6,1,2,3]]
+  end
+end

data/spec/lib/parser_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PNG::Parser do
+  it "errors out when the file header is wrong" do
+    bad_header = [5, 80, 78, 71, 13, 10, 26, 10].pack("C*")
+    file = StringIO.new( bad_header)
+
+    lambda {
+      Parser.go!( file )
+    }.should raise_error
+  end
+end

data/spec/lib/sprite_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PNG::Sprite do
+  before :each do
+    @sprite = PNG::Sprite.new
+    @builder = ImageBuilder.new
+
+    @image1 = @builder.build( :width => 50, :height => 50, :name => "image1")
+    @image2 = @builder.build( :width => 50, :height => 50, :name => "image2")
+  end
+
+  it "can merge an image to the right" do
+    @sprite.append( @image1 )
+    @sprite.append( @image2 )
+
+    @sprite.images.should == [@image1, @image2]
+  end
+
+  it "knows the location of each image in the sprite" do
+    @sprite.append( @image1 )
+    @sprite.append( @image2 )
+
+    @sprite.locations[@image1.name.to_sym].should == {:x => -( 0 ), :width=> @image1.width, :height => @image1.height } 
+    @sprite.locations[@image2.name.to_sym].should == {:x => -( @image2.width ),  :width=> @image2.width, :height => @image2.height } 
+  end
+
+  it "raises a pretty exception when the images are incompatible" do 
+    taller_image = @builder.build( :width => 50, :height => 60, :name => "image")
+    
+    lambda do 
+      @sprite.append taller_image
+      @sprite.append @image1
+    end.should raise_error(PNG::ImageFormatException)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spittle'
+require 'spec'
+require 'spec/autorun'
+
+require 'builders/image_builder'
+
+Spec::Runner.configure do |config|
+  
+end
+
+def chunk(type, data)
+  to_check = type + data
+  [data.length].pack("N") + to_check + [Zlib.crc32(to_check)].pack("N")
+end