rails-brotli-cache 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c53c91a3df8a561eadcb309bc1a0a3315ca331ec36fe9bfe0995b21dc09c821b
-  data.tar.gz: d74f60c63d75643f57ac1c3568b436ed817dcb69e73cd19d4ab369c420deeba2
+  metadata.gz: 412dc55dcd3f00210f9c090472b3dfcf10bedba7c2882015a74349797bfe4197
+  data.tar.gz: 7f8085d5fc354f899db174cf6080ea5f03a06f97a714afbb56b9f05aee801a2e
 SHA512:
-  metadata.gz: f2f4b9f01712a860dd57b6da48cb284c68a92593a50955796abf8eafd8b32e5b712233d0e7029aa3c26ed65b098547e25a3311b83cf6c94f8c6f74b2cdcaf443
-  data.tar.gz: c858ee0fd911aa7805ed2b74ab9dc15328b3584918b5da262b60df3a8a27f9982412b00001ba9da4f189038c57e9b0e2620116dba60b4982b91b5da8f7ad8ae4
+  metadata.gz: 539de77bdcf9cd35b99023859a8e9c8d4cb25c99161ea32699a11818ec45f38165bf29bc7a738fb57e6ee39c8774460b9e2b8a626e77cbf1ed597b3178e6e0c4
+  data.tar.gz: 18326136e7fe619a5af79e6bb3ea803a0656a06aacdf624c7c5f8fd2ef7d175a1a9b24583675b96155e5dd3fc8e838b2dee4bdb3100366c6a799e7462c216c9d

data/README.md

@@ -1,10 +1,10 @@
 # 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::Store` offers better compression and faster performance compared to the default `Rails.cache`, regardless of the underlying data store. The gem also allows specifying any custom compression algorithm instead of Brotli.
+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.
 
 ## Benchmarks
 
-Brotli cache works as a proxy layer wrapping the underlying cache data store.
+Brotli cache works as a proxy layer wrapping the standard cache data store. It applies Brotli compression instead of the default Gzip before storing cache entries.
 
 ```ruby
 redis_cache = ActiveSupport::Cache::RedisCacheStore.new(
@@ -23,8 +23,8 @@ brotli_redis_cache.write("json", json)
 
 ## Check the size of cache entries stored in Redis
 redis = Redis.new(url: "redis://localhost:6379")
-redis.get("json").size # => 31698
-redis.get("br-json").size # => 24058
+redis.get("json").size # => 31698 ~31kb
+redis.get("br-json").size # => 24058 ~24kb
 ```
 
 **~20%** better compression of a sample ActiveRecord objects array:
@@ -34,8 +34,8 @@ users = User.limit(100).to_a # 100 ActiveRecord objects
 redis_cache.write("users", users)
 brotli_redis_cache.write("users", users)
 
-redis.get("users").size # => 12331
-redis.get("br-users").size # => 10299
+redis.get("users").size # => 12331 ~12kb
+redis.get("br-users").size # => 10299 ~10kb
 ```
 
 **~25%** faster performance for reading/writing a larger JSON file:
@@ -103,7 +103,7 @@ config.cache_store = RailsBrotliCache::Store.new(
 )
 ```
 
-You should avoid using it with `ActiveSupport::Cache::MemoryStore`. This type of cache store does not serialize or compress objects but keeps them directly in the RAM of a Ruby process. In this case, adding this gem would reduce RAM usage but add huge performance overhead.
+You should avoid using it with `ActiveSupport::Cache::MemoryStore`. This type of cache store does not serialize or compress objects but keeps them directly in the RAM. In this case, adding this gem would reduce RAM usage but add huge performance overhead.
 
 Gem appends `br-` to the cache key names to prevent conflicts with previously saved entries. You can disable this behavior by passing `{ prefix: nil }` during initialization:
 

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

@@ -82,6 +82,10 @@ module RailsBrotliCache
       Marshal.load(serialized)
     end
 
+     def exist?(name, options = nil)
+      @core_store.exist?(cache_key(name), options)
+    end
+
     def delete(name, options = nil)
       @core_store.delete(cache_key(name), options)
     end
@@ -90,6 +94,10 @@ module RailsBrotliCache
       @core_store.clear
     end
 
+    def self.supports_cache_versioning?
+      true
+    end
+
     private
 
     def compressor_class(options, default:)

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

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

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

@@ -40,6 +40,17 @@ describe RailsBrotliCache do
     end
   end
 
+  describe "exist?" do
+    it "returns true if cache entry exists" do
+      cache_store.write("test-key", 1234)
+      expect(cache_store.exist?("test-key")).to eq true
+    end
+
+    it "returns false if cache entry does not exist" do
+      expect(cache_store.exist?("test-key")).to eq false
+    end
+  end
+
   describe "#core_store" do
     it "exposes the underlying data store" do
       expect(cache_store.core_store.class).to eq ActiveSupport::Cache::MemoryStore

metadata

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