cached_resource 7.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c2150c2dc21cf091c9b26674b3e52a7bd43938318704f7c2f0739a0b9756aa
-  data.tar.gz: 2f7b9665c688f2a60b7def43cfafbe2701accded9fcf9aabc371fe91bf78362d
+  metadata.gz: af6263e0c63b68542a68f62371c79b057e8d9244eb4ab670cfa8956c7cdb1d54
+  data.tar.gz: 471295437c0567959f596cd4a8e13639dc670991632e99d01d1bbdea82123664
 SHA512:
-  metadata.gz: c0c94c6b77f623a49a3259a69a4bb1b1d2d7fc219d590b740d5a86c71f3cfbf7eb783a2e8a2c06631c926bd2679b220341d8fbf03b77a3651d5219a70bb8d779
-  data.tar.gz: 207c37429a14511fb788d21bc69e86b01f8f59a303b20aebafb2f07e54aba48546c03a5ac7fa4b99da0bd9b7cd53d385ddb73306c643d9044d113ea638949e61
+  metadata.gz: 02ee32043c70de70d3befa042ad68c0de0b71e8abf0197e477e97a1489c51ed7eb726bc38a561dd29e34763184cea026275b6a9ff4b9e20ed2c8876f90d5944e
+  data.tar.gz: b652cbf1e7d42adaecf1639ac01c2489a75120bb2780bdb272fef5f2be9ad93fe339521d8e0337434cc98e6eb6234164274fa446710211c8eadb3a349435af15

data/.github/workflows/ruby.yml

@@ -19,31 +19,11 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ['1.9', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
-        rails-version: ['4.2', '5.0', '5.1', '6.0', '6.1', '7.0']
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
+        rails-version: ['4.2', '5.0', '5.1', '6.0', '6.1', '7.0', '7.1']
         exclude:
-          # Segmentation faults during tests, but should work?
-          - ruby-version: '2.2'
-            rails-version: '5.0'
-          - ruby-version: '2.2'
-            rails-version: '5.1'
-          # Too old
-          - ruby-version: '1.9'
-            rails-version: '5.0'
-          - ruby-version: '1.9'
-            rails-version: '5.1'
-          - ruby-version: '1.9'
-            rails-version: '6.0'
-          - ruby-version: '1.9'
-            rails-version: '6.1'
-          - ruby-version: '1.9'
-            rails-version: '7.0'
           # activesupport (~> 6.0.0) was resolved to 6.0.6.1, which depends on ruby (>= 2.5.0)
           # activesupport (~> 6.1.0) was resolved to 6.1.7.2, which depends on ruby (>= 2.5.0)
-          - ruby-version: '2.2'
-            rails-version: '6.0'
-          - ruby-version: '2.2'
-            rails-version: '6.1'
           - ruby-version: '2.3'
             rails-version: '6.0'
           - ruby-version: '2.3'
@@ -53,8 +33,6 @@ jobs:
           - ruby-version: '2.4'
             rails-version: '6.1'
           # activesupport (~> 7.0.0) was resolved to 7.0.4.2, which depends on Ruby (>= 2.7.0)
-          - ruby-version: '2.2'
-            rails-version: '7.0'
           - ruby-version: '2.3'
             rails-version: '7.0'
           - ruby-version: '2.4'
@@ -87,9 +65,25 @@ jobs:
             rails-version: '5.0'
           - ruby-version: '3.2'
             rails-version: '5.1'
+          # rails (~> 7.1.0) was resolved to 7.1.3.2, which depends on Ruby (>= 2.7.0)
+          - ruby-version: '2.3'
+            rails-version: '7.1'
+          - ruby-version: '2.4'
+            rails-version: '7.1'
+          - ruby-version: '2.5'
+            rails-version: '7.1'
+          - ruby-version: '2.6'
+            rails-version: '7.1'
+          # Because rails >= 4.0.0.beta1, < 5.0.5.rc1 depends on bundler >= 1.3.0, < 2.0
+          #   and the current Bundler version (2.5.9) does not satisfy bundler >= 1.3.0, < 2.0,
+          #   rails >= 4.0.0.beta1, < 5.0.5.rc1 cannot be used.
+          # So, because Gemfile depends on rails ~> 4.2.0,
+          #   version solving has failed.
+          - ruby-version: '3.3'
+            rails-version: '4.2'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby-version }}
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
         # change this to (see https://github.com/ruby/setup-ruby#versioning):

