active_remote-cached 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9872e1d79f0ce74478d865b9610ac1f7fbfdca51
-  data.tar.gz: 2d0f206d646b9184b916c49a49ff74aabb1eb42a
+  metadata.gz: 037ff5730170b6fd9bcde427a2551d17eada4242
+  data.tar.gz: d7800b6e88135fac587afc65b3f24cd895c6f510
 SHA512:
-  metadata.gz: b6b752495900bf6fe139b68321f7b9d725bc54843df72721ef44c719f8d197a774e38a5a2e3d36ff2b0ed3b4ace2d570704228629ceb9d2e1d89420d9593096a
-  data.tar.gz: 3ff9109ed522147871f4a93265b6993e333ba42772d703ad81456aff079423d74dbe1f398c3ae6c5222a0456bb9abc0271cf99268d43bdbcbcb95fa1e3844a4c
+  metadata.gz: c23a65bb8c5f8c3fb4d52402be4bc2ad233a402a041574fa29a3fce657fb9b53a0b48b76dbc4fb21244c2794843ac5a11aae13851b0f2f5106733aa3a3b9cad9
+  data.tar.gz: 04864770794f7c776af951eab432a4063713b2a2490131a38b13a16d82dece26d4d9547723867045740ff5223233701f42eb855be85d32b51c8b55270b98ba99

data/README.md

@@ -1,6 +1,6 @@
 # ActiveRemote::Cached
 
-TODO: Write a gem description
+Provides cached finders for ActiveRemote models that allow a caching provider to cache the result of a query.
 
 ## Installation
 
@@ -18,7 +18,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+include `::ActiveRemote::Cached` into your ActiveRemote models that can support cached finders
+
+```ruby
+  class Customer < ::ActiveRemote::Base
+    include ::ActiveRemote::Cached
+
+    # Declare the cached finder methods that will be supported
+    cached_finders_for :id
+    cached_finders_for [:name, :email]
+  end
+```
+
+Now that you have a model that has cached finders on it you can use the `cached_search`, `cached_find`, or dynamic cached finder methods on the model to use the cache before you issue the AR search/find method.
+
+```ruby
+  customer = ::Customer.cached_find_by_id(1) # => <Customer id=1>
+  customer = ::Customer.cached_find(:id => 1) # => <Customer id=1>
+  customer = ::Customer.cached_search_by_id(1) # => [ <Customer id=1> ]
+  customer = ::Customer.cached_search(:id => 1) # => [ <Customer id=1> ]
+```
+
+```ruby
+  # All permutations of "complex" dynamic finders are defined
+  customer = ::Customer.cached_find_by_name_and_email("name", "email") # => <Customer id=1>
+  customer = ::Customer.cached_find_by_email_and_name("email", "name") # => <Customer id=1>
+
+  # Only declared finders are defined
+  customer = ::Customer.cached_find_by_name("name") # => NoMethodError
+```
+
+Each finder as takes an optional options hash that will override the options passed to the caching provider (override from the global defaults setup for ActiveRemote::Cached)
 
 ## Contributing
 

data/lib/active_remote-cached/version.rb

@@ -1,5 +1,5 @@
 module ActiveRemote
   module Cached
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/active_remote-cached.rb

@@ -61,7 +61,8 @@ module ActiveRemote
         #
         cached_finder_key_set.permutation do |arguments|
           delete_method_name = _cached_delete_method_name(arguments)
-          exist_method_name = _cached_exist_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)
 
@@ -69,8 +70,12 @@ module ActiveRemote
             _define_cached_delete_method(delete_method_name, arguments)
           end
 
-          unless self.respond_to?(exist_method_name)
-            _define_cached_exist_method(exist_method_name, arguments)
+          unless self.respond_to?(exist_find_method_name)
+            _define_cached_exist_find_method(exist_find_method_name, arguments)
+          end
+
+          unless self.respond_to?(exist_search_method_name)
+            _define_cached_exist_search_method(exist_search_method_name, arguments)
           end
 
           unless self.respond_to?(find_method_name)
