active_cached_resource 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7398b81424e7d34365729859220d5d05265452e4c7d8024f123b5a18f0490f0
-  data.tar.gz: 0c8b48b2cecec7992a5170b3467839cf7c4e9d13f141d552a9206f9eccc5527d
+  metadata.gz: 654dbb9442c84be7f315fcf02c1b18c87bcf350c2bdc3bc2b5f7eafe3bb1d8c6
+  data.tar.gz: 52544f3e743ef86f0b254412407f60e1015346697d2e6dd7333ce804a3ea1266
 SHA512:
-  metadata.gz: ea69cc9271151a45decccb33a3e52275d05bd0dc0d4244472305e6b050479fb51431f42c13705f19a380bf0cfe1dba1e1242ff6480b4b23992fb850c25df32dd
-  data.tar.gz: '0807a7648e90ffd1e4a0c5650d52c15f67438a9a84366cf9a2563cd775ecd92a68f9fe0d816a8dac80f09f277623928b717a9f25f33fe1c484cb8617da367bc6'
+  metadata.gz: 968ddb5feb0ab1bc0df9146407d2504c26cf5fbe303c6eb261ea6073c5d1ead3a217f690f8e1a47d5dc7415cb3be97b864fb83134d4b7e13c02e2aa76a58a3cc
+  data.tar.gz: 99e7af8f3a51f67a3bb11608a8d11bde63369e804c946104148a84654199f1b6d4c82ce2fba461049a6ae87bedc9b90f14a0453bf2128fa0f8f9d388b46b11c1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [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`

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.to_a) # Redis implementation does not work with Sets
+      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.6"
+  VERSION = "0.1.8"
 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"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_cached_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Jean Luis Urena
 bindir: exe
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel-serializers-xml
@@ -51,26 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: msgpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
-  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
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -101,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
@@ -155,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: []