zstdlib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f25b2a7a2fca87d9f2c1535a4db8814a56b6a49f01f229b18cc4d325295b22ba
+  data.tar.gz: 33ae1662723246dcc7c06b880672b207793127e26a2c810040df11c363cc8ae0
+SHA512:
+  metadata.gz: ae05dbeea9f18383ddeddc11cf307a1e213f87e8c88ca15abd2307fb4c65d0accd8c8ec0bfedd34c4db0f9a5dc87d43c3530e3509849ed20a5af27d251cebb2a
+  data.tar.gz: a6adf1db64a16c97e17ed69c07f6971cda51a501f076db87f36517a89e333824c7eec4bcce3f3656948ed84a8d2d77792a27c927c9f314ab11e3d241e21c094b

data/CHANGES.md

@@ -0,0 +1,9 @@
+# 0.1.0
+
+Initial release.
+
+Zstd version: `1.3.8`
+
+Zlib version: `1.2.11`
+
+Supported MRI Ruby versions: `2.2-2.6`

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# [Zstdlib](https://bitbucket.org/fougas/zstdlib) - a Zstd (de)compression library binding for Ruby
+
+_zstdlib_ is native Ruby extension for [Zstandard](https://facebook.github.io/zstd/) data compression library.
+
+_zstdlib_ is currently available for the [MRI Ruby](https://www.ruby-lang.org/) platform.
+
+## Why bother?
+
+Unlike the other Zstd bindings available for Ruby, *Zstdlib* utilizes Zstd's native *Zlib* compatibility layer. 
+
+This specifically means that `Zstdlib` module is and will be (mostly)  API-compatible with standard Ruby `Zlib` module and thus _zstdlib_ can be used as a drop-in replacement for _zlib_: just replace `Zlib` with `Zstdlib` throughout the source code and you're in!
+
+Streams produced by `Zstdlib::Deflate` can be decompressed with standard _zstd_ utility and hence can be written to _.zst_ or _.zstd_ files.
+
+## Use cases
+
+### Simple string compression
+````ruby
+require 'zstdlib'
+data = Zstdlib.deflate('Hello, Zstd!')
+````
+
+### Incremental data compression
+````ruby
+require 'zstdlib'
+zstd = Zstdlib::Deflate.new
+data = String.new
+data << zstd.deflate('Hello')
+data << zstd.deflate('Zstd')
+data << zstd.finish
+````
+
+### Simple string decompression
+````ruby
+require 'zstdlib'
+data = Zstdlib.inflate(compressed_data)
+````
+
+## Technical notes
+
+_zstdlib_ covers the following parts of _zlib_:
+
+- `ZStream`, `Inflate` and `Deflate` classes
+- Various `Zlib::` constants (`DEFAULT_COMPRESSION` etc.)
+- `Zlib::` exception classes (`Error` and its descendants)
+
+Note that _zstdlib_ currently omits Gzip file support with its `GzipFile`, `GzipReader` and `GzipWriter` classes
+and associated constants although this may be changed in future.
+
+### General guidelines
+
+In order to enable Zstd (de)compression capability in existing code, simply replace _zlib_ with _zstdlib_ in require statements and
+`Zlib` with `Zstdlib` module references throughout the code.
+
+The rest of the _zlib_-aware code should work unchanged.
+
+For further information refer to documentation on _zlib_ .
+                                            
+
+### Notes on compression levels
+
+If unsure do not pass anything to constructor in order to use `DEFAULT_COMPRESSION` level which works for both _zlib_ ans _zstdlib_.
+
+Contrary to _zlib_ the `NO_COMPRESSION` constant in _zstdlib_ is an equivalent to `BEST_SPEED` as Zstd always compresses data.
+
+The `BEST_COMPRESSION` constant is adjusted to reflect Zstd-specific compression level range.
+Anyways this level is recommended against due to abysmal performance not to be expected from the *fast* state-of-the-art compression algorithm. 
+The Zstd documentation (currently) recommends using *19* as the level for optimal *best* compression.
+
+The `BEST_SPEED` constant remains unchanged.
+
+## Availability
+
+_zstdlib_ home page on [bitbucket.org](https://bitbucket.org/fougas/zstdlib).
+
+Source code and Windows-specific multi-versioned binary gems can be obtained from [rubygems.org](https://rubygems.org/gems/zstdlib).
+
+## Release history
+
+For user-visible changes refer to [change log](CHANGES.md).
+
+## Caveats
+
+Ruby documentation  extraction tools (such as RDoc) produce incorrect documentation for _zstdlib_
+which is technically valid but contains all identifies referring to _zlib_.
+This may change in future.
+
+Gzip support, although available in Zstd's Zlib compatibility layer, is currently disabled.
+
+Zstd's external compression dictionaries capability is not (yet) implemented.
+
+# The end
+
+Cheers,
+
+Oleg A. Khlybov <fougas@mail.ru>

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+
+
+spec = Gem::Specification.load('zstdlib.gemspec')
+
+
+Rake::ExtensionTask.new('zstdlib', spec) do |t|
+  t.cross_compile = true
+  t.cross_platform = %w(x86-mingw32 x64-mingw32)
+end
+
+
+Gem::PackageTask.new(spec)
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+
+task :fat do
+  require 'rake_compiler_dock'
+  sh 'bundle package'
+  RakeCompilerDock.sh 'bundle --local && rake cross native gem'
+end

data/ext/zstdlib/extconf.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'mkmf'
+require 'fileutils'
+
+include FileUtils
+
+ZSTD_VERSION = '1.3.8'
+ZLIB_VERSION = '1.2.11'
+RB_VERSION = Gem.ruby_api_version.slice(/^\d+\.\d+/)
+
+root = File.dirname(__FILE__)
+
+zmod = File.expand_path "ruby/zlib-#{RB_VERSION}", root
+zlib = File.expand_path "zlib-#{ZLIB_VERSION}", root
+zstd = File.expand_path "zstd-#{ZSTD_VERSION}/lib", root
+zlibwrapper = File.expand_path "zstd-#{ZSTD_VERSION}/zlibWrapper", root
+
+File.open('zstdlib.c', 'w') do |file|
+  file << File.read("#{zmod}/zlib.c").
+    gsub(/Init_zlib/, 'Init_zstdlib').
+    gsub(/rb_define_module.*/, 'rb_define_module("Zstdlib");').
+    gsub(%~<zlib.h>~, %~<zstd_zlibwrapper.h>~).
+    gsub(%~Z_BEST_COMPRESSION~, %~ZSTD_maxCLevel()~)
+end
+
+$srcs = ['zstdlib.c']
+
+$CFLAGS += ' -fomit-frame-pointer -ffast-math -O3'
+$CPPFLAGS += " -I#{zlib} -I#{zlibwrapper} -I#{zstd}/lib -DZWRAP_USE_ZSTD=1 -DGZIP_SUPPORT=0"
+$LDFLAGS += ' -s'
+$LOCAL_LIBS += ' libzlibwrapper.a libz.a libzstd.a'
+
+create_makefile('zstdlib')
+
+File.open('Makefile', 'a') do |file|
+file << %~
+
+export CC AR CFLAGS CPPFLAGS
+
+$(DLLIB) : libz.a libzstd.a libzlibwrapper.a
+
+libzstd.a :
+\texport SRCDIR=#{zstd} && mkdir -p zstd && $(MAKE) -C zstd -f #{File.expand_path root}/zstd.mk
+
+libz.a :
+\texport SRCDIR=#{zlib} && mkdir -p zlib && $(MAKE) -C zlib -f #{File.expand_path root}/zlib.mk
+
+libzlibwrapper.a :
+\texport SRCDIR=#{zlibwrapper} && mkdir -p zlibwrapper && $(MAKE) -C zlibwrapper -f #{File.expand_path root}/zlibwrapper.mk
+
+~
+end