cached_resource 7.2.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c2150c2dc21cf091c9b26674b3e52a7bd43938318704f7c2f0739a0b9756aa
-  data.tar.gz: 2f7b9665c688f2a60b7def43cfafbe2701accded9fcf9aabc371fe91bf78362d
+  metadata.gz: 42ea4ceb6fd67accfe68fba67eecbde7c9c2f6289fdc382c095e88faf431b37a
+  data.tar.gz: 3ed45f62bf3d3be125b348ca0181fbd87f0becf70c5fb3d617095476cb0d6b6c
 SHA512:
-  metadata.gz: c0c94c6b77f623a49a3259a69a4bb1b1d2d7fc219d590b740d5a86c71f3cfbf7eb783a2e8a2c06631c926bd2679b220341d8fbf03b77a3651d5219a70bb8d779
-  data.tar.gz: 207c37429a14511fb788d21bc69e86b01f8f59a303b20aebafb2f07e54aba48546c03a5ac7fa4b99da0bd9b7cd53d385ddb73306c643d9044d113ea638949e61
+  metadata.gz: 677095f51ebb4555c9c42cf66989146e3d972cf7522cae23f9618ab55843730bfa15b32ba607e84bdf8451b270142edbf4e600477a68712bba4a98b5ac2cec56
+  data.tar.gz: 6401482cbcc33c775b12b64a0c66d029073a904eb485be863bb8236cb60b9635683f478d97f9b5a30cb1aadc2808182f3f1eaf6f5f6e9df6a48f85194cdea19d

data/lib/cached_resource/cached_resource.rb

@@ -10,7 +10,7 @@ module CachedResource
         attr_accessor :cached_resource
 
         # Initialize cached resource or retrieve the current cached resource configuration.
-        def cached_resource(options={})
+        def cached_resource(options = {})
           defined?(@cached_resource) && @cached_resource || setup_cached_resource!(options)
         end
 
@@ -30,7 +30,7 @@ module CachedResource
       # that wants an independent configuration will need to execute:
       # self.cached_resource = CachedResource::Configuration.new(options={})
       def inherited(child)
-        child.cached_resource = self.cached_resource if defined?(@cached_resource)
+        child.cached_resource = cached_resource if defined?(@cached_resource)
         super
       end
     end

data/lib/cached_resource/caching.rb

@@ -25,8 +25,10 @@ module CachedResource
       end
 
       # Clear the cache.
-      def clear_cache(options=nil)
+      def clear_cache(options = nil)
         cache_clear(options)
+
+        true
       end
 
       private
@@ -45,7 +47,7 @@ module CachedResource
         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, *arguments)
-        cache_read(key)
+        object
       end
 
       # If this is a pure, unadulterated "all" request
@@ -73,7 +75,9 @@ module CachedResource
         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 }
+          index = collection.each_with_object({}) { |object, hash|
+            hash[object.send(primary_key)] = object
+          }
           updates.each { |object| index[object.send(primary_key)] = object }
           cache_write(cache_key(cached_resource.collection_arguments), index.values, *arguments)
         end
@@ -82,7 +86,7 @@ module CachedResource
       # Avoid cache nil or [] objects
       def should_cache?(object)
         return false unless cached_resource.enabled
-        object.respond_to?(:empty?) ? !object.empty? : !!object
+        object.present?
       end
 
       # Determine if the given arguments represent
@@ -94,13 +98,12 @@ module CachedResource
       # 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)
+        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|
-
           json = ActiveSupport::JSON.decode(json_cache)
 
           unless json.nil?
@@ -110,7 +113,7 @@ module CachedResource
               next restored unless respond_to?(:collection_parser)
               collection_parser.new(restored).tap do |parser|
                 parser.resource_class = self
-                parser.original_params = json['original_params']
+                parser.original_params = json["original_params"].deep_symbolize_keys
               end
             else
               full_dup(cache)
@@ -127,32 +130,51 @@ module CachedResource
         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.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
 
