active_cached_resource 0.1.10 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afcd141833ea0ddb9bd49c2c6d8381647070bb826908af33a0a4bdb9af9b0baa
-  data.tar.gz: cf5579fb46a2076f86c635e048cf8dcfeb0ae18aae932e59eca73d82576c8c0e
+  metadata.gz: ff5568ae59b708a8797b4a76940222c5b6e6203ae6914fcefcccae0b6fd4702e
+  data.tar.gz: 810e8446382d26728299806a427f865de4fbda34de6704ceb3a231163b471c0a
 SHA512:
-  metadata.gz: dd2750852a436d259d3e7574ec0719b23e6ddf7c24813d3d641abc89931e48396940113a19d61ff963d8fe3c414fc3a4de987a9189c4d40762a7e69d42e1c981
-  data.tar.gz: c7776d28e660fd88807412f8b48a500ead60865b713387974ac94441152d9fdbe16ee3616441a37e42eac7c3cb864ce97ad716bf8863191c18f491d081a1eb81
+  metadata.gz: 9c4e5b58ec0e1e9151c51e62e6760dd408098b68a01c634ca0ef62e2f999a6bb5c2d2a4961db0563a3d3a3490f9dcd6934c76a12e940233fd212a78fa6d34df4
+  data.tar.gz: b5d37c1863e51ef8aec7db5afebabe35a25d0aae60453a48ba61212f9348aea1dda4a1c43f0c00a5d80008d30170988bbf826eecc4e7fc74b7a5d978b63be67f

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.2.0] - 2024-04-24
+- Allow virtual attributes to be persisted into cache with introduction of `ActiveCachedResource::Collection.persisted_attribute`.
+- Optimized cache key generation by switching from `SHA-256` to `MD5`, improving hashing performance while maintaining uniqueness.
+
+## [0.1.10] - 2024-03-05
+- Patch Collection#reload to return correct type
+
 ## [0.1.9] - 2024-02-05
 - Fixed bug not allowing reloading collection cache
 - Change debug to info for cache hits

data/lib/active_cached_resource/caching.rb

@@ -40,9 +40,10 @@ module ActiveCachedResource
       #   @option options [Hash] :params
       #     Query and prefix (nested URL) parameters.
       #
-      # @return [Object, Array<Object>, nil]
+      # @return [ActiveCachedResource::Collection, ActiveCachedResource::Resource, nil]
+      #   Returns the requested resource(s) based on the scope:
       #   * Returns a single resource object if `:one`, `:first`, `:last`, or an ID is given.
-      #   * Returns an array of resources if `:all` is given.
+      #   * Returns an ActiveCachedResource::Collection containing the resources if `:all` is given.
       #   * Returns `nil` if no data is found for `:one`, `:first`, `:last`, or `:all` queries.
       #
       # @raise [ResourceNotFound]
@@ -148,7 +149,7 @@ module ActiveCachedResource
       #
       # @return [void]
       def clear_cache
-        cached_resource.logger.info("Clearing cache for #{name} cache with prefix: #{cache_key_prefix}")
+        cached_resource.logger.debug("Clearing cache for #{name} cache with prefix: #{cache_key_prefix}")
         cached_resource.cache.clear(cache_key_prefix)
       end
 
@@ -166,7 +167,7 @@ module ActiveCachedResource
 
         return nil if json_string.nil?
 
-        cached_resource.logger.info("[KEY:#{key}] Cache hit")
+        cached_resource.logger.debug("[KEY:#{key}] Cache hit")
         json_to_object(json_string)
       end
 
@@ -242,11 +243,17 @@ module ActiveCachedResource
 
         case resource
         when Array
-          resource.map do |attrs|
+          elements = resource.map do |attrs|
             new(attrs["object"], attrs["persistence"]).tap do |r|
               r.prefix_options = object["prefix_options"]
             end
           end
+          object["collection_parser"].constantize.new(elements, object["from"]).tap do |parser|
+            parser.resource_class = self
+            parser.query_params = object["query_params"] || {}
+            parser.prefix_options = object["prefix_options"] || {}
+            parser.path_params = object["path_params"] || {}
+          end
         else
           new(resource["object"], resource["persistence"]).tap do |r|
             r.prefix_options = object["prefix_options"]
@@ -258,13 +265,16 @@ module ActiveCachedResource
         options = extract_options(*)
         params = options.fetch(:params, {})
         prefix_options, query_options = split_options(params)
-        json_object = if object.is_a? Enumerable
-          {
+        json_object = case object
+        when ActiveCachedResource::Collection
+          object.virtual_persistable_attributes.merge({
             resource: object.map { |o| {object: o, persistence: o.persisted?} },
-            prefix_options: prefix_options,
+            collection_parser: object.class.name,
+            from: object.from,
             path_params: params,
+            prefix_options: prefix_options,
             query_params: query_options
-          }
+          })
         else
           {
             resource: {object: object, persistence: object.persisted?},

data/lib/active_cached_resource/caching_strategies/base.rb

@@ -120,7 +120,7 @@ module ActiveCachedResource
         if prefix.nil? || k.nil?
           raise ArgumentError, "Key must have a prefix and a key separated by a dash"
         end
-        "#{prefix}#{ActiveCachedResource::Constants::PREFIX_SEPARATOR}#{Digest::SHA256.hexdigest(k)}"
+        "#{prefix}#{ActiveCachedResource::Constants::PREFIX_SEPARATOR}#{Digest::MD5.hexdigest(k)}"
       end
 
       def compress(value)

data/lib/active_cached_resource/collection.rb

@@ -1,10 +1,27 @@
 module ActiveCachedResource
   class Collection < ActiveResource::Collection
-    # Reload the collection by re-fetching the resources from the API.
+    class_attribute :virtual_persisted_attributes, default: []
+
+    # This method dynamically creates accessor methods for the specified attributes
+    # and adds them to a list of virtual persisted attributes to keep track of
+    # attributes that should be persisted to cache.
     #
-    # ==== Returns
+    # @param args [Array<Symbol>] A list of attribute names to be persisted.
+    # @return [void]
+    def self.persisted_attribute(*args)
+      attr_accessor(*args)
+      self.virtual_persisted_attributes += args
+    end
+
+    def virtual_persistable_attributes
+      self.class.virtual_persisted_attributes.each_with_object({}) do |attribute, hash|
+        hash[attribute] = public_send(attribute)
+      end
+    end
+
+    # Reload the collection by re-fetching the resources from the API.
     #
-    # [Array<Object>] The collection of resources retrieved from the API.
+    # @return Returns [Array<Object>] The collection of resources retrieved from the API.
     def reload
       query_params[Constants::RELOAD_PARAM] = true
       super
@@ -20,19 +37,34 @@ module ActiveCachedResource
       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
-        return @elements if @elements
+        if from_cache
+          update_self!(from_cache)
+          return @elements if @elements
+        end
       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)
+        resource_class.send(:cache_write, self, from, path_params, query_params, prefix_options)
       end
 
       @elements
     ensure
       @requested = true
     end
+
+    def update_self!(other_collection)
+      # Ensure that the virtual persisted attributes are also updated
+      self.class.virtual_persisted_attributes.each do |attribute|
+        public_send(:"#{attribute}=", other_collection.public_send(attribute))
+      end
+
+      @elements = other_collection.instance_variable_get(:@elements)
+      @from = other_collection.instance_variable_get(:@from)
+      @query_params = other_collection.query_params
+      @path_params = other_collection.path_params
+      @prefix_options = other_collection.prefix_options
+    end
   end
 end

data/lib/active_cached_resource/version.rb

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

data/lib/activeresource/lib/active_resource/associations/builder/association.rb

@@ -4,7 +4,7 @@ module ActiveResource::Associations::Builder
   class Association # :nodoc:
     # providing a Class-Variable, which will have a different store of subclasses
     class_attribute :valid_options
-    self.valid_options = [:class_name]
+    self.valid_options = [:class_name, :foreign_key]
 
     # would identify subclasses of association
     class_attribute :macro

data/lib/activeresource/lib/active_resource/associations.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require "pry-byebug" # IGNORE: This line is for debugging purposes and should be removed in production code.
 module ActiveResource::Associations
   module Builder
