rails-brotli-cache 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412dc55dcd3f00210f9c090472b3dfcf10bedba7c2882015a74349797bfe4197
-  data.tar.gz: 7f8085d5fc354f899db174cf6080ea5f03a06f97a714afbb56b9f05aee801a2e
+  metadata.gz: 2d61874a96a2402ac69abd17762f98531de0a5b2c2749447f3c34d03dc76b57b
+  data.tar.gz: dff930d1caf6e592d207db48ffb175ebcd06bc59d228a9b5a78e3185672ee72d
 SHA512:
-  metadata.gz: 539de77bdcf9cd35b99023859a8e9c8d4cb25c99161ea32699a11818ec45f38165bf29bc7a738fb57e6ee39c8774460b9e2b8a626e77cbf1ed597b3178e6e0c4
-  data.tar.gz: 18326136e7fe619a5af79e6bb3ea803a0656a06aacdf624c7c5f8fd2ef7d175a1a9b24583675b96155e5dd3fc8e838b2dee4bdb3100366c6a799e7462c216c9d
+  metadata.gz: f3d3cda105423ff917c8b7bd1785cbad9c4577fe773d9573995f1341a6fb3093538e67febe45e6c4449c80398c5edfc95770c7b968fae78524f55bdefa92bd92
+  data.tar.gz: b705720c468a0c85e2b7cf3ff72a2c320ab0beefa3d0889c862b716d1d8d26146e5f2afe9f08bb2101e0ddc07e313cf06a85095f6b778ab8d11ef3f4977a4783

data/.gitignore

@@ -9,4 +9,5 @@ docker-compose.yml
 .byebug_history
 spec/dummy/log/
 spec/dummy/tmp/
+tmp/
 

data/README.md

@@ -2,6 +2,8 @@
 
 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.
+
 ## Benchmarks
 
 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.

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

@@ -42,6 +42,13 @@ module RailsBrotliCache
     end
 
     def write(name, value, options = nil)
+      if value.is_a?(Integer)
+        return @core_store.write(
+          cache_key(name),
+          value
+        )
+      end
+
       serialized = Marshal.dump(value)
       options = (options || {}).reverse_merge(compress: true)
 
@@ -72,6 +79,8 @@ module RailsBrotliCache
 
       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.inflate(payload.byteslice(1..-1))
@@ -94,6 +103,16 @@ module RailsBrotliCache
       @core_store.clear
     end
 
+    def increment(*args)
+      args[0] = cache_key(args[0])
+      @core_store.increment(*args)
+    end
+
+    def decrement(*args)
+      args[0] = cache_key(args[0])
+      @core_store.decrement(*args)
+    end
+
     def self.supports_cache_versioning?
       true
     end

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

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

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RailsBrotliCache do
+
+  CACHE_STORE_TYPES = [
+    [ActiveSupport::Cache::MemoryStore.new, ActiveSupport::Cache::MemoryStore.new],
+    [ActiveSupport::Cache::RedisCacheStore.new, ActiveSupport::Cache::RedisCacheStore.new],
+    [ActiveSupport::Cache::MemCacheStore.new, ActiveSupport::Cache::MemCacheStore.new],
+    [ActiveSupport::Cache::FileStore.new('./tmp'), ActiveSupport::Cache::FileStore.new('./tmp')],
+    [ActiveSupport::Cache::NullStore.new, ActiveSupport::Cache::NullStore.new]
+  ]
+
+  CACHE_STORE_TYPES.each do |cache_store_types|
+    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])
+      end
+
+      let(:standard_cache) do
+        cache_store_types[1]
+      end
+
+      it "compares the same cache stores" do
+        expect(standard_cache.class).to eq(brotli_store.core_store.class)
+      end
+
+      it "for #clear" do
+        expect(brotli_store.clear.class).to eq(standard_cache.clear.class)
+      end
+
+      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.read("int_val_key")).to eq(standard_cache.read("int_val_key"))
+
+        str_val = "str"
+        expect(brotli_store.write("str_val_key", int_val).class).to eq(standard_cache.write("str_val_key", int_val).class)
+        expect(brotli_store.read("str_val_key")).to eq(standard_cache.read("str_val_key"))
+
+        complex_val = OpenStruct.new(a: 1, b: 2)
+        expect(brotli_store.write("complex_val_key", int_val).class).to eq(standard_cache.write("complex_val_key", int_val).class)
+        expect(brotli_store.read("complex_val_key")).to eq(standard_cache.read("complex_val_key"))
+      end
+
+      it "for #increment and #decrement" do
+        expect(brotli_store.write("inc_val_key", 1).class).to eq(standard_cache.write("inc_val_key", 1).class)
+        expect(brotli_store.increment("inc_val_key").class).to eq(standard_cache.increment("inc_val_key").class)
+        expect(brotli_store.read("inc_val_key")).to eq(standard_cache.read("inc_val_key"))
+        expect(brotli_store.increment("inc_val_key", 2).class).to eq(standard_cache.increment("inc_val_key", 2).class)
+        expect(brotli_store.read("inc_val_key")).to eq(standard_cache.read("inc_val_key"))
+        expect(brotli_store.decrement("inc_val_key", 2).class).to eq(standard_cache.decrement("inc_val_key", 2).class)
+        expect(brotli_store.read("inc_val_key")).to eq(standard_cache.read("inc_val_key"))
+      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")).to eq(standard_cache.fetch("val_key"))
+      end
+    end
+  end
+end

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

@@ -40,6 +40,20 @@ describe RailsBrotliCache do
     end
   end
 
+  describe "#increment and #decrement" do
+    it "works" do
+      cache_store.write("integer-key", 0)
+      cache_store.increment("integer-key")
+      expect(cache_store.read("integer-key")).to eq 1
+      cache_store.increment("integer-key", 3)
+      expect(cache_store.read("integer-key")).to eq 4
+      cache_store.decrement("integer-key", 4)
+      expect(cache_store.read("integer-key")).to eq 0
+      cache_store.decrement("integer-key")
+      expect(cache_store.read("integer-key")).to eq -1
+    end
+  end
+
   describe "exist?" do
     it "returns true if cache entry exists" do
       cache_store.write("test-key", 1234)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-05-26 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/compatibility_spec.rb
 - spec/rails-brotli-cache/rails_store_spec.rb
 - spec/rails-brotli-cache/redis_spec.rb
 - spec/rails-brotli-cache/store_spec.rb
@@ -230,6 +231,7 @@ test_files:
 - spec/dummy/public/robots.txt
 - spec/dummy/vendor/.keep
 - spec/fixtures/sample.json
+- spec/rails-brotli-cache/compatibility_spec.rb
 - spec/rails-brotli-cache/rails_store_spec.rb
 - spec/rails-brotli-cache/redis_spec.rb
 - spec/rails-brotli-cache/store_spec.rb