chunky_png 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+spec/resources/testing.png

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Willem van Bergen
+
+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,24 @@
+= Chunky PNG
+
+This library can read and write PNG files. It is written in pure Ruby for
+maximum portability. It requires the standard Zlib library.
+
+== Usage
+
+  require 'chunky_png'
+  
+  png = ChunkyPNG.load('filename.png')
+  puts png.chunks.inspect
+  puts png.pixel_matrix.inspect
+  
+  # do something with the PNG file
+  
+  File.open('out.png', 'w') { |f| png.write(f) }
+
+(Note: this is subject to change while work is in progress)
+
+== About
+
+The library is written by Willem van Bergen for Floorplanner.com, and released
+under the MIT license (see LICENSE). Please contact me for questions or
+remarks. Patches are greatly appreciated! :-)

data/Rakefile

@@ -0,0 +1,4 @@
+Dir['tasks/*.rake'].each { |file| load(file) }
+
+GithubGem::RakeTasks.new(:gem)
+task :default => [:spec]

data/chunky_png.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name    = 'chunky_png'
+  
+  # Do not change the version and date fields by hand. This will be done
+  # automatically by the gem release script.
+  s.version = "0.0.1"
+  s.date    = "2010-01-10"
+
+  s.summary     = "Pure ruby library for read/write, chunk-level access to PNG files"
+  s.description = "Pure ruby library for read/write, chunk-level access to PNG files"
+
+  s.authors  = ['Willem van Bergen']
+  s.email    = ['willem@railsdoctors.com']
+  s.homepage = 'http://wiki.github.com/wvanbergen/chunky_png'
+
+  s.add_development_dependency('rspec', '>= 1.2.9')
+
+  s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
+  s.extra_rdoc_files = ['README.rdoc']
+
+  # Do not change the files and test_files fields by hand. This will be done
+  # automatically by the gem release script.
+  s.files      = %w(spec/spec_helper.rb .gitignore lib/chunky_png/pixel_matrix.rb LICENSE lib/chunky_png/chunk.rb Rakefile README.rdoc spec/resources/indexed_10x10.png spec/integration/image_spec.rb lib/chunky_png/palette.rb lib/chunky_png/datastream.rb chunky_png.gemspec tasks/github-gem.rake lib/chunky_png/image.rb spec/unit/pixel_matrix_spec.rb lib/chunky_png.rb)
+  s.test_files = %w(spec/integration/image_spec.rb spec/unit/pixel_matrix_spec.rb)
+end

data/lib/chunky_png.rb

@@ -0,0 +1,34 @@
+require 'set'
+require 'zlib'
+
+require 'chunky_png/datastream'
+require 'chunky_png/chunk'
+require 'chunky_png/palette'
+require 'chunky_png/pixel_matrix'
+require 'chunky_png/image'
+
+module ChunkyPNG
+  extend self
+
+  def load_from_io(io)
+    ChunkyPNG::Datastream.read(io)
+  end
+
+  def load_from_file(file)
+    File.open(file, 'r') { |f| load_from_io(f) }
+  end
+
+  def load_from_memory(string)
+    load_from_io(StringIO.new(string))
+  end
+
+  def load(arg)
+    if arg.respond_to?(:read)
+      load_from_io(arg)
+    elsif File.exists?(arg)
+      load_from_file(arg)
+    else
+      load_from_memory(arg)
+    end
+  end
+end

data/lib/chunky_png/chunk.rb

