pr-zlib 1.0.5 → 1.1.0

data/pr-zlib.gemspec

@@ -2,31 +2,31 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name             = 'pr-zlib'
-  spec.version          = '1.0.5'
+  spec.version          = '1.1.0'
   spec.authors          = ['Park Heesob', 'Daniel Berger']
   spec.email            = ['phasis@gmail.com', 'djberg96@gmail.com'],
   spec.homepage         = 'https://github.com/djberg96/pr-zlib'
-  spec.license          = 'zlib'
+  spec.license          = 'Zlib'
   spec.summary          = 'Pure Ruby version of the zlib library'
-  spec.test_files       = Dir['test/*.rb']
+  spec.test_files       = Dir['spec/**/*_spec.rb']
   spec.files            = Dir["**/*"].reject{ |f| f.include?('git') }
-  spec.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST']
+  spec.extra_rdoc_files = ['README.md', 'CHANGES.md', 'MANIFEST.md']
   spec.cert_chain       = Dir['certs/*']
+  spec.executables      = 'minirbgzip'
 
-  spec.add_development_dependency('test-unit', '>= 2.4.0')
-  spec.add_development_dependency('ruby-prof')
-
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.12')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/pr-zlib',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/pr-zlib/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/pr-zlib/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/pr-zlib/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/pr-zlib',
-    'wiki_uri'          => 'https://github.com/djberg96/pr-zlib/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/pr-zlib',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/pr-zlib/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/pr-zlib/blob/main/CHANGES',
+    'documentation_uri'     => 'https://github.com/djberg96/pr-zlib/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/pr-zlib',
+    'wiki_uri'              => 'https://github.com/djberg96/pr-zlib/wiki',
+    'rubygems_mfa_required' => 'true'
   }
-   
+
   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

data/profile/bench_pr_zlib.rb

@@ -7,7 +7,9 @@
 require 'pr/zlib'
 require 'benchmark'
 
-print "\n\n== Running the benchmarks for pr-zlib ==\n\n"
+MAX = 50
+
+print "\n\n== Running the benchmarks for pr-zlib using #{MAX} iterations ==\n\n"
 
 # First, let's create a ~7 MB text file.
 
@@ -23,7 +25,7 @@ end
 
 Benchmark.bm do |x|
   x.report("write") do
