cached_resource 2.3.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7a2fced4f0e8dbfadcb40561224f9edf2d6e86e
-  data.tar.gz: bc219a0630f7f8775f26b809715e810fffd0eda7
+  metadata.gz: a93c586d68149afe39b531b4fa7b9230a1ad71f5
+  data.tar.gz: 66c08229d6334ebd4f79d771a70d26fa3d82c495
 SHA512:
-  metadata.gz: 1bad23ceba36ea99cf5e740ebfb4f730e8ca89a72fda08920f5fe39a68d81289adda8efed286b80144a833ce3d11ce95bcb1a5969a049a1ffed3a57be36c1870
-  data.tar.gz: b82d25319734c6cfb9d3bbebf0c7daf5d234a516bfa5a0612e3b9feb9b16f5b2e7ff6fb71178340a8e46d3eb36b55aef3db736b98fa74c2eb4774d60808925be
+  metadata.gz: 84c687552fa91f2bcd6384e01f63b1682b086442d57d0311d4a0c1e77e13ec602cee0ddb2aa9f62595b17a3b3a1bc70622f745b66117934640d313eb5c6323aa
+  data.tar.gz: 17655fde4e9427fcd3989be0c1aa9cfce1b5e93a0ea9797e71da4d3f40f8287954189d59e6fbfb28f4361578c5e6c45272be28e384eb948e45c55059915efd08

data/.travis.yml

@@ -1,6 +1,15 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
+
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - Gemfile
+
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: Gemfile
+

data/README.md

@@ -5,15 +5,17 @@ CachedResource is a Ruby gem whose goal is to increase the performance of intera
 	gem install cached_resource
 
 ## Compatibility
-CachedResource has been tested with the following Ruby versions:
+CachedResource supports the following Ruby versions:
 
-* 1.8.7
 * 1.9.2, 1.9.3
+* 2.0.0
 
-CachedResource is designed to be framework agnostic, but will hook into Rails for caching and logging.  If there is a `Rails.cache` and/or a `Rails.logger`, then it _should_ be OK.  It is known to work with the following Rails versions:
+If you require 1.8.7 support, please use version 2.3.4.
 
-* 3.1.3
-* 3.2.2, 3.2.3
+CachedResource is designed to be framework agnostic, but will hook into Rails for caching and logging if available. CachedResource officially supports the following Rails versions:
+
+* 3.2.x
+* 4.0.0
 
 ## Configuration
 **Set up CachedResource across all ActiveResources:**
