rails-brotli-cache 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733ccaba5b7f8c9e419556a31a8abc1c5a21d3b6421c2b8c3448d8f1faa5f75c
-  data.tar.gz: 9b1c4366b7cc1c49cd31eb7258c01dfda204f31fcc1a9ce55dd28035b5c83ce1
+  metadata.gz: 25d1a71b5e57f6f4c61612ff8c4cfb99d88aba2ed41b8f2436191c5c3e31904b
+  data.tar.gz: c9305dc9477b54c0072395d6e55ede962b9c311e907025c84d1ab5dc6fdf648d
 SHA512:
-  metadata.gz: 2aadb3e61be2fefb5739c92ccb477605e6550224294ec4f4eabc71d21de068ef4b93f307a02d6e8633ab6001bc98f4c477f961811d30ee88d7a25d3ec5b04157
-  data.tar.gz: 0cfc2f0747af9d2a088f69a0c8b68d765b01ac9f1448ebafcd73a7dfa4c0dc0d0e60fd2a49b1ba6438f6bef3a5936bb19850db57282e9af2ff56c49f7e0cc4c6
+  metadata.gz: b890c5e6b89cd6150fb5e965adecfa2963cce3de9ef4a474c70a66ba7e91f5dc21bba69eed3963e7ec84ddece396cc22be18150a2d0dc54fcf0ea92c4b7be877
+  data.tar.gz: 00d8463045555382d2d59bfff056470c6066042860332d30b9cd127166be119a70c28bf39241c144413a032a6fbc87127872945213d56fbb8bf52bf86d36a73c

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

