cached_resource 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 649cd7b534f3afc2628e4400f3b08e05769ed68b
-  data.tar.gz: 4e47e85d1ae399953ae9544bfe8b0ae0de9c99c7
+SHA256:
+  metadata.gz: 29a5076e42c43b34a6d5b430c8dc16ce062dd3f7f1ac4f63f992efef03b3ccf9
+  data.tar.gz: ff819f199885c83cb65a6e21d1a319c5bb6b747dd467870c913043765fbfa111
 SHA512:
-  metadata.gz: dabb024419aeb48a493fe0d4b1bdffdf7177b17a6c4fbcd573f8fbe99ee756acbbfb809daf8dd8a314843ab32bde126b9e5609b941864e5bc95f99949d6e00fe
-  data.tar.gz: 6008d2ed179cd97d1187cfe4a0f15922a48e1b5ae88af77f857643ac05e76eb8d2326675ecaeca2b78b4d3df75d6fb3c294a5492d65458a6d4bf0a7453fb36e5
+  metadata.gz: ea526acccd50610cf5c39248c9c0180c7a6ca1ca42cb6975df9b6f97b668febda6fc17684e9a9a7ca4b371798019d7d5e818e7a34e428702aeb5f475859ddbae
+  data.tar.gz: cc087aa9dcc0ad28b8779cf4412fd999b84019b7398d610e2e9e271b14d550bb9baa9dd039a0fa10da6bd15c83f76cba843769723e7bd0ca13a8d3f2f24c0e5e

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,8 +1,11 @@
-# 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
-	gem install cached_resource
+
+```ruby
+gem install cached_resource
+```
 
 ## Compatibility
 CachedResource supports the following Ruby versions:
@@ -24,15 +27,19 @@ For previously supported versions, use 4.2.0 or below.
 ## Configuration
 **Set up CachedResource across all ActiveResources:**
 
-	class ActiveResource::Base
-		cached_resource
-	end
+```ruby
+class ActiveResource::Base
+  cached_resource
+end
+```
 
 Or set up CachedResource for a single class:
 
-	class MyActiveResource < ActiveResource::Base
-		cached_resource
-	end
+```ruby
+class MyActiveResource < ActiveResource::Base
+  cached_resource
+end
+```
 
 ### Options
 CachedResource accepts the following options:
@@ -49,81 +56,115 @@ CachedResource accepts the following options:
 
 You can set them like this:
 
-	cached_resource :cache => MyCacheStore.new, :ttl => 60, :collection_synchronize => true, :logger => MyLogger.new
+```ruby
+cached_resource :cache => MyCacheStore.new, :ttl => 60, :collection_synchronize => true, :logger => MyLogger.new
+```
 
 You can also change them on the fly.
 
 Turn CachedResource off.  This will cause all responses to be retrieved normally (i.e. via the network). All responses will still be cached.
 
-	MyActiveResource.cached_resource.off!
+```ruby
+  MyActiveResource.cached_resource.off!
+```
 
 Turn CachedResource on.
-
-	MyActiveResource.cached_resource.on!
+```ruby
+MyActiveResource.cached_resource.on!
+```
 
 Set the cache expiry time to 60 seconds.
 
-	MyActiveResource.cached_resource.ttl = 60
+```ruby
+MyActiveResource.cached_resource.ttl = 60
+```
 
 Enable cache expiry time randomization, allowing it to fall randomly between 60 and 120 seconds.
 
-	MyActiveResource.cached_resource.ttl_randomization = true
+```ruby
+MyActiveResource.cached_resource.ttl_randomization = true
+```
 
 Change the cache expiry time randomization scale so that the cache expiry time falls randomly between 30 and 180 seconds.
 
-	MyActiveResource.cached_resource.ttl_randomization_scale = 0.5..3
-
+```ruby
+MyActiveResource.cached_resource.ttl_randomization_scale = 0.5..3
+```
 Enable collection synchronization.  This will cause a call to `MyActiveResource.all` to also create cache entries for each of its members.  So, for example, a later call to `MyActiveResource.find(1)` will be read from the cache instead of requested from the remote service.
 
-	MyActiveResource.cached_resource.collection_synchronize = true
-
+```ruby
+MyActiveResource.cached_resource.collection_synchronize = true
+```
 Change the arguments that identify the principal collection request.  If for some reason you are concerned with a collection that is retrieved at a "non-standard" URL, you may specify the Ruby arguments that produce that URL.  When `collection_synchronize` is `true`, the collection returned from a request that matches these arguments will be cached and later updated when one of its members or a subset is retrieved.
 
