mock_proxy 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9adac2fb9c8647d2f74cd27918f4ec7a2cab0aa3
-  data.tar.gz: d1a89dc5cf285ae1a86b149165107a936ce9fc97
+  metadata.gz: 1a4278ce46b890ca708d751a055af4476ebc5b74
+  data.tar.gz: 6df4a43793f809f124cc9b97b769e77697d28c53
 SHA512:
-  metadata.gz: 7de74d0b5c42d79bd268032380f01aec93f381bcd34bc5687dde7d7160bcb0a6785f69282019e2614f136d1a435892871f4ced552e32ba40151aa08ae0af9039
-  data.tar.gz: b5029ff013d9fa78b9f319db78805f6ccad749f957a2ab956464cca62ee63c265d5180d65a09d0cea884345850d3bf8e6ec76bc0b3f9b38408c66e75d876492b
+  metadata.gz: 9d31c8ec5f6fc2a9e081879216422b2389267f6afa401bd3d561e1bc0fefd80459254ef9a93d5b2a8a3e1cf4d1494801dae2617f314f735a08752ac477d0d4c9
+  data.tar.gz: a638bcaafc83134d4788885c41122d4fee841f73af4cba6033dd52e1731557736cd699b4dd2c236354c7af8bee3b662939ffc7c6a62305f835b209d9e5d0190d

data/lib/mock_proxy.rb

@@ -15,13 +15,14 @@ require "mock_proxy/version"
 # you did not define all the method calls (it won't automatically return itself for methods not defined in the hash)
 #
 # Example use:
-#   let(:model_proxy) { MockProxy.new(generate_email: { validate!: { send: proc { |to| email } } }) }
+#   let(:model_proxy) { MockProxy.new(receive_email: proc {}, generate_email: { validate!: { send: proc { |to| email } } }) }
 #   before { allow(Model).to receive(:new).and_return model_proxy }
 #   # ...
 #   describe 'Model' do
 #     it 'model also receives email' do
-#       callback = proc { |message| expect(message).to eq 'message' }
-#       MockProxy.update_proxy(model_proxy, receive_email: callback)
+#       MockProxy.observe(model_proxy, :receive_email) do |message|
+#         expect(message).to eq 'message'
+#       end
 #       run_system_under_test
 #     end
 #   end
@@ -32,7 +33,7 @@ require "mock_proxy/version"
 # Example:
 #   let(:model_proxy) do
 #     callback = proc do |type|
-#       MockProxy.update_proxy(generator_proxy, decorate: proc { |*args| method_call(type, *args) })
+#       MockProxy.merge(generator_proxy, decorate: proc { |*args| method_call(type, *args) })
 #       generator_proxy
 #     end
 #     MockProxy.new(generate_email: callback)
@@ -55,7 +56,7 @@ class MockProxy
   #        dot delimited key path or an array of method names as strings or symbols
   # @return [Block]
   def self.get(proxy, key_path)
-    get_callback(proxy, key_path)
+    get_and_validate_callback(proxy, key_path)
   end
 
   # Deep merges the callback tree, replacing existing values with new values.
@@ -76,9 +77,11 @@ class MockProxy
     proxy
   end
 
-  # Replaces the proc at the specified key path
+  # Replaces the proc at the specified key path, but only if there was one there before.
+  # Without creating new paths comes validation, including checking that this replaces an
+  # existing proc, sort of like mkdir (without the -p option)
   #
-  # Use case: Reuse existing stub but modify a proc
+  # Use case: Replace existing stub with a new proc without creating new method chains
   #
   # @param [MockProxy] proxy existing proxy
   # @param [String, Symbol, #to_s, Array<String, Symbol, #to_s>] key_path the chain of methods or key path. Can be a
@@ -89,6 +92,21 @@ class MockProxy
     proxy
   end
 
+  # Sets the proc at the specified key path, regardless if there was a proc there before.
+  # No validation comes with automatic path creation, meaning the key path will be defined
+  # it it hasn't already, sort of like mkdir -p
+  #
+  # Use case: Sets a new stub at specified key path while creating new method chains
+  #
+  # @param [MockProxy] proxy existing proxy
+  # @param [String, Symbol, #to_s, Array<String, Symbol, #to_s>] key_path the chain of methods or key path. Can be a
+  #        dot delimited key path or an array of method names as strings or symbols
+  # @return [MockProxy] the original proxy object
+  def self.set_at(proxy, key_path, &block)
+    set_callback(proxy, key_path, block, false)
+    proxy
+  end
+
   # Add an observer to an existing proxy
   #
   # Use case: Observe method call without changing the existing callback's stubbed return value
