rails-brotli-cache 0.4.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc23ad28701bc9e25cd808d4bc42e38f8090ae8e172f9ef6e5df26e928aeb33
-  data.tar.gz: efdb00baa4949466649fcfa6090089d69755b0242ebe926c00004c702b02c575
+  metadata.gz: 38153c74bf09ef2a13760b3dea18a3a3e97790104b1af8a8d244ee104d0ad34e
+  data.tar.gz: ed7760dd1e7373fa7e855f57ec7082a185f68b114e43bd051d29fb4be7619020
 SHA512:
-  metadata.gz: 2162ea8442386415372396ef1dbf89241b0d9a03661b6873b1da46b9f83ac9d534efa942eb8786c208acc83c64bef89dfbc802ec4bae5ded41d04b2d29e5e8db
-  data.tar.gz: 27b73bd1e0b299e866036962d21e0ba74393d886d82c385ad06b144292c24ec67ce20df918a3074f4407848aa7b8db2d4926585dc85c786e62569df2bdcad7f2
+  metadata.gz: dc9430106e033158f55f6421d42253a8aaec9b62833687538a289010e8b67b1ffc4a75ba0b71071e5925b7256d2d070b5930719ebd40d5a60f28dc6d7cd4cd19
+  data.tar.gz: 47483feabfac21321eb6e4e6a0df6d5ffa8646261dbeb7b728897f3026f4deff699e682a4cf525f8cca79b824082173637baf9517d8e96c3cfd91aaf9b0b3291

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis:alpine
+        ports: ["6379:6379"]
+      memcached:
+        image: memcached:alpine
+        ports: ["11211:11211"]
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0', '2.7', '2.6']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests for Redis cache store
+        run: TEST_RAILS_CACHE_STORE=redis_cache_store bundle exec rspec spec
+      - name: Run tests for Memcache cache store
+        run: TEST_RAILS_CACHE_STORE=mem_cache_store bundle exec rspec spec
+      - name: Run tests for Brotli cache store
+        run: TEST_RAILS_CACHE_STORE=brotli_cache_store bundle exec rspec spec
+      - name: Run tests for in-memory cache store
+        run: bundle exec rspec spec
+

data/README.md

@@ -1,8 +1,17 @@
-# 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)
+# Rails Brotli Cache [![Gem Version](https://img.shields.io/gem/v/rails-brotli-cache)](https://badge.fury.io/rb/rails-brotli-cache) [![GH Actions](https://github.com/pawurb/rails-brotli-cache/actions/workflows/ci.yml/badge.svg)](https://github.com/pawurb/rails-brotli-cache/actions)
 
 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.
