active_cached_resource 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea5e9eb3e2aafbeefeb5453054237509459e44b440935b6565c382131abc4852
-  data.tar.gz: c4d901d53c3802d7c3aed95019b9274f2bf75de1c6a604431db17354a7d99514
+  metadata.gz: fcd11f4ab22e963e432b2130606aa5f56102a284b86752847ea1f2b3c2ca8407
+  data.tar.gz: 87a5cfc1d2a99e4de13748937ec4649c9814c850008f4ebc6246c2f9ad35c746
 SHA512:
-  metadata.gz: 405fe2f90ddb601bfbc717e0bf571e3da7b42598feee52895edbd6a9baf4ba75fe70b7a3d5cf4d95bcd00e3892735f42423d49d3b84dd32b4819336c6efed47e
-  data.tar.gz: 2536aaf04b87746d3cf344d8578e6bb6e83e19d1640a7366a29996b9ed52ca88e59dce54b6b2e90be60fc56d1b7361dc72b9dc6073585ed347372cba2e55d2bf
+  metadata.gz: 2cba101b3f9755198b284ba74a1a2644ac4f4eeca7848460db78ff9db0a41163d45f1eb1d300f14460cdde6081db0007938dc47f1524f01e4c5b5b35c27ffe94
+  data.tar.gz: d15d419528bc2793104bb951bdc12665ded24a17d075e6afc19fd70ad9ade8d0ac42f60517a14316bb912df03e384e1e2b544097fb4ab9e9ce68414183f4dde8

data/CHANGELOG.md

@@ -1,10 +1,23 @@
-## [Unreleased]
+## [0.1.4] - 2024-12-20
+- CI Improvements
+    - Added annotations
+    - Runs tests from ActiveResource
+- Separated Collection caching logic into ActiveCachedResource::Collection as opposed to monkey patching ActiveResource::Collection
+- Changed name of SQL adapter from `active_record` to `active_record_sql`
+- Changed method name of ActiveCachedResource::Model from `clear` to `clear_cache`
+
+## [0.1.3] - 2024-12-19
+- Minor patch on ActiveResource. Removed deprecator log.
+
+## [0.1.2] - 2024-12-19
+- Minor patch on ActiveResource::Collection initializing attributes.
 
 ## [0.1.1] - 2024-12-17
 
 - Added ruby yard documentation
 - Added LICENSE
 - Improved gemspec
+- Changed name of ActiveSupport::Cache adapter from `active_support` to `active_support_cache`
 
 
 ## [0.1.0] - 2024-12-16

data/lib/active_cached_resource/caching.rb

@@ -1,3 +1,5 @@
+require_relative "collection"
+
 module ActiveCachedResource
   module Caching
     GLOBAL_PREFIX = "acr"
@@ -9,6 +11,10 @@ module ActiveCachedResource
       class << self
         alias_method :find_without_cache, :find
         alias_method :find, :find_with_cache
+
+        def collection_parser
+          _collection_parser || ActiveCachedResource::Collection
+        end
       end
     end
 
@@ -119,7 +125,7 @@ module ActiveCachedResource
         should_reload = options.delete(:reload) || !cached_resource.enabled
 
         # When bypassing cache, include the reload option as a query parameter for collection requests.
-        # Hacky but this way ActiveResource::Collection#request_resources! can access it
+        # Hacky but this way ActiveCachedResource::Collection#request_resources! can access it
         if should_reload && args.first == :all
           options[:params] = {} if options[:params].blank?
           options[:params][RELOAD_PARAM] = should_reload
@@ -127,7 +133,7 @@ module ActiveCachedResource
         end
 
         if args.first == :all
-          # Let ActiveResource::Collection handle the caching so that lazy loading is more effective
+          # Let ActiveCachedResource::Collection handle the caching so that lazy loading is more effective
           return find_via_reload(*args)
         end
 
@@ -139,7 +145,7 @@ module ActiveCachedResource
       # This method clears all cached entries that match the cache key prefix.
       #
       # @return [void]
-      def clear
+      def clear_cache
         cached_resource.cache.clear("#{cache_key_prefix}/")
       end
 
@@ -189,16 +195,16 @@ module ActiveCachedResource
 
       # Determines if the given object should be cached.
       #
-      # @param object [Object, ActiveResource::Collection] The object to check for caching eligibility.
+      # @param object [Object, ActiveCachedResource::Collection] The object to check for caching eligibility.
       # @return [Boolean] Returns true if the object should be cached, false otherwise.
       def should_cache?(object)
         return false unless cached_resource.enabled
 
         # Calling `present?` on the `collection_parser`, an instance or descendent of
-        # `ActiveResource::Collection` will trigger a request.
+        # `ActiveCachedResource::Collection` will trigger a request.
         # Checking if `requested?` first, will prevent an unnecessary network request when calling `present?`.
         case object
-        when ActiveResource::Collection
+        when ActiveCachedResource::Collection
           object.requested? && object.present?
         else
           object.present?

data/lib/active_cached_resource/collection.rb

@@ -0,0 +1,28 @@
+module ActiveCachedResource
+  class Collection < ActiveResource::Collection
+    private
+
+    def request_resources!
+      return @elements if requested? || resource_class.nil?
+
+      # Delete the reload param from query params.
+      # This is drilled down via `params` option to determine if the collection should be reloaded
+      should_reload = query_params.delete(ActiveCachedResource::Caching::RELOAD_PARAM)
+      if !should_reload
+        from_cache = resource_class.send(:cache_read, from, path_params, query_params, prefix_options)
+        @elements = from_cache
+        return @elements if @elements
+      end
+
+      super # This sets @elements
+
+      if resource_class.send(:should_cache?, @elements)
+        resource_class.send(:cache_write, @elements, from, path_params, query_params, prefix_options)
+      end
+
+      @elements
+    ensure
+      @requested = true
+    end
+  end
+end

