spy 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3906b9e65a981746a6dc4e51106ed64fc925478cb73335eb8a9d46ae9fc31931
-  data.tar.gz: 85e19b544c6ccb98616dd846db8263da3d0e8abcfd2158a5749d8988c5dc32e8
+  metadata.gz: 20db34080cda44a6de54d9042bd0e8081797b5418ecd31a1cf0e08aafdbeb5f4
+  data.tar.gz: 6c0c13d0871680db8fdf33c05e95e6484c02218cd6d3c021379297a30eac25b6
 SHA512:
-  metadata.gz: 57544c0872ff818dc065037e1e2a10c34b1edb698ad84ebf1e184aa190d24c8663d51d011619bb6a1024c93f1d94a03a8bd6578274605a56f0b0ba06aabf6abc
-  data.tar.gz: 43b7ca82d10759bb6083fdd76b27941425cefbcc63bc2b8a585b34d3c8e2c2659f24c1f4f32843ee1c1b8f3aee1d64c127fb769774430e77a31ea7005aeebbcb
+  metadata.gz: 8eb8e44ee8e3c45ce8d551e2e15db9db23f69bf64052f3514f5bffc28ee3092455d648e27ab7cbc54b702924cf1ee0b724a507d2fa37d36f6442b65b8d4af8a5
+  data.tar.gz: 4273aa86e5502e8de5fbc329f4c4784709e23cd392eb2455fca7baafd85026d9086568fa721f7b9c9e8e3aaa51e72042cae97059c4a2f5ed723c75de46e44c9e

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@0a29871fe2b0200a17a4497bae54fe5df0d973aa # v1.115.3
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.0
+ruby 3.1.2

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## Spy 1.0.4 (December 21th, 2022) ##
+
+* Hash as argument got turned into keyword arguments (@svenpl)
+* drop support for ruby older than 2.7 (@ryanong)
+
+## Spy 1.0.3 (September 15, 2022) ##
+
+* Fix private method call errors for older ruby versions (@dylanahsmith)
+* `Spy.on_instance_method` and `and_call_through` on `#to_ary-able` class causes an error (@mizukami234)
+* Fix `and_return` on class method (@jfirebaugh)
+
+## Spy 1.0.2 (January 10, 2022) ##
+
+* Fix subroutine call with hash as last arg (@dtheo-ad)
+* Ruby 2.7+ support (@casperisfine)
+
 ## Spy 1.0.1 (August 20th, 2020) ##
 
 *   Fix call_through w/ instance methods (@lreeves)

data/README.md

@@ -9,8 +9,7 @@
 
 Spy is a lightweight stubbing framework with support for method spies, constant stubs, and object mocks.
 
-Spy supports ruby 2.1.0+.
-For versions less than 2.1 use v0.4.5
+Spy supports ruby 2.7.0+.
 
 Spy features that were completed were tested against the rspec-mocks tests so it covers all cases that rspec-mocks does.
 
@@ -47,7 +46,7 @@ Fail faster, code faster.
   * you can usually just check the call logs.
   * if you do need to use this. It is probably a code smell. You either need to abstract your method more or add separate tests.
 * you want to use dumb double, Spy has smart mocks, they are better
-* you use `mock_model` and `stub_model` (I want to impliment this soon)
+* you use `mock_model` and `stub_model`
 
 ## Installation
 
