mock_proxy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0be3478b9b871a212964dcaec40e5cf40fa5ee
-  data.tar.gz: ae134b7b4c3c168ede44f0ba2a43316a7520e854
+  metadata.gz: ceef8aba92781d19960ef4b65b3ece2d8d1d3d4e
+  data.tar.gz: 41a93d0fed086e3b9479c60d055b7a7e89a0541a
 SHA512:
-  metadata.gz: 5e95648c74a46db859ad2be919128aa33d1a57160889a575bae6c7b9ddf992d28325094b788480e9f3ef9280e37d1699fd75626064027e486377cf466b3b332c
-  data.tar.gz: 8dd740b3d886373d24ad3537008f8747f9379d8b96ecd79440e4e6db943c236f2c645e7858eae4801a70a3a8698c058a3e8c58a4aec105279d4f533e036d73cc
+  metadata.gz: 9792f03d43756a82d7d8cec9b3a72e371205e9caa7904b0915209c49e5755029a1c5bcec58fd3e41a1f4c968df8e7af0f4f064ef9876cbf149573fac27aea1b0
+  data.tar.gz: 00e2f0de77ffc357f4a175bdd2c143dca74790a0db3c7a6d2433174d160304995d56efd6936da024432f089cd3447c078a1aad8f41aa6a0849104cf97a8faa6f

data/lib/mock_proxy.rb

@@ -51,14 +51,17 @@ class MockProxy
   # Use case: Retrieve proc to mock
   #
   # @param [MockProxy] proxy existing proxy
-  # @param [String, Array<String>] key_path the chain of methods or key path. Can be a
+  # @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 [Block]
   def self.get(proxy, key_path)
     get_callback(proxy, key_path)
   end
 
-  # Deep merges the callback tree, replacing existing values with new values
+  # Deep merges the callback tree, replacing existing values with new values.
+  # Avoid using this method for one method change; prefer replace_at. It has clearer
+  # intent and less chances to mess up. MockProxy.merge uses deep_merge under the hood and
+  # can have unexpected behaviour. It also does not type check. Use at risk
   #
   # Use case: Reuse existing stub but with some different values
   #
@@ -78,7 +81,7 @@ class MockProxy
   # Use case: Reuse existing stub but modify a proc
   #
   # @param [MockProxy] proxy existing proxy
-  # @param [String, Array<String>] key_path the chain of methods or key path. Can be a
+  # @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.replace_at(proxy, key_path, &block)
@@ -91,7 +94,7 @@ class MockProxy
   # Use case: Observe method call without changing the existing callback's stubbed return value
   #
   # @param [MockProxy] proxy existing proxy
-  # @param [String, Array<String>] key_path the chain of methods or key path. Can be a
+  # @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
   # @yieldparam [*args] args
   # @yieldreturn [optional]
@@ -114,7 +117,7 @@ class MockProxy
   # Use case: Get full control of the existing proc while running custom code
   #
   # @param [MockProxy] proxy existing proxy
-  # @param [String, Array<String>] key_path the chain of methods or key path. Can be a
+  # @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
   # @yieldparam [*args, &block] args, original callback
   # @yieldreturn [optional]
@@ -133,12 +136,12 @@ class MockProxy
 
   # @private
   # @param [MockProxy] proxy existing proxy
-  # @param [String, Array<String>] key_path the chain of methods or key path. Can be a
+  # @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_callback(proxy, key_path)
-    key_paths = key_path.is_a?(Array) ? key_path.map(&:to_s) :key_path.split('.')
+    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|
       if callback_hash && callback_hash[key]
@@ -157,13 +160,13 @@ class MockProxy
 
   # @private
   # @param [MockProxy] proxy existing proxy
-  # @param [String, Array<String>] key_path the chain of methods or key path. Can be a
+  # @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
   # @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)
-    key_paths = key_path.is_a?(Array) ? key_path.map(&:to_s) :key_path.split('.')
+    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]

data/lib/mock_proxy/version.rb

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

metadata

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