data/Gemfile

@@ -24,6 +24,8 @@ when "6.1"
   eval_gemfile('../gemfiles/6.1.gemfile')
 when "7.0"
   eval_gemfile('../gemfiles/7.0.gemfile')
+when "7.1"
+  eval_gemfile('../gemfiles/7.1.gemfile')
 else
   puts "\e[93mNo TEST_RAILS_VERSION present, letting dependency manager decide what's best.\e[0m" if ENV['DEBUG']
 end

data/README.md

@@ -12,18 +12,17 @@ gem install cached_resource
 
 CachedResource is designed to be framework agnostic, but will hook into Rails for caching and logging if available. CachedResource supports the following ActiveSupport/Rails (right) and Ruby (down) version combinations:
 
-| | 🛤️ 4.2 | 🛤️ 5.0 | 🛤️ 5.1 | 🛤️ 6.0 | 🛤️ 6.1 | 🛤️ 7.0 |
-|-------|-----|-----|-----|-----|-----|-----|
-| 💎 1.9   | ✅   |     |     |     |     |     |
-| 💎 2.2   | ✅   |     |     |     |     |     |
-| 💎 2.3   | ✅   | ✅   | ✅   |     |     |     |
-| 💎 2.4   | ✅   | ✅   | ✅   |     |     |     |
-| 💎 2.5   | ✅   | ✅   | ✅   | ✅   | ✅   |     |
-| 💎 2.6   |   ✅   |   ✅  |  ✅   |  ✅   |  ✅   |     |
-| 💎 2.7   |     | ✅   | ✅   | ✅   | ✅   | ✅   |
-| 💎 3.0   |     |     |     | ✅   | ✅   | ✅   |
-| 💎 3.1   |     |     |     | ✅   | ✅   | ✅   |
-| 💎 3.2   |     |     |     | ✅   | ✅   | ✅   |
+| | 🛤️ 4.2 | 🛤️ 5.0 | 🛤️ 5.1 | 🛤️ 6.0 | 🛤️ 6.1 | 🛤️ 7.0 | 🛤️ 7.1 |
+|-------|-----|-----|-----|-----|-----|-----|-----|
+| 💎 2.3   | ✅   | ✅   | ✅   |     |     |     | |
+| 💎 2.4   | ✅   | ✅   | ✅   |     |     |     | |
+| 💎 2.5   | ✅   | ✅   | ✅   | ✅   | ✅   |     | |
+| 💎 2.6   |   ✅   |   ✅  |  ✅   |  ✅   |  ✅   | |
+| 💎 2.7   |     | ✅   | ✅   | ✅   | ✅   | ✅   |✅ |
+| 💎 3.0   |     |     |     | ✅   | ✅   | ✅   | ✅ |
+| 💎 3.1   |     |     |     | ✅   | ✅   | ✅   | ✅ |
+| 💎 3.2   |     |     |     | ✅   | ✅   | ✅   | ✅ |
+| 💎 3.3   |     |  ✅   | ✅    | ✅   | ✅   | ✅   | ✅ |
 
 ## Limitations
 
@@ -55,15 +54,17 @@ end
 CachedResource accepts the following options:
 
 * `:enabled` Default: `true`
