active_cached_resource 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d447a38745c6e9f39b708d1de8b800d888b321bf5edae54fe053cc27c96940
-  data.tar.gz: ab1b634d96e4cf7557b7e55e0e30fba8f008a9c298d50c622a6e6128cc2b88da
+  metadata.gz: febe875b913adcca00b5ca5eab9c43b23691912ba4465ce34c3f842ba2c0652c
+  data.tar.gz: 39d644336fd27dc4404c8c2d6f130b74e64686c8d923ee6c3b0257fcd1890576
 SHA512:
-  metadata.gz: 6803152c873fb3375ab6a320d90a77054e614b009ffc66f5595a976073cb58c222015cab83ca87009223b8769c9a9579c8d70a35568e860739ba38d936a04ab6
-  data.tar.gz: 6c9419e7d8050fe6dd63a350f494c4668b06531d6871606aebeb1ecd887b389ad444d9bd80d96dd20f883b7434815162c2b98963b03db3fecb3e6e3eb2e68e47
+  metadata.gz: 78ac473ce4a0710031fd09b9f88f713e90838b287e8361b22ef1c534f8cb9d13369ea2ab1eb78a96e47ea7cfa04bed8014157891098f92743bf4f54113292596
+  data.tar.gz: dc3d33e8c76855b9e58eab1d258aa335f3d939688e2be0ee853a0614d901f61339204c358d866e8ec379318c0fd604e3eee2d4a3318a7d6a28cf9662bf6b2e9b

data/CHANGELOG.md

@@ -1,10 +1,29 @@
-## [Unreleased]
+## [0.1.5] - 2024-01-30
+- Added callbacks to cache:
+    - Create/POST, refresh cache after successful POST request
+    - Update/PUT, refresh cache after successful PUT request
+    - Destroy/DELETE, invalidate cache after successful DELETE request
+- Fixed issue with generator for SQLCache strategy tables
+## [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,20 +133,20 @@ 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
 
         should_reload ? find_via_reload(*args) : find_via_cache(*args)
       end
 
-      # Clears all cache matching the cache key prefix of the model.
-      #
-      # This method clears all cached entries that match the cache key prefix.
+      # Clears the cache for the specified pattern.
       #
+      # @param pattern [String, nil] The pattern to match cache keys against.
+      #  If nil, all cache keys with this models prefix will be cleared.
       # @return [void]
-      def clear
-        cached_resource.cache.clear("#{cache_key_prefix}/")
+      def clear_cache(pattern = nil)
+        cached_resource.cache.clear("#{cache_key_prefix}/#{pattern}")
       end
 
       private
@@ -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

@@ -8,6 +8,11 @@ module ActiveCachedResource
     extend ActiveSupport::Concern
 
     included do
+      before_save :invalidate_cache
+
+      after_save :save_to_cache
+      after_destroy :invalidate_cache
+
       class << self
         attr_accessor :cached_resource
 
@@ -15,7 +20,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).
@@ -47,5 +52,15 @@ module ActiveCachedResource
       end
     end
     # :nodoc:
+
+    private
+
+    def invalidate_cache
+      self.class.clear_cache(id.to_s)
+    end
+
+    def save_to_cache
+      self.class.send(:cache_write, self, id)
+    end
   end
 end

data/lib/active_cached_resource/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCachedResource
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_cached_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
-original_platform: ''
 authors:
 - Jean Luis Urena
 bindir: exe
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-01-09 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
@@ -117,7 +117,7 @@ files:
 - lib/activeresource/lib/active_resource/threadsafe_attributes.rb
 - lib/activeresource/lib/active_resource/validations.rb
 - lib/activeresource/lib/activeresource.rb
-- lib/generators/active_cached_resource/install_generator.rb
+- lib/generators/active_cached_resource/active_record_generator.rb
 - lib/generators/active_cached_resource/templates/migration.erb
 homepage: https://github.com/jlurena/active_cached_resource
 licenses: []
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.1
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ActiveResource, but with a caching layer.
 test_files: []