rails-brotli-cache 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d098c81efe4a27494a1fe24ca629a6b15626b422562d0a730a49391bfda6c89
-  data.tar.gz: fa966f9fed6b7b3af70b4813c1913f90e1f8676fdcca1002be50fa0489d22829
+  metadata.gz: 16016a858334a3110d884e44bf6ce43fce75ac926c75973980f189a1477152b3
+  data.tar.gz: 58756fbc6b6da6bde9144f07352302814d638664b567ad9f51ad069073ac0b35
 SHA512:
-  metadata.gz: 8243b75dcc06ce8be2abe75b205257a2c753392fd12e29490d55b2c8137a8ce9c5ab6742da28adf4de5469cdf87670bf4fa65eafc1264aee20e73addceef8314
-  data.tar.gz: 5db4acf073dcbc191acc8cfa60397c95009e6630fb6243bb7bebe78951516d85565b445d28ab9b6522883f09b20f44fabd4dfd31e7f171c4fcbaca3bf444f751
+  metadata.gz: 7276bf3a52a7861fc80c3be8772c190bbc153c26b26f88c152bce44083aae5cfb294b6720d23f40a0f6766905b6b17431d7c1295781604224af9f6738741a68a
+  data.tar.gz: 4c784d5e0ce3fbe2c7242d875b4be25b87b2984148e54ab981d47069613d165b0065e57b0336f933e4bb7206453eb95cb66870dc2eb37d7b2bba005b52bf4e9f

data/.circleci/config.yml

@@ -0,0 +1,34 @@
+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

data/.gitignore

@@ -1,3 +1,12 @@
 .tool-versions
 coverage/
+pkg/
+Gemfile.lock
+.ruby-version
+pkg/
+*.gem
+docker-compose.yml
+.byebug_history
+spec/dummy/log/
+spec/dummy/tmp/
 

data/README.md

@@ -1,3 +1,92 @@
-# Rails Brotli Cache
+# Rails Brotli Cache [![Gem Version](https://badge.fury.io/rb/rails-brotli-cache.svg)](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)
 
