cache_keeper 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 167f1cc0d9fdfca15b5882a90dde733b9d74b65f3adfad47f71ef34606b6e9d0
-  data.tar.gz: 278285596e0e0bdcbab9a687c07244c0c2f57d19e588b275ccb3e3281a8f3f78
+  metadata.gz: 04c55e34ac5e0676e81456a04f7edae71cf0c79c6cd5be9e135c56561f6439be
+  data.tar.gz: 6f9d9bc0bd404cd350f1cf7ff48b8c59bbff60dbeeda754c052ca22457720b8a
 SHA512:
-  metadata.gz: 62d8e87244040101cb4f345c1e11a6b857c23bd7d7074877e0358d18e44c8acf7b76182ce0a922fa2998699ea74ede71484430c4f701cd12978710e7420b3022
-  data.tar.gz: 72a3207e7df9c92dcaf5764ba3055bed5cba3e943c406f824e6087d741c245301b7b11f05c00091cd8c77ed6a5739e31a843134f08d6856f9d677ee54a2f645d
+  metadata.gz: 1eec12fc16cf629cbe1b3502918b67d6d420bb812c1ed88088a809b07faf31ec981dfddb0d094507f0cd9522238134b1bc60ff011f0d99a12339144a5ba0a3d2
+  data.tar.gz: 6a93852da524a5e478166bc24d0bee53973a3343a8b55c2574ed67259f3e5ffc7f927b31bd35e257fe0107073e69fc32a99e608614b07ab736fa103e8ce33adc

data/.github/workflows/ci.yml

@@ -4,13 +4,20 @@ jobs:
   tests:
     strategy:
       matrix:
-        ruby-version:
-          - "2.7"
-          - "3.0"
         rails-version:
           - "6.1"
           - "7.0"
+          - "7.1"
           - "main"
+        include:
+          - rails-version: "6.1"
+            ruby-version: "2.5"
+          - rails-version: "7.0"
+            ruby-version: "2.7"
+          - rails-version: "7.1"
+            ruby-version: "2.7"
+          - rails-version: "main"
+            ruby-version: "3.2"
 
     env:
       RAILS_VERSION: "${{ matrix.rails-version }}"

data/.gitignore

@@ -1,5 +1,7 @@
 *.gem
+Gemfile.lock
 .byebug_history
+TAGS
 
 test/dummy/db/*.sqlite3
 test/dummy/db/*.sqlite3*

data/.rubocop.yml

@@ -0,0 +1,122 @@
+require:
+  - rubocop-rails
+  - rubocop-performance
+
+AllCops:
+  Exclude:
+    - '**/db/**/*'
+    - '**/config/**/*'
+    - '**/tmp/**/*'
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - '**/node_modules/**/*'
+  TargetRubyVersion: 3.2.2
+
+# Relaxed Ruby Style
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/NumericPredicate:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+# Custom
+Performance:
+  Exclude:
+    - '**/spec/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: true
+  EnforcedStyle: conditionals
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -2,8 +2,22 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rake"
-gem "byebug"
+rails_version = ENV.fetch("RAILS_VERSION", "7.1")
 
-gem "rails", ">= 6.1"
+rails_constraint =
+  if rails_version == "main"
+    { github: "rails/rails" }
+  else
+    "~> #{rails_version}.0"
+  end
+
+gem "rails", rails_constraint
 gem "sqlite3"
+
+group :debug do
+  gem "byebug"
+
+  gem "rubocop"
+  gem "rubocop-performance"
+  gem "rubocop-rails"
+end

data/README.md

@@ -29,14 +29,30 @@ bundle add cache_keeper
 CacheKeeper provides a `caches` method that will cache the result of the methods you give it:
 
 ```ruby
-caches :slow_method, :really_slow_method, expires_in: 1.hour
-caches :incredibly_slow_method, expires_in: 2.hours, must_revalidate: true
+class Recording < ApplicationRecord
+  caches :slow_method, :really_slow_method, expires_in: 1.hour, must_revalidate: true
+  caches :incredibly_slow_method, expires_in: 2.hours, key: -> { "custom-key/#{id}" }
+
+  def slow_method
+    ...
+  end
+
+  def really_slow_method
+    ...
+  end
+
+  def incredibly_slow_method
+    ...
+  end
+end
 ```
 
 It's automatically available in your ActiveRecord models and in your controllers. You can also use it in any other class by including `CacheKeeper::Caching`.
 
 By default, it will immediately run the method call if it hasn't been cached before. The next time it is called, it will return the cached value if it hasn't expired yet. If it has expired, it will enqueue a job to refresh the cache in the background and return the stale value in the meantime. You can avoid returning stale values by setting `must_revalidate: true` in the options.
 
