rails-brotli-cache 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c290253b45a487daecc85b45026bd7d3f140644095c7f15cfb67dcee1299b8
-  data.tar.gz: d37323f26dda367401403714eb094dfd6a0e3274b7d88cb81eb2d5380ce91979
+  metadata.gz: 8f5eae03f927b9f70606cc7b4134fc7173926951da4cf05172bdd9cecb149c61
+  data.tar.gz: c89a69ec5b5d5ddbb8efb432d253784ec30be073ca0a4d142edf347cbc4b75cb
 SHA512:
-  metadata.gz: 537fe80385fbc5f8d339b56f789aaeefc45e2589456e2fb522afdcb3656af6254951654a0524b5136ad3cb25fb23c092ea6bc027377c39ed9f52645886a94fc0
-  data.tar.gz: a6057e3a65505003ee849e9f0a38a12963a78468c32275ca0e1d70ead490ddba7663d2a1d65b4359ca7fb626b27e15fc8552d77d9d35c353bbdf77f933fdb277
+  metadata.gz: 7b8b3daea70b8c8f5cd8f445ee08155eb6356fbab042db3fd505dc26e666fe8a1011080391940d1d77e08d912ddef46d9a7908377bf6135c7784c433a37ce495
+  data.tar.gz: 5c37c70c355770b708b7703333a4f941d5b28e51d8a6e140eb256ce5a145fa8da21a86cd72af9498f274c56c97d5b3daa9718e8a58aefe4e206d31f58a8d1471

data/README.md

@@ -1,8 +1,6 @@
-# Rails Brotli Cache [![Gem Version](https://badge.fury.io/rb/rails-brotli-cache.svg)](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) [![CircleCI](https://circleci.com/gh/pawurb/rails-brotli-cache.svg?style=svg)](https://circleci.com/gh/pawurb/rails-brotli-cache)
 
-This gem enables support for compressing Ruby on Rails cache entries using the [Brotli compression algorithm](https://github.com/google/brotli). `RailsBrotliCache` offers better compression and faster performance compared to the default `Rails.cache` regardless of the underlying data store.
-
-**The gem is currently in an early stage of development. Ideas on how to improve it and PRs are welcome.**
+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 faster performance compared to the default `Rails.cache` regardless of the underlying data store.
 
 ## Benchmarks
 
@@ -101,14 +99,17 @@ config.cache_store = RailsBrotliCache::Store.new(
 )
 ```
 
-Gem appends `br-` to the cache key names to prevent conflicts with previously saved cache entries. You can disable this behaviour by adding the following initializer file:
-
-`app/config/initializers/rails-brotli-cache.rb`
+Gem appends `br-` to the cache key names to prevent conflicts with previously saved cache entries. You can disable this behaviour by passing `{ prefix: nil }` during initialization:
 
 ```ruby
-Rails.cache.disable_prefix!
+config.cache_store = RailsBrotliCache::Store.new(
+  ActiveSupport::Cache::MemoryStore.new,
+  { prefix: nil }
+)
 ```
 
+Addition of the prefix means that you can safely add the Brotli the cache config and avoid compression algorithm conflicts between old and new entries. After configuring the Brotli cache you should run `Rails.cache.clear` to remove the outdated (gzipped) entries.
+
 ## Testing
 
 ```bash

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

@@ -9,9 +9,15 @@ module RailsBrotliCache
     COMPRESS_QUALITY = ENV.fetch("BR_CACHE_COMPRESS_QUALITY", 5).to_i
     MARK_BR_COMPRESSED = "\x02".b
 
+    attr_reader :core_store
+
     def initialize(core_store, options = {})
       @core_store = core_store
-      @prefix = "br-"
+      @prefix = if options.key?(:prefix)
+        options.fetch(:prefix)
+      else
+        "br-"
+      end
     end
 
     def fetch(name, options = nil, &block)
@@ -37,7 +43,12 @@ module RailsBrotliCache
       serialized = Marshal.dump(value)
 
       payload = if serialized.bytesize >= COMPRESS_THRESHOLD
-        MARK_BR_COMPRESSED + ::Brotli.deflate(serialized, quality: COMPRESS_QUALITY)
+        compressed_payload = ::Brotli.deflate(serialized, quality: COMPRESS_QUALITY)
+        if compressed_payload.bytesize < serialized.bytesize
+          MARK_BR_COMPRESSED + compressed_payload
+        else
+          serialized
+        end
       else
         serialized
       end
@@ -74,10 +85,6 @@ module RailsBrotliCache
       @core_store.clear
     end
 
-    def disable_prefix!
-      @prefix = nil
-    end
-
     private
 
     def cache_key(name)

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

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

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

@@ -5,9 +5,14 @@ require 'spec_helper'
 return unless ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
 
 describe RailsBrotliCache do
+  let(:options) do
+    {}
+  end
+
   subject(:cache_store) do
     RailsBrotliCache::Store.new(
-      ActiveSupport::Cache::RedisCacheStore.new(redis: $redis)
+      ActiveSupport::Cache::RedisCacheStore.new(redis: $redis),
+      options
     )
   end
 
@@ -28,16 +33,25 @@ describe RailsBrotliCache do
     expect($redis.get("gz-test-key").size > $redis.get("br-test-key").size).to eq true
   end
 
-  describe "disable_prefix!" do
-    it "saves brotli cache entries without `br-` prefix" do
-      cache_store.fetch("test-key") { 123 }
-      expect($redis.get("test-key")).to eq nil
-      expect($redis.get("br-test-key")).to be_present
-      cache_store.disable_prefix!
-      cache_store.fetch("test-key-2") { 123 }
-      expect($redis.get("br-test-key-2")).to eq nil
-      expect($redis.get("test-key-2")).to be_present
-      cache_store.instance_variable_set(:@prefix, "br-")
+  describe "disable_prefix" do
+    context "default prefix" do
+      it "appends 'br-' prefix" do
+        cache_store.fetch("test-key") { 123 }
+        expect($redis.get("test-key")).to eq nil
+        expect($redis.get("br-test-key")).to be_present
+      end
+    end
+
+    context "no prefix" do
+      let(:options) do
+        { prefix: nil }
+      end
+
+      it "saves brotli cache entries without `br-` prefix" do
+        cache_store.fetch("test-key") { 123 }
+        expect($redis.get("br-test-key")).to eq nil
+        expect($redis.get("test-key")).to be_present
+      end
     end
   end
 end

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

@@ -40,6 +40,12 @@ describe RailsBrotliCache do
     end
   end
 
+  describe "#core_store" do
+    it "exposes the underlying data store" do
+      expect(cache_store.core_store.class).to eq ActiveSupport::Cache::MemoryStore
+    end
+  end
+
   describe "#read and #write" do
     it "reads values stored in Rails cache with a prefix" do
       expect(cache_store.read("test-key")).to eq nil
@@ -67,12 +73,4 @@ describe RailsBrotliCache do
       expect(cache_store.read("test-key")).to eq nil
     end
   end
-
-  describe "disable_prefix!" do
-    it "saves brotli cache entries without `br-` prefix" do
-      cache_store.disable_prefix!
-      cache_store.fetch("test-key") { 123 }
-      cache_store.instance_variable_set(:@prefix, "br-")
-    end
-  end
 end

metadata

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