cache-swr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c60797ab5d9aa428607221b71552b7cad82249c4dcf80d942093b1e2e5714d3c
+  data.tar.gz: 69e9ee1382e71bb9e0aa40617870737fdf70a746f7560b1086679bec5fdcb093
+SHA512:
+  metadata.gz: c2edf4a7279bc8ebe6bf07d35b7b95a193323e971e89eb07e14e700c8c712c2855065dad5046b934b55cfefb3bc60149a8764dca8f6543667c330ece34bc608c
+  data.tar.gz: 9f0686d8daee7cc91eb84d4774f791d97bc369b514e0e7dc7db6d503cf61785aa6a1f1430d3df5ec102c78180e750eda13ad762f80a847f953874db1ff9f079f

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler
+Gemfile.lock
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,26 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We pledge to make participation in our community a harassment-free experience for everyone.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment include:
+- Using welcoming and inclusive language
+- Respecting differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+
+Examples of unacceptable behavior include:
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+
+## Enforcement Responsibilities
+Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior.
+
+## Scope
+This Code of Conduct applies within all project spaces and in public spaces when representing the project.
+
+## Enforcement
+Instances of abusive behavior may be reported to the maintainer listed in the gemspec.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+## Development setup
+- Run `bundle install`
+- Run `bundle exec rspec`
+
+## Release
+1. Update `CHANGELOG.md`
+2. Bump version in `lib/**/version.rb`
+3. Run `bundle exec rake release`

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cache-swr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 MounirGaiby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Cache SWR
+
+Server-side stale-while-revalidate caching for Rails.
+
+## About
+Cache SWR stores a value plus two time windows: a fresh window and a stale window. Within the fresh window, values are returned immediately. Within the stale window, stale values are returned while a refresh runs in the background (or inline if you prefer).
+
+This pattern reduces tail latency and keeps caches warm without blocking callers.
+
+## Use Cases
+- Reduce p99 latency for expensive reads with background refreshes
+- Serve dashboards and reports without blocking on cache refresh
+- Keep hot data warm while avoiding request pileups
+- Provide smoother cache behavior under load
+
+## Compatibility
+- Ruby 3.0+
+- ActiveSupport 6.1+
+- Works with ActiveSupport cache stores
+- Redis-backed stores are recommended when locking is enabled
+
+## Installation
+```ruby
+# Gemfile
+
+gem "cache-swr"
+```
+
+## Usage
+```ruby
+value = Cache::SWR.fetch("expensive-key", ttl: 60, swr: 300, store: Rails.cache) do
+  ExpensiveQuery.call
+end
+```
+
+Rails integration adds `Rails.cache.fetch_swr`:
+```ruby
+Rails.cache.fetch_swr("expensive-key", ttl: 60, swr: 300) { ExpensiveQuery.call }
+```
+
+If you are using an in-memory store, disable locking:
+```ruby
+Cache::SWR.fetch("key", ttl: 30, swr: 120, store: ActiveSupport::Cache::MemoryStore.new, lock: false) do
+  compute
+end
+```
+
+## Options
+- `ttl` (Integer) fresh window in seconds
+- `swr` (Integer) stale window in seconds
+- `refresh` (`:async`, `:sync`, or `nil`) refresh strategy
+- `lock` (Boolean) enable or disable locking
+- `lock_ttl` (Integer) lock expiry in seconds
+- `lock_client` Redis client for custom locking
+- `store` ActiveSupport cache store (defaults to `Rails.cache` when available)
+
+## Notes
+- During the SWR window, stale values are served while a refresh runs.
+- `refresh: :async` uses a background thread; choose `:sync` for deterministic refresh.
+- When `lock` is enabled, the store must expose `redis` or you must provide `lock_client`.
+
+## Release
+```bash
+bundle exec rake release
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cache/swr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cache-swr.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cache/swr/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cache-swr"
+  spec.version = Cache::SWR::VERSION
+  spec.authors = ["MounirGaiby"]
+  spec.email = ["mounirgaiby@gmail.com"]
+
+  spec.summary = "Stale-while-revalidate caching for Rails with background refresh."
+  spec.description = "Serve stale cached values while recomputing in the background to reduce tail latency."
+  spec.homepage = "https://github.com/elysium-arc/cache-swr"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/elysium-arc/cache-swr"
+  spec.metadata["changelog_uri"] = "https://github.com/elysium-arc/cache-swr/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 6.1"
+  spec.add_dependency "redis", ">= 4.0"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+end

data/lib/cache/swr/lock.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Cache
+  module SWR
+    module Lock
+      LUA_RELEASE = <<~LUA
+        if redis.call("get", KEYS[1]) == ARGV[1] then
+          return redis.call("del", KEYS[1])
+        else
+          return 0
+        end
+      LUA
+
+      def self.default_for(store)
+        return RedisLock.new(store.redis) if store.respond_to?(:redis)
+        raise Cache::SWR::Error, "lock_client is required when store does not expose redis"
+      end
+
+      class RedisLock
+        def initialize(redis)
+          @redis = redis
+        end
+
+        def acquire(key, token, ttl)
+          with_redis do |conn|
+            conn.set(key, token, nx: true, px: (ttl * 1000).to_i)
+          end
+        end
+
+        def release(key, token)
+          with_redis do |conn|
+            conn.eval(LUA_RELEASE, keys: [key], argv: [token])
+          end
+        rescue StandardError
+          false
+        end
+
+        private
+
+        def with_redis
+          if @redis.respond_to?(:with)
+            @redis.with { |conn| yield conn }
+          else
+            yield @redis
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cache/swr/railtie.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# :nocov:
+begin
+  require "rails/railtie"
+rescue LoadError
+end
+
+if defined?(Rails::Railtie)
+  module Cache
+    module SWR
+      module StoreExtension
+        def fetch_swr(key, ttl:, swr:, **options, &block)
+          Cache::SWR.fetch(key, ttl: ttl, swr: swr, store: self, **options, &block)
+        end
+      end
+
+      class Railtie < Rails::Railtie
+        initializer "cache_swr.extend_cache" do
+          require "active_support/cache"
+          ::ActiveSupport::Cache::Store.include(Cache::SWR::StoreExtension)
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/cache/swr/version.rb

@@ -0,0 +1,5 @@
+module Cache
+  module SWR
+    VERSION = "0.1.0"
+  end
+end

data/lib/cache/swr.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+# ActiveSupport 8.1+ expects this constant when local cache is used.
+begin
+  require "active_support/isolated_execution_state"
+rescue LoadError
+end
+require "cache/swr/version"
+require "cache/swr/lock"
+
+module Cache
+  module SWR
+    class Error < StandardError; end
+
+    DEFAULT_LOCK_TTL = 5
+
+    def self.fetch(key, ttl:, swr:, store: nil, refresh: :async, lock: true, lock_ttl: DEFAULT_LOCK_TTL,
+                   lock_client: nil, &block)
+      raise ArgumentError, "block required" unless block
+
+      store ||= default_store
+      payload = store.read(key)
+      now = Time.now
+
+      if valid_payload?(payload)
+        if now < payload[:expires_at]
+          return payload[:value]
+        end
+
+        if now < payload[:stale_until]
+          trigger_refresh(key, ttl, swr, store, refresh, lock, lock_ttl, lock_client, &block)
+          return payload[:value]
+        end
+      end
+
+      compute_and_store(key, ttl, swr, store, lock_ttl, lock_client, lock: lock, &block)
+    end
+
+    def self.default_store
+      return Rails.cache if defined?(Rails) && Rails.respond_to?(:cache)
+      raise Error, "store is required when Rails.cache is unavailable"
+    end
+
+    def self.valid_payload?(payload)
+      payload.is_a?(Hash) && payload.key?(:value) && payload.key?(:expires_at) && payload.key?(:stale_until)
+    end
+
+    def self.compute_and_store(key, ttl, swr, store, lock_ttl, lock_client, lock: true)
+      lock_key = lock_key_for(key)
+      acquired = false
+      if lock
+        lock_client ||= Lock.default_for(store) if lock_client.nil?
+        if lock_client
+          acquired = lock_client.acquire(lock_key, "compute", lock_ttl)
+          unless acquired
+            existing = store.read(key)
+            return existing[:value] if valid_payload?(existing)
+          end
+        end
+      end
+
+      value = yield
+      payload = {
+        value: value,
+        expires_at: Time.now + ttl,
+        stale_until: Time.now + ttl + swr
+      }
+      store.write(key, payload, expires_in: ttl + swr)
+      value
+    ensure
+      lock_client.release(lock_key, "compute") if lock_client && acquired
+    end
+
+    def self.trigger_refresh(key, ttl, swr, store, refresh, lock, lock_ttl, lock_client, &block)
+      return if refresh.nil?
+
+      lock_client ||= Lock.default_for(store) if lock && lock_client.nil?
+      lock_key = lock_key_for(key)
+
+      acquired = false
+      if lock && lock_client
+        acquired = lock_client.acquire(lock_key, "refresh", lock_ttl)
+        return unless acquired
+      end
+
+      if refresh == :async
+        Thread.new do
+          compute_and_store(key, ttl, swr, store, lock_ttl, lock_client, lock: lock, &block)
+        end
+      else
+        compute_and_store(key, ttl, swr, store, lock_ttl, lock_client, lock: lock, &block)
+      end
+    ensure
+      lock_client.release(lock_key, "refresh") if lock_client && acquired
+    end
+
+    def self.lock_key_for(key)
+      "cache-swr:lock:#{key}"
+    end
+  end
+end
+
+require "cache/swr/railtie"

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: cache-swr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MounirGaiby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Serve stale cached values while recomputing in the background to reduce
+  tail latency.
+email:
+- mounirgaiby@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache-swr.gemspec
+- lib/cache/swr.rb
+- lib/cache/swr/lock.rb
+- lib/cache/swr/railtie.rb
+- lib/cache/swr/version.rb
+homepage: https://github.com/elysium-arc/cache-swr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elysium-arc/cache-swr
+  source_code_uri: https://github.com/elysium-arc/cache-swr
+  changelog_uri: https://github.com/elysium-arc/cache-swr/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Stale-while-revalidate caching for Rails with background refresh.
+test_files: []