philiprehberger-gzip_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbd25c13b81efd122da745592b41f230c98c5519bb293bf69e01e177e3334401
+  data.tar.gz: b09280836757edb10b5c8f582ebe3012a0c1825161ac55f823dae7c55b3d9270
+SHA512:
+  metadata.gz: 167a67368bbd124938ea30e22cf5aab83a7b8a8b65499c3719f38ffa49ab7845357c1d3715c84ebeb19bca3ba9b345afbf1e6d93fed0b7b35879f54e5dc3e8ad
+  data.tar.gz: 1bd92f01e5be0ddfdc63639874c4d8ced218de7e9b3f11126e93a758aba6649e3fd22fe4d63a86b23f91097a92c7505bb531423d92b673dd71411316ddee3ba8

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-26
+
+### Added
+- Initial release
+- `GzipKit.compress` and `GzipKit.decompress` for string compression
+- `GzipKit.compress_file` and `GzipKit.decompress_file` for file operations
+- `GzipKit.compress_stream` and `GzipKit.decompress_stream` for streaming IO
+- Configurable compression level via `level:` keyword argument
+- 64KB chunk-based streaming for memory-efficient processing

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+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,108 @@
+# philiprehberger-gzip_kit
+
+[![Tests](https://github.com/philiprehberger/rb-gzip-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-gzip-kit/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-gzip_kit.svg)](https://rubygems.org/gems/philiprehberger-gzip_kit)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-gzip-kit)](LICENSE)
+[![Sponsor](https://img.shields.io/badge/sponsor-GitHub%20Sponsors-ec6cb9)](https://github.com/sponsors/philiprehberger)
+
+Gzip compression and decompression with streaming support
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-gzip_kit"
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-gzip_kit
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/gzip_kit"
+
+compressed = Philiprehberger::GzipKit.compress("Hello, world!")
+original = Philiprehberger::GzipKit.decompress(compressed)
+```
+
+### Compression Levels
+
+```ruby
+require "philiprehberger/gzip_kit"
+
+# Fast compression
+fast = Philiprehberger::GzipKit.compress(data, level: Zlib::BEST_SPEED)
+
+# Maximum compression
+small = Philiprehberger::GzipKit.compress(data, level: Zlib::BEST_COMPRESSION)
+
+# No compression (store only)
+raw = Philiprehberger::GzipKit.compress(data, level: Zlib::NO_COMPRESSION)
+```
+
+### File Operations
+
+```ruby
+require "philiprehberger/gzip_kit"
+
+# Compress a file
+Philiprehberger::GzipKit.compress_file("data.txt", "data.txt.gz")
+
+# Decompress a file
+Philiprehberger::GzipKit.decompress_file("data.txt.gz", "data.txt")
+
+# Compress with custom level
+Philiprehberger::GzipKit.compress_file("data.txt", "data.txt.gz", level: Zlib::BEST_COMPRESSION)
+```
+
+### Streaming
+
+```ruby
+require "philiprehberger/gzip_kit"
+
+# Compress from one IO to another
+File.open("input.txt", "rb") do |input|
+  File.open("output.gz", "wb") do |output|
+    Philiprehberger::GzipKit.compress_stream(input, output)
+  end
+end
+
+# Decompress from one IO to another
+File.open("output.gz", "rb") do |input|
+  File.open("restored.txt", "wb") do |output|
+    Philiprehberger::GzipKit.decompress_stream(input, output)
+  end
+end
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `GzipKit.compress(string, level:)` | Compress a string to gzip bytes |
+| `GzipKit.decompress(data)` | Decompress gzip bytes to a string |
+| `GzipKit.compress_file(src, dest, level:)` | Compress a file to a gzip file |
+| `GzipKit.decompress_file(src, dest)` | Decompress a gzip file to a regular file |
+| `GzipKit.compress_stream(io_in, io_out, level:)` | Streaming compression in 64KB chunks |
+| `GzipKit.decompress_stream(io_in, io_out)` | Streaming decompression in 64KB chunks |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+bundle exec rubocop
+```
+
+## License
+
+[MIT](LICENSE)

data/lib/philiprehberger/gzip_kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module GzipKit
+    VERSION = "0.1.0"
+  end
+end

data/lib/philiprehberger/gzip_kit.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "zlib"
+require "stringio"
+require_relative "gzip_kit/version"
+
+module Philiprehberger
+  module GzipKit
+    class Error < StandardError; end
+
+    CHUNK_SIZE = 64 * 1024
+
+    # Compress a string to gzip bytes.
+    #
+    # @param string [String] the data to compress
+    # @param level [Integer] compression level (Zlib::DEFAULT_COMPRESSION by default)
+    # @return [String] gzip-compressed bytes
+    def self.compress(string, level: Zlib::DEFAULT_COMPRESSION)
+      io_out = StringIO.new
+      io_out.binmode
+      gz = Zlib::GzipWriter.new(io_out, level)
+      gz.write(string)
+      gz.close
+      io_out.string
+    end
+
+    # Decompress gzip bytes to a string.
+    #
+    # @param data [String] gzip-compressed bytes
+    # @return [String] decompressed string
+    # @raise [Zlib::GzipFile::Error] if the data is not valid gzip
+    def self.decompress(data)
+      io_in = StringIO.new(data)
+      io_in.binmode
+      gz = Zlib::GzipReader.new(io_in)
+      gz.read
+    ensure
+      gz&.close
+    end
+
+    # Compress a file to a gzip file.
+    #
+    # @param src [String] path to the source file
+    # @param dest [String] path to the destination gzip file
+    # @param level [Integer] compression level (Zlib::DEFAULT_COMPRESSION by default)
+    # @return [void]
+    def self.compress_file(src, dest, level: Zlib::DEFAULT_COMPRESSION)
+      File.open(src, "rb") do |io_in|
+        File.open(dest, "wb") do |io_out|
+          compress_stream(io_in, io_out, level: level)
+        end
+      end
+    end
+
+    # Decompress a gzip file to a regular file.
+    #
+    # @param src [String] path to the gzip source file
+    # @param dest [String] path to the destination file
+    # @return [void]
+    def self.decompress_file(src, dest)
+      File.open(src, "rb") do |io_in|
+        File.open(dest, "wb") do |io_out|
+          decompress_stream(io_in, io_out)
+        end
+      end
+    end
+
+    # Streaming compression from one IO to another, reading in 64KB chunks.
+    #
+    # @param io_in [IO] readable input stream
+    # @param io_out [IO] writable output stream
+    # @param level [Integer] compression level (Zlib::DEFAULT_COMPRESSION by default)
+    # @return [void]
+    def self.compress_stream(io_in, io_out, level: Zlib::DEFAULT_COMPRESSION)
+      gz = Zlib::GzipWriter.new(io_out, level)
+      while (chunk = io_in.read(CHUNK_SIZE))
+        gz.write(chunk)
+      end
+      gz.finish
+    end
+
+    # Streaming decompression from one IO to another, reading in 64KB chunks.
+    #
+    # @param io_in [IO] readable input stream containing gzip data
+    # @param io_out [IO] writable output stream
+    # @return [void]
+    def self.decompress_stream(io_in, io_out)
+      gz = Zlib::GzipReader.new(io_in)
+      while (chunk = gz.read(CHUNK_SIZE))
+        io_out.write(chunk)
+      end
+    ensure
+      gz&.close
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-gzip_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-27 00:00:00.000000000 Z
+dependencies: []
+description: Simple API for gzip compression and decompression with support for strings,
+  files, and IO streams. Configurable compression level. Built on Ruby stdlib zlib.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/gzip_kit.rb
+- lib/philiprehberger/gzip_kit/version.rb
+homepage: https://github.com/philiprehberger/rb-gzip-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-gzip-kit
+  source_code_uri: https://github.com/philiprehberger/rb-gzip-kit
+  changelog_uri: https://github.com/philiprehberger/rb-gzip-kit/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-gzip-kit/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Gzip compression and decompression with streaming support
+test_files: []