css-spriter 0.9.2 → 1.0.1

data/lib/css-spriter/sprite.rb

@@ -1,39 +1,47 @@
-class Sprite
-  class ImageFormatException < Exception; end
-  attr_reader :images, :max_height
+module CssSpriter
+  class Sprite
+    attr_reader :images, :max_height
 
-  def initialize
-    @images = []
-    @locations = {}
-  end
+    def initialize
+      @images = []
+      @locations = {}
+    end
 
-  def append( image )
-    @images.each do |i|
-     unless i.compatible? image
-       raise ImageFormatException.new("Image #{i} not compatible with #{image}")
-     end
+    def append( image )
+      @images << image
+      @max_height = @images.map{ |i| i.height }.max
     end
 
-    @images << image
-    @max_height = @images.map{ |i| i.height }.max
-  end
+    def append_file( filename )
+      append( CssSpriter::Image.from_file( filename ))
+    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
+    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
-    @locations
-  end
 
-  def write( output_filename )
-    return if @images.empty?
-    right_sized = @images.map{|i| i.fill_to_height(@max_height)}
-    # head is the last image, then we merge left
-    head, *tail = right_sized.reverse
-    result = tail.inject( head ){ |head, image| head.merge_left( image ) }
-    PNG::Image.write( output_filename, result )
+    def write( output_filename )
+      return if @images.empty?
+
+      sprite_height = @images.map{ |i| i.height }.max
+      sprite_width = @images.inject(0){|sum, image| sum + image.width }
+
+      sprite = ChunkyPNG::Image.new(sprite_width, sprite_height)
+
+      current_x = 0
+
+      images.each do |image|
+        sprite = sprite.replace(image, current_x, 0)
+        current_x += image.width
+      end
+
+      sprite.save( output_filename, :best_compression )
+    end
   end
-end
+end

data/lib/css-spriter/stylesheet_builder.rb

@@ -1,22 +1,24 @@
-class StylesheetBuilder
-  def initialize(dir)
-    @dir = dir
-    @output_file = @dir + "/sprite.css"
-  end
+module CssSpriter
+  class StylesheetBuilder
+    def initialize(dir)
+      @dir = dir
+      @output_file = @dir + "/sprite.css"
+    end
 
-  def output_file(file)
-    @output_file = file
-  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 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 write
+      File.open(@output_file, 'w') {|f| f.write(css)}
+    end
 
-  def cleanup
-    File.delete(@output_file) rescue nil
+    def cleanup
+      File.delete(@output_file) rescue nil
+    end
   end
-end
+end

data/spec/builders/image_builder.rb

@@ -8,16 +8,11 @@ class ImageBuilder
      @general_options =  default_options.merge general_options
    end
 
-   def data(width, height)
-     Array.new((width * height * 3) + height).fill(0)
-   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] || data(args[:width], args[:height]) )
 
-     PNG::Image.new( ihdr, idat, args[:name] )
+     image = CssSpriter::Image.new( args[:width], args[:height], ChunkyPNG::Color::TRANSPARENT )
+     image.name = args[:name]
+     image
    end
 end

data/spec/integration_spec.rb

@@ -1,81 +1,58 @@
-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", :filter_type => 0)
-    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.image_data("#{@img_dir}/lightening.png", :rgba => false)
-    two = PNG::Image.image_data("#{@img_dir}/lightening.png", :rgba => false)
-    merged = one.merge_left two
-    PNG::Image.write("#{@tmp_dir}/merge_right_test.png", merged, :filter_type => 0)
-    read("#{@expected_dir}/merge_right_test.png").should == read("#{@tmp_dir}/merge_right_test.png")
-  end
-end
-
 describe "Dir sprite" do
   before :all do
     @dir = File.dirname(__FILE__) + "/sprite_dirs/words"
-    @spriter = DirectoryProcessor.new(@dir)
+    @spriter = CssSpriter::DirectoryProcessor.new(@dir)
     @sprite_file = @dir + "/sprite.png"
     @css_file = @dir + "/fragment.css"
     @spriter.write
   end
 
-  after :all do 
+  after :all do
     @spriter.cleanup
   end
 
-  describe "Sprite generation" do 
-    it "provides the correct dir name" do 
+  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 
+    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 
+    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 
+  describe "CSS fragments" do
+    before :all do
       @template = @dir + "/template.css"
       @css = @spriter.css
     end
 
-    after do 
+    after do
       File.delete(@template) rescue nil
     end
 
-    it "should compose class names" do 
+    it "should compose class names" do
       @css.should include( ".words_latitude")
       @css.should include( ".words_of" )
     end
 
-    it "has the correct image path" do 
+    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 
+    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 
+    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")
@@ -83,63 +60,63 @@ describe "Dir sprite" do
   end
 end
 
-describe 'Stylesheet generator' do 
-  before :all do 
+describe 'Stylesheet generator' do
+  before :all do
     @dir = File.dirname(__FILE__) + "/css_fragments"
     @out = @dir + "/complete.css"
-    @builder = StylesheetBuilder.new(@dir)
+    @builder = CssSpriter::StylesheetBuilder.new(@dir)
     @builder.output_file(@out)
     @css = @builder.css
   end
 
-  after :all do 
+  after :all do
     @builder.cleanup
   end
 
-  it "takes the css fragments and concatonates them into a single stylesheet" do 
+  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 
+  it "can handle nested folder structures" do
     @css.should include( ".deep" )
   end
 
