Undefined method error in restore_original_visibility

[ojab]

Subject of the issue

It requires running rails application and I'm not that interested to minimize testcase more since I don't use ruby-2.2 and encountered this by making PR to another project.

require 'rails'
require 'rspec'

module Dummy
  class Application < Rails::Application
  end
end

Dummy::Application.initialize!



describe 'fail' do
  subject { {} }

  it do
    expect(subject).to receive(:except)
    subject.except
  end
end

Your environment

• Ruby version: 2.2.10
• rspec-mocks version: 3.9.1
• rails version: 5.2.2

Steps to reproduce

bundle exec rspec /tmp/tst.rb

Expected behavior

No errors

Actual behavior

Failures:

  1) fail is expected to receive except(*(any args)) 1 time
     Failure/Error: object_singleton_class.__send__(@original_visibility, method_name)

     NameError:
       undefined method `except' for class `Hash'
     # /home/ojab/.rvm/gems/ruby-2.2.10/gems/rspec-mocks-3.9.1/lib/rspec/mocks/method_double.rb:108:in `public'

[JonRowe]

Rails is messing with the hash here, causing a confusing error, this might need to be transferred back to rspec-mocks if its fixable.

[pirj]

Off the top of my head you need to require rails/all, or specifically active_support/core_ext/hash that defines Hash#extract before running the test.

Can you confirm that {}.except(:a) does not error out if you add it as the first line of your test example, @ojab ?

[ojab]

It fails only if expectation is set, so subject.except(:a) on the first line works.
I've tried to require rails in different combinations (including rails/all) trying to minimize it and the error is not reproducible, so rails app initialization is the key.

[pirj]

Less trouble - I can reproduce on Ruby 2.6.3 as well.

[pirj]

I could find a way to work this around:

      # @private
      def restore_original_visibility
        return unless @original_visibility &&
          MethodReference.method_defined_at_any_visibility?(object_singleton_class, @method_name)
+       return if MethodReference.instance_method_visibility_for(object_singleton_class, @method_name) == @original_visibility

but I couldn't understand what the root cause is.

And as @ojab you mention, it's surely caused by something that Dummy::Application.initialize! is doing.

@JonRowe By looking at RSpec::Mocks::MethodDouble I (probably naïvely) think that it can be refactored to always prepend a module instead of dealing with the singleton class directly, and remove_method from this module. This will automatically restore the visibility of the original method.
Does it make sense to work around now, and refactor sometimes later when we drop support for Rubies that don't support prepend?

[pirj]

Wondering if this is somehow related rspec/rspec-mocks#1218 and could be a better solution.
except is defined by reopening the class, no tricks.

[JonRowe]

The root issue is that the hash when we access it doesn't respond to the method but seems to.

[pirj]

It does AFAIR, you can call except on {} with no issue.

[JonRowe]

Sure, you can, but not in this particular scenario.

Probably because the hash is evaluated when the reproduction is loaded, and is thus before Rails installs its extensions.
This is why manually requiring extensions instead fixes it.

[JonRowe]

As with all such issues with rails, you need to have loaded the extensions before parsing literals.

[fledman]

@pirj I believe this is the root cause: rspec/rspec-mocks#1395