active_remote-cached 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c37d8fe5adf8a1227c97dddf83db2eb5d59fc7
-  data.tar.gz: 49690fa347012f5dd569dd1ce175f864adf83b6d
+  metadata.gz: d09ee17c4bc381af4901fdff4db406009ad2c027
+  data.tar.gz: 38b5d38c0ac4ff0dbd0852b155a6dfb5347f756b
 SHA512:
-  metadata.gz: 553ee8882228bb293410908ef21f4c40b7decc3fa2d0a4f40adfe42d83191c2c0649266b3e7db69782f42943cdeb42dead439ebeeed9461fac2f7da02da1ebfd
-  data.tar.gz: 42ca67feb1eddc71a2f679e4ab04453811c12d63810486adb0290d78245b4c2ad0e88ef31fa81ebab5dd7ff4afc7456e4754a9e4aee53cd2131c52a05de06c8f
+  metadata.gz: faa37b47e9d4df79ac735501d72e562b42e10ef5c4302305d080243382b48420417d56317aade1a7c866bf0275fcf6fc2c31ef0c619804efbf8ad6f58e99e464
+  data.tar.gz: b205d8e1b41052fa887efcc28ede71fb3ebaef907d05d4a40c18e4f9848713937e3b47d526e32eb5d057d06a3a93b6b464bece96bddd08720074231366ca1484

data/lib/active_remote/cached.rb

@@ -5,6 +5,7 @@ require "active_support/core_ext/array/extract_options"
 
 require "active_remote/cached/cache"
 require "active_remote/cached/version"
+require "active_remote/errors"
 
 module ActiveRemote
   module Cached
@@ -81,6 +82,7 @@ module ActiveRemote
           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)
@@ -98,6 +100,10 @@ module ActiveRemote
             _define_cached_find_method(find_method_name, arguments, options)
           end
 
+          unless self.respond_to?(search_bang_method_name)
+            _define_cached_search_bang_method(search_bang_method_name, arguments, options)
+          end
+
           unless self.respond_to?(search_method_name)
             _define_cached_search_method(search_method_name, arguments, options)
           end
@@ -240,7 +246,11 @@ module ActiveRemote
           #   options = ::ActiveRemote::Cached.default_options.merge({}).merge(options)
           #
           #   ::ActiveRemote::Cached.cache.fetch([namespace, name, "#search", user_guid], options) do
-          #     self.search(:user_guid => user_guid)
+          #     if block_given?
+          #       yield
+          #     else
+          #       self.search(:user_guid => user_guid)
+          #     end
           #   end
           # end
           #
@@ -262,6 +272,58 @@ module ActiveRemote
           end
         RUBY
       end
+
+      def _define_cached_search_bang_method(method_name, *method_arguments, cached_finder_options)
+        method_arguments.flatten!
+        expanded_method_args = method_arguments.join(",")
+        sorted_method_args = method_arguments.sort.join(",")
+
+        expanded_search_args = ""
+        method_arguments.each do |method_argument|
+          expanded_search_args << ":#{method_argument} => #{method_argument},"
+        end
+
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          # def self.cached_search_by_user_guid!(user_guid, options = {})
+          #   options = ::ActiveRemote::Cached.default_options.merge({}).merge(options)
+          #
+          #   ::ActiveRemote::Cached.cache.fetch([namespace, name, "#search", user_guid], options) do
+          #     results = []
+          #
+          #     if block_given?
+          #       results = yield
+          #     else
+          #       results = self.search(:user_guid => user_guid)
+          #     end
+          #
+          #     raise ::ActiveRemote::RemoteRecordNotFound.new(self.class) if results.size <= 0
+          #     results
+          #   end
+          # end
+          #
+          # If a block is given, it is incumbent on the caller to make sure the expectation
+          # of the result object is maintained for requests/responses
+          #
+          def self.#{method_name}(#{expanded_method_args}, options = {})
+            options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(options)
+            namespace = options.delete(:namespace)
+            cache_key = [namespace, name, "#search", #{sorted_method_args}].compact
+
+            ::ActiveRemote::Cached.cache.fetch(cache_key, options) do
+              results = []
+
+              if block_given?
+                results = yield
+              else
+                results = self.search(#{expanded_search_args})
+              end
+
+              raise ::ActiveRemote::RemoteRecordNotFound.new(self.class) if results.first.nil?
+              results
+            end
+          end
+        RUBY
+      end
     end
 
     # Initialize the cache provider with a MemoryStore cache

data/lib/active_remote/cached/version.rb

@@ -1,5 +1,5 @@
 module ActiveRemote
   module Cached
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/spec/active_remote/cached_search_methods_spec.rb

@@ -20,6 +20,10 @@ describe SearchMethodClass do
       SearchMethodClass.must_respond_to("cached_search_by_foo")
     end
 
+    it "creates 'cached_search_by_foo!'" do
+      SearchMethodClass.must_respond_to("cached_search_by_foo!")
+    end
+
     it "creates 'cached_search_by_guid'" do
       SearchMethodClass.must_respond_to("cached_search_by_guid")
     end
@@ -47,6 +51,10 @@ describe SearchMethodClass do
     it "creates 'cached_search_by_client_guid_and_user_guid_and_derp'" do
       SearchMethodClass.must_respond_to("cached_search_by_client_guid_and_user_guid_and_derp")
     end
+
+    it "creates 'cached_search_by_client_guid_and_user_guid_and_derp!'" do
+      SearchMethodClass.must_respond_to("cached_search_by_client_guid_and_user_guid_and_derp!")
+    end
   end
 
   describe "#cached_search_by_guid" do
@@ -176,4 +184,27 @@ describe SearchMethodClass do
       end
     end
   end
+
+  describe "#cached_search_by_foo!" do
+    before do
+      ::ActiveRemote::Cached.cache(HashCache.new)
+      ::ActiveRemote::Cached.default_options(:expires_in => 100)
+    end
+
+    after do
+      ::ActiveRemote::Cached.default_options({})
+    end
+
+    it "returns results when present" do
+      SearchMethodClass.stub(:search, [:hello]) do
+        SearchMethodClass.cached_search_by_foo!(:foo, :expires_in => 200).must_equal([:hello])
+      end
+    end
+
+    it "raises ActiveRemote::RemoteRecordNotFound when not found" do
+      SearchMethodClass.stub(:search, []) do
+        -> { SearchMethodClass.cached_search_by_foo!(:foo, :expires_in => 200) }.must_raise ::ActiveRemote::RemoteRecordNotFound
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote-cached
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Brandon Dewitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_remote
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides a configuration for caching mechanisms and finders on ActiveRemote