cached_resource 5.1.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2b25cc83718d786c0441bc7cb082944ac7aa4fe3d379792cacb96e87df668eb
-  data.tar.gz: 8fa4f263faee071d9e7361f27b8927113bb36e76b1e5e765e993935cadad8c22
+  metadata.gz: 7102fd60421cc8ddea333b62047f5bf15dcc07e1ac38444084f8815d728ad386
+  data.tar.gz: 51e3b4a15b4094cdcfeda312a10b44aaff7f1da7143020c5100cd55b7f8dd22e
 SHA512:
-  metadata.gz: 0523763d1f6d1dd9eb1d68ddb2a196e8f737d5660c91bcb244374804b0ddc31f50037ebb19c0dc1a25b891586cf3b5025df60b16a11c209e03f0510147e78514
-  data.tar.gz: 8ae89f1cd8fcf8dccedc053c7acc15b76ea84853240b0998ee31b5a17f837d001696866262182787d315d4f432f67d87b1ef4d9ef918b530b4e884f4e2f88363
+  metadata.gz: 789e3ab01ffa4dd155a7587cab2d6f92455c0e9a8e2d8ce429b562c626be43eaadbfda3a44d13e09cb998c5e51805042eb7cd7463adc6b7f1e8cc25e2e77628e
+  data.tar.gz: 636d931d7de4ab7068d3f68704c4832f6216be8b0d7d50cc28797fb55389e8d2b0199b78685b57d5c48f8d596c6bf0e96a58f24d75a2a9b89467688de90140b3

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 sudo: false
+before_install:
+  - gem install bundler:1.17.3
 cache: bundler
 
 rvm:

data/README.md

@@ -1,4 +1,4 @@
-# CachedResource [![Build Status](https://secure.travis-ci.org/mhgbrown/cached_resource.png)](http://travis-ci.org/mhgbrown/cached_resource)
+# CachedResource [![Build Status](https://travis-ci.org/mhgbrown/cached_resource.svg?branch=master)](http://travis-ci.org/mhgbrown/cached_resource)
 CachedResource is a Ruby gem whose goal is to increase the performance of interacting with web services via ActiveResource by caching responses based on request parameters.  It can help reduce the lag created by making repeated requests across a network.
 
 ## Installation
@@ -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.0)
+    cached_resource (5.3.0)
       activeresource (>= 4.0)
       activesupport (>= 4.0)
       nilio (>= 1.0)
@@ -93,7 +93,7 @@ GEM
       rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    rails-observers (0.1.4)
+    rails-observers (0.1.5)
       activemodel (>= 4.0)
     railties (4.2.9)
       actionpack (= 4.2.9)
@@ -137,4 +137,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/gemfiles/5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cached_resource (5.1.0)
+    cached_resource (5.3.0)
       activeresource (>= 4.0)
       activesupport (>= 4.0)
       nilio (>= 1.0)
@@ -37,19 +37,18 @@ GEM
       globalid (>= 0.3.6)
     activemodel (5.0.2)
       activesupport (= 5.0.2)
-    activemodel-serializers-xml (1.0.1)
+    activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
-      activerecord (> 5.x)
       activesupport (> 5.x)
       builder (~> 3.1)
     activerecord (5.0.2)
       activemodel (= 5.0.2)
       activesupport (= 5.0.2)
       arel (~> 7.0)
-    activeresource (5.0.0)
-      activemodel (>= 5.0, < 6)
+    activeresource (5.1.1)
+      activemodel (>= 5.0, < 7)
       activemodel-serializers-xml (~> 1.0)