+CacheKeeper will compose cache keys from the name of the method and the instance's `cache_key` if it's defined or the name of the class otherwise. You can pass a `key` option to customize the cache key if you need it. It accepts [the same values](https://guides.rubyonrails.org/caching_with_rails.html#cache-keys) as `Rails.cache.fetch`, as well as procs or lambdas in case you need access to the instance.
+
 It's important to note that it will only work with methods that don't take any arguments.
 
 ### Serialization
@@ -55,7 +71,7 @@ class Example
 end
 ```
 
-If those options don't work for you, you can always [write custom serializer](https://guides.rubyonrails.org/active_job_basics.html#serializers) for your classes.
+If those options don't work for you, you can always [write custom serializers](https://guides.rubyonrails.org/active_job_basics.html#serializers) for your classes.
 
 
 ## Configuration

data/app/models/cache_keeper/cached_method/refreshable.rb

@@ -1,6 +1,6 @@
 module CacheKeeper::CachedMethod::Refreshable
   def refresh(target)
-    Rails.cache.fetch(cache_key, expires_in: expires_in) do
+    Rails.cache.fetch(cache_key(target), expires_in: expires_in) do
       target.send alias_for_original_method
     end
   end

data/app/models/cache_keeper/cached_method.rb

@@ -14,11 +14,9 @@ class CacheKeeper::CachedMethod
     :"__#{method_name}__hooked__"
   end
 
-  def stale?
-    cache_entry.blank? || cache_entry.expired?
-  end
-
   def call(target)
+    cache_entry = cache_entry(target)
+
     if cache_entry.blank?
       refresh target
     elsif cache_entry.expired?
@@ -36,12 +34,16 @@ class CacheKeeper::CachedMethod
 
   private
 
-  def cache_entry
-    Rails.cache.send :read_entry, Rails.cache.send(:normalize_key, cache_key, {})
+  def cache_entry(target)
+    Rails.cache.send :read_entry, Rails.cache.send(:normalize_key, cache_key(target), {})
   end
 
-  def cache_key
-    ["CacheKeeper", klass, method_name]
+  def cache_key(target)
+    if options[:key].present?
+      options[:key].is_a?(Proc) ? target.instance_exec(&options[:key]) : options[:key]
+    else
+      target.respond_to?(:cache_key) ? ["CacheKeeper", target, method_name] : ["CacheKeeper", klass, method_name]
+    end
   end
 
   def expires_in

data/bin/rails

@@ -2,12 +2,12 @@
 # This command will automatically be run when you run "rails" with Rails gems
 # installed from the root of your application.
 
-ENGINE_ROOT = File.expand_path('..', __dir__)
-APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+ENGINE_ROOT = File.expand_path("..", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
 
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
 
-require 'rails/all'
-require 'rails/engine/commands'
+require "rails/all"
+require "rails/engine/commands"

data/lib/cache_keeper/configuration.rb

@@ -1,7 +1,7 @@
 module CacheKeeper
   class Configuration
     DEFAULT_MUST_REVALIDATE = false
-    DEFAULT_QUEUES = {}
+    DEFAULT_QUEUES = {}.freeze
 
     def must_revalidate
       return rails_config.must_revalidate unless rails_config.must_revalidate.nil?

data/lib/cache_keeper/engine.rb

@@ -7,13 +7,13 @@ module CacheKeeper
     config.cache_keeper = ActiveSupport::OrderedOptions.new
     config.cache_keeper.queues = ActiveSupport::OrderedOptions.new
 
-    initializer "cache_keeper.active_job_serializer" do |app|
+    initializer "cache_keeper.active_job_serializer" do
       config.to_prepare do
         Rails.application.config.active_job.custom_serializers << CacheKeeper::CachedMethodSerializer
       end
     end
 
-    initializer "cache_keeper.caching_methods" do |app|
+    initializer "cache_keeper.caching_methods" do
       ActiveSupport.on_load :action_controller do
         ActionController::Base.send :include, CacheKeeper::Caching
       end

data/lib/cache_keeper/version.rb

@@ -1,3 +1,3 @@
 module CacheKeeper
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/jobs/refresh_job_test.rb

@@ -3,11 +3,12 @@ require "test_helper"
 class CacheKeeper::RefreshJobTest < ActiveSupport::TestCase
   include ActiveJob::TestHelper
 
-  test "calls #refresh" do
+  test "uses the correct queue" do
+    CacheKeeper.configuration.queues[:refresh] = "refresh"
     recording = Recording.create(number: 5)
     cached_method = CacheKeeper.manager.cached_methods.first
 
-    assert_performed_with(queue: :default) do
+    assert_performed_with(queue: "refresh") do
       CacheKeeper::RefreshJob.perform_later cached_method, recording
     end
   end

data/test/models/cached_method/refreshable_test.rb

@@ -7,7 +7,7 @@ class CacheKeeper::CachedMethod::RefreshableTest < ActiveSupport::TestCase
     recording = Recording.create(number: 5)
     cached_method = CacheKeeper.manager.cached_methods.first
 
-    assert_enqueued_with(job: CacheKeeper::RefreshJob, queue: :default) do
+    assert_enqueued_with(job: CacheKeeper::RefreshJob) do
       cached_method.refresh_later recording
     end
   end

data/test/models/cached_method_test.rb

@@ -2,14 +2,14 @@ require "test_helper"
 
 class CacheKeeper::CachedMethodTest < ActiveSupport::TestCase
   test "#call caches the result of the original method" do
-    recording = Recording.new(number: 5)
+    recording = Recording.create(number: 5)
     cached_method = manager.handle(Recording, :another_method, expires_in: 1.hour)
     manager.activate_if_handling(Recording, :another_method)
 
     result = cached_method.call(recording)
 
     assert_equal 5, result
-    assert cache_has_key? "CacheKeeper/Recording/another_method"
+    assert cache_has_key? "CacheKeeper/recordings/#{recording.id}/another_method"
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_keeper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Zamuner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-24 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -32,8 +32,8 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - app/jobs/cache_keeper/base_job.rb

data/Gemfile.lock

@@ -1,199 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cache_keeper (0.3.0)
-      rails (>= 6.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-      zeitwerk (~> 2.6)
-    actionmailbox (7.1.1)
-      actionpack (= 7.1.1)
-      activejob (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.1.1)
-      actionpack (= 7.1.1)
-      actionview (= 7.1.1)
-      activejob (= 7.1.1)
-      activesupport (= 7.1.1)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.2)
-    actionpack (7.1.1)
-      actionview (= 7.1.1)
-      activesupport (= 7.1.1)
-      nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    actiontext (7.1.1)
-      actionpack (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.1.1)
-      activesupport (= 7.1.1)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (7.1.1)
-      activesupport (= 7.1.1)
-      globalid (>= 0.3.6)
-    activemodel (7.1.1)
-      activesupport (= 7.1.1)
-    activerecord (7.1.1)
-      activemodel (= 7.1.1)
-      activesupport (= 7.1.1)
-      timeout (>= 0.4.0)
-    activestorage (7.1.1)
-      actionpack (= 7.1.1)
-      activejob (= 7.1.1)
-      activerecord (= 7.1.1)
-      activesupport (= 7.1.1)
-      marcel (~> 1.0)
-    activesupport (7.1.1)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
-    builder (3.2.4)
-    byebug (11.1.3)
-    concurrent-ruby (1.2.2)
-    connection_pool (2.4.1)
-    crass (1.0.6)
-    date (3.3.3)
-    drb (2.1.1)
-      ruby2_keywords
-    erubi (1.12.0)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.8.3)
-      rdoc
-      reline (>= 0.3.8)
-    loofah (2.21.4)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.2)
-    mini_mime (1.1.5)
-    minitest (5.20.0)
-    mutex_m (0.1.2)
-    net-imap (0.4.2)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.1)
-      timeout
-    net-smtp (0.4.0)
-      net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.15.4-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
-      racc (~> 1.4)
-    psych (5.1.1.1)
-      stringio
-    racc (1.7.1)
-    rack (3.0.8)
-    rack-session (2.0.0)
-      rack (>= 3.0.0)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rackup (2.1.0)
-      rack (>= 3)
-      webrick (~> 1.8)
-    rails (7.1.1)
-      actioncable (= 7.1.1)
-      actionmailbox (= 7.1.1)
-      actionmailer (= 7.1.1)
-      actionpack (= 7.1.1)
-      actiontext (= 7.1.1)
-      actionview (= 7.1.1)
-      activejob (= 7.1.1)
-      activemodel (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
-      bundler (>= 1.15.0)
-      railties (= 7.1.1)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
-      irb
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
-    rake (13.0.6)
-    rdoc (6.5.0)
-      psych (>= 4.0.0)
-    reline (0.3.9)
-      io-console (~> 0.5)
-    ruby2_keywords (0.0.5)
-    sqlite3 (1.6.7-arm64-darwin)
-    sqlite3 (1.6.7-x86_64-linux)
-    stringio (3.0.8)
-    thor (1.3.0)
-    timeout (0.4.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    webrick (1.8.1)
-    websocket-driver (0.7.6)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.12)
-
-PLATFORMS
-  arm64-darwin-22
-  x86_64-linux
-
-DEPENDENCIES
-  byebug
-  cache_keeper!
-  rails (>= 6.1)
-  rake
-  sqlite3
-
-BUNDLED WITH
-   2.4.19