pr-zlib 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884faa312813258452c180d7b246e02d3d373b79d5990c7aed19d66c4280db5d
-  data.tar.gz: dfffc0fd870fc104809938535c89c6a65be8612c607c930c261386b972f741bf
+  metadata.gz: cde92bf4908555ba88f41b5c5e21634008c87aa817d1630eb33f153ad9bb9e19
+  data.tar.gz: 70418f20d59f855af6ac56a85959f09a68ce03e72ecbcb76a5b869accbf026a1
 SHA512:
-  metadata.gz: 0c947923f7ca9f1f73a677774d4820ecbce39e6c059ecd1987c15ee47a5c7fad58e797ec0628e984a27157cc771c5cc6780af0f1ce4c25a988a8666c216f2c4d
-  data.tar.gz: 66bde3b05ad77c5ad8dc45ea4c38b414ce315735c3453cf08dcdd35409e2d8f3965cc576db31a2233668182ade1118e5bffcb22e11b0a71e7db3e34b5c4a269b
+  metadata.gz: 704e0d45e29f0199f7b1dc627a8670900de6b93303dcc324ca25c9607b5d7e9e41ee78e2aee12d2e7f6c56771d3a634b0e6d87185a5b055c3bce23ae77a9d7fc
+  data.tar.gz: 29a6adb5f8fd1ee0afa422a39f20d00d9d907db56e09641426d5f20b98c7a06096566e8a3ec1a369226fc06c27c6239cd94edce6b8fc16c786beb5adf59bd00e

data/{CHANGES → CHANGES.md}

@@ -1,11 +1,17 @@
-= 1.0.6 - 19-Mar-2018
+## 1.1.0 - 30-Aug-2025
+* Fixed several critical bugs.
+* Many Ruby and Rubocop warnings cleaned up.
+* Tests now use rspec instead of test-unit.
+* Lots of cleanup, reorganization and general refactoring.
+
+## 1.0.6 - 19-Mar-2018
 * Added the minirbgzip executable, a Ruby implementation of minigzip.
   Formerly minigzip.rb, this had been part of the repo but had never been
   released with the gem.
 * Some minor updates and fixes to the minirbgzip executable.
 * Metadata fix for changelog_uri.
 
-= 1.0.5 - 18-Mar-2018
+## 1.0.5 - 18-Mar-2018
 * Set the frozen_string_literal pragma, which gives us a small performance
   boost for reads.
 * Removed the custom Fixnum#ord method.
@@ -13,12 +19,12 @@
 * Added metadata to the gemspec plus some other minor updates.
 * Updated cert.
 
-= 1.0.4 - 15-Nov-2016
+## 1.0.4 - 15-Nov-2016
 * Fixed an endian bug. Thanks go to Benoit Daloze for the patch.
 * The version constants are now frozen (and fixed the version number).
 * Updated the cert.
 
-= 1.0.3 - 3-Dec-2015
+## 1.0.3 - 3-Dec-2015
 * Added a license. This library is now covered under the zlib license.
 * Some performance tuning. Reads are 2-3 times faster, while writes are
   about twenty percent faster.
@@ -28,10 +34,10 @@
 * More stringent value and limit checking added. Thanks go to
   Chris Seaton for the patches.
 
-= 1.0.2 - 24-Jun-2015
+## 1.0.2 - 24-Jun-2015
 * Fixed a marshalling issue.
 
-= 1.0.1 - 16-Oct-2014
+## 1.0.1 - 16-Oct-2014
 * Added benchmark and profiler scripts and rake tasks.
 * Switched profiling scripts to use ruby-prof.
 * The test-unit and ruby-prof libraries are now development dependencies.
@@ -39,5 +45,5 @@
 * Some minor test suite updates, mostly for 1.9.3.
 * Updated the gemspec, removed Rubyforge references.
 
-= 1.0.0 - 12-Jun-2009
+## 1.0.0 - 12-Jun-2009
 * Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "ruby-prof", :platforms => [:mri, :truffleruby]
+gem "jruby-prof", :platforms => :jruby
+
+gemspec

data/MANIFEST.md