@@ -0,0 +1,104 @@
+module ChunkyPNG
+  class Chunk
+    
+    def self.read(io)
+
+      length, type = io.read(8).unpack('Na4')
+      content      = io.read(length)
+      crc          = io.read(4).unpack('N').first
+      
+      # verify_crc!(type, content, crc)
+      
+      CHUNK_TYPES.fetch(type, Generic).read(type, content)
+    end
+    
+    class Base
+      attr_accessor :type
+      
+      def initialize(type, attributes = {})
+        self.type = type
+        attributes.each { |k, v| send("#{k}=", v) }
+      end
+      
+      def write_with_crc(io, content)
+        io << [content.length].pack('N') << type << content
+        io << [Zlib.crc32(content, Zlib.crc32(type))].pack('N')
+      end
+      
+      def write(io)
+        write_with_crc(io, content || '')
+      end
+    end
+    
+    class Generic < Base
+      
+      attr_accessor :content
+      
+      def initialize(type, content = '')
+        super(type, :content => content)
+      end
+      
+      def self.read(type, content)
+        self.new(type, content)
+      end
+    end
+    
+    class Header < Base
+      
+      COLOR_GRAYSCALE       = 0
+      COLOR_TRUECOLOR       = 2
+      COLOR_INDEXED         = 3
+      COLOR_GRAYSCALE_ALPHA = 4
+      COLOR_TRUECOLOR_ALPHA = 6
+      
+      attr_accessor :width, :height, :depth, :color, :compression, :filtering, :interlace
+      
+      def initialize(attrs = {})
+        super('IHDR', attrs)
+        @depth       ||= 8
+        @color       ||= COLOR_TRUECOLOR
+        @compression ||= 0
+        @filtering   ||= 0
+        @interlace   ||= 0
+      end
+      
+      def self.read(type, content)
+        fields = content.unpack('NNC5')
+        self.new(:width => fields[0],  :height => fields[1], :depth => fields[2], :color => fields[3],
+                       :compression => fields[4], :filtering => fields[5], :interlace => fields[6])
+      end
+
+      def content
+        [width, height, depth, color, compression, filtering, interlace].pack('NNC5')
+      end
+    end
+    
+    class End < Base
+      def initialize
+        super('IEND')
+      end
+      
+      def self.read(type, content)
+        raise 'The IEND chunk should be empty!' if content != ''
+        self.new
+      end
+      
+      def content
+        ''
+      end
+    end
+
+    class Palette < Generic
+    end
+
+    class ImageData < Generic
+    end
+    
+    # Maps chunk types to classes.
+    # If a chunk type is not given in this hash, a generic chunk type will be used.
+    CHUNK_TYPES = {
+      'IHDR' => Header, 'IEND' => End, 'IDAT' => ImageData, 'PLTE' => Palette
+    }
+    
+  end
+end

data/lib/chunky_png/datastream.rb

@@ -0,0 +1,72 @@
+module ChunkyPNG
+  
+  class Datastream
+    
+    SIGNATURE = [137, 80, 78, 71, 13, 10, 26, 10].pack('C8')
+    
+    attr_accessor :header_chunk
+    attr_accessor :other_chunks
+    attr_accessor :palette_chunk
+    attr_accessor :data_chunks
+    attr_accessor :end_chunk
+
+    def self.read(io)
+      verify_signature!(io)
+
+      ds = self.new
+      until io.eof?
+        chunk = ChunkyPNG::Chunk.read(io)
+        case chunk
+          when ChunkyPNG::Chunk::Header    then ds.header_chunk  = chunk
+          when ChunkyPNG::Chunk::Palette   then ds.palette_chunk = chunk
+          when ChunkyPNG::Chunk::ImageData then ds.data_chunks  << chunk
+          when ChunkyPNG::Chunk::End       then ds.end_chunk     = chunk
+          else ds.other_chunks << chunk
+        end
+      end
+      return ds
+    end
+
+    def self.verify_signature!(io)
+      signature = io.read(ChunkyPNG::Datastream::SIGNATURE.length)
+      raise "PNG signature not found!" unless signature == ChunkyPNG::Datastream::SIGNATURE
+    end
+    
+    def chunks
+      cs = [header_chunk]
+      cs += other_chunks
+      cs << palette_chunk if palette_chunk
+      cs += data_chunks
+      cs << end_chunk
+      return cs
+    end
+    
+    def initialize
+      @other_chunks = []
+      @data_chunks  = []
+    end
+    
+    def write(io)
+      io << SIGNATURE
+      chunks.each { |c| c.write(io) }
+    end
+    
+    def idat_chunks(data)
+      streamdata = Zlib::Deflate.deflate(data)
+      # TODO: Split long streamdata over multiple chunks
+      return [ ChunkyPNG::Chunk::ImageData.new('IDAT', streamdata) ]
+    end
+    
+    def pixel_matrix=(pixel_matrix)
+      @pixel_matrix = pixel_matrix
+    end
+    
+    def pixel_matrix
+      @pixel_matrix ||= begin
+        data = data_chunks.map(&:content).join('')
+        streamdata = Zlib::Inflate.inflate(data)
+        matrix     = ChunkyPNG::PixelMatrix.load(header, streamdata)
+      end
+    end
+  end
+end

data/lib/chunky_png/image.rb

