cached_resource 6.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db920707ba1bb3a1ba5c619c316ea9a1a0c932b9852231f312178a15952ac43
-  data.tar.gz: 7bb62db4f9df25eb585ab2d1a7605ed5b4ca0811df2e83cb19be9adefd039be0
+  metadata.gz: '0895f45566dd7c4ee2f394be6dda1c7a86aed9ad4e7c6a470d9a59d584c529c1'
+  data.tar.gz: 16106c7680c3cd6708b8171aa5db5f3993f3a77368685876e3e125b03e2d8e85
 SHA512:
-  metadata.gz: c7f06dba0aaf189395a70fc6c5d8e7d97a5e48e327f2d73fdc192b9bb3b911b85e01bff9cdda67aad53c91d471df59bb5b3db808f3eac5c92f9a881c41a7347b
-  data.tar.gz: 307f61951d5ac54b1c28677253b862a8857b79358afe7abb8504849b8da902bfba1ae05bda6231aa34044d1f0eaa0228fd4794ccf25e6acf5406df7747840fcc
+  metadata.gz: 0dbb4bc9fc1019dbf38dce7553b1ad15a964ca3699a461d551b892a26608b53ab0dbe4d8dbcce3878977f4b00debd88affa6494ad52d4fb2fb739a3ca6d239c3
+  data.tar.gz: 689a7edad73b7de5cff68c17d34135422d7166b1ae2745ae3be398cc77399e1ccd2d09a8423a3c7fda00f647216834e4b93c0a82287c39dd5ea5177d3fc7072f

data/.github/workflows/ruby.yml

@@ -0,0 +1,109 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Test
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    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']
+        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'
+            rails-version: '6.1'
+          - ruby-version: '2.4'
+            rails-version: '6.0'
+          - 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'
+            rails-version: '7.0'
+          - ruby-version: '2.5'
+            rails-version: '7.0'
+          - ruby-version: '2.6'
+            rails-version: '7.0'
+          # incompatbility with BigDecimal.new
+          - ruby-version: '2.7'
+            rails-version: '4.2'
+          - ruby-version: '3.0'
+            rails-version: '4.2'
+          - ruby-version: '3.1'
+            rails-version: '4.2'
+          - ruby-version: '3.2'
+            rails-version: '4.2'
+          # ArgumentError: expected attributes to be able to convert to Hash, got "#<Thing:0x000055d208b2e258>"
+          # probably keyword argument delegation different in Ruby 3
+          # https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+          - ruby-version: '3.0'
+            rails-version: '5.0'
+          - ruby-version: '3.0'
+            rails-version: '5.1'
+          - ruby-version: '3.1'
+            rails-version: '5.0'
+          - ruby-version: '3.1'
+            rails-version: '5.1'
+          - ruby-version: '3.2'
+            rails-version: '5.0'
+          - ruby-version: '3.2'
+            rails-version: '5.1'
+
+    steps:
+      - uses: actions/checkout@v3
+      - 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):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install bundler 1.x.x
+        if: matrix.rails-version == '4.2'
+        run: gem uninstall -aIx bundler && gem install bundler -v 1.17.3
+      - name: Install dependencies
+        run: bundle install
+        env:
+          TEST_RAILS_VERSION: ${{ matrix.rails-version }}
+          DEBUG: true
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 *DS_Store
 .ruby-version
+.tool-versions

data/FUNDING.json

@@ -0,0 +1,7 @@
+{
+  "drips": {
+    "ethereum": {
+      "ownedBy": "0xe2E9b9B5d0757c26aB477A754788B19b60f2ed83"
+    }
+  }
+}

data/Gemfile

@@ -1,3 +1,29 @@
 source "http://rubygems.org"
 
 gemspec
