zstdlib 0.13.0-x86-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fb52ee73594a2ce8766f1974754e68454c30c07684cc7f4272350add6b90427
+  data.tar.gz: 90b580f359534445b8cfcdabfc63c38e1795b1f8b551514a6ced1fe6b8d950cf
+SHA512:
+  metadata.gz: 02d9a4103d519b739781d9148fdc5face963753c02ea4d1411ae1695a6f00420a9796192fca01934e47f1f133bbee98f1aa5b4798dade17953ddc99866a211d4
+  data.tar.gz: cb6e4d70dc53e94111e416d6043c1df8a0204176b1e42873ebc754222ffc15705dbff59302df4776a0ba5f8061ab230db4bfe551f3408df6ec74191ed54efdd4

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--readme README.md
+-m markdown
+-
+*.md

data/CHANGES.md

@@ -0,0 +1,107 @@
+# 0.13.0
+
+Updated Zstd to `1.5.6`
+
+Upgraded rake-compiler-dock to `1.5.0`
+
+
+# 0.12.0
+
+Updated Zlib to `1.3.1`
+
+Added support for MRI Ruby version `3.3`
+
+Upgraded rake-compiler-dock to `1.4.0`
+
+
+# 0.11.0
+
+Updated Zstd to `1.5.5`
+
+Added support for MRI Ruby version `3.2`
+
+
+# 0.10.0
+
+Updated Zlib to `1.2.12`
+
+
+# 0.9.0
+
+Updated Zstd to `1.5.2`
+
+Added support for MRI Ruby versions `3.0-3.1`
+
+Upgraded rake-compiler-dock to `1.2.0`
+
+Implemented deployment of system-specific compiled gems for for x32/x64 Windows and x64/ARM64 MacOS platforms
+
+
+# 0.8.0
+
+Zstd version update to `1.5.0`
+
+
+# 0.7.0
+
+Zstd version update to `1.4.5`
+
+
+# 0.6.0
+
+Added support for MRI Ruby version `2.7`
+
+Upgraded rake-compiler-dock to `1.0.0`
+
+
+# 0.5.0
+
+Zstd version update to `1.4.4`
+
+
+# 0.4.0
+
+Zstd version update to `1.4.3`
+
+Relocated to GitHub.
+
+
+# 0.3.0
+
+Zstd version update to `1.4.2`
+
+
+# 0.2.0
+
+Zstd version update to `1.4.0`
+
+Documentation updates.
+
+
+# 0.1.2
+
+Implemented `Zstdlib::ZSTD_VERSION` constant and `Zstdlib.zstd_version` module method for Zstd version retrieval.
+ 
+Documentation updates.
+
+
+# 0.1.1
+
+Pick up the most recent compatible source for _zstdlib_ Ruby extension module instead of target Ruby version.
+
+Replaced (most) references to `Zlib` with `Zstdlib` within extractable documentation.
+
+Fixed a few missing methods on Ruby side.
+
+Documentation updates.
+
+
+# 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,107 @@
+# [Zstdlib](https://github.com/okhlybov/zstdlib) - a Zstandard data 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` class can be decompressed with standard _zstd_ utility and hence can be written to _.zst_ or _.zstd_ files.
+Conversely, the `Zstdlib::Inflate` class can handle data from such 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.
+
+There exist `Zstdlib::ZSTD_VERSION` constant and `Zstdlib.zstd_version` module method which can be used to obtain shipped Zstd library version.
+
+
+### 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 [GitHub](https://github.com/okhlybov/zstdlib).
+
+Source code and system-specific compiled gems can be obtained from [rubygems.org](https://rubygems.org/gems/zstdlib).
+
+The system-specific gems are currently provided for x32/x64 Windows and x64/ARM64 MacOS platforms.
+
+Note that these gems are built with the [rake-compiler-dock](https://github.com/rake-compiler/rake-compiler-dock)
+infrastructure the minimum supported Ruby version is raised to 2.4.
+All other installations including Linux will use the source gem and hence require the compilation step with locally installed development tools.
+
+## Release history
+
+For user-visible changes refer to [change log](CHANGES.md).
+
+## Caveats
+
+This module is in testing phase so things beyond basic interface might not work as expected. 
+
+Documentation extracted from _zstdlib_ still contains traces of old zlib-related pieces.
+Just keep this in mind and substitute *zlib* with *zstdlib* upon browsing.
+
+Gzip _.gz_ file 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](mailto:fougas@mail.ru)>

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+require 'rake_compiler_dock'
+
+
+spec = Gem::Specification.load('zstdlib.gemspec')
+
+
+platforms = %w[x86-mingw32 x64-mingw-ucrt x64-mingw32 x86-linux x86_64-linux x86_64-darwin arm64-darwin]
+
+
+Rake::ExtensionTask.new('zstdlib_c', spec) do |t|
+  t.cross_compile = true
+  t.cross_platform = platforms
+  t.cross_config_options << '--enable-cross-build'
+end
+
+
+namespace "gem" do
+  platforms.each do |platform|
+    desc "build native gem for #{platform}"
+    # This runs on a host
+    task platform do
+      RakeCompilerDock.sh(<<~EOF, platform: platform)
+        gem install bundler --no-document &&
+        bundle &&
+        bundle exec rake gem:#{platform}:buildit
+      EOF
+    end
+
+    namespace platform do
+      # This runs in the rake-compiler-dock docker container
+      task "buildit" do
+        # Use Task#invoke because the pkg/*gem task is defined at runtime
+        Rake::Task["native:#{platform}"].invoke
+        Rake::Task["pkg/#{spec.full_name}-#{Gem::Platform.new(platform)}.gem"].invoke
+      end
+    end
+  end
+
+  #
+  desc "build native gem for all platforms"
+  multitask 'all' => platforms
+
+end
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+
+Gem::PackageTask.new(spec)
+
+
+# Build system explained: https://github.com/flavorjones/ruby-c-extensions-explained/tree/main/precompiled

data/ext/zstdlib_c/extconf.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'mkmf'
+require 'fileutils'
+
+include RbConfig
+include FileUtils
+
+ZSTD_VERSION = '1.5.6'
+ZLIB_VERSION = '1.3.1'
+
+RB_VERSION = CONFIG['MAJOR']+'.'+CONFIG['MINOR']
+
+# Review requirements with every new zlib module release!
+ZMOD_VERSION =  if    RB_VERSION >= '2.5' then '3.3'
+                elsif RB_VERSION >= '2.3' then '3.2'
+                else  RB_VERSION
+                end
+
+# For cross compiling
+ENV['CC'] = RbConfig::CONFIG['CC']
+ENV['LD'] = RbConfig::CONFIG['LD']
+
+root = File.dirname(__FILE__)
+
+zmod = File.expand_path "ruby/zlib-#{ZMOD_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
+
+cp "#{zmod}/zstdlib.c", 'zstdlib.c'
+
+$srcs = ['zstdlib.c']
+
+$CFLAGS += ' -fomit-frame-pointer -ffast-math -O3'
+$CPPFLAGS += " -I#{zlib} -I#{zlibwrapper} -I#{zstd} -DZWRAP_USE_ZSTD=1 -DGZIP_SUPPORT=1"
+$LDFLAGS += ' -s'
+$LOCAL_LIBS += ' libzlibwrapper.a libz.a libzstd.a'
+
+create_makefile('zstdlib_c')
+
+File.open('Makefile', 'a') do |file|
+file << %~
+
+export CC LD 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