-* `:ttl` The time in seconds until the cache should expire. Default: `604800`
-* `:race_condition_ttl` The race condition ttl, to prevent [dog pile effect](https://en.wikipedia.org/wiki/Cache_stampede) or [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede). Default: 86400
-* `:ttl_randomization` Enable ttl randomization. Default: `false`
-* `:ttl_randomization_scale` A Range from which a random value will be selected to scale the ttl. Default: `1..2`
-* `:collection_synchronize` Use collections to generate cache entries for individuals.  Update the existing cached principal collection when retrieving subsets of the principal collection or individuals.  Default: `false`
+* `:cache_collections` Set to false to always remake a request for collections. Default: `true`
+* `:cache` The cache store that CacheResource should use. Default: The `Rails.cache` if available, or an `ActiveSupport::Cache::MemoryStore`
 * `:collection_arguments` The arguments that identify the principal collection request. Default: `[:all]`
+* `:collection_synchronize` Use collections to generate cache entries for individuals.  Update the existing cached principal collection when retrieving subsets of the principal collection or individuals.  Default: `false`
+* `:concurrent_write` Set to true to make concurrent writes to cache after successful API response. Default: `false`
+    * Requires the [concurrent-ruby](https://rubygems.org/gems/concurrent-ruby) gem
 * `:logger` The logger to which CachedResource messages should be written. Default: The `Rails.logger` if available, or an `ActiveSupport::Logger`
-* `:cache` The cache store that CacheResource should use. Default: The `Rails.cache` if available, or an `ActiveSupport::Cache::MemoryStore`
-* `:cache_collections` Set to false to always remake a request for collections. Default: `true`
+* `:race_condition_ttl` The race condition ttl, to prevent [dog pile effect](https://en.wikipedia.org/wiki/Cache_stampede) or [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede). Default: 86400
+* `:ttl_randomization_scale` A Range from which a random value will be selected to scale the ttl. Default: `1..2`
+* `:ttl_randomization` Enable ttl randomization. Default: `false`
+* `:ttl` The time in seconds until the cache should expire. Default: `604800`
 
 You can set them like this:
 

data/cached_resource.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "concurrent-ruby", '~> 1.2', '>= 1.2.3'
 end

data/gemfiles/7.1.gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 7.1.0"

data/lib/cached_resource/cached_resource.rb

@@ -18,6 +18,16 @@ module CachedResource
         # and establishing the necessary methods.
         def setup_cached_resource!(options)
           @cached_resource = CachedResource::Configuration.new(options)
+          if @cached_resource.concurrent_write
+            begin
+              send :require, 'concurrent/promise'
+            rescue LoadError
+              @cached_resource.logger.error(
+                "`concurrent_write` option is enabled, but `concurrent-ruby` is not an installed dependency"
+              )
+              raise
+            end
+          end
           send :include, CachedResource::Caching
           @cached_resource
         end

data/lib/cached_resource/caching.rb

@@ -45,7 +45,7 @@ module CachedResource
         cache_collection_synchronize(object, *arguments) if cached_resource.collection_synchronize
         return object if !cached_resource.cache_collections && is_any_collection?(*arguments)
         cache_write(key, object, *arguments)
-        cache_read(key)
+        object
       end
 
       # If this is a pure, unadulterated "all" request
@@ -82,7 +82,7 @@ module CachedResource
       # Avoid cache nil or [] objects
       def should_cache?(object)
         return false unless cached_resource.enabled
-        object.respond_to?(:empty?) ? !object.empty? : !!object
+        object.present?
       end
 
       # Determine if the given arguments represent
@@ -110,7 +110,7 @@ module CachedResource
               next restored unless respond_to?(:collection_parser)
               collection_parser.new(restored).tap do |parser|
                 parser.resource_class = self
-                parser.original_params = json['original_params']
+                parser.original_params = json['original_params'].deep_symbolize_keys
               end
             else
               full_dup(cache)
@@ -123,6 +123,14 @@ module CachedResource
 
       # Write an entry to the cache for the given key and value.
       def cache_write(key, object, *arguments)
+        if cached_resource.concurrent_write
+          Concurrent::Promise.execute { _cache_write(key, object, *arguments) } && true
+        else
+          _cache_write(key, object, *arguments)
+        end
+      end
+
+      def _cache_write(key, object, *arguments)
         options = arguments[1] || {}
         params = options[:params]
         prefix_options, query_options = split_options(params)

data/lib/cached_resource/configuration.rb

@@ -24,18 +24,20 @@ module CachedResource
     # :cache, default: Rails.cache or ActiveSupport::Cache::MemoryStore.new,
     # :logger, default: Rails.logger or ActiveSupport::Logger.new(NilIO.new),
     # :cache_collections, default: true
+    # :concurrent_write, default: false
     def initialize(options={})
       super({
         :enabled => true,
+        :cache => defined?(Rails.cache)  && Rails.cache || CACHE,
+        :cache_collections => true,
+        :collection_arguments => [:all],
+        :collection_synchronize => false,
+        :concurrent_write => false,
+        :logger => defined?(Rails.logger) && Rails.logger || LOGGER,
         :race_condition_ttl => 86400,
         :ttl => 604800,
         :ttl_randomization => false,
-        :ttl_randomization_scale => 1..2,
-        :collection_synchronize => false,
-        :collection_arguments => [:all],
-        :cache => defined?(Rails.cache)  && Rails.cache || CACHE,
-        :logger => defined?(Rails.logger) && Rails.logger || LOGGER,
-        :cache_collections => true
+        :ttl_randomization_scale => 1..2
       }.merge(options))
     end
 
@@ -72,4 +74,4 @@ module CachedResource
     end
 
   end
-end
+end

data/lib/cached_resource/version.rb

@@ -1,3 +1,3 @@
 module CachedResource
-  VERSION = "7.2.0"
+  VERSION = "8.0.0"
 end

data/spec/cached_resource/caching_spec.rb

@@ -66,19 +66,27 @@ describe CachedResource do
       end
     end
 
-    it "should cache a response" do
-      result = Thing.find(1)
-      read_from_cache("thing/1").should == result
-    end
+    shared_examples "caching" do
+      it "should cache a response" do
+        result = Thing.find(1)
+        read_from_cache("thing/1").should == result
+      end
+
+      it "shouldn't cache nil response" do
+        Thing.find(:all, :params => { :name => '42' })
+        read_from_cache("thing/all/name/42").should == nil
+      end
 
-    it "shouldn't cache nil response" do
-      Thing.find(:all, :params => { :name => '42' })
-      read_from_cache("thing/all/name/42").should == nil
+      it "shouldn't cache blank response" do
+        Thing.find(:all, :params => { :name => '43' })
+        read_from_cache("thing/all/name/43").should == nil
+      end
     end
 
-    it "shouldn't cache [] response" do
-      Thing.find(:all, :params => { :name => '43' })
-      read_from_cache("thing/all/name/43").should == nil
+    include_examples "caching"
+
+    context 'when concurrency is turned on' do
+      include_examples "caching"
     end
 
     it "should cache a response for a string primary key" do
@@ -234,12 +242,12 @@ describe CachedResource do
           end
 
           non_cached = Thing.where(name: 'ada')
-          non_cached.original_params.should == { 'name' => 'ada' }
+          non_cached.original_params.should == { :name => 'ada' }
           non_cached.map(&:id).should == @thing_collection.map { |h| h[:id]}
 
           cached = read_from_cache('thing/all/{:params=>{:name=>"ada"}}')
           cached.should be_instance_of(CustomCollection)
-          cached.original_params.should == { 'name' => 'ada' }
+          cached.original_params.should == { :name => 'ada' }
           cached.resource_class.should == Thing
           cached.map(&:id).should == @thing_collection.map { |h| h[:id]}
 
@@ -249,11 +257,11 @@ describe CachedResource do
             non_cached = cached.where(major: 'CS')
           end
 
-          non_cached.original_params.should == { 'name' => 'ada', 'major' => 'CS' }
+          non_cached.original_params.should == { :name => 'ada', :major => 'CS' }
           non_cached.resource_class.should == Thing
           non_cached.map(&:id).should == @thing_collection2.map { |h| h[:id]}
-          cached = read_from_cache('thing/all/{:params=>{"name"=>"ada",:major=>"cs"}}')
-          cached.original_params.should == { 'name' => 'ada', 'major' => 'CS' }
+          cached = read_from_cache('thing/all/{:params=>{:name=>"ada",:major=>"cs"}}')
+          cached.original_params.should == { :name => 'ada', :major => 'CS' }
           cached.resource_class.should == Thing
           cached.map(&:id).should == @thing_collection2.map { |h| h[:id]}
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_resource
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Morgan Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -80,6 +80,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 description: Enables request-based caching for ActiveResource
 email: cached_resource@email.mhgbrown.is
 executables: []
@@ -101,6 +121,7 @@ files:
 - gemfiles/6.0.gemfile
 - gemfiles/6.1.gemfile
 - gemfiles/7.0.gemfile
+- gemfiles/7.1.gemfile
 - lib/cached_resource.rb
 - lib/cached_resource/cached_resource.rb
 - lib/cached_resource/caching.rb