pr-zlib 1.0.0 → 1.0.1

data/lib/pr/zlib.rb

@@ -9,7 +9,7 @@ include Rbzlib
 module Zlib
 
   RUBY_ZLIB_VERSION = '0.6.0'
-  PR_ZLIB_VERSION   = '1.0.0'
+  PR_ZLIB_VERSION   = '1.0.1'
 
   class Error < StandardError
   end
@@ -88,7 +88,7 @@ module Zlib
 
     def raise_zlib_error(err, msg)
       msg = zError(err) if msg.nil? || msg==''
-  
+
       case err
         when Z_STREAM_END
           raise StreamEnd, msg
@@ -110,7 +110,7 @@ module Zlib
           raise Error, "unknown zlib error #errend: #msgend"
       end
     end
- 
+
     def zstream_expand_buffer()
       if @buf.nil?
         @buf = Bytef.new(0.chr * ZSTREAM_INITIAL_BUFSIZE)
@@ -483,15 +483,15 @@ module Zlib
 
     def finish()
       @z.zstream_run("", 0, Z_FINISH)
-      dst = @z.zstream_detach_buffer()
+      @z.zstream_detach_buffer()
     end
 
     def flush_next_in
-      dst = @z.zstream_detach_input
+      @z.zstream_detach_input
     end
 
     def flush_next_out
-      dst = @z.zstream_detach_buffer
+      @z.zstream_detach_buffer
     end
 
     def initialize
@@ -558,7 +558,7 @@ module Zlib
 
     def deflate(src,flush=Z_NO_FLUSH)
       do_deflate(src,flush)
-      dst = @z.zstream_detach_buffer
+      @z.zstream_detach_buffer
     end
 
     def <<(src)
@@ -570,7 +570,7 @@ module Zlib
       if(v_flush != Z_NO_FLUSH)
         @z.zstream_run("", 0, flush)
       end
-      dst = @z.zstream_detach_buffer()
+      @z.zstream_detach_buffer()
     end
 
     def params(level=Z_DEFAULT_COMPRESSION,strategy=Z_DEFAULT_STRATEGY)
@@ -1111,7 +1111,7 @@ module Zlib
       gzfile_write(str, str.length)
       str.length
     end
-    
+
     def putc(ch)
       raise GzipFile::Error, "closed gzip stream" unless @gz.z.ZSTREAM_IS_READY()
       gzfile_write(ch.chr, 1)
@@ -1281,7 +1281,7 @@ module Zlib
     end
 
     def readline(rs=$/)
-      dst = gets(rs)
+      gets(rs)
     end
 
     def each(rs=$/)
@@ -1343,7 +1343,7 @@ module Zlib
       return nil if @gz.z.input.nil?
       @gz.z.input.dup
     end
-    
+
     def rscheck(rsptr,rslen,rs)
       raise RuntimeError, "rs modified" if rs != rsptr
     end
@@ -1385,10 +1385,10 @@ module Zlib
           gzfile_read_more()
           ap = n - rslen
         end
-        
+
         rscheck(rsptr, rslen, rs) if (!rspara)
         res = @gz.z.buf.buffer[ap,@gz.z.buf.offset - n + 1].index(rsptr[0])
-        
+
         if res.nil?
           n = @gz.z.buf.offset + 1
         else
@@ -1417,12 +1417,12 @@ module Zlib
         return ""
       end
 
-      while (!@gz.z.ZSTREAM_IS_FINISHED() && @gz.z.buf.offset < len) 
+      while (!@gz.z.ZSTREAM_IS_FINISHED() && @gz.z.buf.offset < len)
         gzfile_read_more()
       end
 
-      if (GZFILE_IS_FINISHED(@gz)) 
-        if (@gz.z.flags & GZFILE_FLAG_FOOTER_FINISHED).zero? 
+      if (GZFILE_IS_FINISHED(@gz))
+        if (@gz.z.flags & GZFILE_FLAG_FOOTER_FINISHED).zero?
           gzfile_check_footer()
         end
         return nil