-      activesupport (>= 5.0, < 6)
+      activesupport (>= 5.0, < 7)
     activesupport (5.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
@@ -147,4 +146,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/gemfiles/5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cached_resource (5.1.0)
+    cached_resource (5.3.0)
       activeresource (>= 4.0)
       activesupport (>= 4.0)
       nilio (>= 1.0)
@@ -37,19 +37,18 @@ GEM
       globalid (>= 0.3.6)
     activemodel (5.1.2)
       activesupport (= 5.1.2)
-    activemodel-serializers-xml (1.0.1)
+    activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
-      activerecord (> 5.x)
       activesupport (> 5.x)
       builder (~> 3.1)
     activerecord (5.1.2)
       activemodel (= 5.1.2)
       activesupport (= 5.1.2)
       arel (~> 8.0)
-    activeresource (5.0.0)
-      activemodel (>= 5.0, < 6)
+    activeresource (5.1.1)
+      activemodel (>= 5.0, < 7)
       activemodel-serializers-xml (~> 1.0)
-      activesupport (>= 5.0, < 6)
+      activesupport (>= 5.0, < 7)
     activesupport (5.1.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
@@ -147,4 +146,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

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)
 
@@ -24,8 +25,8 @@ module CachedResource
       end
 
       # Clear the cache.
-      def clear_cache
-        cache_clear
+      def clear_cache(options=nil)
+        cache_clear(options)
       end
 
       private
@@ -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,16 +84,27 @@ 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|
-          cache = json_to_object(JSON.parse(json_cache, :symbolize_names => true))
-          if cache.is_a? Enumerable
-            restored = cache.map { |record| full_dup(record) }
-            next restored unless respond_to?(:collection_parser)
-            collection_parser.new(restored)
-          else
-            full_dup(cache)
+
+          json = ActiveSupport::JSON.decode(json_cache)
+
+          unless json.nil?
+            cache = json_to_object(json)
+            if cache.is_a? Enumerable
+              restored = cache.map { |record| full_dup(record) }
+              next restored unless respond_to?(:collection_parser)
+              collection_parser.new(restored)
+            else
+              full_dup(cache)
+            end
           end
         end
         object && cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} READ #{key}")
@@ -106,15 +119,26 @@ module CachedResource
       end
 
       # Clear the cache.
-      def cache_clear
-        cached_resource.cache.clear.tap do |result|
-          cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} CLEAR")
+      def cache_clear(options=nil)
+        # Memcache doesn't support delete_matched, which can also be computationally expensive
+        if cached_resource.cache.class.to_s == 'ActiveSupport::Cache::MemCacheStore' || options.try(:fetch,:all)
+          cached_resource.cache.clear.tap do |result|
+            cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} CLEAR ALL")
+          end
+        else
+          cached_resource.cache.delete_matched("^#{name_key}/*").tap do |result|
+            cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} CLEAR #{name_key}/*")
+          end
         end
       end
 
       # Generate the request cache key.
       def cache_key(*arguments)
-        "#{name.parameterize.gsub("-", "/")}/#{arguments.join('/')}".downcase.delete(' ')
+        "#{name_key}/#{arguments.join('/')}".downcase.delete(' ')
+      end
+
+      def name_key
+        name.parameterize.gsub("-", "/")
       end
 
       # Make a full duplicate of an ActiveResource record.
@@ -128,15 +152,17 @@ module CachedResource
       def json_to_object(json)
         if json.is_a? Array
           json.map { |attrs|
-            self.new(attrs[:object], attrs[:persistence]) }
+            self.new(attrs["object"], attrs["persistence"]) }
         else
-          self.new(json[:object], json[:persistence])
+          self.new(json["object"], json["persistence"])
         end
       end
 
       def object_to_json(object)
         if object.is_a? Enumerable
            object.map { |o| { :object => o, :persistence => o.persisted? } }.to_json
+        elsif object.nil?
+          nil.to_json
         else
           { :object => object, :persistence => object.persisted? }.to_json
         end

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.1.1"
+  VERSION = "5.3.0"
 end

data/spec/cached_resource/caching_spec.rb

@@ -12,6 +12,11 @@ describe CachedResource do
       cached_resource
     end
 
+    class NotTheThing < ActiveResource::Base
+      self.site = "http://api.notthething.com"
+      cached_resource
+    end
+
     @thing = {:thing => {:id => 1, :name => "Ada"}}
     @other_thing = {:thing => {:id => 1, :name => "Ari"}}
     @thing2 = {:thing => {:id => 2, :name => "Joe"}}