+You can check out [this blog post](https://pawelurbanek.com/rails-brotli-cache) describing the gem in more detail.
+
+## Installation
+
+`Gemfile`
+
+```ruby
+  gem 'brotli' # brotli is an optional dependency because other compressors are supported
+  gem 'rails-brotli-cache'
+```
 
 ## Benchmarks
 

data/Rakefile

@@ -7,5 +7,5 @@ task default: :spec
 
 desc 'Test all cache_stores'
 task :test_all do
-  system("RAILS_CACHE_STORE=redis_cache_store bundle exec rspec spec/ && RAILS_CACHE_STORE=brotli_cache_store bundle exec rspec spec/ && bundle exec rspec spec/")
+  system("TEST_RAILS_CACHE_STORE=redis_cache_store bundle exec rspec spec && TEST_RAILS_CACHE_STORE=brotli_cache_store bundle exec rspec spec && TEST_RAILS_CACHE_STORE=mem_cache_store bundle exec rspec spec && bundle exec rspec spec")
 end

data/benchmarks/main.rb

@@ -1,6 +1,8 @@
-require 'rails'
+require 'active_support'
+require 'active_support/core_ext/hash'
 require 'net/http'
 require 'rails-brotli-cache'
+require 'benchmark'
 
 memory_cache = ActiveSupport::Cache::MemoryStore.new(compress: true) # memory store does not use compression by default
 brotli_memory_cache = RailsBrotliCache::Store.new(memory_cache)

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require 'active_support/cache'
-require 'brotli'
+begin
+  require 'brotli'
+rescue LoadError
+end
 
 module RailsBrotliCache
   class Store < ::ActiveSupport::Cache::Store

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

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

data/rails-brotli-cache.gemspec

@@ -15,9 +15,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
-  gem.add_dependency "rails"
-  gem.add_dependency "brotli"
+  gem.add_dependency "activesupport"
+  gem.add_development_dependency "brotli"
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "railties"
+  gem.add_development_dependency "activemodel"
+  gem.add_development_dependency "actionpack"
   gem.add_development_dependency "redis"
   gem.add_development_dependency "dalli"
   gem.add_development_dependency "byebug"

data/spec/dummy/config/application.rb

@@ -21,7 +21,12 @@ Bundler.require(*Rails.groups)
 module Dummy
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.
-    config.load_defaults 7.0
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
+      config.load_defaults 7.0
+    else
+      config.load_defaults 6.0
+    end
 
     # Configuration for the application, engines, and railties goes here.
     #

data/spec/dummy/config/environments/development.rb

@@ -19,7 +19,7 @@ Rails.application.configure do
 
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
-  config.cache_store = $rails_cache_store
+  config.cache_store = $test_rails_cache_store
 
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-return unless ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
+return unless ENV['TEST_RAILS_CACHE_STORE'] == 'redis_cache_store'
 
 describe RailsBrotliCache do
   class Post
@@ -20,7 +20,7 @@ describe RailsBrotliCache do
   end
 
   let(:redis_store) do
-    ActiveSupport::Cache::RedisCacheStore.new({ redis: $redis }.merge(options))
+    ActiveSupport::Cache::RedisCacheStore.new(**{ redis: $redis }.merge(options))
   end
 
   let(:brotli_store) do
@@ -75,7 +75,6 @@ describe RailsBrotliCache do
     end
 
     context "custom namespace proc" do
-      @@counter = 0
       let(:options) do
         {
           namespace: -> { "myapp" }

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-return unless ENV['RAILS_CACHE_STORE'] == 'brotli_cache_store'
+return unless ENV['TEST_RAILS_CACHE_STORE'] == 'brotli_cache_store'
 
 describe RailsBrotliCache do
   subject(:cache_store) do

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-return unless ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
+return unless ENV['TEST_RAILS_CACHE_STORE'] == 'redis_cache_store'
 
 describe RailsBrotliCache do
   let(:options) do

data/spec/spec_helper.rb

@@ -1,15 +1,18 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'rails'
+require "active_support"
+require "active_support/core_ext/hash"
 require 'redis'
 
 require_relative '../lib/rails-brotli-cache'
 
 $redis = Redis.new
-$rails_cache_store = if ENV['RAILS_CACHE_STORE'] == 'redis_cache_store'
+$test_rails_cache_store = if ENV['TEST_RAILS_CACHE_STORE'] == 'redis_cache_store'
   ActiveSupport::Cache::RedisCacheStore.new(redis: $redis)
-elsif ENV['RAILS_CACHE_STORE'] == 'brotli_cache_store'
+elsif ENV['TEST_RAILS_CACHE_STORE'] == 'brotli_cache_store'
   RailsBrotliCache::Store.new(ActiveSupport::Cache::MemoryStore.new)
+elsif ENV['TEST_RAILS_CACHE_STORE'] == 'memcache_cache_store'
+  ActiveSupport::Cache::ActiveSupport::Cache::MemCacheStore.new
 else
   ActiveSupport::Cache::MemoryStore.new
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails-brotli-cache
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.6.0
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,7 +31,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: activemodel
+  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: actionpack
+  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: redis
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -169,7 +211,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Drop-in enhancement for Rails cache, offering better performance and compression
   with Brotli algorithm.

data/.circleci/config.yml

@@ -1,34 +0,0 @@
-version: 2
-jobs:
-  test:
-    docker:
-      - image: cimg/ruby:2.7.6
-      - image: redis:alpine
-      - image: memcached:alpine
-    parallelism: 1
-    steps:
-      - checkout
-      - run: gem update --system
-      - run: gem install bundler
-      - run: sudo apt-get update --allow-releaseinfo-change
-      - run: bundle config set --local path 'vendor/bundle'
-      - run: bundle install
-      - run: sleep 5
-      - run:
-          name: Run specs for redis cache store
-          environment:
-            TEST_CACHE_STORE: redis_cache_store
-          command: bundle exec rspec spec/
-      - run:
-          name: Run specs for memcached cache store
-          environment:
-            TEST_CACHE_STORE: mem_cache_store
-          command: bundle exec rspec spec/
-      - run:
-          name: Run specs for in-memory cache store
-          command: bundle exec rspec spec/
-workflows:
-  version: 2
-  test:
-    jobs:
-      - test