-      # Clear the cache.
-      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)
+      def cache_clear(options = nil)
+        if !cached_resource.cache.respond_to?(:delete_matched) || 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}/*")
+          cached_resource.cache.delete_matched(cache_key_delete_pattern).tap do |result|
+            cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} CLEAR #{cache_key_delete_pattern}")
           end
         end
       end
 
+      def cache_key_delete_pattern
+        case cached_resource.cache
+        when ActiveSupport::Cache::MemoryStore, ActiveSupport::Cache::FileStore
+          /^#{name_key}\//
+        else
+          "#{name_key}/*"
+        end
+      end
+
       # Generate the request cache key.
       def cache_key(*arguments)
-        "#{name_key}/#{arguments.join('/')}".downcase.delete(' ')
+        "#{name_key}/#{arguments.join("/")}".downcase.delete(" ")
       end
 
       def name_key
-        name.parameterize.gsub("-", "/")
+        cache_key_prefix + name.parameterize.tr("-", "/")
+      end
+
+      def cache_key_prefix
+        prefix = cached_resource.cache_key_prefix
+        return "" if prefix.nil?
+
+        if prefix.respond_to?(:call)
+          result = prefix.call
+          result.nil? ? "" : "#{result}/"
+        else
+          "#{prefix}/"
+        end
       end
 
       # Make a full duplicate of an ActiveResource record.
@@ -164,16 +186,16 @@ module CachedResource
       end
 
       def json_to_object(json)
-        resource = json['resource']
+        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']
+            new(attrs["object"], attrs["persistence"]).tap do |resource|
+              resource.prefix_options = json["prefix_options"]
             end
           end
         else
-          self.new(resource["object"], resource["persistence"]).tap do |resource|
-            resource.prefix_options = json['prefix_options']
+          new(resource["object"], resource["persistence"]).tap do |resource|
+            resource.prefix_options = json["prefix_options"]
           end
         end
       end
@@ -181,16 +203,14 @@ module CachedResource
       def object_to_json(object, prefix_options, query_options)
         if object.is_a? Enumerable
           {
-            :resource => object.map { |o| { :object => o, :persistence => o.persisted? } },
-            :prefix_options => prefix_options,
-            :original_params => query_options
+            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
           {
-            :resource => { :object => object, :persistence => object.persisted? },
-            :prefix_options => prefix_options
+            resource: {object: object, persistence: object.persisted?},
+            prefix_options: prefix_options
           }.to_json
         end
       end

data/lib/cached_resource/configuration.rb

@@ -2,7 +2,6 @@ module CachedResource
   # The Configuration class manages class specific options
   # for cached resource.
   class Configuration < OpenStruct
-
     # default or fallback cache without rails
     CACHE = ActiveSupport::Cache::MemoryStore.new
 
@@ -24,18 +23,19 @@ module CachedResource
     # :cache, default: Rails.cache or ActiveSupport::Cache::MemoryStore.new,
     # :logger, default: Rails.logger or ActiveSupport::Logger.new(NilIO.new),
     # :cache_collections, default: true
-    def initialize(options={})
+    def initialize(options = {})
       super({
-        :enabled => true,
-        :race_condition_ttl => 86400,
-        :ttl => 604800,
-        :ttl_randomization => false,
-        :ttl_randomization_scale => 1..2,
-        :collection_synchronize => false,
-        :collection_arguments => [:all],
-        :cache => defined?(Rails.cache)  && Rails.cache || CACHE,
-        :logger => defined?(Rails.logger) && Rails.logger || LOGGER,
-        :cache_collections => true
+        cache: defined?(Rails.cache) && Rails.cache || CACHE,
+        cache_collections: true,
+        cache_key_prefix: nil,
+        collection_arguments: [:all],
+        collection_synchronize: false,
+        enabled: true,
+        logger: defined?(Rails.logger) && Rails.logger || LOGGER,
+        race_condition_ttl: 86400,
+        ttl: 604800,
+        ttl_randomization: false,
+        ttl_randomization_scale: 1..2
       }.merge(options))
     end
 
@@ -47,6 +47,8 @@ module CachedResource
     end
 
     # Enables caching.
+    # NOTE: Disabled coverage because it is not being picked up by simplecov
+    # :nocov:
     def on!
       self.enabled = true
     end
@@ -55,6 +57,7 @@ module CachedResource
     def off!
       self.enabled = false
     end
+    # :nocov:
 
     private
 
@@ -66,10 +69,9 @@ module CachedResource
 
     # Choose a random value from within the given range, optionally
     # seeded by seed.
-    def sample_range(range, seed=nil)
+    def sample_range(range, seed = nil)
       srand seed if seed
       rand * (range.end - range.begin) + range.begin
     end
-
   end
-end
+end

data/lib/cached_resource/version.rb

@@ -1,3 +1,3 @@
 module CachedResource
-  VERSION = "7.2.0"
+  VERSION = "9.0.0"
 end

data/lib/cached_resource.rb

@@ -1,14 +1,14 @@
-require 'ostruct'
+require "ostruct"
 
-require 'nilio'
-require 'active_support/cache'
-require 'active_support/concern'
-require 'active_support/logger'
-require 'cached_resource/cached_resource'
-require 'cached_resource/configuration'
-require 'cached_resource/caching'
-require 'cached_resource/version'
-require 'active_resource'
+require "nilio"
+require "active_support/cache"
+require "active_support/concern"
+require "active_support/logger"
+require "cached_resource/cached_resource"
+require "cached_resource/configuration"
+require "cached_resource/caching"
+require "cached_resource/version"
+require "active_resource"
 
 module CachedResource
   # nada

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_resource
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Morgan Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,36 +108,65 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.39.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.39.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.10
 description: Enables request-based caching for ActiveResource
 email: cached_resource@email.mhgbrown.is
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
-- FUNDING.json
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- cached_resource.gemspec
-- gemfiles/4.2.gemfile
-- gemfiles/5.0.gemfile
-- gemfiles/5.1.gemfile
-- gemfiles/6.0.gemfile
-- gemfiles/6.1.gemfile
-- gemfiles/7.0.gemfile
 - lib/cached_resource.rb
 - lib/cached_resource/cached_resource.rb
 - lib/cached_resource/caching.rb
 - lib/cached_resource/configuration.rb
 - lib/cached_resource/version.rb
-- spec/cached_resource/cached_resource_spec.rb
-- spec/cached_resource/caching_spec.rb
-- spec/cached_resource/configuration_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/mhgbrown/cached_resource
 licenses:
 - MIT
@@ -122,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -133,8 +190,4 @@ rubygems_version: 3.1.6
 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: []

data/.github/workflows/ruby.yml

@@ -1,109 +0,0 @@
-# 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

@@ -1,7 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-*DS_Store
-.ruby-version
-.tool-versions

data/.rspec

@@ -1,3 +0,0 @@
---color
---backtrace
---format d

data/FUNDING.json

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

data/Gemfile

@@ -1,29 +0,0 @@
-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/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2018 Morgan Brown
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.