@@ -0,0 +1,37 @@
+module ChunkyPNG
+  class Image
+    
+    attr_reader :pixels
+    
+    def initialize(width, height, background_color = ChunkyPNG::Color::WHITE)
+      @pixels = ChunkyPNG::PixelMatrix.new(width, height, background_color)
+    end
+    
+    def width
+      pixels.width
+    end
+    
+    def height
+      pixels.height
+    end
+    
+    def write(io)
+      datastream = ChunkyPNG::Datastream.new
+
+      palette = pixels.palette
+      if palette.indexable?
+        datastream.header_chunk = ChunkyPNG::Chunk::Header.new(:width => width, :height => height, :color => ChunkyPNG::Chunk::Header::COLOR_INDEXED)
+        datastream.palette_chunk = palette.to_plte_chunk
+        datastream.data_chunks  = datastream.idat_chunks(pixels.to_indexed_pixelstream(palette))
+        datastream.end_chunk    = ChunkyPNG::Chunk::End.new
+      else
+        raise 'd'
+        datastream.header_chunk = ChunkyPNG::Chunk::Header.new(:width => width, :height => height)
+        datastream.data_chunks  = datastream.idat_chunks(pixels.to_rgb_pixelstream)
+        datastream.end_chunk    = ChunkyPNG::Chunk::End.new
+      end
+      
+      datastream.write(io)
+    end
+  end
+end

data/lib/chunky_png/palette.rb

@@ -0,0 +1,91 @@
+module ChunkyPNG
+  
+  ###########################################
+  # PALETTE CLASS
+  ###########################################
+  
+  class Palette < Set
+    
+    def self.from_pixel_matrix(pixel_matrix)
+      from_pixels(pixel_matrix.pixels)
+    end
+    
+    def self.from_pixels(pixels)
+      from_colors(pixels.map(&:color))
+    end
+    
+    def self.from_colors(colors)
+      palette = self.new
+      colors.each { |color| palette << color }
+      palette
+    end
+    
+    def indexable?
+      size < 256
+    end
+    
+    def index(color)
+      @color_map[color]
+    end
+    
+    def to_plte_chunk
+      @color_map = {}
+      colors     = []
+      
+      each_with_index do |color, index|
+        @color_map[color] = index
+        colors += color.to_rgb_array
+      end
+      
+      ChunkyPNG::Chunk::Generic.new('PLTE', colors.pack('C*'))
+    end
+  end
+  
+  ###########################################
+  # COLOR CLASS
+  ###########################################
+  
+  class Color
+    
+    attr_accessor :r, :g, :b
+
+    def initialize(r, g, b)
+      @r, @g, @b = r, g, b
+    end
+
+    ### CONSTRUCTORS ###########################################
+
+    def self.rgb(r, g, b)
+      new(r, g, b)
+    end
+
+    ### COLOR CONSTANTS ###########################################
+
+    BLACK = rgb(  0,   0,   0)
+    WHITE = rgb(255, 255, 255)
+
+    ### CONVERSION ###########################################
+
+    def index(palette)
+      palette.index(self)
+    end
+
+    def to_rgb_array
+      [r, g, b]
+    end
+
+    def to_rgb
+      to_rgb_array.pack('CCC')
+    end
+
+    def inspect
+      '#%02x%02x%02x' % [r, g, b]
+    end
+    
+    ### EQUALITY ###########################################
+    
+    def ==(other)
+      other.kind_of?(self.class) && to_rgb_array == other.to_rgb_array
+    end
+  end
+end

data/lib/chunky_png/pixel_matrix.rb

