rails-brotli-cache 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5fcc9aa5854debba71fab6f5df69615ab2b9edaa6620ae139e7c68c598c0dcb
-  data.tar.gz: a60ba10b497f50e751ca191ce8e9034bd45b30c93e3dff718a26c14e178ffed9
+  metadata.gz: e109b9b356474fb8085b1cceaa892695de997465db4c90872556f76419da8f86
+  data.tar.gz: c8422310e9fed160052637a40dc7b1150b938c0f891b3b7b011eacdd11b8e4bb
 SHA512:
-  metadata.gz: 066d33ad8b2e12d2fa4242ac120cbd0cd1ceee693619146d72b2dfe95ecd8dfe69b5b01028488a31e5373c5472602c42219cb2e0e749d9a2661c0cbcc26b9cb1
-  data.tar.gz: a8522dff7f3452c216803cf5a45c62eb0ba1acadc3d4efece1130c35574344d4b2509938a076f78293814c271376b576973135791fc5fdf342240d587a2783cc
+  metadata.gz: 6b435443fbf3a6a09baed87b124429e43dcd4d3fbd06cab175a15818b397285aeab96ad0694dc8a2f0e0d91c3478400ba0e3081045e93ca63e275e62626f0e0d
+  data.tar.gz: 95af20d56721fbe1e9118b29a0fa1f7dc3fe5825d8c7ee04d77b783b96b405d6b1e765f4d8b63e8668d9414ca1e716cc010e3201d7a93340d35251ebd966f9e8

data/README.md

