rails-brotli-cache 0.0.1 → 0.1.0

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RailsBrotliCache do
+  context "without prepending Rails.cache" do
+    describe "#fetch" do
+      it "stores value in the configured Rails.cache with a prefix" do
+        RailsBrotliCache.fetch("test-key") { 123 }
+        expect(RailsBrotliCache.read("test-key")).to eq 123
+        expect(Rails.cache.read("br-test-key")).to be_present
+      end
+
+      it "returns nil for missing entries if block is not provided" do
+        expect(RailsBrotliCache.fetch("missing-key")).to eq nil
+      end
+
+      context "{ force: true }" do
+        it "raises an error if block is not provided" do
+          expect {
+            RailsBrotliCache.fetch("missing-key", force: true)
+          }.to raise_error(ArgumentError)
+        end
+
+        it "always refreshes cached entry if block is provided" do
+
+        end
+      end
+    end
+
+    describe "#read and #write" do
+      it "reads values stored in Rails cache with a prefix" do
+        expect(RailsBrotliCache.read("test-key")).to eq nil
+        expect(RailsBrotliCache.write("test-key", 1234))
+        expect(RailsBrotliCache.read("test-key")).to eq 1234
+      end
+    end
+
+    describe "#delete" do
+      it "removes the previously stored cache entry" do
+        expect(RailsBrotliCache.write("test-key", 1234))
+        expect(RailsBrotliCache.read("test-key")).to eq 1234
+        RailsBrotliCache.delete("test-key")
+        expect(RailsBrotliCache.read("test-key")).to eq nil
+      end
+    end
+
+    describe "disable_prefix!" do
+      it "saves brotli cache entries without `br-` prefix" do
+        RailsBrotliCache.disable_prefix!
+        RailsBrotliCache.fetch("test-key") { 123 }
+        expect(Rails.cache.read("br-test-key")).to eq nil
+        expect(Rails.cache.read("test-key")).to be_present
+        RailsBrotliCache.class_variable_set(:@@prefix, "br-")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'redis'
+
+return unless ENV["TEST_CACHE_STORE"] == "redis_cache_store"
+$redis = Redis.new
+
+describe RailsBrotliCache do
+  it "sets correct cache store based on ENV variable" do
+    expect(Rails.cache.class).to eq ActiveSupport::Cache::RedisCacheStore
+  end
+
+  describe "#fetch" do
+    it "stores value in the configured redis cache store" do
+      RailsBrotliCache.fetch("test-key") { 123 }
+      expect($redis.get("br-test-key")).to be_present
+    end
+  end
+
+  let(:json) do
+    File.read('spec/fixtures/sample.json')
+  end
+
+  it "applies more efficient brotli compression" do
+    Rails.cache.write("gz-test-key", json)
+    RailsBrotliCache.write("test-key", json)
+    expect($redis.get("gz-test-key").size > $redis.get("br-test-key").size).to eq true
+  end
+
+  context "payloads smaller then 1kb" do
+    before do
+      # expect(Brotli).not_to receive(:deflate)
+    end
+
+    it "does not apply compression" do
+      RailsBrotliCache.write("test-key", 123)
+      expect(RailsBrotliCache.read("test-key")).to eq 123
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,14 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'rails'
+
 require_relative '../lib/rails-brotli-cache'
+require_relative '../spec/dummy/config/environment'
+ENV['RAILS_ROOT'] ||= "#{File.dirname(__FILE__)}../../../spec/dummy"
 
 RSpec.configure do |config|
+  config.before(:each) do
+    Rails.cache.clear
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " rails-brotli-cache allows to reduce storage needed for Rails cache
   by using Brotli compression which can produce outputs smaller by ~20% "
 email:
@@ -46,17 +102,61 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- docker-compose.yml.sample
 - lib/rails-brotli-cache.rb
-- lib/rails-brotli-cache/main.rb
 - lib/rails-brotli-cache/version.rb
 - rails-brotli-cache.gemspec
-- spec/rails-brotli-cache/main_spec.rb
+- spec/dummy/Gemfile
+- spec/dummy/README.md
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/credentials.yml.enc
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/permissions_policy.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/master.key
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/lib/tasks/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/robots.txt
+- spec/dummy/vendor/.keep
+- spec/fixtures/sample.json
+- spec/rails-brotli-cache/common_spec.rb
+- spec/rails-brotli-cache/redis_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pawurb/rails-brotli-cache
 licenses:
@@ -82,5 +182,49 @@ signing_key:
 specification_version: 4
 summary: Rails cache using Brotli compression algorithm
 test_files:
-- spec/rails-brotli-cache/main_spec.rb
+- spec/dummy/Gemfile
+- spec/dummy/README.md
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/credentials.yml.enc
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/permissions_policy.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/master.key
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/lib/tasks/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/robots.txt
+- spec/dummy/vendor/.keep
+- spec/fixtures/sample.json
+- spec/rails-brotli-cache/common_spec.rb
+- spec/rails-brotli-cache/redis_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,172 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rails-brotli-cache (0.0.1)
-      rails
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activestorage (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      actionview (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.3)
-      actionview (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activestorage (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.4.3)
-      activesupport (= 7.0.4.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.3)
-      activesupport (= 7.0.4.3)
-      globalid (>= 0.3.6)
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activestorage (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.4.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    builder (3.2.4)
-    concurrent-ruby (1.2.2)
-    crass (1.0.6)
-    date (3.3.3)
-    diff-lcs (1.5.0)
-    erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
-    i18n (1.13.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.20.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.2)
-    minitest (5.18.0)
-    net-imap (0.3.4)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.1)
-      timeout
-    net-smtp (0.3.3)
-      net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.14.3)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    racc (1.6.2)
-    rack (2.2.7)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails (7.0.4.3)
-      actioncable (= 7.0.4.3)
-      actionmailbox (= 7.0.4.3)
-      actionmailer (= 7.0.4.3)
-      actionpack (= 7.0.4.3)
-      actiontext (= 7.0.4.3)
-      actionview (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activestorage (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      bundler (>= 1.15.0)
-      railties (= 7.0.4.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rake (13.0.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    thor (1.2.1)
-    timeout (0.3.2)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.8)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rails-brotli-cache!
-  rspec
-
-BUNDLED WITH
-   2.1.4

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

@@ -1,5 +0,0 @@
-#encoding: UTF-8
-module RailsBrotliCache
-  class Main
-  end
-end

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

@@ -1,10 +0,0 @@
-#encoding: UTF-8
-require 'spec_helper'
-
-describe RailsBrotliCache::Main do
-  describe "it" do
-    it "works" do
-      expect(true).to be true
-    end
-  end
-end