compress-bsc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6bb538b17954a08da49b2b72664330e47c044d921cb5f5fbf8fcbf35b15f901
+  data.tar.gz: 723c26400539bc91dc0e290706f672908ea6af8e654641a8c5f1d1f73585a6ee
+SHA512:
+  metadata.gz: f888361c887e1da90ee5a0dd70a44e35cdb7532ee0580d1d5e0ad46490618cdb77b2a139eb9f07feb6407ebba1c2be6026ceacdb344a3850abeec43215cacae5
+  data.tar.gz: 581f874b1e6eb9923a113e86a788c33af70ecb84a0747754772db355c1a90c1cd6312444af0fb49a9cd24f05714ecf4e705e85a1bbe31cb4154af732289796db

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0 - 19-Jul-2025
+* Initial release.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communications that are posted to public
+      discussions, are filed in support of a separate claim or are posted
+      to the License.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, distribute, sublicense,
+      and/or sell copies of the Work, and to permit persons to whom the
+      Work is furnished to do so, subject to the following conditions:
+
+      The above copyright notice and this permission notice shall be
+      included in all copies or substantial portions of the Work.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, trademark, patent,
+          and attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. You may choose to offer, and to
+      charge a fee for, warranty, support, indemnity or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and on
+      Your sole responsibility, not on behalf of any other Contributor, and
+      only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 compress-bsc Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,279 @@
+# compress-bsc
+
+A Ruby interface to the [libbsc](https://github.com/IlyaGrebnov/libbsc) high-performance block-sorting compression library using FFI.
+
+## Features
+
+- Fast block-sorting compression and decompression
+- Multiple compression algorithms (BWT, ST3-ST8)
+- LZP (Lempel-Ziv-Prediction) preprocessing for improved compression
+- Multi-threading support
+- Memory-efficient streaming for large files
+- Command-line interface
+- Comprehensive error handling
+- Object-oriented and functional APIs
+
+## Installation
+
+First, install the libbsc library. On macOS with Homebrew:
+
+```bash
+brew install libbsc
+```
+
+On Ubuntu/Debian:
+
+```bash
+sudo apt-get install libbsc-dev
+
+# or, if not available
+
+apt-get install -y build-essential cmake
+git clone https://github.com/IlyaGrebnov/libbsc
+cd libbsc
+cmake -DBSC_BUILD_SHARED_LIB=ON .
+make
+make install
+```
+
+Then add this line to your application's Gemfile:
+
+```ruby
+gem 'compress-bsc'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install compress-bsc
+```
+
+## Usage
+
+### Simple API
+
+```ruby
+# You can require the library in either of these ways:
+require 'compress/bsc'
+# or
+require 'compress-bsc'
+
+# Initialize the library with default features (fast mode + multithreading)
+bsc = Compress::BSC.new
+
+# Initialize with custom features
+bsc_fast = Compress::BSC.new(features: Compress::BSC::Library::LIBBSC_FEATURE_FASTMODE)
+
+# Initialize with multiple features
+bsc_custom = Compress::BSC.new(
+  features: Compress::BSC::Library::LIBBSC_FEATURE_FASTMODE |
+            Compress::BSC::Library::LIBBSC_FEATURE_MULTITHREADING |
+            Compress::BSC::Library::LIBBSC_FEATURE_LARGEPAGES
+)
+
+# Compress data
+original = "Hello, World!" * 1000
+compressed = bsc.compress(original)
+puts "Compressed #{original.length} bytes to #{compressed.length} bytes"
+
+# Decompress data
+decompressed = bsc.decompress(compressed)
+puts decompressed == original # => true
+```
+
+### Available Features
+
+The BSC library can be initialized with different feature combinations:
+
+- `LIBBSC_FEATURE_NONE` - No special features
+- `LIBBSC_FEATURE_FASTMODE` - Enable fast mode for faster compression/decompression
+- `LIBBSC_FEATURE_MULTITHREADING` - Enable multi-threading support
+- `LIBBSC_FEATURE_LARGEPAGES` - Enable large pages for better memory performance
+- `LIBBSC_FEATURE_CUDA` - Enable CUDA GPU acceleration (if available)
+
+The default is `LIBBSC_FEATURE_FASTMODE | LIBBSC_FEATURE_MULTITHREADING`.
+
+```ruby
+# Examples of different feature combinations:
+bsc_minimal = Compress::BSC.new(features: Compress::BSC::Library::LIBBSC_FEATURE_NONE)
+bsc_gpu = Compress::BSC.new(features: Compress::BSC::Library::LIBBSC_FEATURE_CUDA)
+bsc_all = Compress::BSC.new(
+  features: Compress::BSC::Library::LIBBSC_FEATURE_FASTMODE |
+            Compress::BSC::Library::LIBBSC_FEATURE_MULTITHREADING |
+            Compress::BSC::Library::LIBBSC_FEATURE_LARGEPAGES |
+            Compress::BSC::Library::LIBBSC_FEATURE_CUDA
+)
+```
+
+### Object-Oriented API
+
+```ruby
+require 'compress/bsc'
+
+bsc = Compress::BSC.new
+
+# Create a compressor with custom options
+compressor = Compress::BSC::Compressor.new(
+  lzp_hash_size: 16,     # Enable LZP with 64KB hash table
+  lzp_min_len: 128,      # Minimum LZP match length
+  block_sorter: Compress::BSC::Library::LIBBSC_BLOCKSORTER_ST4,
+  features: Compress::BSC::Library::LIBBSC_FEATURE_MULTITHREADING
+)
+
+# Compress data
+data = File.binread("large_file.txt")
+compressed = compressor.compress(data)
+
+# Or compress directly to file
+compressor.compress_file("input.txt", "output.bsc")
+```
+
+### Decompression
+
+```ruby
+# Create a decompressor
+decompressor = Compress::BSC::Decompressor.new
+
+# Decompress data
+decompressed = decompressor.decompress(compressed)
+
+# Or decompress from file
+decompressor.decompress_file("output.bsc", "restored.txt")
+
+# Get information about compressed data
+info = Compress::BSC::Decompressor.block_info(compressed)
+puts "Original size: #{info[:data_size]} bytes"
+puts "Block size: #{info[:block_size]} bytes"
+```
+
+### Command-Line Interface
+
+The gem includes a command-line tool for compression and decompression:
+
+```bash
+# Compress a file
+rbsc -c -f input.txt -o output.bsc
+
+# Decompress a file
+rbsc -d -f output.bsc -o restored.txt
+
+# Show information about a compressed file
+rbsc -i -f output.bsc
+
+# Advanced compression with LZP preprocessing
+rbsc -c -f large.txt -o large.bsc --lzp-hash 16 --lzp-min 64 --threads
+
+# Show help
+rbsc --help
+```
+
+### Advanced Options
+
+#### Block Sorters
+
+- `LIBBSC_BLOCKSORTER_BWT` (0) - Burrows-Wheeler Transform (default)
+- `LIBBSC_BLOCKSORTER_ST3` (3) - Suffix Tree depth 3
+- `LIBBSC_BLOCKSORTER_ST4` (4) - Suffix Tree depth 4
+- `LIBBSC_BLOCKSORTER_ST5` (5) - Suffix Tree depth 5
+- `LIBBSC_BLOCKSORTER_ST6` (6) - Suffix Tree depth 6
+- `LIBBSC_BLOCKSORTER_ST7` (7) - Suffix Tree depth 7
+- `LIBBSC_BLOCKSORTER_ST8` (8) - Suffix Tree depth 8
+
+#### Coders
+
+- `LIBBSC_CODER_QLFC_STATIC` (1) - Static QLFC
+- `LIBBSC_CODER_QLFC_ADAPTIVE` (2) - Adaptive QLFC (default)
+- `LIBBSC_CODER_QLFC_FAST` (3) - Fast QLFC
+
+#### Features
+
+- `LIBBSC_FEATURE_FASTMODE` - Enable fast compression mode
+- `LIBBSC_FEATURE_MULTITHREADING` - Enable multi-threading
+- `LIBBSC_FEATURE_LARGEPAGES` - Use large memory pages
+- `LIBBSC_FEATURE_CUDA` - Enable CUDA acceleration (if available)
+
+#### LZP Options
+
+- `lzp_hash_size`: Hash table size (10-28, 0 to disable)
+- `lzp_min_len`: Minimum match length (4-255, 0 to disable)
+
+### Error Handling
+
+The library provides detailed error information:
+
+```ruby
+begin
+  bsc = Compress::BSC.new
+  compressed = bsc.compress("some data")
+rescue Compress::BSC::Error => e
+  puts "Error: #{e.error_name} (code: #{e.code})"
+  puts e.message
+end
+```
+
+## Performance
+
+BSC typically provides better compression ratios than traditional algorithms:
+
+- Better than gzip/zlib for most data types
+- Competitive with LZMA/7zip but faster decompression
+- Excellent for text, logs, and structured data
+- LZP preprocessing significantly improves compression for repetitive data
+
+Example compression ratios on text data:
+- Plain text: 3-5x compression
+- Log files: 5-10x compression
+- Source code: 4-7x compression
+- JSON/XML: 6-12x compression
+
+## Requirements
+
+- Ruby 2.7 or later
+- libbsc library installed on your system
+- FFI gem
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+To run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+To run a specific test:
+
+```bash
+bundle exec rspec spec/compressor_spec.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+This gem is available as open source under the terms of the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0), matching the license of the underlying libbsc library.
+
+## Credits
+
+- [libbsc](https://github.com/IlyaGrebnov/libbsc) by Ilya Grebnov - The underlying compression library
+- This Ruby wrapper provides an idiomatic interface to the excellent libbsc library
+
+## Copyright
+(C) 2025, Daniel J. Berger
+All Rights Reserved
+
+## Author
+Daniel J. Berger

data/Rakefile

@@ -0,0 +1,96 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc", "ruby.core", "**/*.lock")
+
+namespace :gem do
+  desc "Create the compress-bsc gem"
+  task :create => [:clean] do
+    require 'rubygems/package'
+    spec = Gem::Specification.load('compress-bsc.gemspec')
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
+  end
+
+  desc "Install the compress-bsc gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+# Default RSpec task
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+# RSpec task with coverage
+RSpec::Core::RakeTask.new(:spec_with_coverage) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+  ENV['COVERAGE'] = 'true'
+end
+
+# RSpec task with verbose output
+RSpec::Core::RakeTask.new(:spec_verbose) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation', '--backtrace']
+end
+
+# RSpec task for CI environments
+RSpec::Core::RakeTask.new(:spec_ci) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress', '--format', 'RspecJunitFormatter', '--out', 'tmp/rspec.xml']
+end
+
+task default: :spec
+
+# Documentation tasks
+YARD::Rake::YardocTask.new do |task|
+  task.files   = ['lib/**/*.rb']
+  task.options = ['--markup', 'markdown', '--readme', 'README.md']
+end
+
+desc "Generate documentation and open it"
+task :doc => :yard do
+  system "open doc/index.html" if RUBY_PLATFORM =~ /darwin/
+end
+
+# Code quality tasks
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  # RuboCop not available
+end
+
+desc "Install libbsc on macOS using Homebrew"
+task :install_libbsc_mac do
+  puts "Installing libbsc on macOS..."
+  sh "brew install libbsc" rescue puts "Failed to install via Homebrew. Please install libbsc manually."
+end
+
+desc "Install libbsc on Ubuntu/Debian"
+task :install_libbsc_ubuntu do
+  puts "Installing libbsc on Ubuntu/Debian..."
+  sh "sudo apt-get update && sudo apt-get install -y libbsc-dev" rescue puts "Failed to install via apt. Please install libbsc manually."
+end
+
+desc "Build libbsc from source"
+task :build_libbsc do
+  puts "Building libbsc from source..."
+  puts "Please follow the instructions at: https://github.com/IlyaGrebnov/libbsc"
+end
+
+desc "Check if libbsc is available"
+task :check_libbsc do
+  begin
+    require_relative 'lib/compress/bsc'
+    Compress::BSC::Library # Try to load the library
+    puts "✓ libbsc library found and loaded successfully"
+  rescue LoadError => e
+    puts "✗ libbsc library not found: #{e.message}"
+    puts "\nTo install libbsc:"
+    puts "  macOS: rake install_libbsc_mac"
+    puts "  Ubuntu/Debian: rake install_libbsc_ubuntu"
+    puts "  From source: rake build_libbsc"
+  end
+end