@@ -100,7 +118,7 @@ class MockProxy
   # @yieldreturn [optional]
   # @return [MockProxy] the original proxy object
   def self.observe(proxy, key_path, &block)
-    callback = get_callback(proxy, key_path)
+    callback = get_and_validate_callback(proxy, key_path)
     # Wrap existing callback, calling the provided block before it
     # Multiple calls to .observe will create a pyramid of callbacks, calling the observers before
     # eventually calling the existing callback
@@ -123,7 +141,7 @@ class MockProxy
   # @yieldreturn [optional]
   # @return [MockProxy] the original proxy object
   def self.wrap(proxy, key_path, &block)
-    callback = get_callback(proxy, key_path)
+    callback = get_and_validate_callback(proxy, key_path)
     # Wrap existing callback, calling the provided block before it
     # Multiple calls to .observe will create a pyramid of callbacks, calling the observers before
     # eventually calling the existing callback
@@ -143,34 +161,51 @@ class MockProxy
   def self.get_callback(proxy, key_path)
     key_paths = key_path.is_a?(Array) ? key_path.map(&:to_s) : key_path.split('.')
     existing_callback_hash = proxy.instance_variable_get('@callback_hash')
-    callback = key_paths.reduce(existing_callback_hash) do |callback_hash, key|
+    key_paths.reduce(existing_callback_hash) do |callback_hash, key|
       if callback_hash && callback_hash[key]
         callback_hash[key]
       else
         fail ArgumentError, "The existing callback tree does not contain the full key path you provided. We stopped at #{key} and the callback tree looks like this: #{existing_callback_hash}"
       end
     end
-    if callback.is_a?(Proc)
-      callback
-    else
-      fail ArgumentError, "The existing callback tree contains the full key path you provided but continues going. If you want to shorten the callback tree, use MockProxy.update. The callback tree looks like this: #{existing_callback_hash}"
-    end
   end
   private_class_method :get_callback
 
+  # @private
+  # @param [MockProxy] proxy existing proxy
+  # @param [String, Symbol, #to_s, Array<String, Symbol, #to_s>] key_path the chain of methods or key path. Can be a
+  #        dot delimited key path or an array of method names as strings or symbols
+  # @return [Proc] if proc found at key path
+  # @raise [ArgumentError] if proc not found or hash found at key path
+  def self.get_and_validate_callback(proxy, key_path)
+    callback = get_callback(proxy, key_path)
+    return callback if callback.is_a?(Proc)
+    fail ArgumentError, "The existing callback tree contains the full key path you provided but continues going (i.e. no proc at exact key path). If you want to shorten the callback tree, use MockProxy.set_at. The callback tree looks like this: #{proxy.instance_variable_get('@callback_hash')}"
+  end
+  private_class_method :get_and_validate_callback
+
   # @private
   # @param [MockProxy] proxy existing proxy
   # @param [String, Symbol, #to_s, Array<String, Symbol, #to_s>] key_path the chain of methods or key path. Can be a
   #        dot delimited key path or an array of method names as strings or symbols
   # @param [Proc] proc the new proc to replace the existing proc
+  # @param [Bool] validate true will throw error if nil at any part of key path, false to
+  #        create key path if missing (mkdir vs mkdir -p) (Defaults: true)
   # @return [MockProxy] if proc existed at key path
   # @raise [ArgumentError] if proc not found or hash found at key path
-  def self.set_callback(proxy, key_path, proc)
+  def self.set_callback(proxy, key_path, proc, validate = true)
+    # Validate by checking if proc exists at key path
+    get_and_validate_callback(proxy, key_path) if validate
+    # Set callback at key path, validating if set
     key_paths = key_path.is_a?(Array) ? key_path.map(&:to_s) : key_path.to_s.split('.')
     copied_callback_hash = proxy.instance_variable_get('@callback_hash').clone
     key_paths.reduce(copied_callback_hash) do |callback_hash, key|
       if !callback_hash || !callback_hash[key]
-        fail ArgumentError, "The existing callback tree does not contain the full key path you provided. We stopped at #{key} and the callback tree looks like this: #{copied_callback_hash}"
+        if validate
+          fail ArgumentError, "The existing callback tree does not contain the full key path you provided. We stopped at #{key} and the callback tree looks like this: #{copied_callback_hash}"
+        else
+          callback_hash[key] = {}
+        end
       end
       if callback_hash[key].is_a?(Proc)
         callback_hash[key] = proc

data/lib/mock_proxy/version.rb

@@ -1,4 +1,4 @@
 class MockProxy
   # The version number
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - matrinox