rails-brotli-cache 0.3.13 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b682e9036d04afd87ca6369b612d524f65cf698ad53f23f06828d7e74690cd3a
-  data.tar.gz: 55a11863fc1e5027be392685beb2cdcb39ed12ea3b66f2761dc4ecfacea49eaa
+  metadata.gz: 9f95297d5e14bdcdef5195541bdcde94c2c0cbbf91cf4cb546f77edce9e67c5b
+  data.tar.gz: 7c0d650a47162ecc053fa3dca2c7824f3b9de173289321212c57d600afa87897
 SHA512:
-  metadata.gz: bfc5e4b2224c5525c91ec7061263dac04cb6f4d0b045000977cd9c1ca90bcf2e07579e08083c4fc3621760b4cc887645c4408d0695da6a98dc54a170a6200f0d
-  data.tar.gz: 2fc5a1e3773b7d310e4b34b46f9209169dab055f02a8cbd7403ad8db467c399a517c7ca66d3a69e0feb89109a0596c8c1a9cd91f24ac533b05890921f6d7bfba
+  metadata.gz: c5fcbc3d4605329e227ca69fe94d320e16ea3f825babb6fa547e384df51b15879553800960615e1db9f24b3123747a07a9411837b6a5d9ff03591564f09a7840
+  data.tar.gz: 8e9200b30e53bdabee4f4f803384c84247aea22fb4e42d838e7eedd09fb8843b06b336f0ed4de401687a61a9dcd5ec37f51ade8daf3af8c322be1aace241e53d

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

@@ -9,6 +9,22 @@ module RailsBrotliCache
     BR_COMPRESS_QUALITY = ENV.fetch("BR_CACHE_COMPRESS_QUALITY", 5).to_i
     MARK_BR_COMPRESSED = "\x02".b
 
+    class BrotliCompressor
+      def self.deflate(payload)
+        ::Brotli.deflate(payload, quality: BR_COMPRESS_QUALITY)
+      end
+
+      def self.inflate(payload)
+        ::Brotli.inflate(payload)
+      end
+    end
+
+    DEFAULT_OPTIONS = {
+      compress_threshold: COMPRESS_THRESHOLD,
+      compress: true,
+      compressor_class: BrotliCompressor
+    }
+
     attr_reader :core_store
 
     def initialize(core_store, options = {})
@@ -19,11 +35,11 @@ module RailsBrotliCache
         "br-"
       end
 
-      @compressor_class = compressor_class(options, default: BrotliCompressor)
+      @init_options = options.reverse_merge(DEFAULT_OPTIONS)
     end
 
     def fetch(name, options = nil, &block)
-      options ||= {}
+      options = (options || {}).reverse_merge(@init_options)
 
       if !block_given? && options[:force]
         raise ArgumentError, "Missing block: Calling `Cache#fetch` with `force: true` requires a block."
@@ -42,7 +58,7 @@ module RailsBrotliCache
     end
 
     def write(name, value, options = nil)
