activesupport-cache-zstd_compressor 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85a9423aef7e7529d792c908ce158dea0c03b2923d442adccf5315830ec4ad36
-  data.tar.gz: a784981439fc2582a12f2ab9248acf36d743ff67896b7c3db765ce9b7e7a99bc
+  metadata.gz: f42d60297d2c596b26d6e4ccd2c37103dfed3787b8cf62b687c3d5a443205f01
+  data.tar.gz: 43b0dde8a7e5b3063ea962e13f5b542b23548825872b54cd8af0f56b5604ddec
 SHA512:
-  metadata.gz: b7a59a02b0d79c36256a738d3aa8c350ac6c784dba58eef85495c75225e5df63e868405dd6bd1d681745fabdcb7aa1b809355331d5470cc6ef5e4b33d26dc7ed
-  data.tar.gz: feefc9a98859b226ef9635f64e85ed658a90c71a3a2dd187a44b9f57edc4006e5b7087099e3e8ab9381f0d9dc026ffcfff9f05b95290e96e6a1829ca7d094340
+  metadata.gz: d8700caa5dc33a6ecb8dddaeb969b59ce4077d16a79cdb080989142da959276fdc432f49a25aad19a4c50beff420c18b49253a8442a0f946006cf01db30ce26e
+  data.tar.gz: 97ff2472e62f7be56af4341497d46c646d34d597ed7f65098b7d1ee9faf19ef7e2b9e9c77c3f5d64a14f938c21baa7f0f9ab37cc7373195613af93788dc9c3e6

data/CHANGES.md

@@ -0,0 +1,13 @@
+## [Unreleased]
+
+## [0.1.2] - 2025-05-31
+
+- Remove Zeitwerk loader.
+
+## [0.1.1] - 2025-05-30
+
+- Initial release.
+
+[Unreleased]: https://github.com/ixti/amazing-activist/compare/v0.1.2...main
+[0.1.2]: https://github.com/ixti/amazing-activist/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/ixti/amazing-activist/tree/v0.1.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Alexey Zapparov
+
+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.adoc

@@ -0,0 +1,116 @@
+= ActiveSupport::Cache::ZstdCompressor
+
+A blazing-fast https://facebook.github.io/zstd/[Zstandard] compressor for
+`ActiveSupport::Cache`. Built for developers who appreciate both performance
+and the finer things in life, like not waiting forever for cache operations.
+
+🚀 Blazing Speed:: Decompression speeds that make LZ4 look sleepy.
+🎯 Excellent Ratios:: Better compression than gzip with less CPU drama.
+⚡ Tunable Performance:: 30 compression levels from "ludicrous speed" to "maximum squeeze".
+🧠 Smart Memory Usage:: Uses modern amounts of RAM because it's not 1995 anymore.
+
+
+== Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+[source,bash]
+----
+bundle add activesupport-cache-zstd_compressor
+----
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+[source,bash]
+----
+gem install activesupport-cache-zstd_compressor
+----
+
+
+== Usage
+
+[source,ruby]
+----
+Rails.application.configure do
+  config.cache_store = :redis_cache_store, {
+  url:        ENV["REDIS_URL"],
+  compress:   true,
+  compressor: ActiveSupport::Cache::ZstdCompressor.new
+}
+----
+
+By default, it uses compression level `3`, but you can easily tweak it:
+
+[source,ruby]
+----
+Rails.application.configure do
+  config.cache_store = :redis_cache_store, {
+  url:        ENV["REDIS_URL"],
+  compress:   true,
+  compressor: ActiveSupport::Cache::ZstdCompressor.new(level: 6)
+}
+----
+
+
+=== Migrating from Rails default compressor (Zlib)
+
+TIP: Perfect for production environments where cache invalidation is not an option.
+
+[source,ruby]
+----
+Rails.application.configure do
+  config.cache_store = :redis_cache_store, {
+  url:        ENV["REDIS_URL"],
+  compress:   true,
+  compressor: ActiveSupport::Cache::ZstdCompressor::WithZlibFallback.new
+}
+----
+
+How it works::
+. 🔍 Detects compressed data format by magic number
+. 📖 Reads existing Zlib-compressed cache entries seamlessly
+. ✍️ Writes all new entries using superior Zstd compression
+
+
+== Compatibility
+
+This library aims to support and is tested against:
+
+* https://www.ruby-lang.org[Ruby]
+** MRI 3.2.x
+** MRI 3.3.x
+** MRI 3.4.x
+
+* https://https://rubygems.org/gems/activesupport[ActiveSupport]
+** 7.1.x
+** 7.2.x
+** 8.0.x
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+
+== Development
+
+[source,bash]
+----
+bundle install
+bundle exec rake
+----
+
+
+== Contributing
+
+* Fork activesupport-cache-zstd_compressor
+* Make your changes
+* Ensure all tests pass (`bundle exec rake`)
+* Send a merge request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access!
+
+
+== Acknowledgements
+
+This library is inspired by https://github.com/pawurb/rails-brotli-cache

