lz4_flex 0.1.1.pre2-arm64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0613aa1dd048b705253080ddf3c686caf87f81af10184c7d811acf078a98480
+  data.tar.gz: e02c7526fc72b8b0f9ef83e4f102c9a22cacd4a18e18be072cc81dc9b2bfd0e6
+SHA512:
+  metadata.gz: 8edff6805db69d5eac77ede46db44e90dda0e3df707bfadd1110a54cd7faae34b0512206be1693148a7c76957654a6e73f8081956a78c46b48b338277601c7c3
+  data.tar.gz: 0527b06314a85f1ccc6269843d2af0517b7f8bfd8e2a17dcca77c2c8b2bcad5d5e51fa44a28fd7cf8d9c8c9f56d5de1aea1003b01f3330431560702466849c22

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Shopify
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software 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 Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# `lz4-flex-rb`
+
+## About this library
+
+**Introduction:**
+`lz4-flex-rb` is a modern LZ4 compression library for Ruby, leveraging the
+power of the [`lz4_flex`](https://github.com/PSeitz/lz4_flex) Rust crate. This
+library provides a pure Rust implementation of the LZ4 algorithm, ensuring high
+performance and safety. One of the standout features of `lz4_flex-rb` is its
+ability to conditionally unlock the Global VM Lock (GVL) for threaded web
+servers, enhancing concurrency and performance in multi-threaded environments.
+
+## How to install this library
+
+### Requirements
+- Ruby 3.0 or higher
+- Rust (for building the native extension)
+
+### Setup
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lz4_flex'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+### Troubleshooting
+
+If you encounter issues during installation, ensure that Rust is correctly installed and available in your PATH. You can install Rust from [rustup.rs](https://rustup.rs/).
+
+## How to use this library
+
+There are two methods provided, `LZ4Flex.compress` and `Lz4Flex.decompress`.
+Both of these methods utilize the lz4 block format, with a small header to
+record the string's size and encoding.
+
+### Basic Usage
+
+```ruby
+require 'lz4_flex'
+
+# Compress data
+compressed = LZ4Flex.compress("Hello, World!")
+
+# Decompress data
+decompressed = LZ4Flex.decompress(compressed)
+
+puts decompressed  # => "Hello, World!"
+puts decompressed.encoding # => Encoding::UTF_8
+```
+
+The header used in these methods will not be recognizable from other lz4 block
+parsers. If you need that, it's best to use the Frame API (which is currently a
+WIP).
+
+### Migrating from `lz4-ruby`
+
+The [`lz4-ruby`](https://github.com/komiya-atsushi/lz4-ruby) gem uses a slighty
+different header format, which keeps track of string size but not the string's
+encoding.
+
+To make it easy to migrate to `lz4_flex`, we provide a parser for the
+`lz4-ruby` format:
+
+```ruby
+# Say you have a string that was compressed with lz4-ruby...
+lz4_ruby_compressed = LZ4.compress("Yo!")
+
+# You can decode it with lz4_flex:
+decompressed = Lz4Flex::VarInt.decompress(lz4_ruby_compressed)
+
+puts decompressed #=> "Yo!"
+puts decompressed.encoding #=> Encoding::BINARY
+```
+
+Combine
+
+### Running Tests
+To run the tests, execute:
+
+```sh
+bundle exec rake
+```
+
+## Contribute to this library (optional)
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b my-feature-branch`).
+3. Make your changes.
+4. Commit your changes (`git commit -am 'Add new feature'`).
+5. Push to the branch (`git push origin my-feature-branch`).
+6. Create a new Pull Request.
+
+Please ensure your code adheres to the project's coding standards and includes appropriate tests.

data/lib/lz4_flex/version.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Lz4Flex
+  VERSION = "0.1.1.pre2"
+end

data/lib/lz4_flex.rb

@@ -0,0 +1,10 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Tries to require the precompiled extension for the given Ruby version first
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "lz4_flex/#{Regexp.last_match(1)}/lz4_flex_ext"
+rescue LoadError
+  require_relative "lz4_flex/lz4_flex_ext"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: lz4_flex
+version: !ruby/object:Gem::Version
+  version: 0.1.1.pre2
+platform: arm64-darwin
+authors:
+- Shopify Engineering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-19 00:00:00.000000000 Z
+dependencies: []
+description: A modern LZ4 compression library for Ruby, leveraging the power of the
+  [`lz4_flex`](https://github.com/PSeitz/lz4_flex) Rust crate. This library provides
+  a pure Rust implementation of the LZ4 algorithm, ensuring high performance and safety.
+email:
+- gems@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/lz4_flex.rb
+- lib/lz4_flex/3.2/lz4_flex_ext.bundle
+- lib/lz4_flex/3.3/lz4_flex_ext.bundle
+- lib/lz4_flex/version.rb
+homepage: https://github.com/Shopify/lz4-flex-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/lz4-flex-rb
+  source_code_uri: https://github.com/Shopify/lz4-flex-rb
+  changelog_uri: https://github.com/Shopify/lz4-flex-rb/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.4.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: A modern LZ4 compression library for Ruby, leveraging the `lz4_flex` Rust
+  crate.
+test_files: []