@@ -98,6 +100,10 @@ Sit back and relax! If you need to reload a particular request you can pass `:re
 
 	MyActiveResource.find(:all, :reload => true)
 
+If you need to clear the entire cache just do the following:
+
+	MyActiveResource.clear_cache
+
 ## Testing
 	rake
 

data/cached_resource.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "rake"
-  s.add_dependency "activeresource", "~> 3.2"
-  s.add_dependency "activesupport", "~> 3.2"
+  s.add_dependency "activeresource", ">= 3.2"
+  s.add_dependency "activesupport", ">= 3.2"
   s.add_dependency "nilio", ">= 1.0"
 
   s.add_development_dependency "rspec"

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem "activeresource", "~> 3.2"
+gem "activesupport", "~> 3.2"
+
+

data/lib/cached_resource/caching.rb

@@ -22,6 +22,11 @@ module CachedResource
         should_reload ? find_via_reload(key, *arguments) : find_via_cache(key, *arguments)
       end
 
+      # Clear the cache.
+      def clear_cache
+        cache_clear
+      end
+
       private
 
       # Try to find a cached response for the given key.  If
@@ -43,7 +48,7 @@ module CachedResource
       # write cache entries for all its members
       # otherwise update an existing collection if possible.
       def cache_collection_synchronize(object, *arguments)
-        if object.is_a? Array
+        if object.is_a? Enumerable
           update_singles_cache(object)
           # update the collection only if this is a subset of it
           update_collection_cache(object) unless is_collection?(*arguments)
@@ -55,19 +60,18 @@ module CachedResource
       # Update the cache of singles with an array of updates.
       def update_singles_cache(updates)
         updates = Array(updates)
-        updates.each { |object| cache_write(object.send(primary_key), object) }
+        updates.each { |object| cache_write(cache_key(object.send(primary_key)), object) }
       end
 
       # Update the "mother" collection with an array of updates.
       def update_collection_cache(updates)
         updates = Array(updates)
-        collection = cache_read(cached_resource.collection_arguments)
+        collection = cache_read(cache_key(cached_resource.collection_arguments))
 
         if collection && !updates.empty?
-          store = CachedResource::Configuration::ORDERED_HASH.new
-          index = collection.inject(store) { |hash, object| hash[object.send(primary_key)] = object; hash }
+          index = collection.inject({}) { |hash, object| hash[object.send(primary_key)] = object; hash }
           updates.each { |object| index[object.send(primary_key)] = object }
-          cache_write(cached_resource.collection_arguments, index.values)
+          cache_write(cache_key(cached_resource.collection_arguments), index.values)
         end
       end
 
@@ -78,9 +82,7 @@ module CachedResource
       end
 
       # Read a entry from the cache for the given key.
-      # The key is processed to make sure it is valid.
       def cache_read(key)
-        key = cache_key(Array(key)) unless key.is_a? String
         object = cached_resource.cache.read(key).try do |cache|
           if cache.is_a? Enumerable
             cache.map { |record| full_dup(record) }
@@ -93,14 +95,19 @@ module CachedResource
       end
 
       # Write an entry to the cache for the given key and value.
-      # The key is processed to make sure it is valid.
       def cache_write(key, object)
-        key = cache_key(Array(key)) unless key.is_a? String
         result = cached_resource.cache.write(key, object, :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")
+        end
+      end
+
       # Generate the request cache key.
       def cache_key(*arguments)
         "#{name.parameterize.gsub("-", "/")}/#{arguments.join('/')}".downcase

data/lib/cached_resource/configuration.rb

@@ -3,14 +3,15 @@ module CachedResource
   # for cached resource.
   class Configuration < OpenStruct
 
-    # Determine and set an appropriate ordered hash based on the current ruby version
-    ORDERED_HASH = RUBY_VERSION.to_f < 1.9 ? ActiveSupport::OrderedHash : Hash
-
     # default or fallback cache without rails
     CACHE = ActiveSupport::Cache::MemoryStore.new
 
     # default of fallback logger without rails
-    LOGGER = ActiveSupport::BufferedLogger.new(NilIO.instance)
+    LOGGER = if defined?(ActiveSupport::Logger)
+        ActiveSupport::Logger.new(NilIO.instance)
+    else
+        ActiveSupport::BufferedLogger.new(NilIO.instance)
+    end
 
     # prefix for log messages
     LOGGER_PREFIX = "[cached_resource]"

data/lib/cached_resource/version.rb

@@ -1,3 +1,3 @@
 module CachedResource
-  VERSION = "2.3.4"
+  VERSION = "3.0.0"
 end

data/spec/cached_resource/caching_spec.rb

@@ -13,8 +13,12 @@ describe CachedResource do
     @thing2 = {:thing => {:id => 2, :name => "Joe"}}
     @other_thing2 = {:thing => {:id => 2, :name => "Jeb"}}
     @thing3 = {:thing => {:id => 3, :name => "Stu"}}
+    @string_thing = {:thing => {:id => "fded", :name => "Lev"}}
+    @other_string_thing = {:thing => {:id => "fded", :name => "Lon"}}
     @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
   end
 
   after(:each) do
@@ -32,6 +36,7 @@ describe CachedResource do
       ActiveResource::HttpMock.reset!
       ActiveResource::HttpMock.respond_to do |mock|
         mock.get "/things/1.json", {}, @thing_json
+        mock.get "/things/fded.json", {}, @string_thing_json
       end
     end
 
@@ -40,6 +45,17 @@ describe CachedResource do
       Thing.cached_resource.cache.read("thing/1").should == result
     end
 
+    it "should cache a response for a string primary key" do
+      result = Thing.find("fded")
+      Thing.cached_resource.cache.read("thing/fded").should == result
+    end
+
+    it "should empty the cache when clear_cache is called" do
+      result = Thing.find(1)
+      Thing.clear_cache
+      Thing.cached_resource.cache.read("thing/1").should == nil
+    end
+
     it "should cache a response with the same persistence" do
       result1 = Thing.find(1)
       result2 = Thing.find(1)
@@ -55,6 +71,15 @@ describe CachedResource do
       ActiveResource::HttpMock.requests.length.should == 1
     end
 
+    it "should read a response when the request is made again for a string primary key" do
+      # make a request
+      Thing.find("fded")
+      # make the same request
+      Thing.find("fded")
+      # only one request should have happened
+      ActiveResource::HttpMock.requests.length.should == 1
+    end
+
     it "should remake a request when reloaded" do
       # make a request
       Thing.find(1)
@@ -64,6 +89,15 @@ describe CachedResource do
       ActiveResource::HttpMock.requests.length.should == 2
     end
 
+    it "should remake a request when reloaded for a string primary key" do
+      # make a request
+      Thing.find("fded")
+      # make the same request, but reload it
+      Thing.find("fded", :reload => true)
+      # we should get two requests
+      ActiveResource::HttpMock.requests.length.should == 2
+    end
+
     it "should rewrite the cache when the request is reloaded" do
       # make a request
       Thing.find(1)
@@ -156,6 +190,15 @@ describe CachedResource do
 
     end
 
+    shared_examples "collection_cache_clearing" do
+      it "should empty the cache when clear_cache is called" do
+        Thing.clear_cache
+        Thing.cached_resource.cache.read("thing/all").should == nil
+        Thing.cached_resource.cache.read("thing/1").should == nil
+      end
+
+    end
+
     describe "when collection synchronize is enabled" do
       before(:each) do
         Thing.cached_resource.cache.clear
@@ -164,7 +207,8 @@ describe CachedResource do
         ActiveResource::HttpMock.reset!
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things/1.json", {}, @thing_json
-          mock.get "/things.json", {}, [@thing[:thing]].to_json(:root => :thing)
+          mock.get "/things/fded.json", {}, @string_thing_json
+          mock.get "/things.json", {}, [@thing[:thing], @string_thing[:thing]].to_json(:root => :thing)
         end
 
         # make a request for all things
@@ -175,19 +219,25 @@ describe CachedResource do
 
       it "should write cache entries for its members" do
         result = Thing.find(1)
+        string_result = Thing.find("fded")
         # only the all request should have been made
         ActiveResource::HttpMock.requests.length.should == 1
         # the result should be cached with the appropriate key
         Thing.cached_resource.cache.read("thing/1").should == result
+        Thing.cached_resource.cache.read("thing/fded").should == string_result
       end
 
+      include_examples "collection_cache_clearing"
+
       it "should rewrite cache entries for its members when reloaded" do
         # get the soon to be stale result so that we have a cache entry
         old_result = Thing.find(1)
+        old_string_result = Thing.find("fded")
         # change the server
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things/1.json", {}, @other_thing_json
-          mock.get "/things.json", {}, [@other_thing[:thing]].to_json(:root => :thing)
+          mock.get "/things/fded.json", {}, @other_string_thing_json
+          mock.get "/things.json", {}, [@other_thing[:thing], @other_string_thing[:thing]].to_json(:root => :thing)
         end
         # reload the collection
         Thing.all(:reload => true)
@@ -195,19 +245,26 @@ describe CachedResource do
         result = Thing.find(1)
         Thing.cached_resource.cache.read("thing/all")[0].should == result
         Thing.cached_resource.cache.read("thing/all")[0].name.should == result.name
+        string_result = Thing.find("fded")
+        Thing.cached_resource.cache.read("thing/all")[1].should == string_result
+        Thing.cached_resource.cache.read("thing/all")[1].name.should == string_result.name
       end
 
       it "should update the collection when an individual request is reloaded" do
         # change the server
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things/1.json", {}, @other_thing_json
-          mock.get "/things.json", {}, [@other_thing[:thing]].to_json(:root => :thing)
+          mock.get "/things/fded.json", {}, @other_string_thing_json
+          mock.get "/things.json", {}, [@other_thing[:thing], @other_string_thing[:thing]].to_json(:root => :thing)
         end
 
         # reload the individual
         result = Thing.find(1, :reload => true)
         Thing.cached_resource.cache.read("thing/all")[0].should == result
         Thing.cached_resource.cache.read("thing/all")[0].name.should == result.name
+        string_result = Thing.find("fded", :reload => true)
+        Thing.cached_resource.cache.read("thing/all")[1].should == string_result
+        Thing.cached_resource.cache.read("thing/all")[1].name.should == string_result.name
       end
 
       it "should update both the collection and the member cache entries when a subset of the collection is retrieved" do
@@ -218,6 +275,7 @@ describe CachedResource do
         # change the server
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things.json?name=Ari", {}, [@other_thing[:thing]].to_json(:root => :thing)
+          mock.get "/things.json?name=Lon", {}, [@other_string_thing[:thing]].to_json(:root => :thing)
         end
 
         # make a request for a subset of the "mother" collection
@@ -228,12 +286,21 @@ describe CachedResource do
         # the individual should be updated to reflect the server change
         Thing.cached_resource.cache.read("thing/1").should == result[0]
         Thing.cached_resource.cache.read("thing/1").name.should == result[0].name
+
+        # make a request for a subset of the "mother" collection
+        result = Thing.find(:all, :params => {:name => "Lon"})
+        # the collection should be updated to reflect the server change
+        Thing.cached_resource.cache.read("thing/all")[1].should == result[0]
+        Thing.cached_resource.cache.read("thing/all")[1].name.should == result[0].name
+        # the individual should be updated to reflect the server change
+        Thing.cached_resource.cache.read("thing/fded").should == result[0]
+        Thing.cached_resource.cache.read("thing/fded").name.should == result[0].name
       end
 
       it "should maintain the order of the collection when updating it" do
         # change the server to return a longer collection
         ActiveResource::HttpMock.respond_to do |mock|
-          mock.get "/things.json", {}, [@thing[:thing], @thing3[:thing], @thing2[:thing]].to_json(:root => :thing)
+          mock.get "/things.json", {}, [@thing[:thing], @thing3[:thing], @thing2[:thing], @string_thing[:thing]].to_json(:root => :thing)
         end
 
         # create cache entry for the collection (we reload because in before block we make an all request)
@@ -242,6 +309,7 @@ describe CachedResource do
         # change the server's response for the thing with id 2
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things/2.json", {}, @other_thing2.to_json(:root => :thing)
+          mock.get "/things/fded.json", {}, @other_string_thing.to_json(:root => :thing)
         end
 
         # get thing 2, thereby updating the collection
@@ -254,6 +322,17 @@ describe CachedResource do
         old_collection.each_with_index do |thing, i|
           updated_collection[i].id.should == thing.id
         end
+
+        # get string thing, thereby updating the collection
+        string_result = Thing.find("fded", :reload => true)
+        # get the updated collection from the cache
+        updated_collection = Thing.all
+        # name should have changed to "Lon"
+        updated_collection[3].name.should == string_result.name
+        # the updated collection should have the elements in the same order
+        old_collection.each_with_index do |thing, i|
+          updated_collection[i].id.should == thing.id
+        end
       end
     end
 
@@ -265,7 +344,8 @@ describe CachedResource do
         ActiveResource::HttpMock.reset!
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things/1.json", {}, @thing_json
-          mock.get "/things.json", {}, [@thing[:thing]].to_json(:root => :thing)
+          mock.get "/things/fded.json", {}, @string_thing_json
+          mock.get "/things.json", {}, [@thing[:thing], @string_thing[:thing]].to_json(:root => :thing)
         end
 
         # make a request for all things
@@ -276,21 +356,30 @@ describe CachedResource do
 
       it "should not write cache entries for its members" do
         result = Thing.find(1)
+        result = Thing.find("fded")
         # both the all in the before each and this request should have been made
-        ActiveResource::HttpMock.requests.length.should == 2
+        ActiveResource::HttpMock.requests.length.should == 3
       end
 
+      include_examples "collection_cache_clearing"
+
       it "should not update the collection when an individual request is reloaded" do
         # change the server
         ActiveResource::HttpMock.respond_to do |mock|
           mock.get "/things/1.json", {}, @other_thing_json
-          mock.get "/things.json", {}, [@other_thing[:thing]].to_json(:root => :thing)
+          mock.get "/things/fded.json", {}, @other_string_thing_json
+          mock.get "/things.json", {}, [@other_thing[:thing], @other_string_thing[:thing]].to_json(:root => :thing)
         end
 
         # reload the individual
         result = Thing.find(1, :reload => true)
         # the ids are the same, but the names should be different
         Thing.cached_resource.cache.read("thing/all")[0].name.should_not == result.name
+
+        # reload the individual
+        string_result = Thing.find("fded", :reload => true)
+        # the ids are the same, but the names should be different
+        Thing.cached_resource.cache.read("thing/all")[1].name.should_not == string_result.name
       end
     end
 
@@ -324,6 +413,7 @@ describe CachedResource do
       ActiveResource::HttpMock.reset!
       ActiveResource::HttpMock.respond_to do |mock|
         mock.get "/things/1.json", {}, @thing_json
+        mock.get "/things/fded.json", {}, @string_thing_json
       end
     end
 
@@ -332,6 +422,11 @@ describe CachedResource do
       Thing.cached_resource.cache.read("thing/1").should == result
     end
 
+    it "should cache a response for a string primary key" do
+      result = Thing.find("fded")
+      Thing.cached_resource.cache.read("thing/fded").should == result
+    end
+
     it "should always remake the request" do
       Thing.find(1)
       ActiveResource::HttpMock.requests.length.should == 1
@@ -339,6 +434,13 @@ describe CachedResource do
       ActiveResource::HttpMock.requests.length.should == 2
     end
 
+    it "should always remake the request for a string primary key" do
+      Thing.find("fded")
+      ActiveResource::HttpMock.requests.length.should == 1
+      Thing.find("fded")
+      ActiveResource::HttpMock.requests.length.should == 2
+    end
+
     it "should rewrite the cache for each request" do
       Thing.find(1)
       old_result = Thing.cached_resource.cache.read("thing/1")
@@ -356,5 +458,23 @@ describe CachedResource do
       # not new?, and have the same id.
       new_result.name.should_not == old_result.name
     end
+
+    it "should rewrite the cache for each request for a string primary key" do
+      Thing.find("fded")
+      old_result = Thing.cached_resource.cache.read("thing/fded")
+
+      # change the response
+      ActiveResource::HttpMock.reset!
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get "/things/fded.json", {}, @other_string_thing_json
+      end
+
+      Thing.find("fded")
+      new_result = Thing.cached_resource.cache.read("thing/fded")
+      # since active resources are equal if and only if they
+      # are the same object or an instance of the same class,
+      # not new?, and have the same id.
+      new_result.name.should_not == old_result.name
+    end
   end
 end

data/spec/cached_resource/configuration_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe "CachedResource::Configuration" do
 
   let(:configuration) { CachedResource::Configuration.new }
+  let(:default_logger) { defined?(ActiveSupport::Logger) ? ActiveSupport::Logger : ActiveSupport::BufferedLogger }
 
   describe "by default" do
     it "should be enabled" do
@@ -23,12 +24,13 @@ describe "CachedResource::Configuration" do
 
     describe "outside a Rails environment" do
       it "should be logging to a buffered logger attached to a NilIO" do
-        configuration.logger.class.should == ActiveSupport::BufferedLogger
+        configuration.logger.class.should == default_logger
         # ActiveSupport switched around the log destination variables
         # Check if either are what we expect to be compatible
         old_as = configuration.logger.instance_variable_get(:@log).class == NilIO
         new_as = configuration.logger.instance_variable_get(:@log_dest).class == NilIO
-        (old_as || new_as).should == true
+        newer_as = configuration.logger.instance_variable_get(:@logdev).instance_variable_get(:@dev).class == NilIO
+        (old_as || new_as || newer_as).should == true
       end
 
       it "should cache responses in a memory store" do
@@ -173,7 +175,7 @@ describe "CachedResource::Configuration" do
     it "should have the default options for anything unspecified" do
       cr = Foo.cached_resource
       cr.cache.class.should == ActiveSupport::Cache::MemoryStore
-      cr.logger.class.should == ActiveSupport::BufferedLogger
+      cr.logger.class.should == default_logger
       cr.enabled.should == true
       cr.collection_synchronize.should == false
       cr.collection_arguments.should == [:all]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_resource
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Andrew Chan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,28 +28,28 @@ dependencies:
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -94,6 +94,7 @@ files:
 - README.md
 - Rakefile
 - cached_resource.gemspec
+- gemfiles/Gemfile.rails-3.2.x
 - lib/cached_resource.rb
 - lib/cached_resource/cached_resource.rb
 - lib/cached_resource/caching.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Caching for ActiveResource