active_cached_resource 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: febe875b913adcca00b5ca5eab9c43b23691912ba4465ce34c3f842ba2c0652c
-  data.tar.gz: 39d644336fd27dc4404c8c2d6f130b74e64686c8d923ee6c3b0257fcd1890576
+  metadata.gz: 45d04dcc0d591d945fbee26f110200f54a889a55516b2340e16f5a53e571d07d
+  data.tar.gz: 9ccf72f8ff91404b52650d199c2ea0569e93b1cc62e830ec2f8551cae8537d23
 SHA512:
-  metadata.gz: 78ac473ce4a0710031fd09b9f88f713e90838b287e8361b22ef1c534f8cb9d13369ea2ab1eb78a96e47ea7cfa04bed8014157891098f92743bf4f54113292596
-  data.tar.gz: dc3d33e8c76855b9e58eab1d258aa335f3d939688e2be0ee853a0614d901f61339204c358d866e8ec379318c0fd604e3eee2d4a3318a7d6a28cf9662bf6b2e9b
+  metadata.gz: 4a3f42bfc71f0f3abba12204f1bb27ce08389ec6a28d79ca527b95b9bc010eee02bb9f3bc238bbd9a481a3d4f3454b1f05baba48b8885474f92d0778db189975
+  data.tar.gz: 8cda34284a02b73a3c4c3f5a29eb00543c82636340371997af90219d556e80c62056e3d4d50bf7f795680dfd02805c637a4f89c4611a056cffac48c1754e0e81

data/CHANGELOG.md

@@ -1,9 +1,20 @@
-## [0.1.5] - 2024-01-30
+## [0.1.7] - 2024-01-23
+- Improved `clear_cache` method for `active_support_cache` strategy to no longer use `delete_matched`.
+- Introduced `.delete_from_cache` method to delete single cached resources.
+
+## [0.1.6] - 2024-01-15
+- Renamed `ActiveResource::Collection#refresh` to `#reload` to match Rails ORM naming convention.
+- Added a `ActiveResource::Collection.none` class method similar to Rails `ActiveRecord::QueryMethods.none`
+- Enhanced `ActiveResource::Collection#where` so that it returns `ActiveResource::Collection.none` if `resource_class` is missing.
+    - This is useful for when `where` clauses are chained on an empty `ActiveResource::Collection`
+
+## [0.1.5] - 2024-01-09
 - 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

data/lib/active_cached_resource/caching.rb

@@ -2,9 +2,6 @@ require_relative "collection"
 
 module ActiveCachedResource
   module Caching
-    GLOBAL_PREFIX = "acr"
-    RELOAD_PARAM = :_acr_reload
-
     extend ActiveSupport::Concern
 
     included do
@@ -128,7 +125,7 @@ module ActiveCachedResource
         # 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
+          options[:params][Constants::RELOAD_PARAM] = should_reload
           args << options
         end
 
@@ -140,13 +137,19 @@ module ActiveCachedResource
         should_reload ? find_via_reload(*args) : find_via_cache(*args)
       end
 
-      # Clears the cache for the specified pattern.
+      # Deletes a resource from the cache.
+      #
+      # @param id [Object] the identifier of the resource to be deleted from the cache.
+      def delete_from_cache(id)
+        cached_resource.cache.delete(cache_key(id))
+      end
+
+      # Clears the entire cache for the specified model that matches current prefix.
       #
-      # @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_cache(pattern = nil)
-        cached_resource.cache.clear("#{cache_key_prefix}/#{pattern}")
+      def clear_cache
+        cached_resource.logger.debug("Clearing cache for #{name} cache with prefix: #{cache_key_prefix}")
+        cached_resource.cache.clear(cache_key_prefix)
       end
 
       private
@@ -216,8 +219,7 @@ module ActiveCachedResource
       end
 
       def name_key
-        # `cache_key_prefix` is separated from key parts with a dash to easily distinguish the prefix
-        "#{cache_key_prefix}-" + name.parameterize.tr("-", "/")
+        "#{cache_key_prefix}#{Constants::PREFIX_SEPARATOR}#{name.parameterize.tr("-", "/")}"
       end
 
       def cache_key_prefix