data/activesupport-cache-zstd_compressor.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "./lib/active_support/cache/zstd_compressor/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "activesupport-cache-zstd_compressor"
+  spec.version = ActiveSupport::Cache::ZstdCompressor::VERSION
+  spec.authors = ["Alexey Zapparov"]
+  spec.email   = ["alexey@zapparov.com"]
+
+  spec.summary     = "ZStandard compressor for ActiveSupport::Cache"
+  spec.description = "Drop-in Zlib compressor replacement for ActiveSupport::Cache"
+  spec.homepage    = "https://github.com/ixti/activesupport-cache-zstd_compressor"
+  spec.license     = "MIT"
+
+  spec.metadata["homepage_uri"]          = spec.homepage
+  spec.metadata["source_code_uri"]       = "#{spec.homepage}/tree/v#{spec.version}"
+  spec.metadata["bug_tracker_uri"]       = "#{spec.homepage}/issues"
+  spec.metadata["changelog_uri"]         = "#{spec.homepage}/blob/v#{spec.version}/CHANGES.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    extras = %w[CHANGES.md LICENSE.txt README.adoc] << File.basename(__FILE__)
+
+    ls.readlines("\x0", chomp: true).select do |f|
+      f.start_with?("lib/") || extras.include?(f)
+    end
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.add_dependency "activesupport", ">= 7.1"
+  spec.add_dependency "zstd-ruby",     "~> 1.5", ">= 1.5.6.6"
+end

data/lib/active_support/cache/zstd_compressor/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module Cache
+    class ZstdCompressor
+      VERSION = "0.1.2"
+    end
+  end
+end

data/lib/active_support/cache/zstd_compressor/with_zlib_fallback.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+module ActiveSupport
+  module Cache
+    class ZstdCompressor
+      class WithZlibFallback < self
+        # ZStandard Magic Number (0xFD2FB528) in little-endian format.
+        # See: https://datatracker.ietf.org/doc/html/rfc8878#name-zstandard-frames
+        ZSTD_MAGIC_NUMBER = [0xFD2FB528].pack("L<")
+
+        def inflate(deflated)
+          return super if deflated.b.start_with?(ZSTD_MAGIC_NUMBER)
+
+          Zlib.inflate(deflated)
+        end
+      end
+    end
+  end
+end

data/lib/active_support/cache/zstd_compressor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "active_support/cache"
+require "zstd-ruby"
+
+require_relative "./zstd_compressor/with_zlib_fallback"
+require_relative "./zstd_compressor/version"
+
+module ActiveSupport
+  module Cache
+    class ZstdCompressor
+      # @return [Integer] Compression level
+      attr_reader :level
+
+      # @param level [Integer] Compression level
+      def initialize(level: 3)
+        raise ArgumentError, "Compression level must be an Integer" unless level.is_a?(Integer)
+
+        @level = level
+      end
+
+      def deflate(inflated)
+        Zstd.compress(inflated, level:)
+      end
+
+      def inflate(deflated)
+        Zstd.decompress(deflated)
+      end
+    end
+  end
+end

