cached_resource 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29a5076e42c43b34a6d5b430c8dc16ce062dd3f7f1ac4f63f992efef03b3ccf9
-  data.tar.gz: ff819f199885c83cb65a6e21d1a319c5bb6b747dd467870c913043765fbfa111
+  metadata.gz: 7102fd60421cc8ddea333b62047f5bf15dcc07e1ac38444084f8815d728ad386
+  data.tar.gz: 51e3b4a15b4094cdcfeda312a10b44aaff7f1da7143020c5100cd55b7f8dd22e
 SHA512:
-  metadata.gz: ea526acccd50610cf5c39248c9c0180c7a6ca1ca42cb6975df9b6f97b668febda6fc17684e9a9a7ca4b371798019d7d5e818e7a34e428702aeb5f475859ddbae
-  data.tar.gz: cc087aa9dcc0ad28b8779cf4412fd999b84019b7398d610e2e9e271b14d550bb9baa9dd039a0fa10da6bd15c83f76cba843769723e7bd0ca13a8d3f2f24c0e5e
+  metadata.gz: 789e3ab01ffa4dd155a7587cab2d6f92455c0e9a8e2d8ce429b562c626be43eaadbfda3a44d13e09cb998c5e51805042eb7cd7463adc6b7f1e8cc25e2e77628e
+  data.tar.gz: 636d931d7de4ab7068d3f68704c4832f6216be8b0d7d50cc28797fb55389e8d2b0199b78685b57d5c48f8d596c6bf0e96a58f24d75a2a9b89467688de90140b3

data/README.md

@@ -53,6 +53,7 @@ CachedResource accepts the following options:
 * `:collection_arguments` The arguments that identify the principal collection request. Default: `[:all]`
 * `: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`
 
 You can set them like this:
 

data/gemfiles/4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cached_resource (5.1.3)
+    cached_resource (5.3.0)
       activeresource (>= 4.0)
       activesupport (>= 4.0)
       nilio (>= 1.0)

data/gemfiles/5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cached_resource (5.1.3)
+    cached_resource (5.3.0)
       activeresource (>= 4.0)
       activesupport (>= 4.0)
       nilio (>= 1.0)

data/gemfiles/5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cached_resource (5.1.3)
+    cached_resource (5.3.0)
       activeresource (>= 4.0)
       activesupport (>= 4.0)
       nilio (>= 1.0)

data/lib/cached_resource/caching.rb

@@ -17,6 +17,7 @@ module CachedResource
       def find_with_cache(*arguments)
         arguments << {} unless arguments.last.is_a?(Hash)
         should_reload = arguments.last.delete(:reload) || !cached_resource.enabled
+        should_reload = true if !cached_resource.cache_collections && is_any_collection?(*arguments)
         arguments.pop if arguments.last.empty?
         key = cache_key(arguments)
 
@@ -41,6 +42,7 @@ module CachedResource
       def find_via_reload(key, *arguments)
         object = find_without_cache(*arguments)
         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)
         cache_read(key)
       end
@@ -82,6 +84,12 @@ module CachedResource
         arguments == cached_resource.collection_arguments
       end
 
+      # Determine if the given arguments represent
+      # any collection of objects
+      def is_any_collection?(*arguments)
+        cached_resource.collection_arguments.all?{ |arg| arguments.include?(arg) } || arguments.include?(:all)
+      end
+
       # Read a entry from the cache for the given key.
       def cache_read(key)
         object = cached_resource.cache.read(key).try do |json_cache|

data/lib/cached_resource/configuration.rb

@@ -22,7 +22,8 @@ module CachedResource
     # :collection_synchronize, default: false,
     # :collection_arguments, default: [:all]
     # :cache, default: Rails.cache or ActiveSupport::Cache::MemoryStore.new,