@@ -46,7 +46,7 @@ module RailsBrotliCache
       end
 
       uncompressed(
-        @core_store.fetch(cache_key(name), options.merge(compress: false)) do
+        @core_store.fetch(expanded_cache_key(name), options.merge(compress: false)) do
           if block_given?
             compressed(block.call, options)
           else
@@ -62,7 +62,7 @@ module RailsBrotliCache
       payload = compressed(value, options)
 
       @core_store.write(
-        cache_key(name),
+        expanded_cache_key(name),
         payload,
         options.merge(compress: false)
       )
@@ -72,7 +72,7 @@ module RailsBrotliCache
       options = (options || {}).reverse_merge(@init_options)
 
       payload = @core_store.read(
-        cache_key(name),
+        expanded_cache_key(name),
         options
       )
 
@@ -83,7 +83,7 @@ module RailsBrotliCache
       options = (options || {}).reverse_merge(@init_options)
       new_hash = hash.map do |key, val|
         [
-          cache_key(key),
+          expanded_cache_key(key),
           compressed(val, options)
         ]
       end
@@ -96,17 +96,17 @@ module RailsBrotliCache
 
     def read_multi(*names)
       options = names.extract_options!
-      names = names.map { |name| cache_key(name) }
+      names = names.map { |name| expanded_cache_key(name) }
       options = options.reverse_merge(@init_options)
 
-      Hash[core_store.read_multi(*names, options).map do |key, val|
+      core_store.read_multi(*names, options).map do |key, val|
         [source_cache_key(key), uncompressed(val, options)]
-      end]
+      end.to_h
     end
 
     def fetch_multi(*names)
       options = names.extract_options!
-      names = names.map { |name| cache_key(name) }
+      names = names.map { |name| expanded_cache_key(name) }
       options = options.reverse_merge(@init_options)
 
       @core_store.fetch_multi(
@@ -116,24 +116,24 @@ module RailsBrotliCache
       end
     end
 
-    def exist?(name, options = nil)
-      @core_store.exist?(cache_key(name), options)
+    def exist?(name, options = {})
+      @core_store.exist?(expanded_cache_key(name), options)
     end
 
-    def delete(name, options = nil)
-      @core_store.delete(cache_key(name), options)
+    def delete(name, options = {})
+      @core_store.delete(expanded_cache_key(name), options)
     end
 
-    def clear(options = nil)
+    def clear
       @core_store.clear
     end
 
     def increment(name, amount = 1, **options)
-      @core_store.increment(cache_key(name), amount, **options)
+      @core_store.increment(expanded_cache_key(name), amount, **options)
     end
 
     def decrement(name, amount = 1, **options)
-      @core_store.decrement(cache_key(name), amount, **options)
+      @core_store.decrement(expanded_cache_key(name), amount, **options)
     end
 
     def self.supports_cache_versioning?
@@ -174,8 +174,8 @@ module RailsBrotliCache
       Marshal.load(serialized)
     end
 
-    def cache_key(name)
-      "#{@prefix}#{name}"
+    def expanded_cache_key(name)
+      "#{@prefix}#{::ActiveSupport::Cache.expand_cache_key(name)}"
     end
 
     def source_cache_key(name)

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

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

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+return unless ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
+
+describe RailsBrotliCache do
+  class Post
+    include ActiveModel::Model
+
+    attr_accessor :id
+
+    def to_param
+      "post/#{id}"
+    end
+  end
+
+  let(:options) do
+    {}
+  end
+
+  let(:redis_store) do
+    ActiveSupport::Cache::RedisCacheStore.new({ redis: $redis }.merge(options))
+  end
+
+  let(:brotli_store) do
+    RailsBrotliCache::Store.new(
+      ActiveSupport::Cache::RedisCacheStore.new(redis: $redis),
+      options
+    )
+  end
+
+  describe "generated cache keys are identical to standard cache stores" do
+    it "works for string keys" do
+      redis_store.fetch("string-key") { 123 }
+      brotli_store.fetch("string-key") { 123 }
+      expect($redis.get("br-string-key")).to be_present
+      expect($redis.get("string-key")).to be_present
+    end
+
+    it "ActiveModel object keys" do
+      post_1 = Post.new(id: 1)
+      redis_store.fetch(post_1) { 123 }
+      brotli_store.fetch(post_1) { 123 }
+      expect($redis.get("br-post/1")).to be_present
+      expect($redis.get("post/1")).to be_present
+    end
+
+    it "ActiveModel objects complex collection keys" do
+      post_1 = Post.new(id: 1)
+      post_2 = Post.new(id: 2)
+      collection = [post_1, post_2]
+      redis_store.fetch([:views, "controller/action", collection]) { 123 }
+      brotli_store.fetch([:views, "controller/action", collection]) { 123 }
+      expect($redis.get("views/controller/action/post/1/post/2")).to be_present
+      expect($redis.get("br-views/controller/action/post/1/post/2")).to be_present
+      expect(brotli_store.read([:views, "controller/action", collection])).to eq 123
+    end
+
+    context "custom namespace string is not duplicated" do
+      let(:options) do
+        {
+          namespace: "myapp"
+        }
+      end
+
+      it "activemodel object keys" do
+        post_1 = Post.new(id: 1)
+        redis_store.fetch(post_1) { 123 }
+        brotli_store.fetch(post_1) { 123 }
+        expect($redis.get("myapp:post/1")).to be_present
+        expect($redis.get("myapp:br-post/1")).to be_present
+        expect(brotli_store.read(post_1)).to eq 123
+      end
+    end
+
+    context "custom namespace proc" do
+      @@counter = 0
+      let(:options) do
+        {
+          namespace: -> { "myapp" }
+        }
+      end
+
+      it "activemodel object keys" do
+        post_1 = Post.new(id: 1)
+        redis_store.fetch(post_1) { 123 }
+        brotli_store.fetch(post_1) { 123 }
+        expect($redis.get("myapp:post/1")).to be_present
+        expect($redis.get("myapp:br-post/1")).to be_present
+        expect(brotli_store.read(post_1)).to eq 123
+      end
+    end
+  end
+end

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

@@ -28,6 +28,16 @@ describe RailsBrotliCache do
     end
   end
 
+  class Post
+    include ActiveModel::Model
+
+    attr_accessor :id
+
+    def to_param
+      "post/#{id}"
+    end
+  end
+
   describe "#fetch" do
     it "stores value in the configured Rails.cache with a prefix" do
       cache_store.fetch("test-key") { 123 }
@@ -45,6 +55,15 @@ describe RailsBrotliCache do
       expect(cache_store.read("test-key")).to eq 1
     end
 
+    it "stores and reads fragment caches with complex objects as cache keys" do
+      cached_fragment = "<div>Cached fragment</div>"
+
+      collection = [Post.new(id: 1), Post.new(id: 2)]
+
+      cache_store.fetch([:views, "controller/action", collection]) { cached_fragment }
+      expect(cache_store.read([:views, "controller/action", collection])).to eq(cached_fragment)
+    end
+
     context "{ force: true }" do
       it "raises an error if block is not provided" do
         expect {
@@ -127,6 +146,15 @@ describe RailsBrotliCache do
       expect(cache_store.read("test-key")).to eq big_enough_to_compress_value
     end
 
+    it "writes and reads fragment caches with complex objects as cache keys" do
+      cached_fragment = "<div>Cached fragment</div>"
+
+      collection = [Post.new(id: 1), Post.new(id: 2)]
+
+      cache_store.write([:views, "controller/action", [collection, nil]], cached_fragment)
+      expect(cache_store.read([:views, "controller/action", [collection, nil]])).to eq(cached_fragment)
+    end
+
     describe ":compressor_class option" do
       context "as an init config" do
         let(:options) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.4
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -158,6 +158,7 @@ files:
 - spec/dummy/public/robots.txt
 - spec/dummy/vendor/.keep
 - spec/fixtures/sample.json
+- spec/rails-brotli-cache/cache_keys_spec.rb
 - spec/rails-brotli-cache/compatibility_spec.rb
 - spec/rails-brotli-cache/rails_store_spec.rb
 - spec/rails-brotli-cache/redis_spec.rb
@@ -231,6 +232,7 @@ test_files:
 - spec/dummy/public/robots.txt
 - spec/dummy/vendor/.keep
 - spec/fixtures/sample.json
+- spec/rails-brotli-cache/cache_keys_spec.rb
 - spec/rails-brotli-cache/compatibility_spec.rb
 - spec/rails-brotli-cache/rails_store_spec.rb
 - spec/rails-brotli-cache/redis_spec.rb