+
+def eval_gemfile(path)
+  gemfile_local = File.expand_path(path, __FILE__)
+  if File.readable?(gemfile_local)
+    puts "Loading #{gemfile_local}..." if ENV['DEBUG']
+    instance_eval(File.read(gemfile_local))
+  end
+end
+
+puts "\e[93mUsing TEST_RAILS_VERSION #{ENV['TEST_RAILS_VERSION']}\e[0m" if ENV['DEBUG']
+case ENV['TEST_RAILS_VERSION']
+when "4.2"
+  eval_gemfile('../gemfiles/4.2.gemfile')
+when "5.0"
+  eval_gemfile('../gemfiles/5.0.gemfile')
+when "5.1"
+  eval_gemfile('../gemfiles/5.1.gemfile')
+when "6.0"
+  eval_gemfile('../gemfiles/6.0.gemfile')
+when "6.1"
+  eval_gemfile('../gemfiles/6.1.gemfile')
+when "7.0"
+  eval_gemfile('../gemfiles/7.0.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

@@ -1,4 +1,5 @@
-# CachedResource [![Build Status](https://app.travis-ci.com/mhgbrown/cached_resource.svg?branch=master)](https://app.travis-ci.com/github/mhgbrown/cached_resource)
+# CachedResource ![Tests](https://github.com/mhgbrown/cached_resource/actions/workflows/ruby.yml/badge.svg)
+
 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
@@ -8,28 +9,32 @@ gem install cached_resource
 ```
 
 ## Compatibility
-CachedResource supports the following Ruby versions:
 
-* 2.2.x
-* 2.3.x
-* 2.4.x
-* 2.5.x
-* 2.7.x
+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:
 
-...and likely other modern Ruby versions. If you require 1.8.7 support, please use version 2.3.4.
+| | 🛤️ 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   |     |     |     | ✅   | ✅   | ✅   |
 
-CachedResource is designed to be framework agnostic, but will hook into Rails for caching and logging if available. The latest CachedResource officially supports the following Rails versions:
+## Limitations
 
-* 4.2.x
-* 5.0.x
-* 5.1.x
-* 6.0.x
-* 6.1.x
-* 7.0.x
+The following are limitations for ActiveResource/Rails versions
 
-For previously supported versions, use 4.2.0 or below.
+| ActiveSupport Version |                             Limitation                                  |
+|---------------------- | ----------------------------------------------------------------------- |
+| 🛤️ 4.X                |  You cannot chain calls. Ie `Thing.where(fn: 'foo').where(ln: 'bar')`. <br> However, you can still access `original_params` and the `resource_class` and replicate it with <br>`call1 = Thing.where(fn: 'foo')`<br>`call1.resource_class.where(call1.original_params.merge(ln: 'bar'))`  |
 
 ## Configuration
+
 **Set up CachedResource across all ActiveResources:**
 
 ```ruby
@@ -154,25 +159,46 @@ Since resources are cached with an argument based key, you may pass in extra dat
 ```ruby
 MyActiveResource.find(:one, from: "/admin/shop.json", uid: "unique value")
 ```
+
 ## Testing
 
-```ruby
-rake
+To test the Ruby + Rails combination configured by default:
+
+```bash
+$ rake
 ```
 
-or to test all supported environments, make sure appraisal is setup
+or to test all supported environments...you have to do a little more work...
 
-```ruby
-bundle exec appraisal install
+Switch your Ruby version to the desired version. This project's maintainer uses `asdf`, so switching to Ruby 3 looks like this:
+
+```bash
+$ asdf local ruby 3.0.5
 ```
 
-and then run
+If you have a `Gemfile.lock`, delete it:
 
-```ruby
-bundle exec appraisal rake
+```bash
+$ rm Gemfile.lock
 ```
 
-For more details, head over to the [appraisal](https://github.com/thoughtbot/appraisal) documentation.
+Then reinstall your dependencies:
+
+```bash
+$ bundle install
+```
+
+and finally, run the tests:
+
+```bash
+$ rake
+```
+
+If you want to test with a specific Rails version, start over and install dependencies with `TEST_RAILS_VERSION` set:
+
+```bash
+$ TEST_RAILS_VERSION=6.1 bundle install
+```
 
 ## Credit/Inspiration
 * quamen and [this gist](http://gist.github.com/947734)

data/cached_resource.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "cached_resource"
   s.version     = CachedResource::VERSION
   s.authors     = "Morgan Brown"
-  s.email       = "brown.mhg@gmail.com"
+  s.email       = "cached_resource@email.mhgbrown.is"
   s.homepage    = "https://github.com/mhgbrown/cached_resource"
   s.summary     = %q{Caching for ActiveResource}
   s.description = %q{Enables request-based caching for ActiveResource}
@@ -17,11 +17,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = '>= 1.9.0'
+
   s.add_runtime_dependency "activeresource", ">= 4.0"
   s.add_runtime_dependency "activesupport", ">= 4.0"
   s.add_runtime_dependency "nilio", ">= 1.0"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
-  s.add_development_dependency "appraisal"
 end

data/gemfiles/4.2.gemfile

@@ -1,9 +1,6 @@
-# This file was generated by Appraisal
-
 source "http://rubygems.org"
 
 gem "rails", "~> 4.2.0"
-# https://stackoverflow.com/questions/60226893/rails-nomethoderror-undefined-method-new-for-bigdecimalclass
-gem "bigdecimal", "1.3.5"
 
-gemspec path: "../"
+# https://stackoverflow.com/questions/60226893/rails-nomethoderror-undefined-method-new-for-bigdecimalclass
+# gem "bigdecimal", "1.3.5"

data/gemfiles/5.0.gemfile

@@ -1,7 +1,3 @@
-# This file was generated by Appraisal
-
 source "http://rubygems.org"
 
 gem "rails", "~> 5.0.0"
-
-gemspec path: "../"

data/gemfiles/5.1.gemfile

@@ -1,7 +1,3 @@
-# This file was generated by Appraisal
-
 source "http://rubygems.org"
 
 gem "rails", "~> 5.1.0"
-
-gemspec path: "../"

data/gemfiles/6.0.gemfile

@@ -1,7 +1,3 @@
-# This file was generated by Appraisal
-
 source "http://rubygems.org"
 
 gem "rails", "~> 6.0.0"
-
-gemspec path: "../"

data/gemfiles/6.1.gemfile

@@ -1,7 +1,3 @@
-# This file was generated by Appraisal
-
 source "http://rubygems.org"
 
 gem "rails", "~> 6.1.0"
-
-gemspec path: "../"

data/gemfiles/7.0.gemfile

@@ -1,7 +1,3 @@
-# This file was generated by Appraisal
-
 source "http://rubygems.org"
 
 gem "rails", "~> 7.0.0"
-
-gemspec path: "../"

data/lib/cached_resource/caching.rb

@@ -37,13 +37,14 @@ module CachedResource
         cache_read(key) || find_via_reload(key, *arguments)
       end
 
-      # Re/send the request to fetch the resource. Cache the response
-      # for the request.
+      # Re/send the request to fetch the resource
       def find_via_reload(key, *arguments)
         object = find_without_cache(*arguments)
+        return object unless cached_resource.enabled
+
         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_write(key, object, *arguments)
         cache_read(key)
       end
 
@@ -52,29 +53,29 @@ module CachedResource
       # otherwise update an existing collection if possible.
       def cache_collection_synchronize(object, *arguments)
         if object.is_a? Enumerable
-          update_singles_cache(object)
+          update_singles_cache(object, *arguments)
           # update the collection only if this is a subset of it
-          update_collection_cache(object) unless is_collection?(*arguments)
+          update_collection_cache(object, *arguments) unless is_collection?(*arguments)
         else
-          update_collection_cache(object)
+          update_collection_cache(object, *arguments)
         end
       end
 
       # Update the cache of singles with an array of updates.
-      def update_singles_cache(updates)
+      def update_singles_cache(updates, *arguments)
         updates = Array(updates)
-        updates.each { |object| cache_write(cache_key(object.send(primary_key)), object) }
+        updates.each { |object| cache_write(cache_key(object.send(primary_key)), object, *arguments) }
       end
 
       # Update the "mother" collection with an array of updates.
-      def update_collection_cache(updates)
+      def update_collection_cache(updates, *arguments)
         updates = Array(updates)
         collection = cache_read(cache_key(cached_resource.collection_arguments))
 
         if collection && !updates.empty?
           index = collection.inject({}) { |hash, object| hash[object.send(primary_key)] = object; hash }
           updates.each { |object| index[object.send(primary_key)] = object }
-          cache_write(cache_key(cached_resource.collection_arguments), index.values)
+          cache_write(cache_key(cached_resource.collection_arguments), index.values, *arguments)
         end
       end
 
@@ -101,7 +102,10 @@ module CachedResource
             if cache.is_a? Enumerable
               restored = cache.map { |record| full_dup(record) }
               next restored unless respond_to?(:collection_parser)
-              collection_parser.new(restored)
+              collection_parser.new(restored).tap do |parser|
+                parser.resource_class = self
+                parser.original_params = json['original_params']
+              end
             else
               full_dup(cache)
             end
@@ -112,8 +116,12 @@ module CachedResource
       end
 
       # 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(object), :race_condition_ttl => cached_resource.race_condition_ttl, :expires_in => cached_resource.generate_ttl)
+      def cache_write(key, object, *arguments)
+        options = arguments[1] || {}
+        params = options[:params]
+        prefix_options, query_options = split_options(params)
+
+        result = cached_resource.cache.write(key, object_to_json(object, prefix_options, query_options), :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
@@ -150,21 +158,34 @@ module CachedResource
       end
 
       def json_to_object(json)
-        if json.is_a? Array
-          json.map { |attrs|
-            self.new(attrs["object"], attrs["persistence"]) }
+        resource = json['resource']
+        if resource.is_a? Array
+          resource.map do |attrs|
+            self.new(attrs["object"], attrs["persistence"]).tap do |resource|
+              resource.prefix_options = json['prefix_options']
+            end
+          end
         else
-          self.new(json["object"], json["persistence"])
+          self.new(resource["object"], resource["persistence"]).tap do |resource|
+            resource.prefix_options = json['prefix_options']
+          end
         end
       end
 
-      def object_to_json(object)
+      def object_to_json(object, prefix_options, query_options)
         if object.is_a? Enumerable
-           object.map { |o| { :object => o, :persistence => o.persisted? } }.to_json
+          {
+            :resource => object.map { |o| { :object => o, :persistence => o.persisted? } },
+            :prefix_options => prefix_options,
+            :original_params => query_options
+          }.to_json
         elsif object.nil?
           nil.to_json
         else
-          { :object => object, :persistence => object.persisted? }.to_json
+          {
+            :resource => { :object => object, :persistence => object.persisted? },
+            :prefix_options => prefix_options
+          }.to_json
         end
       end
     end

data/lib/cached_resource/version.rb

@@ -1,3 +1,3 @@
 module CachedResource
-  VERSION = "6.0.0"
+  VERSION = "7.1.0"
 end

data/spec/cached_resource/caching_spec.rb

@@ -18,6 +18,8 @@ describe CachedResource do
     end
 
     @thing = {:thing => {:id => 1, :name => "Ada"}}
+    @thing_collection = [{:id => 1, :name => "Ada"}, {:id => 2, :name => "Ada", :major => 'CS'}]
+    @thing_collection2 = [{:id => 2, :name => "Ada", :major => 'CS'}]
     @other_thing = {:thing => {:id => 1, :name => "Ari"}}
     @thing2 = {:thing => {:id => 2, :name => "Joe"}}
     @other_thing2 = {:thing => {:id => 2, :name => "Jeb"}}
@@ -215,13 +217,39 @@ describe CachedResource do
           cached.should be_instance_of(ActiveResource::Collection)
         end
 
-        it "should return an instance of the collection_parser" do
+        it "should return a chainable instance of the collection_parser" do
           Thing.cached_resource.cache.clear
           class CustomCollection < ActiveResource::Collection; end
           Thing.collection_parser = CustomCollection
-          Thing.all
-          cached = read_from_cache("thing/all")
+
+          ActiveResource::HttpMock.respond_to do |mock|
+            mock.get "/things.json?name=ada", {}, @thing_collection.to_json
+            mock.get "/things.json?major=CS&name=ada", {}, @thing_collection2.to_json
+          end
+
+          non_cached = Thing.where(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.resource_class.should == Thing
+          cached.map(&:id).should == @thing_collection.map { |h| h[:id]}
+
+          if ActiveResource::VERSION::MAJOR < 5
+            non_cached = cached.resource_class.where(cached.original_params.merge(major: 'CS'))
+          else
+            non_cached = cached.where(major: 'CS')
+          end
+
+          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.resource_class.should == Thing
+          cached.map(&:id).should == @thing_collection2.map { |h| h[:id]}
         end
       else
         it "should return an Array" do
@@ -505,14 +533,9 @@ describe CachedResource do
       end
     end
 
-    it "should cache a response" do
+    it "should not cache a response" do
       result = Thing.find(1)
-      read_from_cache("thing/1").should == result
-    end
-
-    it "should cache a response for a string primary key" do
-      result = Thing.find("fded")
-      read_from_cache("thing/fded").should == result
+      read_from_cache("thing/1").should be_nil
     end
 
     it "should always remake the request" do
@@ -528,42 +551,6 @@ describe CachedResource do
       Thing.find("fded")
       ActiveResource::HttpMock.requests.length.should == 2
     end
-
-    it "should rewrite the cache for each request" do
-      Thing.find(1)
-      old_result = read_from_cache("thing/1")
-
-      # change the response
-      ActiveResource::HttpMock.reset!
-      ActiveResource::HttpMock.respond_to do |mock|
-        mock.get "/things/1.json", {}, @other_thing_json
-      end
-
-      Thing.find(1)
-      new_result = read_from_cache("thing/1")
-      # 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
-
-    it "should rewrite the cache for each request for a string primary key" do
-      Thing.find("fded")
-      old_result = read_from_cache("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 = read_from_cache("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
 
   describe "when cache_collections is disabled" do

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 require 'active_resource'
 require 'active_support'
+require 'active_support/time'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'cached_resource'
@@ -9,3 +10,4 @@ require 'cached_resource'
 RSpec.configure do |config|
   # nada
 end
+