@@ -87,8 +92,12 @@ module ActiveRemote
         "cached_delete_by_#{arguments.join('_and_')}"
       end
 
-      def _cached_exist_method_name(arguments)
-        "cached_exist_by_#{arguments.join('_and_')}"
+      def _cached_exist_find_method_name(arguments)
+        "cached_exist_find_by_#{arguments.join('_and_')}"
+      end
+
+      def _cached_exist_search_method_name(arguments)
+        "cached_exist_search_by_#{arguments.join('_and_')}"
       end
 
       def _cached_find_method_name(arguments)
@@ -109,31 +118,56 @@ module ActiveRemote
           #   ::ActiveRemote::Cached.cache.delete([name, user_guid])
           # end
           def self.#{method_name}(#{expanded_method_args}, options = {})
-            ::ActiveRemote::Cached.cache.delete([name, #{sorted_method_args}])
+            ::ActiveRemote::Cached.cache.delete([name, "#search", #{sorted_method_args}])
+            ::ActiveRemote::Cached.cache.delete([name, "#find", #{sorted_method_args}])
+          end
+        RUBY
+      end
+
+      def _define_cached_exist_find_method(method_name, *method_arguments)
+        method_arguments.flatten!
+        expanded_method_args = method_arguments.join(",")
+        sorted_method_args = method_arguments.sort.join(",")
+
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          # def self.cached_exist_find_by_user_guid(user_guid, options = {})
+          #   ::ActiveRemote::Cached.cache.exist?([name, user_guid])
+          # end
+          def self.#{method_name}(#{expanded_method_args}, options = {})
+            ::ActiveRemote::Cached.cache.exist?([name, "#find", #{sorted_method_args}])
+          end
+        RUBY
+
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          # def self.cached_exist_find_by_user_guid?(user_guid, options = {})
+          #   ::ActiveRemote::Cached.cache.exist?([name, user_guid])
+          # end
+          def self.#{method_name}?(#{expanded_method_args}, options = {})
+            ::ActiveRemote::Cached.cache.exist?([name, "#find", #{sorted_method_args}])
           end
         RUBY
       end
 
-      def _define_cached_exist_method(method_name, *method_arguments)
+      def _define_cached_exist_search_method(method_name, *method_arguments)
         method_arguments.flatten!
         expanded_method_args = method_arguments.join(",")
         sorted_method_args = method_arguments.sort.join(",")
 
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          # def self.cached_exist_by_user_guid(user_guid, options = {})
+          # def self.cached_exist_search_by_user_guid(user_guid, options = {})
           #   ::ActiveRemote::Cached.cache.exist?([name, user_guid])
           # end
           def self.#{method_name}(#{expanded_method_args}, options = {})
-            ::ActiveRemote::Cached.cache.exist?([name, #{sorted_method_args}])
+            ::ActiveRemote::Cached.cache.exist?([name, "#search", #{sorted_method_args}])
           end
         RUBY
 
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          # def self.cached_exist_by_user_guid?(user_guid, options = {})
+          # def self.cached_exist_search_by_user_guid?(user_guid, options = {})
           #   ::ActiveRemote::Cached.cache.exist?([name, user_guid])
           # end
           def self.#{method_name}?(#{expanded_method_args}, options = {})
-            ::ActiveRemote::Cached.cache.exist?([name, #{sorted_method_args}])
+            ::ActiveRemote::Cached.cache.exist?([name, "#search", #{sorted_method_args}])
           end
         RUBY
       end
@@ -152,14 +186,14 @@ module ActiveRemote
           # def self.cached_find_by_user_guid(user_guid, options = {})
           #   options = ::ActiveRemote::Cached.default_options.merge(options)
           #
-          #   ::ActiveRemote::Cached.cache.fetch([name, user_guid], options) do
+          #   ::ActiveRemote::Cached.cache.fetch([name, "#find", user_guid], options) do
           #     self.find(:user_guid => user_guid)
           #   end
           # end
           def self.#{method_name}(#{expanded_method_args}, options = {})
             options = ::ActiveRemote::Cached.default_options.merge(options)
 
-            ::ActiveRemote::Cached.cache.fetch([name, #{sorted_method_args}], options) do
+            ::ActiveRemote::Cached.cache.fetch([name, "#find", #{sorted_method_args}], options) do
               self.find(#{expanded_search_args})
             end
           end
@@ -180,14 +214,14 @@ module ActiveRemote
           # def self.cached_search_by_user_guid(user_guid, options = {})
           #   options = ::ActiveRemote::Cached.default_options.merge(options)
           #
-          #   ::ActiveRemote::Cached.cache.fetch([name, user_guid], options) do
+          #   ::ActiveRemote::Cached.cache.fetch([name, "#search", user_guid], options) do
           #     self.search(:user_guid => user_guid)
           #   end
           # end
           def self.#{method_name}(#{expanded_method_args}, options = {})
             options = ::ActiveRemote::Cached.default_options.merge(options)
 
-            ::ActiveRemote::Cached.cache.fetch([name, #{sorted_method_args}], options) do
+            ::ActiveRemote::Cached.cache.fetch([name, "#search", #{sorted_method_args}], options) do
               self.search(#{expanded_search_args})
             end
           end

data/spec/cached_exist_methods_spec.rb

@@ -14,60 +14,117 @@ end
 
 describe ExistMethodClass do
   describe "API" do
-    it "creates 'cached_exist_by_guid'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_guid")
+    it "creates 'cached_exist_find_by_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_guid")
     end
 
-    it "creates 'cached_exist_by_user_guid'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_user_guid")
+    it "creates 'cached_exist_search_by_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_guid")
     end
 
-    it "creates 'cached_exist_by_user_guid_and_client_guid'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_user_guid_and_client_guid")
+    it "creates 'cached_exist_find_by_user_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_user_guid")
     end
 
-    it "creates 'cached_exist_by_client_guid_and_user_guid'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_client_guid_and_user_guid")
+    it "creates 'cached_exist_search_by_user_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_user_guid")
     end
 
-    it "creates 'cached_exist_by_derp_and_user_guid_and_client_guid'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_derp_and_user_guid_and_client_guid")
+    it "creates 'cached_exist_find_by_user_guid_and_client_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_user_guid_and_client_guid")
     end
 
-    it "creates 'cached_exist_by_client_guid_and_derp_and_user_guid'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_client_guid_and_derp_and_user_guid")
+    it "creates 'cached_exist_search_by_user_guid_and_client_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_user_guid_and_client_guid")
     end
 
-    it "creates 'cached_exist_by_client_guid_and_user_guid_and_derp'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_client_guid_and_user_guid_and_derp")
+    it "creates 'cached_exist_find_by_client_guid_and_user_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_client_guid_and_user_guid")
     end
 
-    it "creates 'cached_exist_by_guid?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_guid?")
+    it "creates 'cached_exist_search_by_client_guid_and_user_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_client_guid_and_user_guid")
     end
 
-    it "creates 'cached_exist_by_user_guid?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_user_guid?")
+    it "creates 'cached_exist_find_by_derp_and_user_guid_and_client_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_derp_and_user_guid_and_client_guid")
     end
 
-    it "creates 'cached_exist_by_user_guid_and_client_guid?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_user_guid_and_client_guid?")
+    it "creates 'cached_exist_search_by_derp_and_user_guid_and_client_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_derp_and_user_guid_and_client_guid")
     end
 
-    it "creates 'cached_exist_by_client_guid_and_user_guid?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_client_guid_and_user_guid?")
+    it "creates 'cached_exist_find_by_client_guid_and_derp_and_user_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_client_guid_and_derp_and_user_guid")
     end
 
-    it "creates 'cached_exist_by_derp_and_user_guid_and_client_guid?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_derp_and_user_guid_and_client_guid?")
+    it "creates 'cached_exist_search_by_client_guid_and_derp_and_user_guid'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_client_guid_and_derp_and_user_guid")
     end
 
-    it "creates 'cached_exist_by_client_guid_and_derp_and_user_guid?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_client_guid_and_derp_and_user_guid?")
+    it "creates 'cached_exist_find_by_client_guid_and_user_guid_and_derp'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_client_guid_and_user_guid_and_derp")
     end
 
-    it "creates 'cached_exist_by_client_guid_and_user_guid_and_derp?'" do
-      ExistMethodClass.must_respond_to("cached_exist_by_client_guid_and_user_guid_and_derp?")
+    it "creates 'cached_exist_search_by_client_guid_and_user_guid_and_derp'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_client_guid_and_user_guid_and_derp")
+    end
+
+    # ? based methods
+    it "creates 'cached_exist_find_by_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_guid?")
+    end
+
+    it "creates 'cached_exist_search_by_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_guid?")
+    end
+
+    it "creates 'cached_exist_find_by_user_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_user_guid?")
+    end
+
+    it "creates 'cached_exist_search_by_user_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_user_guid?")
+    end
+
+    it "creates 'cached_exist_find_by_user_guid_and_client_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_user_guid_and_client_guid?")
+    end
+
+    it "creates 'cached_exist_search_by_user_guid_and_client_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_user_guid_and_client_guid?")
+    end
+
+    it "creates 'cached_exist_find_by_client_guid_and_user_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_client_guid_and_user_guid?")
+    end
+
+    it "creates 'cached_exist_search_by_client_guid_and_user_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_client_guid_and_user_guid?")
+    end
+
+    it "creates 'cached_exist_find_by_derp_and_user_guid_and_client_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_derp_and_user_guid_and_client_guid?")
+    end
+
+    it "creates 'cached_exist_search_by_derp_and_user_guid_and_client_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_derp_and_user_guid_and_client_guid?")
+    end
+
+    it "creates 'cached_exist_find_by_client_guid_and_derp_and_user_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_client_guid_and_derp_and_user_guid?")
+    end
+
+    it "creates 'cached_exist_search_by_client_guid_and_derp_and_user_guid?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_client_guid_and_derp_and_user_guid?")
+    end
+
+    it "creates 'cached_exist_find_by_client_guid_and_user_guid_and_derp?'" do
+      ExistMethodClass.must_respond_to("cached_exist_find_by_client_guid_and_user_guid_and_derp?")
+    end
+
+    it "creates 'cached_exist_search_by_client_guid_and_user_guid_and_derp?'" do
+      ExistMethodClass.must_respond_to("cached_exist_search_by_client_guid_and_user_guid_and_derp?")
     end
   end
 end