-    5.times{
+    MAX.times{
       Zlib::GzipWriter.open(GZ_FILE_NAME) do |gz|
         gz.write(File.read(FILE_NAME))
       end
@@ -31,7 +33,7 @@ Benchmark.bm do |x|
   end
 
   x.report("read") do
-    5.times{
+    MAX.times{
       Zlib::GzipReader.open(GZ_FILE_NAME) do |gz|
         gz.read
       end
@@ -39,5 +41,5 @@ Benchmark.bm do |x|
   end
 end
 
-File.delete(FILE_NAME) if File.exists?(FILE_NAME)
-File.delete(GZ_FILE_NAME) if File.exists?(GZ_FILE_NAME)
+File.delete(FILE_NAME) if File.exist?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exist?(GZ_FILE_NAME)

data/profile/bench_zlib.rb

@@ -7,7 +7,9 @@
 require 'zlib'
 require 'benchmark'
 
-print "\n\n== Running the benchmarks for zlib (stdlib) ==\n\n"
+MAX = 2000
+
+print "\n\n== Running the benchmarks for zlib (stdlib) using #{MAX} iterations ==\n\n"
 
 # First, let's create a ~7 MB text file.
 
@@ -23,7 +25,7 @@ end
 
 Benchmark.bm do |x|
   x.report("write") do
-    5.times{
+    MAX.times{
       Zlib::GzipWriter.open(GZ_FILE_NAME) do |gz|
         gz.write(File.read(FILE_NAME))
       end
@@ -31,7 +33,7 @@ Benchmark.bm do |x|
   end
 
   x.report("read") do
-    5.times{
+    MAX.times{
       Zlib::GzipReader.open(GZ_FILE_NAME) do |gz|
         gz.read
       end
@@ -39,5 +41,5 @@ Benchmark.bm do |x|
   end
 end
 
-File.delete(FILE_NAME) if File.exists?(FILE_NAME)
-File.delete(GZ_FILE_NAME) if File.exists?(GZ_FILE_NAME)
+File.delete(FILE_NAME) if File.exist?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exist?(GZ_FILE_NAME)

data/profile/profile_pr_zlib_read.rb

@@ -15,14 +15,14 @@ Zlib::GzipWriter.open(GZ_FILE_NAME){ |gz| gz.write(IO.read(FILE_NAME)) }
 
 require 'ruby-prof'
 
-result = RubyProf.profile do
+result = RubyProf::Profile.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)
+File.delete(FILE_NAME) if File.exist?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exist?(GZ_FILE_NAME)
 
 printer = RubyProf::FlatPrinter.new(result)
 printer.print(STDOUT)

data/profile/profile_pr_zlib_write.rb

@@ -13,14 +13,14 @@ end
 
 require 'ruby-prof'
 
-result = RubyProf.profile do
+result = RubyProf::Profile.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)
+File.delete(FILE_NAME) if File.exist?(FILE_NAME)
+File.delete(GZ_FILE_NAME) if File.exist?(GZ_FILE_NAME)
 
 printer = RubyProf::FlatPrinter.new(result)
 printer.print(STDOUT)

data/spec/README.md

@@ -0,0 +1,46 @@
+# RSpec Tests for pr-zlib
+
+This directory contains RSpec specifications for the pr-zlib library, converted from the original test-unit tests.
+
+## Running Tests
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run tests via rake
+bundle exec rake spec
+
+# Run specific test file
+bundle exec rspec spec/zlib_spec.rb
+
+# Run with documentation format
+bundle exec rspec --format documentation
+```
+
+## Test Structure
+
+- `spec_helper.rb` - Common RSpec configuration
+- `zlib_spec.rb` - Tests for the main Zlib module
+- `rbzlib_spec.rb` - Tests for the Rbzlib module
+- `rbzlib_bytef_spec.rb` - Tests for Rbzlib::Bytef class
+- `rbzlib_posf_spec.rb` - Tests for Rbzlib::Posf class
+- `zlib/` - Directory containing tests for Zlib subclasses
+  - `deflate_spec.rb` - Tests for Zlib::Deflate
+  - `inflate_spec.rb` - Tests for Zlib::Inflate
+  - `zstream_spec.rb` - Tests for Zlib::ZStream
+  - `gzip_file_spec.rb` - Tests for Zlib::GzipFile
+  - `gzip_reader_spec.rb` - Basic tests for Zlib::GzipReader
+  - `gzip_writer_spec.rb` - Basic tests for Zlib::GzipWriter
+
+## Conversion Notes
+
+The tests were converted from test-unit to RSpec format with the following changes:
+
+- `assert_equal(expected, actual)` → `expect(actual).to eq(expected)`
+- `assert_respond_to(object, method)` → `expect(object).to respond_to(method)`
+- `assert_raise(exception)` → `expect { }.to raise_error(exception)`
+- `assert_not_nil(value)` → `expect(value).not_to be_nil`
+- `assert_nothing_raised` → `expect { }.not_to raise_error`
+
+The basic interface tests have been preserved, though some complex file I/O tests for GzipReader and GzipWriter have been simplified to focus on the core interface verification.

data/spec/rbzlib/bytef_arr_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+########################################################################
+# bytef_arr_spec.rb
+#
+# Spec for the Rbzlib::Bytef_arr class.
+########################################################################
+require 'spec_helper'
+require 'pr/rbzlib/bytef_arr'
+
+RSpec.describe Rbzlib::Bytef_arr do
+  let(:buffer) { Array.new(32, 0) }
+  let(:bytef) { described_class.new(buffer) }
+
+  describe 'inheritance' do
+    it 'inherits from Bytef_str' do
+      expect(described_class.superclass).to eq(Rbzlib::Bytef_str)
+    end
+  end
+
+  describe 'array access' do
+    it 'responds to []' do
+      expect(bytef).to respond_to(:[])
+    end
+
+    it 'reads from the buffer' do
+      expect { bytef[0] }.not_to raise_error
+      expect(bytef[0]).to eq(0)
+    end
+
+    it 'responds to []=' do
+      expect(bytef).to respond_to(:[]=)
+    end
+
+    it 'writes to the buffer' do
+      expect { bytef[0] = 65 }.not_to raise_error
+      expect(bytef[0]).to eq(65)
+    end
+  end
+
+  describe '#get' do
+    it 'responds to get' do
+      expect(bytef).to respond_to(:get)
+    end
+
+    it 'gets the current value' do
+      expect(bytef.get).to eq(0)
+    end
+  end
+
+  describe '#set' do
+    it 'responds to set' do
+      expect(bytef).to respond_to(:set)
+    end
+
+    it 'sets the current value' do
+      expect { bytef.set(42) }.not_to raise_error
+      expect(bytef.get).to eq(42)
+    end
+  end
+
+  describe 'arithmetic operations' do
+    it 'responds to +' do
+      expect(bytef).to respond_to(:+)
+    end
+
+    it 'increments the offset' do
+      expect { bytef + 4 }.not_to raise_error
+      expect(bytef.offset).to eq(4)
+    end
+
+    it 'responds to -' do
+      expect(bytef).to respond_to(:-)
+    end
+
+    it 'decrements the offset' do
+      bytef + 8
+      bytef - 4
+      expect(bytef.offset).to eq(4)
+    end
+  end
+end

data/spec/rbzlib/bytef_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+########################################################################
+# bytef_spec.rb
+#
+# Spec for the Rbzlib::Bytef factory class.
+########################################################################
+require 'spec_helper'
+require 'pr/rbzlib/bytef'
+
+RSpec.describe Rbzlib::Bytef do
+  describe '.new' do
+    context 'with string buffer' do
+      let(:string_buffer) { +'hello world' }  # Make string mutable
+
+      it 'returns a Bytef_str instance' do
+        result = described_class.new(string_buffer)
+        expect(result).to be_a(Rbzlib::Bytef_str)
+      end
+
+      it 'initializes with the correct buffer' do
+        result = described_class.new(string_buffer)
+        expect(result.buffer).to eq(string_buffer)
+      end
+
+      it 'initializes with default offset 0' do
+        result = described_class.new(string_buffer)
+        expect(result.offset).to eq(0)
+      end
+
+      it 'initializes with custom offset' do
+        result = described_class.new(string_buffer, 5)
+        expect(result.offset).to eq(5)
+      end
+    end
+
+    context 'with array buffer' do
+      let(:array_buffer) { [65, 66, 67, 68, 69] }
+
+      it 'returns a Bytef_arr instance' do
+        result = described_class.new(array_buffer)
+        expect(result).to be_a(Rbzlib::Bytef_arr)
+      end
+
+      it 'initializes with the correct buffer' do
+        result = described_class.new(array_buffer)
+        expect(result.buffer).to eq(array_buffer)
+      end
+
+      it 'initializes with default offset 0' do
+        result = described_class.new(array_buffer)
+        expect(result.offset).to eq(0)
+      end
+
+      it 'initializes with custom offset' do
+        result = described_class.new(array_buffer, 3)
+        expect(result.offset).to eq(3)
+      end
+    end
+
+    context 'factory behavior' do
+      it 'creates appropriate instance based on buffer type' do
+        string_result = described_class.new(+'test')  # Make string mutable
+        array_result = described_class.new([1, 2, 3])
+
+        expect(string_result.class).not_to eq(array_result.class)
+        expect(string_result).to be_a(Rbzlib::Bytef_str)
+        expect(array_result).to be_a(Rbzlib::Bytef_arr)
+      end
+    end
+  end
+end

data/spec/rbzlib/bytef_str_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+########################################################################
+# bytef_str_spec.rb
+#
+# Spec for the Rbzlib::Bytef_str class.
+########################################################################
+require 'spec_helper'
+require 'pr/rbzlib/bytef_str'
+
+RSpec.describe Rbzlib::Bytef_str do
+  let(:buffer) { 0.chr * 32 }
+  let(:bytef) { described_class.new(buffer) }
+
+  describe '#buffer' do
+    it 'responds to buffer getter' do
+      expect(bytef).to respond_to(:buffer)
+    end
+
+    it 'returns the buffer' do
+      expect(bytef.buffer).to eq(buffer)
+    end
+
+    it 'responds to buffer setter' do
+      expect(bytef).to respond_to(:buffer=)
+    end
+
+    it 'sets the buffer' do
+      new_buffer = 0.chr * 8
+      expect { bytef.buffer = new_buffer }.not_to raise_error
+      expect(bytef.buffer).to eq(new_buffer)
+    end
+  end
+
+  describe '#length' do
+    it 'responds to length' do
+      expect(bytef).to respond_to(:length)
+    end
+
+    it 'returns the correct length' do
+      expect(bytef.length).to eq(32)
+    end
+  end
+
+  describe 'arithmetic operations' do
+    it 'responds to +' do
+      expect(bytef).to respond_to(:+)
+    end
+
+    it 'increments the offset' do
+      expect { bytef + 4 }.not_to raise_error
+      expect(bytef.offset).to eq(4)
+    end
+
+    it 'responds to -' do
+      expect(bytef).to respond_to(:-)
+    end
+
+    it 'decrements the offset' do
+      bytef + 8
+      bytef - 4
+      expect(bytef.offset).to eq(4)
+    end
+  end
+
+  describe 'array access' do
+    it 'responds to []' do
+      expect(bytef).to respond_to(:[])
+    end
+
+    it 'reads from the buffer' do
+      expect { bytef[0] }.not_to raise_error
+    end
+
+    it 'responds to []=' do
+      expect(bytef).to respond_to(:[]=)
+    end
+
+    it 'writes to the buffer' do
+      expect { bytef[0] = 'A' }.not_to raise_error
+    end
+  end
+
+  describe '#get' do
+    it 'responds to get' do
+      expect(bytef).to respond_to(:get)
+    end
+
+    it 'gets the current value' do
+      expect { bytef.get }.not_to raise_error
+    end
+  end
+
+  describe '#set' do
+    it 'responds to set' do
+      expect(bytef).to respond_to(:set)
+    end
+
+    it 'sets the current value' do
+      expect { bytef.set('A') }.not_to raise_error
+    end
+  end
+
+  describe '#current' do
+    it 'responds to current' do
+      expect(bytef).to respond_to(:current)
+    end
+
+    it 'returns the current buffer' do
+      expect(bytef.current).to eq(buffer)
+    end
+  end
+end

data/spec/rbzlib/posf_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+########################################################################
+# posf_spec.rb
+#
+# Spec for the Rbzlib::Posf class.
+########################################################################
+require 'spec_helper'
+require 'pr/rbzlib/posf'
+
+RSpec.describe Rbzlib::Posf do
+  let(:buffer) { 0.chr * 32 }
+  let(:posf) { described_class.new(buffer) }
+
+  describe 'inheritance' do
+    it 'inherits from Bytef_str' do
+      expect(described_class.superclass).to eq(Rbzlib::Bytef_str)
+    end
+  end
+
+  describe 'arithmetic operations' do
+    it 'responds to +' do
+      expect(posf).to respond_to(:+)
+    end
+
+    it 'increments the offset by 2x the value' do
+      expect { posf + 4 }.not_to raise_error
+      expect(posf.offset).to eq(8)
+    end
+
+    it 'responds to -' do
+      expect(posf).to respond_to(:-)
+    end
+
+    it 'decrements the offset by 2x the value' do
+      expect { posf - 4 }.not_to raise_error
+      expect(posf.offset).to eq(-8)
+    end
+  end
+
+  describe 'array access' do
+    it 'responds to []' do
+      expect(posf).to respond_to(:[])
+    end
+
+    it 'reads from the buffer' do
+      expect { posf[2] }.not_to raise_error
+      expect(posf[2]).to eq(0)
+    end
+
+    it 'responds to []=' do
+      expect(posf).to respond_to(:[]=)
+    end
+
+    it 'writes to the buffer' do
+      expect { posf[2] = 7 }.not_to raise_error
+      expect(posf[2]).to eq(7)
+      expect(posf.buffer[4, 2]).to eq("\a\000")
+    end
+  end
+
+  describe '#get' do
+    it 'responds to get' do
+      expect(posf).to respond_to(:get)
+    end
+
+    it 'gets the current value' do
+      expect { posf.get }.not_to raise_error
+      expect(posf.get).to eq(0)
+    end
+  end
+
+  describe '#set' do
+    it 'responds to set' do
+      expect(posf).to respond_to(:set)
+    end
+
+    it 'sets the current value' do
+      expect { posf.set(4) }.not_to raise_error
+      expect(posf.buffer[0, 2]).to eq("\004\000")
+    end
+  end
+end