data/lib/activesupport-cache-zstd_compressor.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "./active_support/cache/zstd_compressor"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-cache-zstd_compressor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexey Zapparov
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: zstd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -64,37 +50,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
-- Appraisals
-- Gemfile
-- Rakefile
-- bin/console
-- rubocop/layout.yml
-- rubocop/lint.yml
-- rubocop/metrics.yml
-- rubocop/naming.yml
-- rubocop/performance.yml
-- rubocop/rspec.yml
-- rubocop/style.yml
-- spec/active_support/cache/zstd_compressor/version_spec.rb
-- spec/active_support/cache/zstd_compressor/with_zlib_fallback_spec.rb
-- spec/active_support/cache/zstd_compressor_spec.rb
-- spec/spec_helper.rb
-- spec/support/compressor_behaviour.rb
-- spec/support/mutual-aid.muse
-- tmp/.keep
+- CHANGES.md
+- LICENSE.txt
+- README.adoc
+- activesupport-cache-zstd_compressor.gemspec
+- lib/active_support/cache/zstd_compressor.rb
+- lib/active_support/cache/zstd_compressor/version.rb
+- lib/active_support/cache/zstd_compressor/with_zlib_fallback.rb
+- lib/activesupport-cache-zstd_compressor.rb
 homepage: https://github.com/ixti/activesupport-cache-zstd_compressor
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/activesupport-cache-zstd_compressor
-  source_code_uri: https://github.com/ixti/activesupport-cache-zstd_compressor/tree/v0.1.0
+  source_code_uri: https://github.com/ixti/activesupport-cache-zstd_compressor/tree/v0.1.2
   bug_tracker_uri: https://github.com/ixti/activesupport-cache-zstd_compressor/issues
-  changelog_uri: https://github.com/ixti/activesupport-cache-zstd_compressor/blob/v0.1.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/activesupport-cache-zstd_compressor/blob/v0.1.2/CHANGES.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:

data/.github/workflows/ci.yml

@@ -1,56 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-    name: "test / ${{ matrix.ruby }}"
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ "3.2", "3.3", "3.4", head ]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake test
-
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
-
-  # See: https://github.com/orgs/community/discussions/26822#discussioncomment-3305794
-  test-finale:
-    name: "test"
-
-    runs-on: ubuntu-latest
-    if: ${{ always() }}
-
-    needs: [test]
-
-    steps:
-      - run: test "success" = "${{ needs.test.result }}"
-
-  lint:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.4"
-          bundler-cache: true
-
-      - run: bundle exec rake lint

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.ruby-lsp/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-
-/tmp/*
-!/tmp/.keep
-
-/Gemfile.lock
-/gemfiles/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---require simplecov
---require spec_helper

data/.rubocop.yml

@@ -1,20 +0,0 @@
-plugins:
-  - rubocop-performance
-  - rubocop-rake
-  - rubocop-rspec
-
-inherit_from:
-  - rubocop/layout.yml
-  - rubocop/lint.yml
-  - rubocop/metrics.yml
-  - rubocop/naming.yml
-  - rubocop/performance.yml
-  - rubocop/rspec.yml
-  - rubocop/style.yml
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.2
-  Exclude:
-    - gemfiles/**/*
-    - vendor/**/*

data/.simplecov

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-SimpleCov.start do
-  gemfile = File.basename(ENV.fetch("BUNDLE_GEMFILE", "Gemfile"), ".gemfile").strip
-  gemfile = nil if gemfile.empty? || gemfile.casecmp?("gems.rb") || gemfile.casecmp?("Gemfile")
-
-  command_name ["#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}", gemfile].compact.join("/")
-
-  enable_coverage :branch
-
-  if ENV["CI"]
-    require "simplecov-cobertura"
-    formatter SimpleCov::Formatter::CoberturaFormatter
-  else
-    formatter SimpleCov::Formatter::MultiFormatter.new([
-      SimpleCov::Formatter::SimpleFormatter,
-      SimpleCov::Formatter::HTMLFormatter
-    ])
-  end
-
-  add_filter "/spec/"
-end

data/Appraisals

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-appraise "activesupport-7.1.x" do
-  gem "activesupport", "~> 7.1.0"
-end
-
-appraise "activesupport-7.2.x" do
-  gem "activesupport", "~> 7.2.0"
-end
-
-appraise "activesupport-8.0.x" do
-  gem "activesupport", "~> 8.0.0"
-end