-  it "writes the css file to the specified location" do 
+  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 
+describe "Complete spriting process" do
+  before :all do
     @dir = File.dirname(__FILE__) + "/sprite_dirs"
     @css_file = @dir + "/sprite.css"
     @spriter = CssSpriter::Processor.new(:path_prefix => "/images", :source => @dir, :css_file => @css_file)
     @spriter.write
   end
 
-  after :all do 
+  after :all do
     @spriter.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 "prepends a path prefix to all sprites in the css file" do 
+  it "prepends a path prefix to all sprites in the css file" do
     file = read(@css_file)
     file.should include("/images/sprite_dirs/words")
   end
 
-  it "can find all the sprite directories" do 
+  it "can find all the sprite directories" do
     dirs = @spriter.directories.map{|d| d.split('/').last}
     dirs.should include( "words" )
   end
 
-  it "generates the css file at the appropriate location" do 
+  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 
+  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

data/spec/lib/css_spriter_image_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CssSpriter::Image do
+  it "sets the name with the filename of the image" do
+    image = CssSpriter::Image.from_file( File.dirname(__FILE__) + '/../images/lightening.png')
+    image.name.should == 'lightening'
+  end
+end

data/spec/lib/sprite_spec.rb

@@ -1,13 +1,12 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe Sprite do
+describe CssSpriter::Sprite do
   before :each do
-    @sprite = Sprite.new
+    @sprite = CssSpriter::Sprite.new
     @builder = ImageBuilder.new
 
-    #TODO - We should just create ImageData objects here
-    @image1 = @builder.build( :width => 50, :height => 50, :name => "image1").to_image
-    @image2 = @builder.build( :width => 50, :height => 50, :name => "image2").to_image
+    @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
@@ -35,5 +34,4 @@ describe Sprite do
 
     @sprite.max_height.should == max_height
   end
-
 end

data/spec/mtime_tracking_spec.rb

@@ -2,65 +2,79 @@ require 'benchmark'
 require 'fileutils'
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe MtimeTracker do
-  describe "on a new directory" do 
-    before do 
+describe CssSpriter::MtimeTracker do
+  describe "on a new directory" do
+    before do
       @img_dir = File.dirname(__FILE__) + '/images'
-      @tracker = MtimeTracker.new(@img_dir)
+      @tracker = CssSpriter::MtimeTracker.new(@img_dir)
     end
 
     after do
       File.delete(@img_dir + "/.mtimes") rescue nil
     end
 
-    it "tells me there are changes" do 
+    it "tells me there are changes" do
       @tracker.has_changes?.should be_true
     end
 
-    it "tells me things have not changed after I update the tracking" do 
+    it "tells me things have not changed after I update the tracking" do
       @tracker.update
       @tracker.has_changes?.should be_false
     end
   end
 
-  describe "on an existing directory" do 
-    before do 
+  describe "on an existing directory" do
+    before do
       @img_dir = File.dirname(__FILE__) + '/images'
-      MtimeTracker.new(@img_dir).update
-      @tracker = MtimeTracker.new(@img_dir)
+      CssSpriter::MtimeTracker.new(@img_dir).update
+      @tracker = CssSpriter::MtimeTracker.new(@img_dir)
     end
 
     after do
       File.delete(@img_dir + "/.mtimes") rescue nil
     end
 
-    it "tells me nothing has changed" do 
+    it "tells me nothing has changed" do
       @tracker.has_changes?.should be_false
     end
 
-    describe "when a file has changed" do 
-      before do 
+    describe "when a file has changed" do
+      before do
         FileUtils.touch(@img_dir + "/lightening.png")
         @tracker.reset
       end
 
-      it "returns true from has_changes" do 
+      it "returns true from has_changes" do
         @tracker.has_changes?.should be_true
         @tracker.changeset.first.should include("/spec/images/lightening.png")
       end
     end
 
-    describe "file exclustions" do 
-      before do 
+    describe "when a file is deleted" do
+      before do
+        FileUtils.touch(@img_dir + "/a_test.png")
+        File.exists?(@img_dir + "/a_test.png").should be_true
+        @tracker.update
+        File.delete(@img_dir + "/a_test.png")
+      end
+
+      it "returns true from has_changes" do
+        @tracker.has_changes?.should be_true
+        @tracker.changeset.first.should include("/spec/images/a_test.png")
+      end
+    end
+
+    describe "file exclustions" do
+      before do
         @img_dir = File.dirname(__FILE__) + '/images'
-        @tracker = MtimeTracker.new(@img_dir, :exclude => [/lightening/, "tacos"])
+        @tracker = CssSpriter::MtimeTracker.new(@img_dir, :exclude => [/lightening/, "tacos"])
       end
 
-      after do 
+      after do
         File.delete(@img_dir + "/.mtimes") rescue nil
       end
 
-      it "does not report excluded files as changed" do 
+      it "does not report excluded files as changed" do
         FileUtils.touch(@img_dir + "/lightening.png")
         @tracker.has_changes?.should be_false
       end

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
-# $LOAD_PATH.unshift(File.dirname(__FILE__))
-# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'spec'
-require 'spec/autorun'
+require 'rspec'
+require 'rspec/autorun'
 
+require 'chunky_png'
 require 'css-spriter'
 
+
 require 'builders/image_builder'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
 
 end