-	MyActiveResource.cached_resource.collection_arguments = [:all, :params => {:name => "Bob"}]
-
+```ruby
+MyActiveResource.cached_resource.collection_arguments = [:all, :params => {:name => "Bob"}]
+```
 Set a different logger.
 
-	MyActiveResource.cached_resource.logger = MyLogger.new
-
+```ruby
+MyActiveResource.cached_resource.logger = MyLogger.new
+```
 Set a different cache store.
 
-	MyActiveResource.cached_resource.cache = MyCacheStore.new
+```ruby
+MyActiveResource.cached_resource.cache = MyCacheStore.new
+```
 
 ### Caveats
 If you set up CachedResource across all ActiveResources or any subclass of ActiveResource that will be inherited by other classes and you want some of those others to have independent CachedResource configurations, then check out the example below:
 
-	class ActiveResource::Base
-		cached_resource
-	end
-
-	class MyActiveResource < ActiveResource::Base
-		self.cached_resource = CachedResource::Configuration.new(:collection_synchronize => true)
-	end
-
+```ruby
+class ActiveResource::Base
+  cached_resource
+end
+```
+
+```ruby
+class MyActiveResource < ActiveResource::Base
+  self.cached_resource = CachedResource::Configuration.new(:collection_synchronize => true)
+end
+```
 ## Usage
 Sit back and relax! If you need to reload a particular request you can pass `:reload => true` into the options hash like this:
 
-	MyActiveResource.find(:all, :reload => true)
-
+```ruby
+MyActiveResource.find(:all, :reload => true)
+```
 If you need to clear the entire cache just do the following:
 
-	MyActiveResource.clear_cache
-
+```ruby
+MyActiveResource.clear_cache
+```
 ---
 Sometimes you might have a case the resource pathing is non-unique per call. This can create a situation where your caching the same result for multiple calls:
 
-	MyActiveResource.find(:one, from: "/admin/shop.json")
+```ruby
+MyActiveResource.find(:one, from: "/admin/shop.json")
+```
 
 Since resources are cached with an argument based key, you may pass in extra data to be appended to the cache key:
 
-	MyActiveResource.find(:one, from: "/admin/shop.json", uid: "unique value")
-
+```ruby
+MyActiveResource.find(:one, from: "/admin/shop.json", uid: "unique value")
+```
 ## Testing
-	rake
 
-or to test all supported environments
+```ruby
+rake
+```
+
+or to test all supported environments, make sure appraisal is setup
+
+```ruby
+bundle exec appraisal install
+```
+
+and then run
 
-	bundle exec appraisal rake
+```ruby
+bundle exec appraisal rake
+```
 
 For more details, head over to the [appraisal](https://github.com/thoughtbot/appraisal) documentation.
 

data/gemfiles/4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    cached_resource (5.1.0)
+    cached_resource (5.1.3)
       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.15.1
+   1.17.3

data/gemfiles/5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    cached_resource (5.1.0)
+    cached_resource (5.1.3)
       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.15.1
+   1.17.3

data/gemfiles/5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    cached_resource (5.1.0)
+    cached_resource (5.1.3)
       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.15.1
+   1.17.3

data/lib/cached_resource/caching.rb

@@ -24,8 +24,8 @@ module CachedResource
       end
 
       # Clear the cache.
-      def clear_cache
-        cache_clear
+      def clear_cache(options=nil)
+        cache_clear(options)
       end
 
       private
@@ -85,13 +85,18 @@ module CachedResource
       # 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))
-          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}")
@@ -100,21 +105,32 @@ module CachedResource
 
       # Write an entry to the cache for the given key and value.
       def cache_write(key, object)
-        result = cached_resource.cache.write(key, object.to_json, :race_condition_ttl => cached_resource.race_condition_ttl, :expires_in => cached_resource.generate_ttl)
+        result = cached_resource.cache.write(key, object_to_json(object), :race_condition_ttl => cached_resource.race_condition_ttl, :expires_in => cached_resource.generate_ttl)
         result && cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} WRITE #{key}")
         result
       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.
@@ -127,12 +143,22 @@ module CachedResource
 
       def json_to_object(json)
         if json.is_a? Array
-          json.map { |attrs| self.new(attrs) }
+          json.map { |attrs|
+            self.new(attrs["object"], attrs["persistence"]) }
         else
-          self.new(json)
+          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
+      end
     end
   end
 end

data/lib/cached_resource/version.rb

@@ -1,3 +1,3 @@
 module CachedResource
-  VERSION = "5.1.0"
+  VERSION = "5.2.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,8 +89,23 @@ 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
       result2 = Thing.find(1)
       result1.persisted?.should == result2.persisted?
     end
@@ -158,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_resource
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Morgan Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2021-11-04 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.5.2
+rubygems_version: 3.0.8
 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: []