@@ -228,9 +230,9 @@ module ActiveCachedResource
           if !result.is_a?(String) || result.empty?
             raise ArgumentError, "cache_key_prefix must return a non-empty String"
           end
-          "#{GLOBAL_PREFIX}/#{result}"
+          "#{Constants::GLOBAL_PREFIX}/#{result}"
         else
-          "#{GLOBAL_PREFIX}/#{prefix}"
+          "#{Constants::GLOBAL_PREFIX}/#{prefix}"
         end
       end
 

data/lib/active_cached_resource/caching_strategies/active_support_cache.rb

@@ -15,16 +15,35 @@ module ActiveCachedResource
       end
 
       def write_raw(key, compressed_value, options)
-        @cache_store.write(key, compressed_value, options)
+        successful_write = @cache_store.write(key, compressed_value, options)
+        update_master_key(key, options) if successful_write
+
+        successful_write
+      end
+
+      def delete_raw(key)
+        @cache_store.delete(key)
       end
 
-      def clear_raw(pattern)
-        if @cache_store.respond_to?(:delete_matched)
-          @cache_store.delete_matched("#{pattern}*")
-          true
-        else
-          false
-        end
+      def clear_raw(prefix)
+        existing_keys = @cache_store.read(prefix)
+        return if existing_keys.nil?
+
+        existing_keys.add(prefix)
+        @cache_store.delete_multi(existing_keys)
+      end
+
+      private
+
+      # Updates the `master` key, which contains keys for a given prefix.
+      def update_master_key(key, options)
+        prefix, _ = split_key(key)
+
+        existing_keys = @cache_store.read(prefix) || Set.new
+        existing_keys.add(key)
+
+        # Maintain the list of keys for twice the expiration time
+        @cache_store.write(prefix, existing_keys, expires_in: options[:expires_in])
       end
     end
   end

data/lib/active_cached_resource/caching_strategies/base.rb

@@ -1,4 +1,3 @@
-require "msgpack"
 module ActiveCachedResource
   module CachingStrategies
     class Base
@@ -29,6 +28,14 @@ module ActiveCachedResource
         write_raw(hash_key(key), compress(value), options)
       end
 
+      # Deletes the cached value associated with the given key.
+      #
+      # @param key [Object] the key whose associated cached value is to be deleted.
+      # @return [void]
+      def delete(key)
+        delete_raw(hash_key(key))
+      end
+
       # Clears the cache based on the given pattern.
       #
       # @param pattern [String] the pattern to match cache keys that need to be cleared.
@@ -76,6 +83,22 @@ module ActiveCachedResource
         raise NotImplementedError, "#{self.class} must implement `clear_raw`"
       end
 
+      protected
+
+      # Splits the provided key into a prefix and the remaining part
+      #
+      # @param key [String] the key to be split
+      #
+      # @example Splitting a key
+      #  split_key("prefix-key") #=> "acr/prefix/keyvalue"
+      #
+      # @return [Array<String>] an array containing two elements: the part before the first "-", and the rest of the string
+      def split_key(key)
+        # Prefix of keys are expected to be the first part of key separated by a dash.
+        prefix, k = key.split(ActiveCachedResource::Constants::PREFIX_SEPARATOR, 2)
+        [prefix, k]
+      end
+
       private
 
       # Generates a hashed key for caching purposes.
@@ -88,25 +111,25 @@ module ActiveCachedResource
       # @example Hashing a key
       #  hash_key("prefix-key") #=> "acr/prefix/Digest::SHA256.hexdigest(key)"
       #
+      # @raise [ArgumentError] If the key does not contain a prefix and a key separated by a dash.
+      #
       # @param key [String] the original key to be hashed. It is expected to have a prefix and the key separated by a dash.
       # @return [String] the generated hashed key with the global prefix and the prefix from the original key.
       def hash_key(key)
-        # Prefix of keys are expected to be the first part of key separated by a dash.
-        prefix, k = key.split("-", 2)
+        prefix, k = split_key(key)
         if prefix.nil? || k.nil?
           raise ArgumentError, "Key must have a prefix and a key separated by a dash"
         end