data/pr-zlib.gemspec

@@ -1,28 +1,22 @@
 require 'rubygems'
 
-spec = Gem::Specification.new do |gem|
-   gem.name              = 'pr-zlib'
-   gem.version           = '1.0.0'
-   gem.authors           = ['Park Heesob', 'Daniel Berger']
-   gem.email             = 'phasis@gmail.com'
-   gem.homepage          = 'http://www.rubyforge.org/projects/pure'
-   gem.rubyforge_project = 'pure'
-   gem.platform          = Gem::Platform::RUBY
-   gem.summary           = 'Pure Ruby version of the zlib library'
-   gem.test_files        = Dir['test/*.rb']
-   gem.has_rdoc          = true
-   gem.files             = Dir["**/*"].reject{ |f| f.include?('SVN') }
-   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+Gem::Specification.new do |spec|
+  spec.name              = 'pr-zlib'
+  spec.version           = '1.0.1'
+  spec.authors           = ['Park Heesob', 'Daniel Berger']
+  spec.email             = 'phasis@gmail.com'
+  spec.homepage          = 'https://github.com/djberg96/pr-zlib'
+  spec.summary           = 'Pure Ruby version of the zlib library'
+  spec.test_files        = Dir['test/*.rb']
+  spec.files             = Dir["**/*"].reject{ |f| f.include?('git') }
+  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
    
-   gem.add_dependency('test-unit', '>= 2.0.2')
+  spec.add_development_dependency('test-unit', '>= 2.4.0')
+  spec.add_development_dependency('ruby-prof')
    
-   gem.description = <<-EOF
-      The pr-zlib library is a pure Ruby implementation of both the zlib C
-      library, and the Ruby zlib interface that ships as part of the standard
-      library.
-   EOF
-end
-
-if $0 == __FILE__
-   Gem::Builder.new(spec).build
+  spec.description = <<-EOF
+    The pr-zlib library is a pure Ruby implementation of both the zlib C
+    library, and the Ruby zlib interface that ships as part of the standard
+    library.
+  EOF
 end

data/profile/bench_pr_zlib.rb

@@ -0,0 +1,43 @@
+########################################################################
+# This benchmarks the zlib library that ships as part of the Ruby
+# standard library.
+#
+# You can run this benchmark via the bench:przlib Rake task.
+########################################################################
+require 'pr/zlib'
+require 'benchmark'
+
+print "\n\n== Running the benchmarks for pr-zlib ==\n\n"
+
+# First, let's create a ~7 MB text file.
+
+FILE_NAME = "benchmark.txt"
+GZ_FILE_NAME = "benchmark.txt.gz"
+
+File.open(FILE_NAME, "w") do |fh|
+  10000.times{ |x|
+    s = "Now is the time for #{x} good men to come to the aid of their country."
+    fh.puts s
+  }
+end
+
+Benchmark.bm do |x|
+  x.report("write") do
+    5.times{
+      Zlib::GzipWriter.open(GZ_FILE_NAME) do |gz|
+        gz.write(File.read(FILE_NAME))
+      end
+    }
+  end
+
+  x.report("read") do
+    5.times{
+      Zlib::GzipReader.open(GZ_FILE_NAME) do |gz|
+        gz.read
+      end
+    }
+  end
+end
+
+File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exists?(GZ_FILE_NAME)

data/profile/bench_zlib.rb

@@ -0,0 +1,43 @@
+########################################################################
+# This benchmarks the zlib library that ships as part of the Ruby
+# standard library.
+#
+# You can run this benchmark via the bench-zlib Rake task.
+########################################################################
+require 'zlib'
+require 'benchmark'
+
+print "\n\n== Running the benchmarks for zlib (stdlib) ==\n\n"
+
+# First, let's create a ~7 MB text file.
+
+FILE_NAME = "benchmark.txt"
+GZ_FILE_NAME = "benchmark.txt.gz"
+
+File.open(FILE_NAME, "w") do |fh|
+  10000.times{ |x|
+    s = "Now is the time for #{x} good men to come to the aid of their country."
+    fh.puts s
+  }
+end
+
+Benchmark.bm do |x|
+  x.report("write") do
+    5.times{
+      Zlib::GzipWriter.open(GZ_FILE_NAME) do |gz|
+        gz.write(File.read(FILE_NAME))
+      end
+    }
+  end
+
+  x.report("read") do
+    5.times{
+      Zlib::GzipReader.open(GZ_FILE_NAME) do |gz|
+        gz.read
+      end
+    }
+  end
+end
+
+File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exists?(GZ_FILE_NAME)