data/spec/cached_find_methods_spec.rb

@@ -66,7 +66,7 @@ describe FindMethodClass do
     end
 
     it "merges the default options in for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, :guid], :expires_in => 100).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", :guid], :expires_in => 100).returns(:hello)
 
       FindMethodClass.stub(:find, :hello) do
         FindMethodClass.cached_find_by_guid(:guid).must_equal(:hello)
@@ -74,7 +74,7 @@ describe FindMethodClass do
     end
 
     it "overrides the default options with local options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, :guid], :expires_in => 200).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", :guid], :expires_in => 200).returns(:hello)
 
       FindMethodClass.stub(:find, :hello) do
         FindMethodClass.cached_find_by_guid(:guid, :expires_in => 200).must_equal(:hello)

data/spec/cached_search_methods_spec.rb

@@ -66,7 +66,7 @@ describe SearchMethodClass do
     end
 
     it "merges the default options in for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, :guid], :expires_in => 100).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", :guid], :expires_in => 100).returns(:hello)
 
       SearchMethodClass.stub(:search, :hello) do
         SearchMethodClass.cached_search_by_guid(:guid).must_equal(:hello)
@@ -74,7 +74,7 @@ describe SearchMethodClass do
     end
 
     it "overrides the default options with local options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, :guid], :expires_in => 200).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", :guid], :expires_in => 200).returns(:hello)
 
       SearchMethodClass.stub(:search, :hello) do
         SearchMethodClass.cached_search_by_guid(:guid, :expires_in => 200).must_equal(:hello)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote-cached
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Brandon Dewitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_remote