scoped_cache_keys 0.1.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 599264adc7feb1e042fde17a4473126615907cfd03e27172d9355f9c5dfc6308
+  data.tar.gz: bd9335f025963374103c7fd8a0a897606e977b02568ba1a5816cc55a7f8f9afd
+SHA512:
+  metadata.gz: 9740614f52aeb1c14a7462ac11c1c4a496146402a7973f76991651bd3480ebf2e95754af17962ebecb2f1dab544fe56c7555f86b0d578be7032f374acbe26bf2
+  data.tar.gz: 9d2dc9a88572ef4991280a50bd9c764041d96d9996f8bc548b07cde2ecc614d7e5a619979099cc92c33af497b79816cfc5c8691fa0f56bd681261bd49bc058fc

data/.gitignore

@@ -0,0 +1 @@
+.ruby-version

data/Gemfile

@@ -1,4 +1,5 @@
-source :rubygems
+source "https://rubygems.org"
+
 gemspec
 
 gem 'rake'

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    scoped_cache_keys (0.1.1)
+    scoped_cache_keys (0.3.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.3)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    i18n (0.6.0)
-    multi_json (1.3.4)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    sqlite3 (1.3.6)
-    timecop (0.3.5)
-    tzinfo (0.3.33)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    rake (13.0.6)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    sqlite3 (1.5.3)
+      mini_portile2 (~> 2.8.0)
+    timecop (0.9.5)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   ruby
@@ -45,3 +47,6 @@ DEPENDENCIES
   scoped_cache_keys!
   sqlite3
   timecop
+
+BUNDLED WITH
+   2.3.12

data/Readme.md

@@ -1,25 +1,104 @@
-Add scoped_cache_key / expire_scoped_cache_key to your models for caching/sweeping of model-related caches.
+scoped_cache_keys
+=================
+
+Add `scoped_cache_key` / `expire_scoped_cache_key` to your models for caching/sweeping of model-related caches.
+
+Overview
+--------
+
+`scoped_cache_keys` enables you to "scope" multiple cache entries together, such that they can be expired
+together in a single operation.
+
+This saves the trouble of having to delete several individual cache entries, and improves the consistency
+of your cache entries by having them all expire together.
+
+Model-related caches in a Rails application often consist of multiple cache entries, which should be
+consistent with each other.
+
+For instance, you might have a cache entry which is a key->value mapping for a model, but another
+cache entry which is a value->key mapping.
 
 Install
-=======
-    sudo gem install scoped_cache_keys
-Or
+-------
 
-    rails plugin install git://github.com/grosser/scoped_cache_keys.git
+```bash
+gem "scoped_cache_keys"
+```
 
 Usage
-=====
+-----
+
+To use `scoped_cached_keys`, use `include ScopedCacheKeys` in your model declaration:
+
+```ruby
+class User < ActiveRecord::Base
+  include ScopedCacheKeys
+  ...
+end
+```
+
+### scoped_cache_key ###
+
+The `scoped_cache_key` method returns a key that will change whenever `expire_scoped_cache_key` is called.
+The cache key will be scoped to the model object that `scoped_cache_key` is invoked on, along with
+whatever scope is passed:
+
+```ruby
+  account.scoped_cache_key(:orders)
+```
+
+Options: Any caching options that are passed to `Rails.cache` methods may be passed to `scoped_cache_key`.
+For example:
+
+```ruby
+  account.scoped_cache_key(:orders, expires_in: 10.minutes)
+```
+
+The key that is returned can be treated as a "base key," that is, concatenated with other strings to form
+other cache keys. All such cache keys will become unreachable, and thus "expired," when
+`expire_scoped_cache_key` is called.
+
+### expire_scoped_cache_key ###
+
+The `expire_scoped_cache_key` method will expire a scoped cache key obtained with `scoped_cache_key`.
+Example:
+
+```ruby
+  account.expire_scoped_cache_key(:orders)
+```
+
+Options: The optional `delay` parameter specifies an amount of time to delay before actually expiring
+the scoped cache key. Example:
+
+```ruby
+  account.expire_scoped_cache_key(:orders, delay: 5.seconds)
+```
+
+The `delay` parameter can be useful for contending with database replication lag. When many concurrent 
+processes access the scoped cache entries, one or more may immediately try to rebuild the cache
+the instant that `expire_scoped_cache_key` completes. This could happen so quickly that the database
+replicas may not be caught up with the model changes that were just committed. Alternately, one
+could force the models to be queried from the primary database to avoid such race conditions.
+
+The expiration delay may also be set at a global level:
+
+```ruby
+    ScopedCacheKeys.expire_scoped_cache_key_delay = 10.seconds
+```
 
-Gives you a key that will change whenever expire_scoped_cache_key is called.
+### Example ###
 