data/profile/profile_pr_zlib_read.rb

@@ -0,0 +1,28 @@
+require 'pr/zlib'
+
+FILE_NAME = 'zlib_temp.txt'
+GZ_FILE_NAME = 'zlib_temp.txt.gz'
+
+# Create a text file to use first.
+File.open(FILE_NAME, "w") do |fh|
+  1000.times{ |x|
+    s = "Now is the time for #{x} good men to come to the aid of their country."
+    fh.puts s
+  }
+end
+
+Zlib::GzipWriter.open(GZ_FILE_NAME){ |gz| gz.write(IO.read(FILE_NAME)) }
+
+require 'ruby-prof'
+
+result = RubyProf.profile do
+  Zlib::GzipReader.open(GZ_FILE_NAME) do |gz|
+    gz.read
+  end
+end
+
+File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exists?(GZ_FILE_NAME)
+
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT)

data/profile/profile_pr_zlib_write.rb

@@ -0,0 +1,26 @@
+require 'pr/zlib'
+
+FILE_NAME = 'zlib_temp.txt'
+GZ_FILE_NAME = 'zlib_temp.txt.gz'
+
+# Create a text file to use first.
+File.open(FILE_NAME, "w") do |fh|
+  1000.times{ |x|
+    s = "Now is the time for #{x} good men to come to the aid of their country."
+    fh.puts s
+  }
+end
+
+require 'ruby-prof'
+
+result = RubyProf.profile do
+  Zlib::GzipWriter.open(GZ_FILE_NAME) do |gz|
+    gz.write(File.read(FILE_NAME))
+  end
+end
+
+File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exists?(GZ_FILE_NAME)
+
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT)

data/test/test_rbzlib.rb

@@ -3,134 +3,131 @@
 #
 # Test case for the Rbzlib module.
 ########################################################################
-require 'rubygems'
-gem 'test-unit'
-
 require 'pr/rbzlib'
-require 'test/unit'
+require 'test-unit'
 
 class TC_Rbzlib < Test::Unit::TestCase