-
-        "#{prefix}/" + Digest::SHA256.hexdigest(k)
+        "#{prefix}#{ActiveCachedResource::Constants::PREFIX_SEPARATOR}#{Digest::SHA256.hexdigest(k)}"
       end
 
       def compress(value)
-        MessagePack.pack(value)
+        value.to_json
       end
 
       def decompress(value)
-        MessagePack.unpack(value)
-      rescue MessagePack::UnpackError
+        JSON.parse(value)
+      rescue JSON::ParserError
         nil
       end
     end

data/lib/active_cached_resource/caching_strategies/sql_cache.rb

@@ -11,6 +11,10 @@ module ActiveCachedResource
 
       protected
 
+      def delete_raw(key)
+        @model.where(key: key).delete_all
+      end
+
       def read_raw(key)
         record = @model.where(key: key).where(@model.arel_table[:expires_at].gt(Time.current)).first
         record&.value

data/lib/active_cached_resource/collection.rb

@@ -7,7 +7,7 @@ module ActiveCachedResource
 
       # 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)
+      should_reload = query_params.delete(Constants::RELOAD_PARAM)
       if !should_reload
         from_cache = resource_class.send(:cache_read, from, path_params, query_params, prefix_options)
         @elements = from_cache

data/lib/active_cached_resource/constants.rb

@@ -0,0 +1,7 @@
+module ActiveCachedResource
+  module Constants
+    GLOBAL_PREFIX = "acr"
+    PREFIX_SEPARATOR = ":"
+    RELOAD_PARAM = :_acr_reload
+  end
+end

data/lib/active_cached_resource/model.rb

@@ -56,7 +56,7 @@ module ActiveCachedResource
     private
 
     def invalidate_cache
-      self.class.clear_cache(id.to_s)
+      self.class.delete_from_cache(id.to_s)
     end
 
     def save_to_cache

data/lib/active_cached_resource/version.rb

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

data/lib/active_cached_resource.rb

@@ -2,6 +2,7 @@
 
 require_relative "activeresource/lib/activeresource"
 
+require_relative "active_cached_resource/constants"
 require_relative "active_cached_resource/model"
 require_relative "active_cached_resource/version"
 

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

@@ -21,6 +21,23 @@ module ActiveResource # :nodoc:
     attr_writer :prefix_options
     attr_reader :from
 
+    # Returns a frozen empty collection.
+    #
+    # @return [ActiveResource::Collection] an empty collection
+    def self.none
+      new([]).tap do |collection|
+        collection.instance_variable_set(:@requested, true)
+      end
+    end
+
+    # Creates a new ActiveResource::Collection instance.
+    #
+    # ==== Arguments
+    #
+    # +elements+ (Array<Object>) - An optional array of resources to be set as the collection elements.
+    #                              Defaults to an empty array.
+    # +from+ (String, Symbol) - The path to the collection resource or the symbol for the collection resource.
+
     # ActiveResource::Collection is a wrapper to handle parsing index responses that
     # do not directly map to Rails conventions.
     #
@@ -98,12 +115,12 @@ module ActiveResource # :nodoc:
       @prefix_options || {}
     end
 
-    # Refreshes the collection by re-fetching the resources from the API.
+    # Reload the collection by re-fetching the resources from the API.
     #
     # ==== Returns
     #
     # [Array<Object>] The collection of resources retrieved from the API.
-    def refresh
+    def reload
       @requested = false
       request_resources!
     end
@@ -182,6 +199,7 @@ module ActiveResource # :nodoc:
     #   # => PostCollection:xxx (filtered collection)
     def where(clauses = {})
       raise ArgumentError, "expected a clauses Hash, got #{clauses.inspect}" unless clauses.is_a? Hash
+      return self.class.none if resource_class.nil?
       new_clauses = query_params.merge(clauses)
       resource_class.where(new_clauses)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_cached_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Jean Luis Urena
 bindir: exe
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel-serializers-xml
@@ -52,25 +52,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 0.6.1
 email:
 - eljean@live.com
 executables: []
@@ -87,6 +81,7 @@ files:
 - 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/constants.rb
 - lib/active_cached_resource/logger.rb
 - lib/active_cached_resource/model.rb
 - lib/active_cached_resource/version.rb
@@ -141,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: ActiveResource, but with a caching layer.
 test_files: []