@@ -0,0 +1,20 @@
+* CHANGES.md
+* MANIFEST.md
+* README.md
+* pr-zlib.gemspec
+* bin/minirbgzip
+* certs/djberg96_pub.pem
+* examples/example_rbzlib.rb
+* lib/pr-zlib.rb
+* lib/pr/rbzlib.rb
+* lib/pr/zlib.rb
+* test/test_rbzlib_bytef.rb
+* test/test_rbzlib_posf.rb
+* test/test_rbzlib.rb
+* test/test_zlib_deflate.rb
+* test/test_zlib_gzip_file.rb
+* test/test_zlib_gzip_reader.rb
+* test/test_zlib_gzip_writer.rb
+* test/test_zlib_inflate.rb
+* test/test_zlib_zstream.rb
+* test/test_zlib.rb

data/{README → README.md}

@@ -1,19 +1,25 @@
-= Description
+## Description
 The pr-zlib library is a pure Ruby version of the zlib compression library.
 It consists of both a port of zlib.h and the Ruby zlib library that ships as
 part of the standard library.
 
-= Synopsis
+## Installation
+`gem install pr-zlib`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/pr-zlib/main/certs/djberg96_pub.pem)`
+
+## Synopsis
+```ruby
 # Imitating a bit of code used in rubygems
 require 'pr/zlib'
 require 'stringio'
 
 data = StringIO.new(data)
 Zlib::GzipReader.new(data).read