@@ -87,7 +86,7 @@ Spy::Subroutine.new(book, :flamethrower).hook(force:true).and_return("burnninant
 ```
 
 You can also stub instance methods of Classes and Modules. This is equivalent to
-rspec-mock's `Module#any_instance`
+rspec-mock's `allow_any_instance_of(Module)`
 
 ```ruby
 Spy.on_instance_method(Book, :title).and_return("Cannery Row")

data/lib/spy/call_log.rb

@@ -10,6 +10,9 @@ module Spy
     # @!attribute [r] args
     #   @return [Array] arguments were sent to the method
     #
+    # @!attribute [r] kwargs
+    #   @return [Array] keyword arguments were sent to the method
+    #
     # @!attribute [r] block
     #   @return [Proc] the block that was sent to the method
     #
@@ -17,10 +20,10 @@ module Spy
     #   @return The result of the method of being stubbed, or called through
 
 
-    attr_reader :object, :called_from, :args, :block, :result
+    attr_reader :object, :called_from, :args, :kwargs, :block, :result
 
-    def initialize(object, called_from, args, block, result)
-      @object, @called_from, @args, @block, @result = object, called_from, args, block, result
+    def initialize(object, called_from, args, kwargs, block, result)
+      @object, @called_from, @args, @kwargs, @block, @result = object, called_from, args, kwargs, block, result
     end
   end
 end

data/lib/spy/subroutine.rb

@@ -84,7 +84,7 @@ module Spy
       raise NeverHookedError, "'#{method_name}' method has not been hooked" unless hooked?
 
       method_owner.send(:remove_method, method_name)
-      if original_method && method_owner == original_method.owner
+      if original_method
         original_method.owner.send(:define_method, method_name, original_method)
         original_method.owner.send(original_method_visibility, method_name) if original_method_visibility
       end
@@ -201,30 +201,28 @@ module Spy
     # check if the method was called with the exact arguments
     # @param args Arguments that should have been sent to the method
     # @return [Boolean]
-    def has_been_called_with?(*args, &block)
+    def has_been_called_with?(*args, **kwargs, &block)
       raise NeverHookedError unless @was_hooked
-      match = block_given? ? block : proc { |call| call.args == args }
+      match = block_given? ? block : proc { |call| call.args == args && call.kwargs == kwargs }
       calls.any?(&match)
     end
 
     # invoke that the method has been called. You really shouldn't use this
     # method.
-    def invoke(object, args, block, called_from)
-      check_arity!(args.size)
+    def invoke(object, args, kwargs, block, called_from)
+      arity = args.size
+      arity += 1 if kwargs.present?
+      check_arity!(arity)
 
       result =
         if @call_through
-          call_plan(build_call_through_plan(object), block, *args)
+          call_plan(build_call_through_plan(object), block, *args, **kwargs)
         elsif @plan
           check_for_too_many_arguments!(@plan)
-          if base_object.is_a? Class
-            call_plan(@plan, block, object, *args)
-          else
-            call_plan(@plan, block, *args)
-          end
+          call_plan(@plan, block, *args, **kwargs)
         end
     ensure
-      calls << CallLog.new(object, called_from, args, block, result)
+      calls << CallLog.new(object, called_from, args, kwargs, block, result)
     end
 
     # reset the call log
@@ -241,11 +239,12 @@ module Spy
     # we use eval to set the spy object id as a parameter so it can be extracted
     # and looked up later using `Method#parameters`
     SPY_ARGS_PREFIX='__spy_args_'.freeze
+    SPY_KWARGS_PREFIX='__spy_kwargs_'.freeze
     def override_method
       eval <<-METHOD, binding, __FILE__, __LINE__ + 1
       __method_spy__ = self
-      lambda do |*#{SPY_ARGS_PREFIX}#{self.object_id}, &block|
-        __method_spy__.invoke(self, #{SPY_ARGS_PREFIX}#{self.object_id}, block, caller(1)[0])
+      lambda do |*#{SPY_ARGS_PREFIX}#{self.object_id}, **#{SPY_KWARGS_PREFIX}#{self.object_id}, &block|
+        __method_spy__.invoke(self, #{SPY_ARGS_PREFIX}#{self.object_id}, #{SPY_KWARGS_PREFIX}#{self.object_id}, block, caller(1)[0])
       end
       METHOD
     end
@@ -349,23 +348,8 @@ module Spy
       end
     end
 
-    def call_plan(plan, block, *args)
-      if ruby_27_last_arg_hash?(args)
-        *prefix, last = args
-        plan.call(*prefix, **last, &block)
-      else
-        plan.call(*args, &block)
-      end
-    end
-
-    # Ruby 2.7 gives a deprecation warning about passing hash as last argument for a method
-    # with a double-splat operator (**), and Ruby 3 raises an ArgumentError exception.
-    # This checks if args has a hash as last element to extract it and pass it with double-splat to avoid an exception.
-    def ruby_27_last_arg_hash?(args)
-      last = args.last
-      last.instance_of?(Hash) &&
-        !last.empty? &&
-        Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
+    def call_plan(plan, block, *args, **kwargs)
+      plan.call(*args, **kwargs, &block)
     end
 
     class << self

data/lib/spy/version.rb

@@ -1,3 +1,3 @@
 module Spy
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/spy.gemspec

@@ -6,7 +6,7 @@ require 'spy/version'
 Gem::Specification.new do |gem|
   gem.name          = "spy"
   gem.version       = Spy::VERSION
-  gem.required_ruby_version = '>= 2.1.0'
+  gem.required_ruby_version = '>= 2.7.0'
   gem.license       = 'MIT'
   gem.authors       = ["Ryan Ong"]
   gem.email         = ["ryanong@gmail.com"]

data/test/integration/test_class_method.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class TestClassMethod < Minitest::Test
+  def teardown
+    Spy::Agency.instance.dissolve!
+  end
+
+  def test_and_return
+    klass = Class.new do
+      def self.class_method(*args, &block)
+      end
+    end
+    received_args = nil
+    received_block = nil
+    Spy.on(klass, :class_method).and_return do |*args, &block|
+      received_args = args
+      received_block = block
+    end
+    block = -> {}
+    klass.class_method(:a, :b, &block)
+    assert_equal [:a, :b], received_args
+    assert_equal block, received_block
+  end
+end

data/test/spy/test_subroutine.rb

@@ -150,6 +150,14 @@ module Spy
       assert_equal string, result
     end
 
+    def test_spy_and_call_through_with_hash_and_keyword_args
+      spy_on(@pen, 'hash_and_keyword_arg').and_call_through
+      hsh = { hello: 'world' }
+
+      assert_equal [hsh, nil], @pen.hash_and_keyword_arg(hsh)
+      assert_equal [hsh, 'foo'], @pen.hash_and_keyword_arg(hsh, keyword: 'foo')
+    end
+
     def test_spy_and_call_through_returns_original_method_result
       string = "hello world"
 
@@ -237,6 +245,20 @@ module Spy
       assert pen_write_spy.has_been_called_with?("hello")
     end
 
+    def test_has_been_called_with_kwargs
+      pen_write_spy = spy_on(@pen, :opt_kwargs)
+      refute pen_write_spy.has_been_called_with?("hello")
+
+      @pen.opt_kwargs("hello")
+      assert pen_write_spy.has_been_called_with?("hello")
+
+      @pen.opt_kwargs("world", opt: "hello")
+      assert pen_write_spy.has_been_called_with?("world", opt: "hello")
+
+      @pen.opt_kwargs("hello world", opt: "world", opt2: "hello")
+      assert pen_write_spy.has_been_called_with?("hello world", opt: "world", opt2: "hello")
+    end
+
     def test_spy_hook_records_number_of_calls2
       args = ["hello world"]
       block = Proc.new {}

data/test/spy/test_unhook.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+module Spy
+  class TestUnhook < Minitest::Test
+    module ModuleFunctionStyle
+      extend self
+
+      def hello
+        'hello world'
+      end
+    end
+
+    module Injected
+      def hello
+        'hello world'
+      end
+    end
+
+    class ModuleInjectedStyle
+      include Injected
+    end
+
+    class ModuleExtendedStyle
+      extend Injected
+    end
+
+    class SingletonMethodStyle
+      def self.hello
+        'hello world'
+      end
+    end
+
+    class InstanceMethodStyle
+      def hello
+        'hello world'
+      end
+    end
+
+    def test_ModuleFunctionStyle
+      spy = Spy.on(ModuleFunctionStyle, :hello).and_return('yo')
+      assert_equal ModuleFunctionStyle.hello, 'yo'
+      spy.unhook
+      assert_equal ModuleFunctionStyle.hello, 'hello world'
+    end
+
+    def test_ModuleInjectedStyle
+      instance = ModuleInjectedStyle.new
+      spy = Spy.on(instance, :hello).and_return('yo')
+      assert_equal instance.hello, 'yo'
+      spy.unhook
+      assert_equal instance.hello, 'hello world'
+    end
+
+    def test_ModuleExtendedStyle
+      spy = Spy.on(ModuleExtendedStyle, :hello).and_return('yo')
+      assert_equal ModuleExtendedStyle.hello, 'yo'
+      spy.unhook
+      assert_equal ModuleExtendedStyle.hello, 'hello world'
+    end
+
+    def test_SingletonMethodStyle
+      spy = Spy.on(SingletonMethodStyle, :hello).and_return('yo')
+      assert_equal SingletonMethodStyle.hello, 'yo'
+      spy.unhook
+      assert_equal SingletonMethodStyle.hello, 'hello world'
+    end
+
+    def test_InstanceMethodStyle
+      instance = InstanceMethodStyle.new
+      spy = Spy.on(instance, :hello).and_return('yo')
+      assert_equal instance.hello, 'yo'
+      spy.unhook
+      assert_equal instance.hello, 'hello world'
+    end
+  end
+end

data/test/support/pen.rb

@@ -37,6 +37,10 @@ class Pen
     write("#{hello} #{name}")
   end
 
+  def hash_and_keyword_arg(hsh, keyword: nil)
+    [hsh, keyword]
+  end
+
   def public_method
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spy
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Ryan Ong
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -117,9 +117,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".tool-versions"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -139,30 +139,16 @@ files:
 - lib/spy/nest.rb
 - lib/spy/subroutine.rb
 - lib/spy/version.rb
-- spec/spec_helper.rb
-- spec/spy/and_call_original_spec.rb
-- spec/spy/and_yield_spec.rb
-- spec/spy/any_instance_spec.rb
-- spec/spy/hash_excluding_matcher_spec.rb
-- spec/spy/hash_including_matcher_spec.rb
-- spec/spy/mutate_const_spec.rb
-- spec/spy/nil_expectation_warning_spec.rb
-- spec/spy/null_object_mock_spec.rb
-- spec/spy/partial_mock_spec.rb
-- spec/spy/passing_argument_matchers_spec.rb
-- spec/spy/serialization_spec.rb
-- spec/spy/stash_spec.rb
-- spec/spy/stub_implementation_spec.rb
-- spec/spy/stub_spec.rb
-- spec/spy/to_ary_spec.rb
 - spy.gemspec
 - test/integration/test_api.rb
+- test/integration/test_class_method.rb
 - test/integration/test_constant_spying.rb
 - test/integration/test_instance_method.rb
 - test/integration/test_mocking.rb
 - test/integration/test_subroutine_spying.rb
 - test/spy/test_mock.rb
 - test/spy/test_subroutine.rb
+- test/spy/test_unhook.rb
 - test/support/pen.rb
 - test/test_helper.rb
 homepage: https://github.com/ryanong/spy
@@ -177,41 +163,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.17
 signing_key:
 specification_version: 4
 summary: A simple modern mocking library that uses the spy pattern and checks method's
   existence and arity.
 test_files:
-- spec/spec_helper.rb
-- spec/spy/and_call_original_spec.rb
-- spec/spy/and_yield_spec.rb
-- spec/spy/any_instance_spec.rb
-- spec/spy/hash_excluding_matcher_spec.rb
-- spec/spy/hash_including_matcher_spec.rb
-- spec/spy/mutate_const_spec.rb
-- spec/spy/nil_expectation_warning_spec.rb
-- spec/spy/null_object_mock_spec.rb
-- spec/spy/partial_mock_spec.rb
-- spec/spy/passing_argument_matchers_spec.rb
-- spec/spy/serialization_spec.rb
-- spec/spy/stash_spec.rb
-- spec/spy/stub_implementation_spec.rb
-- spec/spy/stub_spec.rb
-- spec/spy/to_ary_spec.rb
 - test/integration/test_api.rb
+- test/integration/test_class_method.rb
 - test/integration/test_constant_spying.rb
 - test/integration/test_instance_method.rb
 - test/integration/test_mocking.rb
 - test/integration/test_subroutine_spying.rb
 - test/spy/test_mock.rb
 - test/spy/test_subroutine.rb
+- test/spy/test_unhook.rb
 - test/support/pen.rb
 - test/test_helper.rb

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - '2.1'
-  - '2.5'
-  - '2.7'
-  - jruby
-  - ruby-head
-  - rbx-3
-matrix:
-  allow_failures:
-      - rvm: ruby-head
-      - rvm: rbx-3
-      - rvm: jruby

data/spec/spec_helper.rb

@@ -1,41 +0,0 @@
-require "rspec/core"
-require "rspec/matchers"
-require "rspec/expectations"
-require "spy"
-require "pry"
-require "pry-nav"
-
-RSpec::Matchers.define :include_method do |expected|
-  match do |actual|
-    actual.map { |m| m.to_s }.include?(expected.to_s)
-  end
-end
-
-RSpec.configure do |config|
-  config.color_enabled = true
-  config.order = :random
-  config.run_all_when_everything_filtered = true
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.filter_run_including :focus
-  config.filter_run_excluding :broken => true
-  config.mock_with :absolutely_nothing
-
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = :expect
-  end
-
-  old_verbose = nil
-  config.before(:each, :silence_warnings) do
-    old_verbose = $VERBOSE
-    $VERBOSE = nil
-  end
-
-  config.after(:each, :silence_warnings) do
-    $VERBOSE = old_verbose
-  end
-
-  config.after(:each) do
-    Spy.teardown
-  end
-end
-