-WIP
+This gem enables support for compressing Ruby on Rails cache entries using the [Brotli compression algorithm](https://github.com/google/brotli). Brotli is a modern compression algorithm developed by Google that provides superior compression ratios and performance compared to the default Gzip algorithm.
+
+**The gem is currently in an early stage of development. Ideas on how to improve it and PRs are welcome.**
+
+## Benchmarks
+
+Brotli offers a better compression and faster performance.
+
+**~25%** better compression of a sample JSON object:
+
+```ruby
+json = File.read("sample.json") # sample 565kb JSON text
+json.size # => 562033
+Rails.cache.write("json", json)
+RailsBrotliCache.write("json", json)
+
+## Check the size of cache entry stored in Redis
+$redis.get("json").size # => 41697
+$redis.get("br-json").size # => 31601
+```
+
+**~20%** better compression of a sample ActiveRecord objects array:
+
+```ruby
+users = User.limit(100).to_a # 100 ActiveRecord objects
+Rails.cache.write("users", users)
+RailsBrotliCache.write("users", users)
+$redis.get("users").size # => 12331
+$redis.get("br-users").size # => 10299
+```
+
+
+**~25%** faster performance for reading/writing a larger JSON file:
+
+```ruby
+json = File.read("sample.json") # sample 565kb JSON text
+
+Benchmark.bm do |x|
+  x.report("Rails.cache") do
+    1000.times do
+      Rails.cache.write("test", json)
+      Rails.cache.read("test")
+    end
+  end
+
+  x.report("RailsBrotliCache") do
+    1000.times do
+      RailsBrotliCache.write("test", json)
+      RailsBrotliCache.read("test")
+    end
+  end
+end
+
+# user     system      total        real
+# Rails.cache  5.177678   0.216435   5.394113 (  8.296072)
+# RailsBrotliCache  3.513312   0.323601   3.836913 (  6.114179)
+```
+
+## API
+
+`RailsBrotliCache` module exposes methods that are compatible with the default `Rails.cache`. Values are stored in the underlying `Rails.cache` store but precompressed with Brotli algorithm.
+
+You can use it just like the default `Rails.cache` API:
+
+```ruby
+RailsBrotliCache.read("test-key") # => nil
+RailsBrotliCache.fetch("test-key") { 123 } # => 123
+RailsBrotliCache.delete("test-key")
+RailsBrotliCache.read("test-key") # => nil
+RailsBrotliCache.write("test-key", 123, expires_in: 5.seconds)
+sleep 6
+RailsBrotliCache.read("test-key") # => nil
+
+```
+
+Gem appends `br-` to the cache key names to prevent conflicts with previously saved cache entries. You can disable this behaviour by adding the following initializer file:
+
+`app/config/initializers/rails-brotli-cache.rb`
+
+```ruby
+RailsBrotliCache.disable_prefix!
+```
+
+## Testing
+
+```bash
+cp docker-compose.yml.sample docker-compose.yml
+docker compose up -d
+rake test_all
+```

data/Rakefile

@@ -4,3 +4,8 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc 'Test all cache_stores'
+task :test_all do
+  system("TEST_CACHE_STORE=redis_cache_store bundle exec rspec spec/ && TEST_CACHE_STORE=mem_cache_store bundle exec rspec spec/ && bundle exec rspec spec/")
+end

data/docker-compose.yml.sample

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  redis:
+    image: redis:alpine
+    ports:
+      - '6379:6379'
+  memcached:
+    image: memcached:alpine
+    ports:
+      - '11211:11211'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsBrotliCache
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/rails-brotli-cache.rb

@@ -1,5 +1,73 @@
-require 'rails-brotli-cache/main'
+# frozen_string_literal: true
+
 require 'rails-brotli-cache/version'
+require 'brotli'
 
 module RailsBrotliCache
+  COMPRESS_THRESHOLD = ENV.fetch("BR_CACHE_COMPRESS_THRESHOLD", 1).to_f * 1024.0
+  COMPRESS_QUALITY = ENV.fetch("BR_CACHE_COMPRESS_QUALITY", 5).to_i
+  MARK_BR_COMPRESSED = "\x02".b
+  @@prefix = "br-"
+
+  def self.fetch(name, options = nil, &block)
+    value = read(name, options)
+    return value if value.present?
+
+    if block_given?
+      value = block.call
+      write(name, value, options)
+
+      value
+    elsif options && options[:force]
+      raise ArgumentError, "Missing block: Calling `Cache#fetch` with `force: true` requires a block."
+    else
+      read(name, options)
+    end
+  end
+
+  def self.write(name, value, options = nil)
+    serialized = Marshal.dump(value)
+
+    payload = if serialized.bytesize >= COMPRESS_THRESHOLD
+      MARK_BR_COMPRESSED + ::Brotli.deflate(serialized, quality: COMPRESS_QUALITY)
+    else
+      serialized
+    end
+
+    Rails.cache.write(
+      cache_key(name),
+      payload,
+      (options || {}).merge(compress: false)
+    )
+  end
+
+  def self.read(name, options = nil)
+    payload = Rails.cache.read(
+      cache_key(name),
+      options
+    )
+
+    return nil unless payload.present?
+
+    serialized = if payload.start_with?(MARK_BR_COMPRESSED)
+      ::Brotli.inflate(payload.byteslice(1..-1))
+    else
+      payload
+    end
+
+    Marshal.load(serialized)
+  end
+
+  def self.delete(name, options = nil)
+    Rails.cache.delete(cache_key(name), options)
+  end
+
+  def self.disable_prefix!
+    @@prefix = nil
+  end
+
+  def self.cache_key(name)
+    "#{@@prefix}#{name}"
+  end
 end
+

data/rails-brotli-cache.gemspec

@@ -8,13 +8,17 @@ Gem::Specification.new do |gem|
   gem.version       = RailsBrotliCache::VERSION
   gem.authors       = ["pawurb"]
   gem.email         = ["contact@pawelurbanek.com"]
-  gem.summary       = %q{ Rails cache using Brotli compression algorithm }
-  gem.description   = %q{ rails-brotli-cache allows to reduce storage needed for Rails cache by using Brotli compression which can produce outputs smaller by ~20% }
+  gem.summary       = %q{ Rails cache using Brotli algorithm offers better compression and performance. }
+  gem.description   = %q{ rails-brotli-cache allows to reduce storage needed for Rails cache by using Brotli compression which can produce outputs smaller by ~20%. }
   gem.homepage      = "https://github.com/pawurb/rails-brotli-cache"
   gem.files         = `git ls-files`.split("\n")
   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_development_dependency "rspec"
+  gem.add_development_dependency "redis"
+  gem.add_development_dependency "dalli"
+  gem.add_development_dependency "byebug"
 end

data/spec/dummy/Gemfile

@@ -0,0 +1,45 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "2.7.5"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0.4", ">= 7.0.4.3"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 5.0"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+# Use Sass to process CSS
+# gem "sassc-rails"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+

data/spec/dummy/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application" %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,37 @@
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+require "action_view/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 7.0
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+
+    # Don't generate system test files.
+    config.generators.system_tests = nil
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,3 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.

data/spec/dummy/config/credentials.yml.enc

@@ -0,0 +1 @@
+3QQlVtTisvLrhKqInPlY1i4jP47tE/OO4pM8zGjpgX0rFN57s0RLVpVIzclaCygn8Yz1l+JIDeGoghd8Nqilu/AvBwGgsb4Mlsq8MSN4sWfQYtZBkqtzsZ4WgWGdfj/LFTh1OGm+PWTPf7hA596k2plDC6oZA+p/C00d5Gs0KjDk2qBeItWN2Oyp4UBkQiDwYV+ZSMPgeLddhpR9w1rfXD6XhKM/bzSLwsh+Bq0/DqJ41ukO53S4CdgIAm9JIv4hGsG1jgOrrcFY3Uaw3rA5DQLQ5FPeJvOgeXMHs1F/xZMcTnQ7u3wBHLS2qmnVvYYHPYaxD7ZCP0EU2fkTh9ywdM+jYLOjVBHm9s1n4iOjX0T0zr55oZ932wdYSQtAjdU2EKn202Mftl0S5Xx+/8F1+bdS9oj8EttydK94--n17oCtetNlFexV2+--5L+PDgO0y2VKHQBrSd3AdQ==

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

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

@@ -0,0 +1,41 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing
+  config.server_timing = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  config.cache_store = (ENV["TEST_CACHE_STORE"] || :memory_store).to_sym
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end