-      options = (options || {}).reverse_merge(compress: true)
+      options = (options || {}).reverse_merge(@init_options)
       payload = compressed(value, options)
 
       @core_store.write(
@@ -53,6 +69,8 @@ module RailsBrotliCache
     end
 
     def read(name, options = nil)
+      options = (options || {}).reverse_merge(@init_options)
+
       payload = @core_store.read(
         cache_key(name),
         options
@@ -62,7 +80,7 @@ module RailsBrotliCache
     end
 
     def write_multi(hash, options = nil)
-      options ||= {}
+      options = (options || {}).reverse_merge(@init_options)
       new_hash = hash.map do |key, val|
         [
           cache_key(key),
@@ -79,6 +97,7 @@ module RailsBrotliCache
     def read_multi(*names)
       options = names.extract_options!
       names = names.map { |name| cache_key(name) }
+      options = options.reverse_merge(@init_options)
 
       Hash[core_store.read_multi(*names, options).map do |key, val|
         [source_cache_key(key), uncompressed(val, options)]
@@ -88,6 +107,7 @@ module RailsBrotliCache
     def fetch_multi(*names)
       options = names.extract_options!
       names = names.map { |name| cache_key(name) }
+      options = options.reverse_merge(@init_options)
 
       @core_store.fetch_multi(
         *names, options.merge(compress: false)
@@ -125,13 +145,11 @@ module RailsBrotliCache
     private
 
     def compressed(value, options)
-      options ||= {}
-
       return value if value.is_a?(Integer)
       serialized = Marshal.dump(value)
 
-      if serialized.bytesize >= COMPRESS_THRESHOLD && !options.fetch(:compress) == false
-        compressor = compressor_class(options, default: @compressor_class)
+      if serialized.bytesize >= options.fetch(:compress_threshold) && !options.fetch(:compress) == false
+        compressor = options.fetch(:compressor_class)
         compressed_payload = compressor.deflate(serialized)
         if compressed_payload.bytesize < serialized.bytesize
           MARK_BR_COMPRESSED + compressed_payload
@@ -144,14 +162,12 @@ module RailsBrotliCache
     end
 
     def uncompressed(payload, options)
-      options ||= {}
-
       return nil unless payload.present?
 
       return payload if payload.is_a?(Integer)
 
       serialized = if payload.start_with?(MARK_BR_COMPRESSED)
-        compressor = compressor_class(options, default: @compressor_class)
+        compressor = options.fetch(:compressor_class)
         compressor.inflate(payload.byteslice(1..-1))
       else
         payload
@@ -160,15 +176,6 @@ module RailsBrotliCache
       Marshal.load(serialized)
     end
 
-    def compressor_class(options, default:)
-      options = options || {}
-      if (klass = options[:compressor_class])
-        klass
-      else
-        default
-      end
-    end
-
     def cache_key(name)
       "#{@prefix}#{name}"
     end
@@ -176,15 +183,5 @@ module RailsBrotliCache
     def source_cache_key(name)
       name.delete_prefix(@prefix.to_s)
     end
-
-    class BrotliCompressor
-      def self.deflate(payload)
-        ::Brotli.deflate(payload, quality: BR_COMPRESS_QUALITY)
-      end
-
-      def self.inflate(payload)
-        ::Brotli.inflate(payload)
-      end
-    end
   end
 end

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

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

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

@@ -4,16 +4,6 @@ require 'spec_helper'
 
 return unless ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
 
-class DummyCompressor
-  def self.deflate(payload)
-    payload
-  end
-
-  def self.inflate(payload)
-    payload
-  end
-end
-
 describe RailsBrotliCache do
   let(:options) do
     {}
@@ -49,12 +39,6 @@ describe RailsBrotliCache do
     expect($redis.get("gz-test-key").size < $redis.get("br-test-key").size).to eq true
   end
 
-  it "allows specyfing custom compressor class" do
-    Rails.cache.write("gz-test-key", json)
-    cache_store.write("test-key", json, compressor_class: DummyCompressor)
-    expect($redis.get("gz-test-key").size < $redis.get("br-test-key").size).to eq true
-  end
-
   describe "disable_prefix" do
     context "default prefix" do
       it "appends 'br-' prefix" do

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

@@ -4,7 +4,28 @@ require 'spec_helper'
 
 describe RailsBrotliCache do
   subject(:cache_store) do
-    RailsBrotliCache::Store.new(ActiveSupport::Cache::MemoryStore.new)
+    RailsBrotliCache::Store.new(
+      ActiveSupport::Cache::MemoryStore.new,
+      options
+    )
+  end
+
+  let(:big_enough_to_compress_value) do
+    SecureRandom.hex(2048)
+  end
+
+  let(:options) do
+    {}
+  end
+
+  class DummyCompressor
+    def self.deflate(payload)
+      Zlib::Deflate.deflate(payload)
+    end
+
+    def self.inflate(payload)
+      Zlib::Inflate.inflate(payload)
+    end
   end
 
   describe "#fetch" do
@@ -38,6 +59,30 @@ describe RailsBrotliCache do
         expect(cache_store.read("forced-key")).to eq 2
       end
     end
+
+    it "stores value in the configured Rails.cache when options passed" do
+      cache_store.fetch("test-key", expires_in: 5.seconds) { big_enough_to_compress_value }
+      expect(cache_store.read("test-key")).to eq big_enough_to_compress_value
+    end
+  end
+
+  describe "#write_multi and #read_multi" do
+    it "works" do
+      values = {
+        "key_1" => big_enough_to_compress_value,
+        "key_2" => 123
+      }
+
+      cache_store.write_multi(values, expires_in: 5.seconds)
+      expect(cache_store.read_multi("key_1", "key_2")).to eq values
+    end
+  end
+
+  describe "fetch_multi" do
+    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
+    end
   end
 
   describe "#increment and #decrement" do
@@ -72,20 +117,60 @@ describe RailsBrotliCache do
   end
 
   describe "#read and #write" do
+    let(:one_kb_value) do
+      SecureRandom.hex(512)
+    end
+
     it "reads values stored in Rails cache with a prefix" do
       expect(cache_store.read("test-key")).to eq nil
-      expect(cache_store.write("test-key", 1234))
-      expect(cache_store.read("test-key")).to eq 1234
+      expect(cache_store.write("test-key", big_enough_to_compress_value))
+      expect(cache_store.read("test-key")).to eq big_enough_to_compress_value
     end
 
-    context "payloads smaller then 1kb" do
-      before do
-        expect(Brotli).not_to receive(:deflate)
+    describe ":compressor_class option" do
+      context "as an init config" do
+        let(:options) do
+          { compressor_class: DummyCompressor }
+        end
+
+        it "calls the custom compressor_class" do
+          expect(DummyCompressor).to receive(:deflate).and_call_original
+          cache_store.write("test-key", one_kb_value)
+          expect(DummyCompressor).to receive(:inflate).and_call_original
+          cache_store.read("test-key")
+        end
       end
 
-      it "does not apply compression" do
+      context "as an method call" do
+        it "calls the custom compressor_class" do
+          expect(DummyCompressor).to receive(:deflate).and_call_original
+          cache_store.write("test-key", one_kb_value, compressor_class: DummyCompressor)
+          expect(DummyCompressor).to receive(:inflate).and_call_original
+          cache_store.read("test-key", compressor_class: DummyCompressor)
+        end
+      end
+    end
+
+    describe ":compress_threshold option" do
+      it "applies compression for larger objects" do
+        expect(Brotli).to receive(:deflate).and_call_original
+        cache_store.write("test-key", one_kb_value)
+      end
+
+      it "does not apply compression for smaller objects" do
+        expect(Brotli).not_to receive(:deflate)
         cache_store.write("test-key", 123)
-        expect(cache_store.read("test-key")).to eq 123
+      end
+
+      context "custom :compress_threshold value" do
+        let(:options) do
+          { compress_threshold: 2.kilobyte }
+        end
+
+        it "does not apply compression for objects smaller then custom threshold" do
+          expect(Brotli).not_to receive(:deflate)
+          cache_store.write("test-key", one_kb_value)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.4.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails