active_remote-cached 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da0c6caa85c4c4bc50f0df7e6b3315783b546628
-  data.tar.gz: 408733b9f1a0708bbd7fb8289df0d55c454efe1c
+SHA256:
+  metadata.gz: c89a29c20fea4fff1a59ab534285774e7758620a73fc4005866011326b67ddbe
+  data.tar.gz: 1fbb57ba895a2aedb8067e399ac747cd6428b2e11c18c043e0fc9fbd8e3a63a1
 SHA512:
-  metadata.gz: 535e2f65f6933679c321832536c61d3048399ea18899403d090f8dfe5f74c885b45e13bac36933e4b7732a05d106e6e277bf391539f2ff40dbb145c4476b0622
-  data.tar.gz: 240613cf4187528adf150f8ff7b6e3ab111b12653b4fdf45ca62e635a66566635a6d9a285a1246758b3c00ebc84677e49b1a510059da52e3e0281c5e151250ca
+  metadata.gz: e07972d8b297ad00be81d09dc05330075db0f744d6d40f0323135f326368846325cc66975f8771260d14ba5cd96156c36e134e9bf500df4bff924d6bdcc9ef82
+  data.tar.gz: 5a1818958e13bac846e04616c1762f1fdbb3d7e5e664d8d7c56e86b36e1fa10d608bf242bd666e43ba1bea5eef6f3a17be01e2c1f715bab205413aabe3a764eb

data/active_remote-cached.gemspec

@@ -6,8 +6,8 @@ require 'active_remote/cached/version'
 Gem::Specification.new do |gem|
   gem.name          = "active_remote-cached"
   gem.version       = ActiveRemote::Cached::VERSION
-  gem.authors       = ["Brandon Dewitt"]
-  gem.email         = ["brandonsdewitt@gmail.com"]
+  gem.authors       = ["Brandon Dewitt", "MXDevExperience"]
+  gem.email         = ["brandonsdewitt@gmail.com", "devexperience@mx.com"]
   gem.description   = %q{ Provides "cached" finders and a DSL to enumerate which finders should have cached versions }
   gem.summary       = %q{ Provides a configuration for caching mechanisms and finders on ActiveRemote models that are cached/cacheable }
   gem.homepage      = ""

data/lib/active_remote/cached/version.rb

@@ -1,5 +1,5 @@
 module ActiveRemote
   module Cached
-    VERSION = "0.1.4"
+    VERSION = "1.0.0"
   end
 end

data/lib/active_remote/cached.rb

@@ -12,6 +12,10 @@ module ActiveRemote
   module Cached
     extend ::ActiveSupport::Concern
 
+    # When upgrading Rails versions, don't reuse the same cache key, because you can't rely upon the serialized objects to be consistent across versions.
+    # To fix, this adds a cache key that caches the ruby engine version and the activesupport version to prevent cache re-use across different versions.
+    RUBY_AND_ACTIVE_SUPPORT_VERSION = "#{RUBY_ENGINE_VERSION}:#{ActiveSupport::VERSION::STRING}".freeze
+
     def self.cache(cache_provider = nil)
       if cache_provider
         @cache_provider = ::ActiveRemote::Cached::Cache.new(cache_provider)
@@ -29,6 +33,11 @@ module ActiveRemote
     end
 
     module ClassMethods
+      def cached_methods
+        @cached_methods ||= []
+        @cached_methods
+      end
+
       def cached_finders_for(*cached_finder_keys)
         options = cached_finder_keys.extract_options!
 
@@ -43,7 +52,7 @@ module ActiveRemote
 
       def cached_find(argument_hash, options = {})
         method_name = _cached_find_method_name(argument_hash.keys)
-        arguments = argument_hash.values
+        arguments = argument_hash.keys.sort.map { |k| argument_hash[k] }
 
         if block_given?
           __send__(method_name, *arguments, options) do
@@ -56,7 +65,7 @@ module ActiveRemote
 
       def cached_search(argument_hash, options = {})
         method_name = _cached_search_method_name(argument_hash.keys)
-        arguments = argument_hash.values
+        arguments = argument_hash.keys.sort.map { |k| argument_hash[k] }
 
         if block_given?
           __send__(method_name, *arguments, options) do
@@ -67,74 +76,131 @@ module ActiveRemote
         end
       end
 
+      def method_missing(m, *args, &block)
+        method_name = _method_missing_name(m)
+
+        if method_name.nil? || !cached_methods.include?(method_name.to_s)
+          super(m, *args, &block)
+        else
+          new_args = _args_in_sorted_order(m, args)
+          __send__(method_name, *new_args, &block)
+        end
+      end
+
+      def respond_to_missing?(m, include_private = false)
+        method_name = _method_missing_name(m)
+
+        if !method_name.nil? && cached_methods.include?(method_name.to_s)
+          true
+        else
+          super
+        end
+      end
+
       ##
       # Underscored Methods
       #
-      def _create_cached_finder_for(cached_finder_key, options = {})
-        cached_finder_key_set = [ cached_finder_key ].flatten.sort
+      def _method_missing_name(m)
+        regex = /(cached_(?:delete|exist_search|search|exist_find|find)_by_)([a-zA-Z_]*)(!|\?)?/
 
-        ##
-        # Run each permutation of the arguments passed in
-        # and define each finder/searcher
-        #
-        cached_finder_key_set.permutation do |arguments|
-          delete_method_name = _cached_delete_method_name(arguments)
-          exist_find_method_name = _cached_exist_find_method_name(arguments)
-          exist_search_method_name = _cached_exist_search_method_name(arguments)
-          find_method_name = _cached_find_method_name(arguments)
-          search_method_name = _cached_search_method_name(arguments)
-          search_bang_method_name = "#{search_method_name}!"
-
-          unless self.respond_to?(delete_method_name)
-            _define_cached_delete_method(delete_method_name, arguments, options)
-          end
+        if m.to_s =~ regex
+          params = $2.split("_and_")
+          "#{$1}#{params.sort.join("_and_")}#{$3}".to_sym
+        else
+          nil
+        end
+      end
 
-          unless self.respond_to?(exist_find_method_name)
-            _define_cached_exist_find_method(exist_find_method_name, arguments, options)
-          end
+      def _args_in_sorted_order(m, args)
+        regex = /cached_(?:delete|exist_search|search|exist_find|find)_by_([a-zA-Z_]*)(!|\?)?/
 
-          unless self.respond_to?(exist_search_method_name)
-            _define_cached_exist_search_method(exist_search_method_name, arguments, options)
-          end
+        method_name = _method_missing_name(m)
 
-          unless self.respond_to?(find_method_name)
-            _define_cached_find_method(find_method_name, arguments, options)
-          end
+        match_1 = m.match(regex)
+        match_2 = method_name.match(regex)
+
+        args_in_order = []
+
+        if match_1[1] && match_2[1]
+          orignal_args_name = match_1[1].split("_and_")
+          args_names_in_order = match_2[1].split("_and_")
 
-          unless self.respond_to?(search_bang_method_name)
-            _define_cached_search_bang_method(search_bang_method_name, arguments, options)
+          args_names_in_order.each do |arg_name|
+            index = orignal_args_name.index(arg_name)
+            args_in_order << args[index]
           end
 
-          unless self.respond_to?(search_method_name)
-            _define_cached_search_method(search_method_name, arguments, options)
+          if args.size > args_in_order.size
+            # Add options if passed
+            args_in_order << args.last
           end