@@ -0,0 +1,157 @@
+module ChunkyPNG
+  
+  class PixelMatrix
+    
+    FILTER_NONE    = 0
+    FILTER_SUB     = 1
+    FILTER_UP      = 2
+    FILTER_AVERAGE = 3
+    FILTER_PAETH   = 4
+    
+    attr_reader :width, :height, :pixels
+    
+    def self.load(header, content)
+      matrix = self.new(header.width, header.height)
+      matrix.decode_pixelstream(content, header)
+      return matrix
+    end
+    
+    def [](x, y)
+      @pixels[y * width + x]
+    end
+    
+    def each_scanline(&block)
+      height.times do |i|
+        scanline = @pixels[width * i, width]
+        yield(scanline)
+      end
+    end
+    
+    def []=(x, y, color)
+      @pixels[y * width + x] = Pixel.new(color)
+    end
+    
+    def initialize(width, height, background_color = ChunkyPNG::Color::WHITE)
+      @width, @height = width, height
+      @pixels = Array.new(width * height, Pixel.new(background_color))
+    end
+
+    def decode_pixelstream(stream, header = nil)
+      verify_length!(stream.length)
+      @pixels = []
+      
+      decoded_bytes = Array.new(header.width * 3, 0)
+      height.times do |line_no|
+        position       = line_no * (width * 3 + 1)
+        line_length    = header.width * 3
+        bytes          = stream.unpack("@#{position}CC#{line_length}")
+        filter         = bytes.shift
+        decoded_bytes  = decode_scanline(filter, bytes, decoded_bytes, header)
+        decoded_colors = decode_colors(decoded_bytes, header)
+        @pixels += decoded_colors.map { |c| Pixel.new(c) }
+      end
+      
+      raise "Invalid amount of pixels" if @pixels.size != width * height
+    end
+    
+    def decode_colors(bytes, header)
+      (0...width).map { |i| ChunkyPNG::Color.rgb(bytes[i*3+0], bytes[i*3+1], bytes[i*3+2]) }
+    end
+    
+    def decode_scanline(filter, bytes, previous_bytes, header = nil)
+      case filter
+      when FILTER_NONE    then decode_scanline_none( bytes, previous_bytes, header)
+      when FILTER_SUB     then decode_scanline_sub(  bytes, previous_bytes, header)
+      when FILTER_UP      then decode_scanline_up(   bytes, previous_bytes, header)
+      when FILTER_AVERAGE then raise "Average filter are not yet supported!"
+      when FILTER_PAETH   then raise "Paeth filter are not yet supported!"
+      else raise "Unknown filter type"
+      end
+    end
+    
+    def decode_scanline_none(bytes, previous_bytes, header = nil)
+      bytes
+    end
+    
+    def decode_scanline_sub(bytes, previous_bytes, header = nil)
+      bytes.each_with_index { |b, i| bytes[i] = (b + (i >= 3 ? bytes[i-3] : 0)) % 256 }
+      bytes
+    end
+    
+    def decode_scanline_up(bytes, previous_bytes, header = nil)
+      bytes.each_with_index { |b, i| bytes[i] = (b + previous_bytes[i]) % 256 }
+      bytes
+    end
+    
+    def verify_length!(bytes_count)
+      raise "Invalid stream length!" unless bytes_count == width * height * 3 + height
+    end
+    
+    def encode_scanline(filter, bytes, previous_bytes, header = nil)
+      case filter
+      when FILTER_NONE    then encode_scanline_none( bytes, previous_bytes, header)
+      when FILTER_SUB     then encode_scanline_sub(  bytes, previous_bytes, header)
+      when FILTER_UP      then encode_scanline_up(   bytes, previous_bytes, header)
+      when FILTER_AVERAGE then raise "Average filter are not yet supported!"
+      when FILTER_PAETH   then raise "Paeth filter are not yet supported!"
+      else raise "Unknown filter type"
+      end
+    end
+    
+    def encode_scanline_none(bytes, previous_bytes, header = nil)
+      [FILTER_NONE] + bytes
+    end
+    
+    def encode_scanline_sub(bytes, previous_bytes, header = nil)
+      encoded = (3...bytes.length).map { |n| (bytes[n-3] - bytes[n]) % 256 }
+      [FILTER_SUB] + bytes[0...3] + encoded
+    end
+    
+    def encode_scanline_up(bytes, previous_bytes, header = nil)
+      encoded = (0...bytes.length).map { |n| previous_bytes[n] - bytes[n] % 256 }
+      [FILTER_UP] + encoded
+    end
+    
+    def palette
+      ChunkyPNG::Palette.from_pixels(@pixels)
+    end
+    
+    def indexable?
+      palette.indexable?
+    end
+    
+    def to_indexed_pixelstream(palette)
+      stream = ""
+      each_scanline do |line|
+        bytes  = line.map { |p| p.color.index(palette) }
+        stream << encode_scanline(FILTER_NONE, bytes, nil, nil).pack('C*')
+      end
+      return stream
+    end
+    
+    def to_rgb_pixelstream
+      stream = ""
+      each_scanline do |line|
+        bytes = line.map { |p| p.color.to_rgb_array }.flatten
+        stream << encode_scanline(FILTER_NONE, bytes, nil, nil).pack('C*')
+      end
+      return stream
+    end
+  end
+  
+  class Pixel
+    attr_accessor :color, :alpha
+    
+    def initialize(color, alpha = 255)
+      @color, @alpha = color, alpha
+    end
+    
+    def opaque?
+      alpha == 255
+    end
+    
+    def make_opaque!
+      alpha = 255
+    end
+  end
+end