-    autoload :Association, "active_resource/associations/builder/association"
-    autoload :HasMany,     "active_resource/associations/builder/has_many"
-    autoload :HasOne,      "active_resource/associations/builder/has_one"
-    autoload :BelongsTo,   "active_resource/associations/builder/belongs_to"
+    autoload :Association, "activeresource/lib/active_resource/associations/builder/association"
+    autoload :HasMany,     "activeresource/lib/active_resource/associations/builder/has_many"
+    autoload :HasOne,      "activeresource/lib/active_resource/associations/builder/has_one"
+    autoload :BelongsTo,   "activeresource/lib/active_resource/associations/builder/belongs_to"
   end
 
 
@@ -148,9 +149,11 @@ module ActiveResource::Associations
       elsif attributes.include?(method_name)
         attributes[method_name]
       elsif !new_record?
-        instance_variable_set(ivar_name, reflection.klass.find(:all, params: { "#{self.class.element_name}_id": self.id }))
+        # Association would be set on custom primary key if explicitly defined, otherwise use convention _id
+        assoc_key = self.class.custom_primary_key || "#{self.class.element_name}_id"
+        instance_variable_set(ivar_name, reflection.klass.find(:all, params: { assoc_key => self.id }))
       else
-        instance_variable_set(ivar_name, reflection.klass.find(:all))
+        instance_variable_set(ivar_name, reflection.klass.none)
       end
     end
   end

data/lib/activeresource/lib/active_resource/base.rb

@@ -672,6 +672,10 @@ module ActiveResource
         end
       end
 
+      def none
+        collection_parser.none
+      end
+
       # An instance of ActiveResource::Connection that is the base \connection to the remote service.
       # The +refresh+ parameter toggles whether or not the \connection is refreshed at every request
       # or not (defaults to <tt>false</tt>).
@@ -717,6 +721,10 @@ module ActiveResource
 
       attr_writer :primary_key
 
+      def custom_primary_key
+        @primary_key
+      end
+
       def primary_key
         if defined?(@primary_key)
           @primary_key
@@ -1226,6 +1234,10 @@ module ActiveResource
       load(attributes, false, persisted)
     end
 
+    def [](key)
+      public_send(key)
+    end
+
     # Returns a \clone of the resource that hasn't been assigned an +id+ yet and
     # is treated as a \new resource.
     #

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

@@ -6,12 +6,12 @@ require "active_support/inflector"
 module ActiveResource # :nodoc:
   class Collection # :nodoc:
     include Enumerable
-    delegate :==, :[], :&, :*, :+, :-, :<=>, :all?, :any?, :as_json, :at, :assoc, :blank?, :bsearch, :bsearch_index,
-         :collect, :combination, :compact, :count, :cycle, :deconstruct, :deep_dup, :dig, :difference, :drop,
+    delegate :==, :[], :&, :*, :+, :-, :<=>, :<<, :all?, :any?, :as_json, :at, :assoc, :blank?, :bsearch, :bsearch_index,
+         :collect, :combination, :compact, :concat, :count, :cycle, :deconstruct, :deep_dup, :dig, :difference, :drop,
          :drop_while, :each, :each_index, :empty?, :eql?, :excluding, :filter, :fifth, :find_index, :first,
-         :flatten, :forty_two, :fourth, :from, :hash, :include?, :including, :index, :inspect, :intersect?,
+         :flatten, :fourth, :hash, :include?, :including, :index, :inspect, :intersect?,
          :intersection, :join, :last, :length, :map, :max, :min, :minmax, :none?, :one?, :pack, :permutation,
-         :pretty_print_cycle, :present?, :product, :reject, :repeated_combination, :repeated_permutation,
+         :pretty_print_cycle, :present?, :product, :push, :reject, :repeated_combination, :repeated_permutation,
          :rassoc, :reverse, :reverse_each, :rindex, :rotate, :sample, :second, :second_to_last, :select,
          :shelljoin, :shuffle, :size, :slice, :sort, :sum, :take, :take_while, :third, :third_to_last, :to,
          :to_a, :to_ary, :to_fs, :to_formatted_s, :to_h, :to_param, :to_query, :to_s, :to_sentence, :to_xml,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_cached_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.2
 platform: ruby
 authors:
 - Jean Luis Urena
 bindir: exe
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel-serializers-xml
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.7.0
 specification_version: 4
 summary: ActiveResource, but with a caching layer.
 test_files: []