+
+          args_in_order
+        else
+          args
+        end
+      end
+
+      def _create_cached_finder_for(cached_finder_key, options = {})
+        cached_finder_key_set = [ cached_finder_key ].flatten.sort
+
+        delete_method_name = _cached_delete_method_name(cached_finder_key_set)
+        exist_find_method_name = _cached_exist_find_method_name(cached_finder_key_set)
+        exist_search_method_name = _cached_exist_search_method_name(cached_finder_key_set)
+        find_method_name = _cached_find_method_name(cached_finder_key_set)
+        search_method_name = _cached_search_method_name(cached_finder_key_set)
+        search_bang_method_name = "#{search_method_name}!"
+
+        unless cached_methods.include?(delete_method_name)
+          _define_cached_delete_method(delete_method_name, cached_finder_key_set, options)
+        end
+        
+        unless cached_methods.include?(exist_find_method_name)
+          _define_cached_exist_find_method(exist_find_method_name, cached_finder_key_set, options)
+        end
+
+        unless cached_methods.include?(exist_search_method_name)
+          _define_cached_exist_search_method(exist_search_method_name, cached_finder_key_set, options)
+        end
+
+        unless cached_methods.include?(find_method_name)
+          _define_cached_find_method(find_method_name, cached_finder_key_set, options)
+        end
+
+        unless cached_methods.include?(search_bang_method_name)
+          _define_cached_search_bang_method(search_bang_method_name, cached_finder_key_set, options)
+        end
+
+        unless cached_methods.include?(search_method_name)
+          _define_cached_search_method(search_method_name, cached_finder_key_set, options)
         end
       end
 
       def _cached_delete_method_name(arguments)
-        "cached_delete_by_#{arguments.join('_and_')}"
+        "cached_delete_by_#{arguments.sort.join('_and_')}"
       end
 
       def _cached_exist_find_method_name(arguments)
-        "cached_exist_find_by_#{arguments.join('_and_')}"
+        "cached_exist_find_by_#{arguments.sort.join('_and_')}"
       end
 
       def _cached_exist_search_method_name(arguments)
-        "cached_exist_search_by_#{arguments.join('_and_')}"
+        "cached_exist_search_by_#{arguments.sort.join('_and_')}"
       end
 
       def _cached_find_method_name(arguments)
-        "cached_find_by_#{arguments.join('_and_')}"
+        "cached_find_by_#{arguments.sort.join('_and_')}"
       end
 
       def _cached_search_method_name(arguments)
-        "cached_search_by_#{arguments.join('_and_')}"
+        "cached_search_by_#{arguments.sort.join('_and_')}"
       end
 
       def _define_cached_delete_method(method_name, *method_arguments, cached_finder_options)
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
+        cached_methods << method_name
 
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           # def self.cached_delete_by_user_guid(user_guid, options = {})
@@ -144,6 +210,7 @@ module ActiveRemote
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
             find_cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#find",
@@ -151,6 +218,7 @@ module ActiveRemote
             ].compact
 
             search_cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#search",
@@ -167,6 +235,8 @@ module ActiveRemote
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
+        cached_methods << method_name
+        cached_methods << "#{method_name}?"
 
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           # def self.cached_exist_find_by_user_guid(user_guid, options = {})
@@ -176,6 +246,7 @@ module ActiveRemote
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
             cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#find",
@@ -193,6 +264,8 @@ module ActiveRemote
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
+        cached_methods << method_name
+        cached_methods << "#{method_name}?"
 
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           # def self.cached_exist_search_by_user_guid(user_guid, options = {})
@@ -202,6 +275,7 @@ module ActiveRemote
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
             cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#search",
@@ -219,6 +293,7 @@ module ActiveRemote
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
+        cached_methods << method_name
 
         expanded_search_args = ""
         method_arguments.each do |method_argument|
@@ -241,6 +316,7 @@ module ActiveRemote
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
             cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#find",
@@ -262,6 +338,7 @@ module ActiveRemote
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
+        cached_methods << method_name
 
         expanded_search_args = ""
         method_arguments.each do |method_argument|
@@ -288,6 +365,7 @@ module ActiveRemote
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
             cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#search",
@@ -309,6 +387,7 @@ module ActiveRemote
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
+        cached_methods << method_name
 
         expanded_search_args = ""
         method_arguments.each do |method_argument|
@@ -340,6 +419,7 @@ module ActiveRemote
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
             cache_key = [
+              RUBY_AND_ACTIVE_SUPPORT_VERSION,
               namespace,
               name,
               "#search",

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_remote-cached
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Brandon Dewitt
-autorequire: 
+- MXDevExperience
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_remote
@@ -98,6 +99,7 @@ description: ' Provides "cached" finders and a DSL to enumerate which finders sh
   have cached versions '
 email:
 - brandonsdewitt@gmail.com
+- devexperience@mx.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -124,7 +126,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Provides a configuration for caching mechanisms and finders on ActiveRemote
   models that are cached/cacheable