@@ -1,8 +1,17 @@
-# Rails Brotli Cache [![Gem Version](https://img.shields.io/gem/v/rails-brotli-cache)](https://badge.fury.io/rb/rails-brotli-cache) [![CircleCI](https://circleci.com/gh/pawurb/rails-brotli-cache.svg?style=svg)](https://circleci.com/gh/pawurb/rails-brotli-cache)
+# Rails Brotli Cache [![Gem Version](https://img.shields.io/gem/v/rails-brotli-cache)](https://badge.fury.io/rb/rails-brotli-cache) [![GH Actions](https://github.com/pawurb/rails-brotli-cache/actions/workflows/ci.yml/badge.svg)](https://github.com/pawurb/rails-brotli-cache/actions)
 
 This gem enables support for compressing Ruby on Rails cache entries using the [Brotli compression algorithm](https://github.com/google/brotli). `RailsBrotliCache::Store` offers better compression and performance compared to the default `Rails.cache` Gzip, regardless of the underlying data store. The gem also allows specifying any custom compression algorithm instead of Brotli.
 
-I'm currently working on a post describing the gem in more detail. You can subscribe to [my blog's mailing list](https://eepurl.com/dhuFg5) or [follow me on Twitter](https://twitter.com/_pawurb) to get notified when it's out.
+You can check out [this blog post](https://pawelurbanek.com/rails-brotli-cache) describing the gem in more detail.
+
+## Installation
+
+`Gemfile`
+
+```ruby
+  gem 'brotli' # an optional dependency, other compressors are supported
+  gem 'rails-brotli-cache'
+```
 
 ## Benchmarks
 
@@ -130,10 +139,21 @@ config.cache_store = RailsBrotliCache::Store.new(
 ```
 
 ```ruby
+
+class ZSTDCompressor
+  def self.deflate(payload)
+    ::Zstd.compress(payload, 10)
+  end
+
+  def self.inflate(payload)
+    ::Zstd.decompress(payload)
+  end
+end
+
 Rails.cache.write('test-key', json, compressor_class: Snappy)
 ```
 
-This config expects a class which defines two class methods `inflate` and `deflate`. It allows you to instead use for example a [Google Snappy algorithm](https://github.com/miyucy/snappy) offering even better performance for the cost of worse compresion ratios. Optionally, you can define a custom class wrapping any compression library.
+This config expects a class that defines two methods, `inflate` and `deflate`. It allows to use, for example, a [ZSTD by Facebook](https://github.com/SpringMT/zstd-ruby), offering even better performance and compression.
 
 ## Testing
 

data/benchmarks/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+gem 'brotli'
 gem 'rails-brotli-cache', path: "../"
 gem 'redis'
 gem 'dalli'
+gem 'zstd-ruby'

data/benchmarks/main.rb

@@ -1,30 +1,62 @@
-require "active_support"
-require "active_support/core_ext/hash"
+require 'active_support'
+require 'active_support/core_ext/hash'
 require 'net/http'
+require 'brotli'
 require 'rails-brotli-cache'
+require 'benchmark'
+require 'zstd-ruby'
+
+class ZSTDCompressor
+  def self.deflate(payload)
+    ::Zstd.compress(payload, 10)
+  end
+
+  def self.inflate(payload)
+    ::Zstd.decompress(payload)
+  end
+end
 
 memory_cache = ActiveSupport::Cache::MemoryStore.new(compress: true) # memory store does not use compression by default
 brotli_memory_cache = RailsBrotliCache::Store.new(memory_cache)
+zstd_memory_cache = RailsBrotliCache::Store.new(memory_cache, compressor_class: ZSTDCompressor, prefix: "zs-")
+
 redis_cache = ActiveSupport::Cache::RedisCacheStore.new
 brotli_redis_cache = RailsBrotliCache::Store.new(redis_cache)
+zstd_redis_cache = RailsBrotliCache::Store.new(redis_cache, compressor_class: ZSTDCompressor, prefix: "zs-")
+
 memcached_cache = ActiveSupport::Cache::MemCacheStore.new
 brotli_memcached_cache = RailsBrotliCache::Store.new(memcached_cache)
+zstd_memcached_cache = RailsBrotliCache::Store.new(memcached_cache, compressor_class: ZSTDCompressor, prefix: "zs-")
+
 file_cache = ActiveSupport::Cache::FileStore.new('/tmp')
 brotli_file_cache = RailsBrotliCache::Store.new(file_cache)
+zstd_file_cache = RailsBrotliCache::Store.new(file_cache, compressor_class: ZSTDCompressor, prefix: "zs-")
 
 json_uri = URI("https://raw.githubusercontent.com/pawurb/rails-brotli-cache/main/spec/fixtures/sample.json")
 json = Net::HTTP.get(json_uri)
 
 puts "Uncompressed JSON size: #{json.size}"
 redis_cache.write("gz-json", json)
-gzip_json_size = redis_cache.redis.get("gz-json").size
+gzip_json_size = redis_cache.redis.with do |conn|
+  conn.get("gz-json").size
+end
 puts "Gzip JSON size: #{gzip_json_size}"
 brotli_redis_cache.write("json", json)
-br_json_size = redis_cache.redis.get("br-json").size
+br_json_size = redis_cache.redis.with do |conn|
+  conn.get("br-json").size
+end
 puts "Brotli JSON size: #{br_json_size}"
 puts "~#{((gzip_json_size - br_json_size).to_f / gzip_json_size.to_f * 100).round}% improvment"
 puts ""
 
+zstd_redis_cache.write("json", json)
+zs_json_size = redis_cache.redis.with do |conn|
+  conn.get("zs-json").size
+end
+puts "ZSTD JSON size: #{zs_json_size}"
+puts "~#{((gzip_json_size - zs_json_size).to_f / gzip_json_size.to_f * 100).round}% improvment"
+puts ""
+
 iterations = 100
 
 Benchmark.bm do |x|
@@ -42,6 +74,13 @@ Benchmark.bm do |x|
     end
   end
 
+  x.report("zstd_memory_cache") do
+    iterations.times do
+      zstd_memory_cache.write("test", json)
+      zstd_memory_cache.read("test")
+    end
+  end
+
   x.report("redis_cache") do
     iterations.times do
       redis_cache.write("test", json)
@@ -56,6 +95,13 @@ Benchmark.bm do |x|
     end
   end
 
+  x.report("zstd_redis_cache") do
+    iterations.times do
+      zstd_redis_cache.write("test", json)
+      zstd_redis_cache.read("test")
+    end
+  end
+
   x.report("memcached_cache") do
     iterations.times do
       memcached_cache.write("test", json)
@@ -70,6 +116,13 @@ Benchmark.bm do |x|
     end
   end
 
+  x.report("zstd_memcached_cache") do
+    iterations.times do
+      zstd_memcached_cache.write("test", json)
+      zstd_memcached_cache.read("test")
+    end
+  end
+
   x.report("file_cache") do
     iterations.times do
       file_cache.write("test", json)
@@ -83,4 +136,11 @@ Benchmark.bm do |x|
       brotli_file_cache.read("test")
     end
   end
+
+  x.report("zstd_file_cache") do
+    iterations.times do
+      zstd_file_cache.write("test", json)
+      zstd_file_cache.read("test")
+    end
+  end
 end

data/lib/rails-brotli-cache/store.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require 'active_support/cache'
-require 'brotli'
+begin
+  require 'brotli'
+rescue LoadError
+end
 
 module RailsBrotliCache
   class Store < ::ActiveSupport::Cache::Store
@@ -112,8 +115,10 @@ module RailsBrotliCache
       @core_store.fetch_multi(
         *names, options.merge(compress: false)
       ) do |name|
-        compressed(yield(name), options)
-      end
+        compressed(yield(source_cache_key(name)), options)
+      end.map do |key, val|
+        [source_cache_key(key), uncompressed(val, options)]
+      end.to_h
     end
 
     def exist?(name, options = {})

data/lib/rails-brotli-cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBrotliCache
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

data/rails-brotli-cache.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
   gem.add_dependency "activesupport"
-  gem.add_dependency "brotli"
+  gem.add_development_dependency "brotli"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "railties"
   gem.add_development_dependency "activemodel"

data/spec/rails-brotli-cache/compatibility_spec.rb

@@ -13,6 +13,10 @@ describe RailsBrotliCache do
   ]
 
   CACHE_STORE_TYPES.each do |cache_store_types|
+    let(:big_enough_to_compress_value) do
+      SecureRandom.hex(2048)
+    end
+
     describe "Brotli cache has the same API as #{cache_store_types[0].class}" do
       subject(:brotli_store) do
         RailsBrotliCache::Store.new(cache_store_types[0])
@@ -32,7 +36,7 @@ describe RailsBrotliCache do
 
       it "for #read and #write" do
         int_val = 123
-        expect(brotli_store.write("int_val_key", int_val).class).to eq(standard_cache.write("int_val_key", int_val).class)
+        expect(brotli_store.write("int_val_key", big_enough_to_compress_value).class).to eq(standard_cache.write("int_val_key", big_enough_to_compress_value).class)
         expect(brotli_store.read("int_val_key")).to eq(standard_cache.read("int_val_key"))
 
         str_val = "str"
@@ -55,16 +59,15 @@ describe RailsBrotliCache do
       end
 
       it "for #fetch" do
-        val = "123"
-        expect(brotli_store.fetch("val_key") { val }).to eq(standard_cache.fetch("val_key") { val })
-        expect(brotli_store.fetch("val_key", force: true) { val }).to eq(standard_cache.fetch("val_key", force: true) { val })
+        expect(brotli_store.fetch("val_key") { big_enough_to_compress_value }).to eq(standard_cache.fetch("val_key") { big_enough_to_compress_value })
+        expect(brotli_store.fetch("val_key", force: true) { big_enough_to_compress_value }).to eq(standard_cache.fetch("val_key", force: true) { big_enough_to_compress_value })
         expect(brotli_store.fetch("val_key")).to eq(standard_cache.fetch("val_key"))
       end
 
       it "for #write_multi and #read_multi" do
         values = {
           "key_1" => "val_1",
-          "key_2" => "val_2"
+          "key_2" => big_enough_to_compress_value
         }
 
         brotli_store.write_multi(values)
@@ -78,7 +81,7 @@ describe RailsBrotliCache do
 
       it "for #fetch_multi" do
         values = {
-          "key_1" => "val_1",
+          "key_1" => big_enough_to_compress_value,
           "key_2" => "val_2"
         }
 

data/spec/rails-brotli-cache/store_spec.rb

@@ -98,9 +98,22 @@ describe RailsBrotliCache do
   end
 
   describe "fetch_multi" do
+    subject do
+      cache_store.fetch_multi(*keys) do |key|
+        big_enough_to_compress_value + key
+      end
+    end
+
+    let(:keys) { %w[key_1 key_2] }
+    let(:response) do
+      {
+        'key_1' => big_enough_to_compress_value + 'key_1',
+        'key_2' => big_enough_to_compress_value + 'key_2'
+      }
+    end
+
     it "works" do
-      cache_store.fetch_multi("key_1", "key_2", expires_in: 5.seconds) { big_enough_to_compress_value }
-      expect(cache_store.read("key_1")).to eq big_enough_to_compress_value
+      expect(subject).to eq response
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-19 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,7 +31,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Drop-in enhancement for Rails cache, offering better performance and compression