activesupport-cache-zstd_compressor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85a9423aef7e7529d792c908ce158dea0c03b2923d442adccf5315830ec4ad36
+  data.tar.gz: a784981439fc2582a12f2ab9248acf36d743ff67896b7c3db765ce9b7e7a99bc
+SHA512:
+  metadata.gz: b7a59a02b0d79c36256a738d3aa8c350ac6c784dba58eef85495c75225e5df63e868405dd6bd1d681745fabdcb7aa1b809355331d5470cc6ef5e4b33d26dc7ed
+  data.tar.gz: feefc9a98859b226ef9635f64e85ed658a90c71a3a2dd187a44b9f57edc4006e5b7087099e3e8ab9381f0d9dc026ffcfff9f05b95290e96e6a1829ca7d094340

data/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+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

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,30 @@
+# 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

@@ -0,0 +1,11 @@
+#!/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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,41 @@
+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

@@ -0,0 +1,18 @@
+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

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

data/rubocop/performance.yml

@@ -0,0 +1,25 @@
+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
+
+

data/rubocop/rspec.yml

@@ -0,0 +1,14 @@
+RSpec/ExampleLength:
+  Enabled: true
+  Max: 10
+  CountAsOne: [array, hash, heredoc, method_call]
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/BeNil:
+  Enabled: true
+  EnforcedStyle: be

data/rubocop/style.yml

@@ -0,0 +1,86 @@
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantCurrentDirectoryInPath:
+  Enabled: false
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: true
+  EnforcedStyle: percent_r
+
+Style/RescueStandardError:
+  Enabled: true
+  EnforcedStyle: explicit
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/YodaCondition:
+  Enabled: false

data/spec/active_support/cache/zstd_compressor/version_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe "ActiveSupport::Cache::ZstdCompressor::VERSION" do
+  subject { ActiveSupport::Cache::ZstdCompressor::VERSION }
+
+  it { is_expected.to be_a(String).and match(%r{\A\d+(\.\d+){2}}) }
+end

data/spec/active_support/cache/zstd_compressor/with_zlib_fallback_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "support/compressor_behaviour"
+
+RSpec.describe ActiveSupport::Cache::ZstdCompressor::WithZlibFallback do
+  it_behaves_like "a compressor" do
+    describe "#inflate" do
+      it "is capable of inflating data compressed with Zlib" do
+        uncompressed = compressor.inflate(Zlib.deflate(FOOD_FOR_THOUGHT))
+
+        expect(uncompressed).to eq(FOOD_FOR_THOUGHT)
+      end
+    end
+  end
+
+  it "itegrates perfectly" do
+    compressor = described_class.new
+    serializer = Marshal
+    cache      = ActiveSupport::Cache.lookup_store(:memory_store, serializer:, compressor:, compress: true)
+
+    cache.write("example", { food_for_thought: FOOD_FOR_THOUGHT })
+
+    expect(cache.read("example")).to eq({ food_for_thought: FOOD_FOR_THOUGHT })
+  end
+
+  it "works with with Zlib legacy compressor nicely" do
+    compressor = described_class.new
+    serializer = Marshal
+    old_cache  = ActiveSupport::Cache.lookup_store(:memory_store, serializer:, compress: true)
+    new_cache  = ActiveSupport::Cache.lookup_store(:memory_store, serializer:, compressor:, compress: true)
+
+    old_cache.write("example", { food_for_thought: FOOD_FOR_THOUGHT })
+
+    new_cache.instance_variable_set(:@data, old_cache.instance_variable_get(:@data))
+
+    expect(new_cache.read("example")).to eq({ food_for_thought: FOOD_FOR_THOUGHT })
+  end
+end

data/spec/active_support/cache/zstd_compressor_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "support/compressor_behaviour"
+
+RSpec.describe ActiveSupport::Cache::ZstdCompressor do
+  it_behaves_like "a compressor" do
+    describe "#inflate" do
+      it "is uncapable of inflating data compressed with Zlib" do
+        expect { compressor.inflate(Zlib.deflate(FOOD_FOR_THOUGHT)) }
+          .to raise_error(%r{not compressed by zstd})
+      end
+    end
+  end
+
+  it "itegrates perfectly" do
+    compressor = described_class.new
+    serializer = Marshal
+    cache      = ActiveSupport::Cache.lookup_store(:memory_store, serializer:, compressor:, compress: true)
+
+    cache.write("example", { food_for_thought: FOOD_FOR_THOUGHT })
+
+    expect(cache.read("example")).to eq({ food_for_thought: FOOD_FOR_THOUGHT })
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "activesupport-cache-zstd_compressor"
+
+# Ensure project struture and Zeitwerk ara correct
+ActiveSupport::Cache::ZstdCompressor::Loader.eager_load(force: true)
+
+require "active_support/cache"
+require "active_support/notifications"
+
+FOOD_FOR_THOUGHT = File.binread("#{__dir__}/support/mutual-aid.muse").freeze
+
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/compressor_behaviour.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "a compressor" do
+  subject(:compressor) { described_class.new }
+
+  describe ".new" do
+    it "initializes compressor with default compression level=3" do
+      expect(described_class.new.level).to eq 3
+    end
+
+    it "allows setting different compression level" do
+      expect(described_class.new(level: 6).level).to eq(6)
+    end
+
+    it "requires level to be an Integer" do
+      expect { described_class.new(level: "high") }
+        .to raise_error(ArgumentError, "Compression level must be an Integer")
+    end
+  end
+
+  describe "#deflate" do
+    it "compresses data using Zstd" do
+      compressed = compressor.deflate(FOOD_FOR_THOUGHT)
+
+      expect(compressed).not_to eq(FOOD_FOR_THOUGHT)
+      expect(compressed.bytesize).to be < FOOD_FOR_THOUGHT.bytesize
+    end
+  end
+
+  describe "#inflate" do
+    it "uncompresses data using Zstd" do
+      uncompressed = compressor.inflate(compressor.deflate(FOOD_FOR_THOUGHT))
+
+      expect(uncompressed).to eq(FOOD_FOR_THOUGHT)
+    end
+  end
+end