+```
     <% cache user.scoped_cache_key :products do %>
       ... user.products.each ...
     <% end %>
 
-    <% cache "something-else-" + user.scoped_cache_key :products %>
+    <% cache "something-else-" + user.scoped_cache_key(:products) do %>
       ... will also be expired ...
     <% end %>
+```
 
+```ruby
     # app/sweepers/product_sweeper.rb
     class ProductSweeper < ActionController::Caching::Sweeper
       observe Product
@@ -28,10 +107,10 @@ Gives you a key that will change whenever expire_scoped_cache_key is called.
         record.user.expire_scoped_cache_key :products
       end
     end
+```
 
 Author
-======
+------
 [Zendesk](http://zendesk.com)<br/>
 michael@grosser.it<br/>
-License: MIT<br/>
-[![Build Status](https://secure.travis-ci.org/grosser/scoped_cache_keys.png)](http://travis-ci.org/grosser/scoped_cache_keys)
+License: MIT

data/lib/scoped_cache_keys/version.rb

@@ -1,3 +1,3 @@
 module ScopedCacheKeys
-  VERSION = '0.1.1'
+  VERSION = '0.3.0'
 end

data/lib/scoped_cache_keys.rb

@@ -1,13 +1,26 @@
 require 'scoped_cache_keys/version'
 
 module ScopedCacheKeys
-  def scoped_cache_key(scope)
-    base_key = Rails.cache.fetch(build_scoped_cache_key([scope])){ Time.now.to_f }
+  class << self
+    # If set, expire_scoped_cache_key will delay expiration by this many seconds
+    # globally.
+    attr_accessor :expire_scoped_cache_key_delay
+  end
+
+  def scoped_cache_key(scope, options = nil)
+    base_key = Rails.cache.fetch(build_scoped_cache_key([scope]), options) { Time.now.to_f }
     build_scoped_cache_key [scope, base_key]
   end
 
-  def expire_scoped_cache_key(scope)
-    Rails.cache.delete(build_scoped_cache_key(scope))
+  def expire_scoped_cache_key(scope, delay: nil)
+    delay ||= ScopedCacheKeys.expire_scoped_cache_key_delay
+    key = build_scoped_cache_key(scope)
+    if delay
+      entry = Rails.cache.read(key)
+      Rails.cache.write(key, entry, expires_in: delay) if entry
+    else
+      Rails.cache.delete(key)
+    end
   end
 
   private

data/spec/scoped_cache_keys_spec.rb

@@ -45,6 +45,12 @@ describe ScopedCacheKeys do
         user.updated_at = 1.week.ago
       }.to_not change{ user.scoped_cache_key(:foo) }
     end
+
+    it "accepts cache options such as expired_in" do
+      key = user.scoped_cache_key(:foo, expires_in: 10.seconds)
+      Timecop.travel(11.seconds.from_now)
+      user.scoped_cache_key(:foo).should_not == key
+    end
   end
 
   describe "#expire_scoped_cache_key" do
@@ -59,5 +65,25 @@ describe ScopedCacheKeys do
         user.expire_scoped_cache_key :bar
       }.to_not change{ user.scoped_cache_key(:foo) }
     end
+
+    it "expires a specific scope after a specified delay" do
+      key = user.scoped_cache_key :foo
+      user.expire_scoped_cache_key :foo, delay: 5.seconds
+      Timecop.travel(4.seconds.from_now)
+      user.scoped_cache_key(:foo).should == key
+      Timecop.travel(2.seconds.from_now)
+      user.scoped_cache_key(:foo).should_not == key
+    end
+
+    it "expires a specific scope after a specified global delay" do
+      ScopedCacheKeys.expire_scoped_cache_key_delay = 10.seconds
+      key = user.scoped_cache_key :foo
+      user.expire_scoped_cache_key :foo
+      Timecop.travel(9.seconds.from_now)
+      user.scoped_cache_key(:foo).should == key
+      Timecop.travel(2.seconds.from_now)
+      user.scoped_cache_key(:foo).should_not == key
+      ScopedCacheKeys.expire_scoped_cache_key_delay = nil
+    end
   end
 end

metadata

@@ -1,33 +1,22 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: scoped_cache_keys
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-04 00:00:00 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies: []
-
 description: 
 email: michael@grosser.it
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .travis.yml
+files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -38,37 +27,27 @@ files:
 - spec/scoped_cache_keys_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/grosser/scoped_cache_keys
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.6
 signing_key: 
-specification_version: 3
-summary: Add scoped_cache_key / expire_scoped_cache_key to your models for caching/sweeping of model-related caches + touch_if_necessary
+specification_version: 4
+summary: Add scoped_cache_key / expire_scoped_cache_key to your models for caching/sweeping
+  of model-related caches + touch_if_necessary
 test_files: []
-

data/.travis.yml

@@ -1,5 +0,0 @@
-script: "bundle exec rake"
-rvm:
-  - ree
-  - 1.9.2
-  - 1.9.3