-    # :logger, default: Rails.logger or ActiveSupport::Logger.new(NilIO.new)
+    # :logger, default: Rails.logger or ActiveSupport::Logger.new(NilIO.new),
+    # :cache_collections, default: true
     def initialize(options={})
       super({
         :enabled => true,
@@ -33,7 +34,8 @@ module CachedResource
         :collection_synchronize => false,
         :collection_arguments => [:all],
         :cache => defined?(Rails.cache)  && Rails.cache || CACHE,
-        :logger => defined?(Rails.logger) && Rails.logger || LOGGER
+        :logger => defined?(Rails.logger) && Rails.logger || LOGGER,
+        :cache_collections => true
       }.merge(options))
     end
 

data/lib/cached_resource/version.rb

@@ -1,3 +1,3 @@
 module CachedResource
-  VERSION = "5.2.0"
+  VERSION = "5.3.0"
 end

data/spec/cached_resource/caching_spec.rb

@@ -565,4 +565,37 @@ describe CachedResource do
       new_result.name.should_not == old_result.name
     end
   end
+
+  describe "when cache_collections is disabled" do
+    before(:each) do
+      Thing.cached_resource.cache.clear
+      Thing.cached_resource.cache_collections = false
+
+      ActiveResource::HttpMock.reset!
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get "/things.json", {}, [@thing[:thing],@string_thing[:thing]].to_json(:root => :thing)
+        mock.get "/things/1.json", {}, @thing_json
+        mock.get "/things/fded.json", {}, @string_thing_json
+      end
+    end
+
+    it "should cache a response" do
+      result = Thing.find(1)
+      read_from_cache("thing/1").should == result
+    end
+
+    it "should not remake a single request" do
+      result = Thing.find(1)
+      ActiveResource::HttpMock.requests.length.should == 1
+      result = Thing.find(1)
+      ActiveResource::HttpMock.requests.length.should == 1
+    end
+
+    it "should always remake the request for collections" do
+      Thing.all
+      ActiveResource::HttpMock.requests.length.should == 1
+      Thing.all
+      ActiveResource::HttpMock.requests.length.should == 2
+    end
+  end
 end

data/spec/cached_resource/configuration_spec.rb

@@ -22,6 +22,10 @@ describe "CachedResource::Configuration" do
       configuration.collection_arguments.should == [:all]
     end
 
+    it "should cache collections" do
+      configuration.cache_collections == true
+    end
+
     describe "outside a Rails environment" do
       it "should be logging to a buffered logger attached to a NilIO" do
         configuration.logger.class.should == default_logger
@@ -72,7 +76,8 @@ describe "CachedResource::Configuration" do
                         :enabled => false,
                         :collection_synchronize => true,
                         :collection_arguments => [:every],
-                        :custom => "irrelevant"
+                        :custom => "irrelevant",
+                        :cache_collections => true
       end
     end
 
@@ -90,6 +95,7 @@ describe "CachedResource::Configuration" do
       cr.collection_synchronize.should == true
       cr.collection_arguments.should == [:every]
       cr.custom.should == "irrelevant"
+      cr.cache_collections.should == true
     end
   end
 
@@ -130,7 +136,8 @@ describe "CachedResource::Configuration" do
                         :enabled => false,
                         :collection_synchronize => true,
                         :collection_arguments => [:every],
-                        :custom => "irrelevant"
+                        :custom => "irrelevant",
+                        :cache_collections => true
       end
 
       class Foo < Bar
@@ -158,7 +165,8 @@ describe "CachedResource::Configuration" do
                         :enabled => false,
                         :collection_synchronize => true,
                         :collection_arguments => [:every],
-                        :custom => "irrelevant"
+                        :custom => "irrelevant",
+                        :cache_collections => true
       end
 
       class Foo < Bar
@@ -186,6 +194,7 @@ describe "CachedResource::Configuration" do
       cr.custom.should == nil
       cr.ttl_randomization.should == false
       cr.ttl_randomization_scale.should == (1..2)
+      cr.cache_collections.should == true
       expect(cr.race_condition_ttl).to eq(86400)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_resource
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Morgan Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Caching for ActiveResource