-   include Rbzlib
-
-   def setup
-      @fixnum = 7
-      @buffer = 0.chr * 16
-   end
-
-   def test_version
-      assert_equal('1.2.3', ZLIB_VERSION)
-   end
-
-   def test_fixnum_ord
-      assert_respond_to(7, :ord)
-      assert_equal(7, 7.ord)
-   end
-
-   def test_misc_constants
-      assert_equal(9, MAX_MEM_LEVEL)
-      assert_equal(8, DEF_MEM_LEVEL)
-      assert_equal(15, MAX_WBITS)
-      assert_equal(MAX_WBITS, DEF_WBITS)
-      assert_equal(0, STORED_BLOCK)
-      assert_equal(1, STATIC_TREES)
-      assert_equal(2, DYN_TREES)
-      assert_equal(3, MIN_MATCH)
-      assert_equal(258, MAX_MATCH)
-      assert_equal(0x20, PRESET_DICT)
-      assert_equal(65521, BASE)
-      assert_equal(5552, NMAX)
-      assert_equal(0, OS_CODE)
-      assert_equal(1, SEEK_CUR)
-      assert_equal(2, SEEK_END)
-   end
-
-   def test_sync_contants
-      assert_equal(0, Z_NO_FLUSH)
-      assert_equal(1, Z_PARTIAL_FLUSH)
-      assert_equal(2, Z_SYNC_FLUSH)
-      assert_equal(3, Z_FULL_FLUSH)
-      assert_equal(4, Z_FINISH)
-      assert_equal(5, Z_BLOCK)
-   end
-
-   def test_stream_constants
-      assert_equal(0, Z_OK)
-      assert_equal(1, Z_STREAM_END)
-      assert_equal(2, Z_NEED_DICT)
-      assert_equal(-1, Z_ERRNO)
-      assert_equal(-1, Z_EOF)
-      assert_equal(-2, Z_STREAM_ERROR)
-      assert_equal(-3, Z_DATA_ERROR)
-      assert_equal(-4, Z_MEM_ERROR)
-      assert_equal(-5, Z_BUF_ERROR)
-      assert_equal(-6, Z_VERSION_ERROR)
-      assert_equal(16384, Z_BUFSIZE)
-   end
-
-   def test_compression_constants
-      assert_equal(0, Z_NO_COMPRESSION)
-      assert_equal(1, Z_BEST_SPEED)
-      assert_equal(9, Z_BEST_COMPRESSION)
-      assert_equal(-1, Z_DEFAULT_COMPRESSION)
-      assert_equal(8, Z_DEFLATED)
-   end
-
-   def test_encoding_constants
-      assert_equal(1, Z_FILTERED)
-      assert_equal(2, Z_HUFFMAN_ONLY)
-      assert_equal(3, Z_RLE)
-      assert_equal(4, Z_FIXED)
-      assert_equal(0, Z_DEFAULT_STRATEGY)
-   end
-
-   def test_crc_constants
-      assert_equal(0x01, ASCII_FLAG)
-      assert_equal(0x02, HEAD_CRC)
-      assert_equal(0x04, EXTRA_FIELD)
-      assert_equal(0x08, ORIG_NAME)
-      assert_equal(0x10, COMMENT_)
-      assert_equal(0xE0, RESERVED)
-   end
-
-   def test_zError
-      assert_respond_to(self, :zError)
-      assert_equal('stream end', self.zError(Z_STREAM_END))
-   end
-
-   def test_zlibVersion
-      assert_respond_to(self, :zlibVersion)
-      assert_equal(ZLIB_VERSION, self.zlibVersion)
-   end
-
-   def test_z_error
-      assert_respond_to(self, :z_error)
-      assert_raise(RuntimeError){ self.z_error('hello') }
-   end
-
-   def test_adler32
-      assert_respond_to(Rbzlib, :adler32)
-      assert_equal(1, Rbzlib.adler32(32, nil))
-      assert_equal(0, Rbzlib.adler32(0, @buffer))
-      assert_equal(1048577, Rbzlib.adler32(1, @buffer))
-      assert_equal(10485770, Rbzlib.adler32(10, @buffer))
-      assert_equal(33554464, Rbzlib.adler32(32, @buffer))
-   end
-
-   def test_adler32_expected_errors
-      assert_raise(ArgumentError){ Rbzlib.adler32 }
-      assert_raise(ArgumentError){ Rbzlib.adler32('test') }
-   end
-
-   def test_get_crc_table
-      assert_respond_to(Rbzlib, :get_crc_table)
-   end
-
-   def test_gz_open
-      assert_respond_to(Rbzlib, :gz_open)
-   end
-
-   def teardown
-      @fixnum = 0
-      @buffer = nil
-   end
+  include Rbzlib
+
+  def setup
+    @fixnum = 7
+    @buffer = 0.chr * 16
+  end
+
+  def test_version
+    assert_equal('1.2.3', ZLIB_VERSION)
+  end
+
+  def test_fixnum_ord
+    assert_respond_to(7, :ord)
+    assert_equal(7, 7.ord)
+  end
+
+  def test_misc_constants
+    assert_equal(9, MAX_MEM_LEVEL)
+    assert_equal(8, DEF_MEM_LEVEL)
+    assert_equal(15, MAX_WBITS)
+    assert_equal(MAX_WBITS, DEF_WBITS)
+    assert_equal(0, STORED_BLOCK)
+    assert_equal(1, STATIC_TREES)
+    assert_equal(2, DYN_TREES)
+    assert_equal(3, MIN_MATCH)
+    assert_equal(258, MAX_MATCH)
+    assert_equal(0x20, PRESET_DICT)
+    assert_equal(65521, BASE)
+    assert_equal(5552, NMAX)
+    assert_equal(0, OS_CODE)
+    assert_equal(1, SEEK_CUR)
+    assert_equal(2, SEEK_END)
+  end
+
+  def test_sync_contants
+    assert_equal(0, Z_NO_FLUSH)
+    assert_equal(1, Z_PARTIAL_FLUSH)
+    assert_equal(2, Z_SYNC_FLUSH)
+    assert_equal(3, Z_FULL_FLUSH)
+    assert_equal(4, Z_FINISH)
+    assert_equal(5, Z_BLOCK)
+  end
+
+  def test_stream_constants
+    assert_equal(0, Z_OK)
+    assert_equal(1, Z_STREAM_END)
+    assert_equal(2, Z_NEED_DICT)
+    assert_equal(-1, Z_ERRNO)
+    assert_equal(-1, Z_EOF)
+    assert_equal(-2, Z_STREAM_ERROR)
+    assert_equal(-3, Z_DATA_ERROR)
+    assert_equal(-4, Z_MEM_ERROR)
+    assert_equal(-5, Z_BUF_ERROR)
+    assert_equal(-6, Z_VERSION_ERROR)
+    assert_equal(16384, Z_BUFSIZE)
+  end
+
+  def test_compression_constants
+    assert_equal(0, Z_NO_COMPRESSION)
+    assert_equal(1, Z_BEST_SPEED)
+    assert_equal(9, Z_BEST_COMPRESSION)
+    assert_equal(-1, Z_DEFAULT_COMPRESSION)
+    assert_equal(8, Z_DEFLATED)
+  end
+
+  def test_encoding_constants
+    assert_equal(1, Z_FILTERED)
+    assert_equal(2, Z_HUFFMAN_ONLY)
+    assert_equal(3, Z_RLE)
+    assert_equal(4, Z_FIXED)
+    assert_equal(0, Z_DEFAULT_STRATEGY)
+  end
+
+  def test_crc_constants
+    assert_equal(0x01, ASCII_FLAG)
+    assert_equal(0x02, HEAD_CRC)
+    assert_equal(0x04, EXTRA_FIELD)
+    assert_equal(0x08, ORIG_NAME)
+    assert_equal(0x10, COMMENT_)
+    assert_equal(0xE0, RESERVED)
+  end
+
+  def test_zError
+    assert_respond_to(self, :zError)
+    assert_equal('stream end', self.zError(Z_STREAM_END))
+  end
+
+  def test_zlibVersion
+    assert_respond_to(self, :zlibVersion)
+    assert_equal(ZLIB_VERSION, self.zlibVersion)
+  end
+
+  def test_z_error
+    assert_respond_to(self, :z_error)
+    assert_raise(RuntimeError){ self.z_error('hello') }
+  end
+
+  def test_adler32
+    assert_respond_to(Rbzlib, :adler32)
+    assert_equal(1, Rbzlib.adler32(32, nil))
+    assert_equal(0, Rbzlib.adler32(0, @buffer))
+    assert_equal(1048577, Rbzlib.adler32(1, @buffer))
+    assert_equal(10485770, Rbzlib.adler32(10, @buffer))
+    assert_equal(33554464, Rbzlib.adler32(32, @buffer))
+  end
+
+  def test_adler32_expected_errors
+    assert_raise(ArgumentError){ Rbzlib.adler32 }
+    assert_raise(ArgumentError){ Rbzlib.adler32('test') }
+  end
+
+  def test_get_crc_table
+    assert_respond_to(Rbzlib, :get_crc_table)
+  end
+
+  def test_gz_open
+    assert_respond_to(Rbzlib, :gz_open)
+  end
+
+  def teardown
+    @fixnum = 0
+    @buffer = nil
+  end
 end