data/Gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec
-
-gem "appraisal"
-gem "rake"
-
-gem "rspec"
-
-gem "simplecov"
-gem "simplecov-cobertura"
-
-gem "rubocop",             require: false
-gem "rubocop-performance", require: false
-gem "rubocop-rake",        require: false
-gem "rubocop-rspec",       require: false
-
-gem "debug"
-gem "irb"

data/Rakefile

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-desc "Run tests"
-task :test do
-  rm_rf "coverage"
-  rm_rf "gemfiles"
-
-  Bundler.with_unbundled_env do
-    sh "bundle exec appraisal generate"
-
-    # XXX: `bundle exec appraisal install` fails on ruby-3.2
-    Dir["gemfiles/*.gemfile"].each do |gemfile|
-      sh({ "BUNDLE_GEMFILE" => gemfile }, "bundle lock")
-      sh({ "BUNDLE_GEMFILE" => gemfile }, "bundle check") do |ok|
-        sh({ "BUNDLE_GEMFILE" => gemfile }, "bundle install") unless ok
-      end
-    end
-
-    sh "bundle exec appraisal rspec --force-colour"
-  end
-end
-
-desc "Lint codebase"
-task :lint do
-  sh "bundle exec rubocop --color"
-end
-
-task default: %i[test lint]

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "active_support/cache/zstd_compressor"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "irb"
-IRB.start(__FILE__)

data/rubocop/layout.yml

@@ -1,29 +0,0 @@
-Layout/ArgumentAlignment:
-  Enabled: true
-  EnforcedStyle: with_fixed_indentation
-
-Layout/ClassStructure:
-  Enabled: true
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Layout/FirstArrayElementIndentation:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Layout/FirstHashElementIndentation:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Layout/HashAlignment:
-  Enabled: true
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented

data/rubocop/lint.yml

@@ -1,41 +0,0 @@
-Lint/BinaryOperatorWithIdenticalOperands:
-  Enabled: true
-
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/DuplicateElsifCondition:
-  Enabled: true
-
-Lint/DuplicateRescueException:
-  Enabled: true
-
-Lint/EmptyConditionalBody:
-  Enabled: true
-
-Lint/FloatComparison:
-  Enabled: true
-
-Lint/MissingSuper:
-  Enabled: true
-
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-
-Lint/OutOfRangeRegexpRef:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/SelfAssignment:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-Lint/TopLevelReturnWithArgument:
-  Enabled: true
-
-Lint/UnreachableLoop:
-  Enabled: true

data/rubocop/metrics.yml

@@ -1,18 +0,0 @@
-Metrics/BlockLength:
-  Enabled: true
-  CountAsOne: [array, hash, heredoc, method_call]
-  Exclude:
-    - "spec/**/*_spec.rb"
-    - "**/*.gemspec"
-
-Metrics/ClassLength:
-  Enabled: true
-  CountAsOne: [array, hash, heredoc, method_call]
-
-Metrics/MethodLength:
-  Enabled: true
-  CountAsOne: [array, hash, heredoc, method_call]
-
-Metrics/ModuleLength:
-  Enabled: true
-  CountAsOne: [array, hash, heredoc, method_call]

data/rubocop/naming.yml

@@ -1,4 +0,0 @@
-Naming/FileName:
-  Enabled: true
-  Exclude:
-    - "lib/activesupport-cache-zstd_compressor.rb"

data/rubocop/performance.yml

@@ -1,25 +0,0 @@
-Performance/AncestorsInclude:
-  Enabled: true
-
-Performance/BigDecimalWithNumericArgument:
-  Enabled: true
-
-Performance/RedundantSortBlock:
-  Enabled: true
-
-Performance/RedundantStringChars:
-  Enabled: true
-
-Performance/ReverseFirst:
-  Enabled: true
-
-Performance/SortReverse:
-  Enabled: true
-
-Performance/Squeeze:
-  Enabled: true
-
-Performance/StringInclude:
-  Enabled: true
-
-