data/spec/integration/image_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../spec_helper.rb', File.dirname(__FILE__))
+
+describe ChunkyPNG::Image do
+
+  it "should write a valid PNG image using an indexed palette" do
+    image    = ChunkyPNG::Image.new(10, 20, ChunkyPNG::Color.rgb(10, 100, 255))
+    filename = resource_file('testing.png')
+    File.open(filename, 'w') { |f| image.write(f) }
+
+    png = ChunkyPNG.load(filename)
+    png.header_chunk.width.should  == 10
+    png.header_chunk.height.should == 20
+    png.header_chunk.color.should  == ChunkyPNG::Chunk::Header::COLOR_INDEXED
+
+    png.palette_chunk.should_not be_nil
+    png.data_chunks.should_not be_empty
+    # `open #{filename}`
+    
+    File.unlink(filename)
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'spec'
+
+require 'chunky_png'
+
+module ResourceFileHelper
+  def resource_file(name)
+    File.expand_path("./resources/#{name}", File.dirname(__FILE__))
+  end
+end
+
+
+Spec::Runner.configure do |config|
+  config.include ResourceFileHelper
+end

data/spec/unit/pixel_matrix_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path('../spec_helper.rb', File.dirname(__FILE__))
+
+describe ChunkyPNG::PixelMatrix do
+  
+  describe '#decode_scanline' do
+    before(:each) do
+      @matrix = ChunkyPNG::PixelMatrix.new(3, 3)
+    end
+    
+    it "should decode a line without filtering as is" do
+      bytes = Array.new(@matrix.width * 3, ChunkyPNG::Color.rgb(10, 20, 30))
+      @matrix.decode_scanline(ChunkyPNG::PixelMatrix::FILTER_NONE, bytes, nil).should == bytes
+    end
+    
+    it "should decode a line with sub filtering correctly" do
+      # all white pixels
+      bytes = [255, 255, 255, 0, 0, 0, 0, 0, 0]
+      decoded_bytes = @matrix.decode_scanline(ChunkyPNG::PixelMatrix::FILTER_SUB, bytes, nil)
+      decoded_bytes.should == [255, 255, 255, 255, 255, 255, 255, 255, 255]
+      
+      # all black pixels
+      bytes = [0, 0, 0, 0, 0, 0, 0, 0, 0]
+      decoded_bytes = @matrix.decode_scanline(ChunkyPNG::PixelMatrix::FILTER_SUB, bytes, nil)
+      decoded_bytes.should == [0, 0, 0, 0, 0, 0, 0, 0, 0]
+      
+      # various colors
+      bytes = [255, 0, 45, 0, 255, 0, 112, 200, 178]
+      decoded_bytes = @matrix.decode_scanline(ChunkyPNG::PixelMatrix::FILTER_SUB, bytes, nil)
+      decoded_bytes.should == [255, 0, 45, 255, 255, 45, 111, 199, 223]
+    end
+    
+    it "should decode a line with up filtering correctly" do
+      # previous line is all black
+      previous_bytes = [0, 0, 0, 0, 0, 0, 0, 0, 0]
+      bytes          = [255, 255, 255, 127, 127, 127, 0, 0, 0]
+      decoded_bytes = @matrix.decode_scanline(ChunkyPNG::PixelMatrix::FILTER_UP, bytes, previous_bytes)
+      decoded_bytes.should == [255, 255, 255, 127, 127, 127, 0, 0, 0]
+      
+      # previous line has various pixels
+      previous_bytes = [255, 255, 255, 127, 127, 127, 0, 0, 0]
+      bytes          = [0, 127, 255, 0, 127, 255, 0, 127, 255]
+      decoded_bytes = @matrix.decode_scanline(ChunkyPNG::PixelMatrix::FILTER_UP, bytes, previous_bytes)
+      decoded_bytes.should == [255, 126, 254, 127, 254, 126, 0, 127, 255]
+    end
+  end
+  
+  describe '#encode_scanline' do
+    before(:each) do
+      @matrix = ChunkyPNG::PixelMatrix.new(3, 3)
+    end
+    
+    it "should encode a scanline without filtering correctly" do
+      bytes = [0, 0, 0, 1, 1, 1, 2, 2, 2]
+      encoded_bytes = @matrix.encode_scanline(ChunkyPNG::PixelMatrix::FILTER_NONE, bytes, nil, nil)
+      encoded_bytes.should == [0, 0, 0, 0, 1, 1, 1, 2, 2, 2]
+    end
+    
+    it "should encode a scanline with sub filtering correctly" do
+      bytes = [255, 255, 255, 255, 255, 255, 255, 255, 255]
+      encoded_bytes = @matrix.encode_scanline(ChunkyPNG::PixelMatrix::FILTER_SUB, bytes, nil, nil)
+      encoded_bytes.should == [1, 255, 255, 255, 0, 0, 0, 0, 0, 0]
+    end
+    
+    it "should encode a scanline with up filtering correctly" do
+      bytes          = [255, 255, 255, 255, 255, 255, 255, 255, 255]
+      previous_bytes = [255, 255, 255, 255, 255, 255, 255, 255, 255]
+      encoded_bytes = @matrix.encode_scanline(ChunkyPNG::PixelMatrix::FILTER_UP, bytes, previous_bytes, nil)
+      encoded_bytes.should == [2, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    end    
+  end
+end

data/tasks/github-gem.rake

@@ -0,0 +1,323 @@
+require 'rubygems'
+require 'rake'
+require 'rake/tasklib'
+require 'date'
+require 'git'
+
+module GithubGem
+
+  # Detects the gemspc file of this project using heuristics.
+  def self.detect_gemspec_file
+    FileList['*.gemspec'].first
+  end
+
+  # Detects the main include file of this project using heuristics
+  def self.detect_main_include
+    if detect_gemspec_file =~ /^(\.*)\.gemspec$/ && File.exist?("lib/#{$1}.rb")
+      "lib/#{$1}.rb"
+    elsif FileList['lib/*.rb'].length == 1
+      FileList['lib/*.rb'].first
+    else
+      nil
+    end
+  end
+
+  class RakeTasks
+
+    attr_reader   :gemspec, :modified_files, :git
+    attr_accessor :gemspec_file, :task_namespace, :main_include, :root_dir, :spec_pattern, :test_pattern, :remote, :remote_branch, :local_branch
+
+    # Initializes the settings, yields itself for configuration
+    # and defines the rake tasks based on the gemspec file.
+    def initialize(task_namespace = :gem)
+      @gemspec_file   = GithubGem.detect_gemspec_file
+      @task_namespace = task_namespace
+      @main_include   = GithubGem.detect_main_include
+      @modified_files = []
+      @root_dir       = Dir.pwd
+      @test_pattern   = 'test/**/*_test.rb'
+      @spec_pattern   = 'spec/**/*_spec.rb'
+      @local_branch   = 'master'
+      @remote         = 'origin'
+      @remote_branch  = 'master'
+
+      yield(self) if block_given?
+
+      @git = Git.open(@root_dir)
+      load_gemspec!
+      define_tasks!
+    end
+
+    protected
+
+    # Define Unit test tasks
+    def define_test_tasks!
+      require 'rake/testtask'
+
+      namespace(:test) do
+        Rake::TestTask.new(:basic) do |t|
+          t.pattern = test_pattern
+          t.verbose = true
+          t.libs << 'test'
+        end
+      end
+
+      desc "Run all unit tests for #{gemspec.name}"
+      task(:test => ['test:basic'])
+    end
+
+    # Defines RSpec tasks
+    def define_rspec_tasks!
+      require 'spec/rake/spectask'
+
+      namespace(:spec) do
+        desc "Verify all RSpec examples for #{gemspec.name}"
+        Spec::Rake::SpecTask.new(:basic) do |t|
+          t.spec_files = FileList[spec_pattern]
+        end
+
+        desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+        Spec::Rake::SpecTask.new(:specdoc) do |t|
+          t.spec_files = FileList[spec_pattern]
+          t.spec_opts << '--format' << 'specdoc' << '--color'
+        end
+
+        desc "Run RCov on specs for #{gemspec.name}"
+        Spec::Rake::SpecTask.new(:rcov) do |t|
+          t.spec_files = FileList[spec_pattern]
+          t.rcov = true
+          t.rcov_opts = ['--exclude', '"spec/*,gems/*"', '--rails']
+        end
+      end
+
+      desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+      task(:spec => ['spec:specdoc'])
+    end
+
+    # Defines the rake tasks
+    def define_tasks!
+
+      define_test_tasks!  if has_tests?
+      define_rspec_tasks! if has_specs?
+
+      namespace(@task_namespace) do
+        desc "Updates the filelist in the gemspec file"
+        task(:manifest) { manifest_task }
+
+        desc "Builds the .gem package"
+        task(:build => :manifest) { build_task }
+
+        desc "Sets the version of the gem in the gemspec"
+        task(:set_version => [:check_version, :check_current_branch]) { version_task }
+        task(:check_version => :fetch_origin) { check_version_task }
+
+        task(:fetch_origin) { fetch_origin_task }
+        task(:check_current_branch) { check_current_branch_task }
+        task(:check_clean_status) { check_clean_status_task }
+        task(:check_not_diverged => :fetch_origin) { check_not_diverged_task }
+
+        checks = [:check_current_branch, :check_clean_status, :check_not_diverged, :check_version]
+        checks.unshift('spec:basic') if has_specs?
+        checks.unshift('test:basic') if has_tests?
+        checks.push << [:check_rubyforge] if gemspec.rubyforge_project
+
+        desc "Perform all checks that would occur before a release"
+        task(:release_checks => checks)
+
+        release_tasks = [:release_checks, :set_version, :build, :github_release]
+        release_tasks << [:rubyforge_release] if gemspec.rubyforge_project
+
+        desc "Release a new verison of the gem"
+        task(:release => release_tasks) { release_task }
+
+        task(:check_rubyforge)   { check_rubyforge_task }
+        task(:rubyforge_release) { rubyforge_release_task }
+        task(:github_release => [:commit_modified_files, :tag_version]) { github_release_task }
+        task(:tag_version) { tag_version_task }
+        task(:commit_modified_files) { commit_modified_files_task }
+
+        desc "Updates the gem release tasks with the latest version on Github"
+        task(:update_tasks) { update_tasks_task }
+      end
+    end
+
+    # Updates the files list and test_files list in the gemspec file using the list of files
+    # in the repository and the spec/test file pattern.
+    def manifest_task
+      # Load all the gem's files using "git ls-files"
+      repository_files = git.ls_files.keys
+      test_files       = Dir[test_pattern] + Dir[spec_pattern]
+
+      update_gemspec(:files, repository_files)
+      update_gemspec(:test_files, repository_files & test_files)
+    end
+
+    # Builds the gem
+    def build_task
+      sh "gem build -q #{gemspec_file}"
+      Dir.mkdir('pkg') unless File.exist?('pkg')
+      sh "mv #{gemspec.name}-#{gemspec.version}.gem pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    # Updates the version number in the gemspec file, the VERSION constant in the main
+    # include file and the contents of the VERSION file.
+    def version_task
+      update_gemspec(:version, ENV['VERSION']) if ENV['VERSION']
+      update_gemspec(:date, Date.today)
+
+      update_version_file(gemspec.version)
+      update_version_constant(gemspec.version)
+    end
+
+    def check_version_task
+      raise "#{ENV['VERSION']} is not a valid version number!" if ENV['VERSION'] && !Gem::Version.correct?(ENV['VERSION'])
+      proposed_version = Gem::Version.new(ENV['VERSION'] || gemspec.version)
+      # Loads the latest version number using the created tags
+      newest_version   = git.tags.map { |tag| tag.name.split('-').last }.compact.map { |v| Gem::Version.new(v) }.max
+      raise "This version (#{proposed_version}) is not higher than the highest tagged version (#{newest_version})" if newest_version && newest_version >= proposed_version
+    end
+
+    # Checks whether the current branch is not diverged from the remote branch
+    def check_not_diverged_task
+      raise "The current branch is diverged from the remote branch!" if git.log.between('HEAD', git.remote(remote).branch(remote_branch).gcommit).any?
+    end
+
+    # Checks whether the repository status ic clean
+    def check_clean_status_task
+      raise "The current working copy contains modifications" if git.status.changed.any?
+    end
+
+    # Checks whether the current branch is correct
+    def check_current_branch_task
+      raise "Currently not on #{local_branch} branch!" unless git.branch.name == local_branch.to_s
+    end
+
+    # Fetches the latest updates from Github
+    def fetch_origin_task
+      git.fetch('origin')
+    end
+
+    # Commits every file that has been changed by the release task.
+    def commit_modified_files_task
+      if modified_files.any?
+        modified_files.each { |file| git.add(file) }
+        git.commit("Released #{gemspec.name} gem version #{gemspec.version}")
+      end
+    end
+
+    # Adds a tag for the released version
+    def tag_version_task
+      git.add_tag("#{gemspec.name}-#{gemspec.version}")
+    end
+
+    # Pushes the changes and tag to github
+    def github_release_task
+      git.push(remote, remote_branch, true)
+    end
+
+    # Checks whether Rubyforge is configured properly
+    def check_rubyforge_task
+      # Login no longer necessary when using rubyforge 2.0.0 gem
+      # raise "Could not login on rubyforge!" unless `rubyforge login 2>&1`.strip.empty?
+      output = `rubyforge names`.split("\n")
+      raise "Rubyforge group not found!"   unless output.any? { |line| %r[^groups\s*\:.*\b#{Regexp.quote(gemspec.rubyforge_project)}\b.*] =~ line }
+      raise "Rubyforge package not found!" unless output.any? { |line| %r[^packages\s*\:.*\b#{Regexp.quote(gemspec.name)}\b.*] =~ line }
+    end
+
+    # Task to release the .gem file toRubyforge.
+    def rubyforge_release_task
+      sh 'rubyforge', 'add_release', gemspec.rubyforge_project, gemspec.name, gemspec.version.to_s, "pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    # Gem release task.
+    # All work is done by the task's dependencies, so just display a release completed message.
+    def release_task
+      puts
+      puts '------------------------------------------------------------'
+      puts "Released #{gemspec.name} version #{gemspec.version}"
+    end
+
+    private
+
+    # Checks whether this project has any RSpec files
+    def has_specs?
+      FileList[spec_pattern].any?
+    end
+
+    # Checks whether this project has any unit test files
+    def has_tests?
+      FileList[test_pattern].any?
+    end
+
+    # Loads the gemspec file
+    def load_gemspec!
+      @gemspec = eval(File.read(@gemspec_file))
+    end
+
+    # Updates the VERSION file with the new version
+    def update_version_file(version)
+      if File.exists?('VERSION')
+        File.open('VERSION', 'w') { |f| f << version.to_s }
+        modified_files << 'VERSION'
+      end
+    end
+
+    # Updates the VERSION constant in the main include file if it exists
+    def update_version_constant(version)
+      if main_include && File.exist?(main_include)
+        file_contents = File.read(main_include)
+        if file_contents.sub!(/^(\s+VERSION\s*=\s*)[^\s].*$/) { $1 + version.to_s.inspect }
+          File.open(main_include, 'w') { |f| f << file_contents }
+          modified_files << main_include
+        end
+      end
+    end
+
+    # Updates an attribute of the gemspec file.
+    # This function will open the file, and search/replace the attribute using a regular expression.
+    def update_gemspec(attribute, new_value, literal = false)
+
+      unless literal
+        new_value = case new_value
+          when Array        then "%w(#{new_value.join(' ')})"
+          when Hash, String then new_value.inspect
+          when Date         then new_value.strftime('%Y-%m-%d').inspect
+          else              raise "Cannot write value #{new_value.inspect} to gemspec file!"
+        end
+      end
+
+      spec   = File.read(gemspec_file)
+      regexp = Regexp.new('^(\s+\w+\.' + Regexp.quote(attribute.to_s) + '\s*=\s*)[^\s].*$')
+      if spec.sub!(regexp) { $1 + new_value }
+        File.open(gemspec_file, 'w') { |f| f << spec }
+        modified_files << gemspec_file
+
+        # Reload the gemspec so the changes are incorporated
+        load_gemspec!
+      end
+    end
+
+    # Updates the tasks file using the latest file found on Github
+    def update_tasks_task
+      require 'net/http'
+
+      server = 'github.com'
+      path   = '/wvanbergen/github-gem/raw/master/tasks/github-gem.rake'
+
+      Net::HTTP.start(server) do |http|
+        response = http.get(path)
+        open(__FILE__, "w") { |file| file.write(response.body) }
+      end
+
+      relative_file = File.expand_path(__FILE__).sub(%r[^#{git.dir.path}/], '')
+      if git.status[relative_file] && git.status[relative_file].type == 'M'
+        git.add(relative_file)
+        git.commit("Updated to latest gem release management tasks.")
+        puts "Updated to latest version of gem release management tasks."
+      else
+        puts "Release managament tasks already are at the latest version."
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: chunky_png
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Pure ruby library for read/write, chunk-level access to PNG files
+email: 
+- willem@railsdoctors.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- spec/spec_helper.rb
+- .gitignore
+- lib/chunky_png/pixel_matrix.rb
+- LICENSE
+- lib/chunky_png/chunk.rb
+- Rakefile
+- README.rdoc
+- spec/resources/indexed_10x10.png
+- spec/integration/image_spec.rb
+- lib/chunky_png/palette.rb
+- lib/chunky_png/datastream.rb
+- chunky_png.gemspec
+- tasks/github-gem.rake
+- lib/chunky_png/image.rb
+- spec/unit/pixel_matrix_spec.rb
+- lib/chunky_png.rb
+has_rdoc: true
+homepage: http://wiki.github.com/wvanbergen/chunky_png
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- chunky_png
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pure ruby library for read/write, chunk-level access to PNG files
+test_files: 
+- spec/integration/image_spec.rb
+- spec/unit/pixel_matrix_spec.rb