+```
 
-= Motivation
-
+## Motivation
 First, building the zlib C library on MS Windows with Visual C++ is very
 difficult. However, certain libraries depend on zlib, most notably rubygems.
 By providing a pure Ruby version we eliminate any compiler or platform
@@ -32,21 +38,32 @@ Last, the zlib interface that ships as part of the stdlib is a little on the
 clunky side. By providing a pure Ruby version, authors can create their own
 interface as they see fit.
 
-= TODO
+Update August 2025: Most of the original motivation for this library is no
+longer relevant today. Desktop users of MS Windows typically use the one-click
+installer which bundles the shared objects it needs. In the land of Unix, where
+most actual production code happens, folks use Docker images for Ruby which
+either already bundles everything, or they just add it to their Dockerfile.
+
+But, hey, I paid for this and it works. Who knows, maybe it'll be nice to have
+around someday.
+
+## Origins
+This library was the result of a small code bounty that I (Daniel Berger) funded:
 
+https://rubytalk.org/t/bounty-pure-ruby-zlib-gzipwriter/50730
+
+## TODO
 More tests, and better tests, are needed for both Rbzlib and Zlib.
 
-= Caveats
+## Caveats
 You cannot use both this library and the zlib standard library at the same
 time. If you try to use both there is a good chance you will get an allocation
 error of some sort. If you already have zlib, you do not need this library.
 
-= License
-
+## License
 This library is covered under the same license as zlib itself. For the text
 of the zlib license, please see http://zlib.net/zlib_license.html.
 
-= Authors
-
-* Park Heesob (C translation)
-* Daniel Berger (Testing, packaging, deployment)
+## Authors
+* Park Heesob (Original C translation)
+* Daniel Berger (Testing, packaging, deployment, maintenance)

data/Rakefile

@@ -1,9 +1,9 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 require 'rbconfig'
 
-CLEAN.include("**/*.rbc", "**/*.gem", "**/*.txt", "**/*.gz")
+CLEAN.include("**/*.rbc", "**/*.gem", "**/*.txt", "**/*.gz", "**/*.lock")
 
 desc 'Install the pr-zlib library as zlib'
 task :install_as_zlib do
@@ -20,7 +20,7 @@ namespace :gem do
     require 'rubygems/package'
     spec = eval(IO.read('pr-zlib.gemspec'))
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc 'Install the pr-zlib gem'
@@ -54,63 +54,13 @@ namespace :profile do
   end
 end
 
-Rake::TestTask.new do |t|
-  t.warning = true
-  t.verbose = true
+# RSpec tests
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ['--format', 'documentation', '--color']
 end
 
-Rake::TestTask.new('test_zlib') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_zlib.rb']
-end
-
-Rake::TestTask.new('test_gzip_file') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_zlib_gzip_file.rb']
-end
-
-Rake::TestTask.new('test_gzip_reader') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_zlib_gzip_reader.rb']
-end
-
-Rake::TestTask.new('test_gzip_writer') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_zlib_gzip_writer.rb']
-end
-
-Rake::TestTask.new('test_deflate') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_zlib_deflate.rb']
-end
-
-Rake::TestTask.new('test_inflate') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_zlib_inflate.rb']
-end
-
-Rake::TestTask.new('test_rbzlib') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_rbzlib.rb']
-end
-
-Rake::TestTask.new('test_rbzlib_bytef') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_rbzlib_bytef.rb']
-end
-
-Rake::TestTask.new('test_rbzlib_posf') do |t|
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_rbzlib_posf.rb']
-end
+desc 'Run all RSpec tests'
+task :test => :spec
 
-task :default => :test
+task :default => :spec

data/bin/minirbgzip

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 # minigzip -- simulate gzip using the zlib compression library
 # Copyright (C) 1995-2005 Jean-loup Gailly.
 # For conditions of distribution and use, see copyright notice in rbzlib.rb
@@ -12,7 +14,7 @@
 #
 # minigzip to minirbgzip Ruby translation By Park Heesob.
 
-require 'pr-zlib'
+require_relative '../lib/pr-zlib'
 include Rbzlib
 
 GZ_SUFFIX = ".gz"
@@ -147,7 +149,7 @@ end
           -f : compress with Z_FILTERED
           -h : compress with Z_HUFFMAN_ONLY
           -r : compress with Z_RLE
-          -1 to -9 : compression level 
+          -1 to -9 : compression level
         HERE
         puts help
         exit!

data/lib/pr/rbzlib/bytef.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'bytef_str'
+require_relative 'bytef_arr'
+
+module Rbzlib
+  class Bytef
+    def self.new(buffer, offset = 0)
+      if buffer.class == Array
+        Bytef_arr.new(buffer, offset)
+      else
+        Bytef_str.new(buffer, offset)
+      end
+    end
+  end
+end

data/lib/pr/rbzlib/bytef_arr.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'bytef_str'
+
+module Rbzlib
+  class Bytef_arr < Bytef_str
+
+    def initialize(buffer, offset = 0)
+      @buffer = buffer
+      @offset = offset
+    end
+
+    def [](idx)
+      @buffer[idx + @offset]
+    end
+
+    def []=(idx, val)
+      @buffer[idx + @offset] = val
+    end
+
+    def get
+      @buffer[@offset]
+    end
+
+    def set(val)
+      @buffer[@offset] = val
+    end
+  end
+end

data/lib/pr/rbzlib/bytef_str.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rbzlib
+  class Bytef_str
+    attr_accessor :buffer, :offset
+
+    def initialize(buffer, offset = 0)
+      if buffer.class == String
+        @buffer = buffer
+        @offset = offset
+        @buffer.force_encoding('ASCII-8BIT')
+      else
+        @buffer = buffer.buffer
+        @offset = offset
+      end
+    end
+
+    def length
+      @buffer.length
+    end
+
+    def +(inc)
+      @offset += inc
+      self
+    end
+
+    def -(dec)
+      @offset -= dec
+      self
+    end
+
+    def [](idx)
+      @buffer.getbyte(idx + @offset)
+    end
+
+    def []=(idx, val)
+      @buffer.setbyte(idx + @offset, val.ord)
+    end
+
+    def get
+      @buffer.getbyte(@offset)
+    end
+
+    def set(val)
+      @buffer.setbyte(@offset, val.ord)
+    end
+
+    def current
+      @buffer[@offset..-1]
+    end
+  end
+end

data/lib/pr/rbzlib/posf.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'bytef_str'
+
+module Rbzlib
+  class Posf < Bytef_str
+    def +(inc)
+      @offset += inc * 2
+      self
+    end
+
+    def -(dec)
+      @offset -= dec * 2
+      self
+    end
+
+    def [](idx)
+      @buffer[(idx * 2) + @offset, 2].unpack('v').first
+    end
+
+    def []=(idx, val)
+      @buffer[(idx * 2) + @offset, 2] = [val].pack('v')
+    end
+
+    def get
+      @buffer[@offset, 2].unpack('v').first
+    end
+
+    def set(val)
+      @buffer[@offset, 2] = [val].pack('v')
+    end
+  end
+end