invoke_matcher 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf226105ac69330c4904343286ffd39734097e4ea744de55653eb90923619742
-  data.tar.gz: 28f11ae446664b5e4bee2dacd4d6cf69ebf72d5f350651e0c4f35685dc77cccf
+  metadata.gz: 975e4d078755b24aaf9874972f3f394db04eab312a53ecc4c251eb4025248763
+  data.tar.gz: 8b72b943934a89bdd02869da51accfd88abf539f5f4c96cbde2d826774811a37
 SHA512:
-  metadata.gz: a5b84b12fef7d3b9dad5b9a830396a72a1b5a1bb9eef45d6421c1dfe92f1fcff735e9b043f4a419aee489d74a7417489fd964088a104425a4403dc36d7a7e355
-  data.tar.gz: be4132ca6edce95552a85f46bb102c289f265cc3477eee70799a634e22d25476adcd7ad5a278939c4e816b951d39835090d2138a580e5f376bd6033b71f6280c
+  metadata.gz: de4a6738c8c6d6df78236286b4599994c6a34bc0969ba10e1e1a2d3d5bf56119c2c072ffd4f50e99ce190b9414a25b8aebe46ba525b9ac30c5b3fb3d5903e06e
+  data.tar.gz: d4a3577643c9fa90fe1af113b40cf0370eb24aa44b9887b6f177eeae44e13e699eb9cb7c7e2b4ea4307d84005f3c7545b1c7f8763c8214188ecf7d72ebe1dc45

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Tyler Rhodes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# InvokeMatcher
+
+This is adapted from: https://github.com/rspec/rspec-expectations/issues/934
+
+It allows us to write expectations in a more declarative way, by checking if a
+method was called on a class or instance.
+
+Old way:
+
+```ruby
+allow(foo).to receive(:method).and_return('value')
+subject
+expect(foo).to have_received(:method)
+```
+
+Or:
+
+```ruby
+expect(foo).to receive(:method).and_return('value')
+subject
+```
+
+New way:
+```ruby
+expect { subject }.to invoke(:method).on(foo).with('bar').and_return('value')
+```
+
+## Installation
+Add this to your test gems:
+```ruby
+group :test do
+  gem 'invoke_matcher'
+end
+```
+
+Make sure to require it in your `spec_helper.rb` or `rails_helper.rb`:
+```ruby
+require 'invoke_matcher'
+
+RSpec.configure do |config|
+  config.include InvokeMatcher
+end
+```
+
+## Usage
+```ruby
+expect { foo }.to invoke(:method).on(Class).and_call_original
+
+expect { foo }.to change{ bar }.and not_invoke(:method).on(Class)
+
+expect { foo }.to invoke(:method).on(Class).at_least(3).times
+
+expect { foo }.to invoke(:method).and_expect_return('bar')
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/invoke_matcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InvokeMatcher
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/invoke_matcher.rb

@@ -11,63 +11,30 @@ module InvokeMatcher
 
     def_delegators :have_received_matcher, :failure_message, :failure_message_when_negated
 
-    attr_reader :have_received_matcher, :expected_recipient
+    attr_reader :have_received_matcher, :expected_recipient, :expected_method
 
     def initialize(expected_method)
       @expected_method = expected_method
-      @have_received_matcher = RSpec::Mocks::Matchers::HaveReceived.new(@expected_method)
+      @have_received_matcher = RSpec::Mocks::Matchers::HaveReceived.new(expected_method)
     end
 
     def description
-      "invoke #{@expected_method} on #{expected_recipient.inspect}"
-    end
-
-    def and_call_original
-      @call_original = true
-      self
-    end
-
-    def method_missing(name, ...)
-      ensure_recipient_is_defined!
-      return super unless respond_to_missing?(name)
-
-      @have_received_matcher = have_received_matcher.public_send(name, ...)
-      self
-    end
-
-    def respond_to_missing?(name, include_private = false)
-      @have_received_matcher.respond_to?(name, include_private)
+      "invoke #{expected_method} on #{expected_recipient.inspect}"
     end
 
     def matches?(event_proc)
       ensure_recipient_is_defined!
       set_method_expectation
-
+      setup_return_value_check if defined?(@expected_return)
+      
       event_proc.call
-
-      have_received_matcher.matches?(expected_recipient) && matches_result?
-    end
-
-    def set_method_expectation
-      return if testing_double?
-
-      @actual_result = expected_recipient.send(@expected_method)
-      expectation = allow(expected_recipient).to receive(@expected_method)
-      expectation.and_call_original if @call_original
-    end
-
-    def testing_double?
-      @expected_recipient.is_a?(RSpec::Mocks::Double) ||
-        @expected_recipient.is_a?(RSpec::Mocks::InstanceVerifyingDouble) ||
-        @expected_recipient.is_a?(RSpec::Mocks::ObjectVerifyingDouble)
+      have_received_matcher.matches?(expected_recipient)
     end
 
     def does_not_match?(event_proc)
       ensure_recipient_is_defined!
       set_method_expectation
-
       event_proc.call
-
       have_received_matcher.does_not_match?(expected_recipient)
     end
 
@@ -81,34 +48,60 @@ module InvokeMatcher
       self
     end
 
-    def supports_block_expectations?
-      true
+    def and_call_original
+      @call_original = true
+      self
     end
 
-    def matches_result?
-      return true unless defined?(@expected_return_value)
-
-      values_match?(@expected_return_value, @actual_result)
+    def and_expect_return(expected_value)
+      @expected_return = expected_value
+      self
     end
 
-    def and_expect_return(expected_return_value)
-      @expected_return_value = expected_return_value
+    def method_missing(name, ...)
+      ensure_recipient_is_defined!
+      return super unless have_received_matcher.respond_to?(name)
+
+      @have_received_matcher = have_received_matcher.public_send(name, ...)
       self
     end
 
+    def respond_to_missing?(name, include_private = false)
+      have_received_matcher.respond_to?(name, include_private)
+    end
+
+    def supports_block_expectations?
+      true
+    end
+
     private
 
     def ensure_recipient_is_defined!
       raise ArgumentError, "missing `on`" unless defined?(expected_recipient)
     end
 
-    def call_original(matcher)
-      @call_original ? matcher.and_call_original : matcher
+    def set_method_expectation
+      allow(expected_recipient).to receive(expected_method)
+    end
+
+    def setup_return_value_check
+      allow(expected_recipient).to receive(expected_method) do |*args, **kwargs|
+        actual_value = expected_recipient.method(expected_method).super_method.call(*args, **kwargs)
+        verify_return_value(actual_value)
+        actual_value
+      end
+    end
+
+    def verify_return_value(actual_value)
+      return if actual_value == @expected_return
+
+      raise RSpec::Expectations::ExpectationNotMetError,
+        "expected #{expected_method} to return #{@expected_return.inspect} but got #{actual_value.inspect}"
     end
   end
 
   def invoke(expected_method)
-    InvokeMatcher::Matcher.new(expected_method)
+    Matcher.new(expected_method)
   end
 end
 

metadata

@@ -1,22 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: invoke_matcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Rhodes
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: A Ruby gem that provides RSpec matchers for verifying method invocations
+  with specific arguments
 email:
 - rhodetyl000@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/invoke_matcher.rb
 - lib/invoke_matcher/version.rb
 homepage: https://github.com/tylerCaineRhodes/invoke_matcher
@@ -26,7 +29,7 @@ metadata:
   homepage_uri: https://github.com/tylerCaineRhodes/invoke_matcher
   source_code_uri: https://github.com/tylerCaineRhodes/invoke_matcher
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -41,8 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: RSpec matcher for testing method invocations
 test_files: []