@@ -19,15 +24,22 @@ describe CachedResource do
     @thing3 = {:thing => {:id => 3, :name => "Stu"}}
     @string_thing = {:thing => {:id => "fded", :name => "Lev"}}
     @other_string_thing = {:thing => {:id => "fded", :name => "Lon"}}
+    @date_thing = {:thing => {:id => 4, :created_at => Time.utc(2020).iso8601}}
     @thing_json = @thing.to_json
     @other_thing_json = @other_thing.to_json
     @string_thing_json = @string_thing.to_json
     @other_string_thing_json = @other_string_thing.to_json
+    @date_thing_json = @date_thing.to_json
+    @nil_thing = nil.to_json
+    @not_the_thing = {:not_the_thing => {:id => 1, :name => "Not"}}
+    @not_the_thing_json = @not_the_thing.to_json
   end
 
   after(:each) do
     Thing.cached_resource.cache.clear
     Object.send(:remove_const, :Thing)
+    NotTheThing.cached_resource.cache.clear
+    Object.send(:remove_const, :NotTheThing)
   end
 
   describe "when enabled" do
@@ -36,12 +48,17 @@ describe CachedResource do
       # to make sure it works
       Thing.cached_resource.cache.clear
       Thing.cached_resource.on!
+      NotTheThing.cached_resource.cache.clear
+      NotTheThing.cached_resource.on!
 
       ActiveResource::HttpMock.reset!
       ActiveResource::HttpMock.respond_to do |mock|
         mock.get "/things/1.json", {}, @thing_json
         mock.get "/things/1.json?foo=bar", {}, @thing_json
         mock.get "/things/fded.json", {}, @string_thing_json
+        mock.get "/things.json?name=42", {}, @nil_thing, 404
+        mock.get "/things/4.json", {}, @date_thing_json
+        mock.get "/not_the_things/1.json", {}, @not_the_thing_json
       end
     end
 
@@ -51,6 +68,11 @@ describe CachedResource do
       read_from_cache("thing/1").should == result
     end
 
+    it "should cache a nil response" do
+      result = Thing.find(:all, :params => { :name => '42' })
+      read_from_cache("thing/all/name/42").should == nil
+    end
+
     it "should cache a response for a string primary key" do
       result = Thing.find("fded")
       read_from_cache("thing/fded").should == result
@@ -67,6 +89,20 @@ describe CachedResource do
       read_from_cache("thing/1").should == nil
     end
 
+    it "should not empty the cache of NotTheThing when clear_cache is called on the Thing" do
+      result1 = Thing.find(1)
+      result2 = NotTheThing.find(1)
+      Thing.clear_cache
+      NotTheThing.send(:cache_read, 'notthething/1').should == result2
+    end
+
+    it "should empty all the cache when clear_cache is called on the Thing with :all option set" do
+      result1 = Thing.find(1)
+      result2 = NotTheThing.find(1)
+      Thing.clear_cache(all: true)
+      NotTheThing.send(:cache_read, 'notthething/1').should == nil
+    end
+
     it "should cache a response with the same persistence" do
       result1 = Thing.find(1)
       result1.persisted?.should be true
@@ -159,6 +195,19 @@ describe CachedResource do
       result1.should_not be_frozen
     end
 
+    describe "when ActiveSupport.parse_json_times is enabled" do
+      before(:all) do
+        Time.zone = 'UTC'
+        ActiveSupport.parse_json_times = true
+      end
+
+      it "should convert date times to objects when reading from cache" do
+        Thing.find(4)
+
+        read_from_cache("thing/4").created_at.should == @date_thing[:thing][:created_at]
+      end
+    end
+
     shared_examples "collection_return_type" do
       if ActiveResource::VERSION::MAJOR >= 4
         it "should return an ActiveResource::Collection" do
@@ -516,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.1.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Morgan Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -143,13 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Caching for ActiveResource
-test_files:
-- spec/cached_resource/cached_resource_spec.rb
-- spec/cached_resource/caching_spec.rb
-- spec/cached_resource/configuration_spec.rb
-- spec/spec_helper.rb
+test_files: []