data/lib/active_cached_resource/configuration.rb

@@ -7,7 +7,7 @@ require_relative "caching_strategies/base"
 module ActiveCachedResource
   class Configuration < OpenStruct
     CACHING_STRATEGIES = {
-      active_record: ActiveCachedResource::CachingStrategies::SQLCache,
+      active_record_sql: ActiveCachedResource::CachingStrategies::SQLCache,
       active_support_cache: ActiveCachedResource::CachingStrategies::ActiveSupportCache
     }
 
@@ -18,7 +18,7 @@ module ActiveCachedResource
     # @param model [Class] The model class for which the configuration is being set.
     # @param options [Hash] A hash of options to customize the configuration.
     # @option options [Symbol] :cache_store The cache store to be used.
-    # @option options [Symbol] :cache_strategy The cache strategy to be used. One of :active_record or :active_support_cache.
+    # @option options [Symbol] :cache_strategy The cache strategy to be used. One of :active_record_sql or :active_support_cache.
     # @option options [String] :cache_key_prefix The prefix for cache keys (default: model name underscored).
     # @option options [Logger] :logger The logger instance to be used (default: ActiveCachedResource::Logger).
     # @option options [Boolean] :enabled Whether caching is enabled (default: true).

data/lib/active_cached_resource/model.rb

@@ -15,7 +15,7 @@ module ActiveCachedResource
         #
         # @param options [Hash] A hash of options to customize the configuration.
         # @option options [Symbol] :cache_store The cache store to be used. Must be a CachingStrategies::Base instance.
-        # @option options [Symbol] :cache_strategy The cache strategy to be used. One of :active_record or :active_support_cache.
+        # @option options [Symbol] :cache_strategy The cache strategy to be used. One of :active_record_sql or :active_support_cache.
         # @option options [String] :cache_key_prefix The prefix for cache keys (default: model name underscored).
         # @option options [Logger] :logger The logger instance to be used (default: ActiveCachedResource::Logger).
         # @option options [Boolean] :enabled Whether caching is enabled (default: true).

data/lib/active_cached_resource/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCachedResource
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/active_cached_resource.rb

@@ -12,53 +12,4 @@ module ActiveResource
   class Base
     include ActiveCachedResource::Model
   end
-
-  class Collection
-    private
-
-    # Monkey patch ActiveResource::Collection to handle caching
-    # @see lib/activeresource/lib/active_resource/collection.rb
-    def request_resources!
-      return @elements if requested?
-
-      # MONKEY PATCH
-      # Delete the reload param from query params.
-      # This is drilled down via `params` option to determine if the collection should be reloaded
-      should_reload = query_params.delete(ActiveCachedResource::Caching::RELOAD_PARAM)
-      if !should_reload
-        from_cache = resource_class.send(:cache_read, from, path_params, query_params, prefix_options)
-        @elements = from_cache
-        return @elements if @elements
-      end
-      # MONKEY PATCH
-
-      response =
-        case from
-        when Symbol
-          resource_class.get(from, path_params)
-        when String
-          path = "#{from}#{query_string(query_params)}"
-          resource_class.format.decode(resource_class.connection.get(path, resource_class.headers).body)
-        else
-          path = resource_class.collection_path(prefix_options, query_params)
-          resource_class.format.decode(resource_class.connection.get(path, resource_class.headers).body)
-        end
-
-      # Update the elements
-      parse_response(response)
-      @elements.map! { |e| resource_class.instantiate_record(e, prefix_options) }
-
-      # MONKEY PATCH
-      # Write cache
-      resource_class.send(:cache_write, @elements, from, path_params, query_params, prefix_options)
-      @elements
-      # MONKEY PATCH
-    rescue ActiveResource::ResourceNotFound
-      # Swallowing ResourceNotFound exceptions and return nothing - as per ActiveRecord.
-      # Needs to be empty array as Array methods are delegated
-      []
-    ensure
-      @requested = true
-    end
-  end
 end

data/lib/activeresource/lib/active_resource/collection.rb

@@ -202,7 +202,7 @@ module ActiveResource # :nodoc:
       #
       # [Array<Object>] The collection of resources retrieved from the API.
       def request_resources!
-        return @elements if requested?
+        return @elements if requested? || resource_class.nil?
         response =
           case from
           when Symbol

data/lib/activeresource/lib/active_resource/railtie.rb

@@ -21,11 +21,5 @@ module ActiveResource
         app.config.active_job.custom_serializers << ActiveResource::ActiveJobSerializer
       end
     end
-
-    initializer "active_resource.deprecator" do |app|
-      if app.respond_to?(:deprecators)
-        app.deprecators[:active_resource] = ActiveResource.deprecator
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_cached_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
-original_platform: ''
 authors:
 - Jean Luis Urena
 bindir: exe
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2024-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel-serializers-xml
@@ -86,6 +85,7 @@ files:
 - lib/active_cached_resource/caching_strategies/active_support_cache.rb
 - lib/active_cached_resource/caching_strategies/base.rb
 - lib/active_cached_resource/caching_strategies/sql_cache.rb
+- lib/active_cached_resource/collection.rb
 - lib/active_cached_resource/configuration.rb
 - lib/active_cached_resource/logger.rb
 - lib/active_cached_resource/model.rb