Unable to run specs with sunspot

[francescobbo]

I recently created an issue in the sunspot repository, but I believe that this may belong here too. This is the link to the original issue: sunspot/sunspot#645

After a few hours of testing I found that sunspot relies on method_missing to implement the "boolean" method, but rspec-mocks is overriding the method_missing definition in sunspot, and so it result in errors during rspec setup. Tests are perfectly working with rspec up to 2.99, but once migrated to 3.0 or 3.1 (I tried with both versions) they won't run :( I am not actually sure whether this is rspec or sunspot fault but I hope that someone will find a solution.

[myronmarston]

After a few hours of testing I found that sunspot relies on method_missing to implement the "boolean" method, but rspec-mocks is overriding the method_missing definition in sunspot

rspec-mocks only defines method_missing on a couple classes that it owns. It does not define method_missing on any external classes within sunspot.

Anyhow, I was going to ask for a backtrace (since you didn't report the actual error) but I can see you reported it in the other issue, so porting it here:

/Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/rspec-mocks-3.1.3/lib/rspec/mocks/argument_matchers.rb:60:in `boolean': wrong number of arguments (1 for 0) (ArgumentError)
    from /Users/f.boffa/Projects/promoqui-server/app/models/city.rb:33:in `block in <class:City>'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot-2.0.0/lib/sunspot/util.rb:208:in `instance_eval'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot-2.0.0/lib/sunspot/util.rb:208:in `instance_eval_with_context'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot-2.0.0/lib/sunspot/util.rb:86:in `instance_eval_or_call'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot-2.0.0/lib/sunspot/setup.rb:103:in `setup'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot-2.0.0/lib/sunspot/setup.rb:296:in `setup'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot-2.0.0/lib/sunspot.rb:166:in `setup'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/sunspot_rails-2.0.0/lib/sunspot/rails/searchable.rb:81:in `searchable'
    from /Users/f.boffa/Projects/promoqui-server/app/models/city.rb:21:in `<class:City>'
    from /Users/f.boffa/Projects/promoqui-server/app/models/city.rb:1:in `<top (required)>'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:228:in `require'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:228:in `block in require'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:213:in `load_dependency'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:228:in `require'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:329:in `require_or_load'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:462:in `load_missing_constant'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:183:in `const_missing'
    from /Users/f.boffa/Projects/promoqui-server/spec/factories/city.rb:4:in `block in <top (required)>'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/factory_girl-4.2.0/lib/factory_girl/syntax/default.rb:49:in `instance_eval'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/factory_girl-4.2.0/lib/factory_girl/syntax/default.rb:49:in `run'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/factory_girl-4.2.0/lib/factory_girl/syntax/default.rb:7:in `define'
    from /Users/f.boffa/Projects/promoqui-server/spec/factories/city.rb:3:in `<top (required)>'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:222:in `load'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:222:in `block in load'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:213:in `load_dependency'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:222:in `load'
    from /Users/f.boffa/.rbenv/versions/2.0.0-p247/lib/ruby/gems/2.0.0/gems/factory_girl-4.2.0/lib/factory_girl/find_definitions.rb:20:in `block (2 levels) in find_definitions'

According to the other issue, the code that triggers this is the boolean call in the searchable block:

class City < ActiveRecord::Base
  # [...]

  searchable :auto_index => false, :auto_remove => false do
    text :name, :stored => true
    autosuggest :city_name, :using => :name

    boolean :active
  end
  # [...]
end

The error is indicated that the boolean call is blowing up because it is trying to call RSpec::Mocks::ArgumentMatchers#boolean, which takes no arguments. This is very odd...our boolean definition is in a module, and it should only affect classes and contexts that include that module. Are you including RSpec::Mocks::ArgumentMatchers in ActiveRecord::Base or anything like that? Actually, now that I think about it, it's likely that the searchable block is instance eval'd in some other context owned by sunspot, so it sounds like RSpec::Mocks::ArgumentMatchers is being included there somehow? The other possibility is that RSpec::Mocks::ExampleMethods is being included somehow, since it itself includes RSpec::Mocks::ArgumentMatchers:

https://github.com/rspec/rspec-mocks/blob/v3.1.3/lib/rspec/mocks/example_methods.rb#L10

Are you including RSpec::Mocks::ExampleMethods anywhere? One way to troubleshoot this is to add a logging line just before the call to boolean:

  searchable :auto_index => false, :auto_remove => false do
    text :name, :stored => true
    autosuggest :city_name, :using => :name

    puts "Ancestors at boolean call site: #{singleton_class.ancestors.inspect}"
    boolean :active
  end

That should show you which modules are in the ancestor chain in which order. Can you try that and report back what you see?

[francescobbo]

Right before the backtrace:

Ancestors at boolean call site: [Sunspot::DSL::Fields, Object, RSpec::Mocks::ExampleMethods::ExpectHost, RSpec::Mocks::ExampleMethods, RSpec::Mocks::ArgumentMatchers, PP::ObjectMixin, FriendlyId::ObjectUtils, Delayed::MessageSending, ActiveSupport::Dependencies::Loadable, JSON::Ext::Generator::GeneratorMethods::Object, Kernel, BasicObject]

[francescobbo]

Reduce the application to the minimum code triggering the error (to publish a repository showing to reproduce the error), I found that deleting the grape-entity-matchers gem from the Gemfile just fix everything (Grape was used for some older APIs). At this point I suspect that I should report the problem there too 😢

[myronmarston]

So the problem is indeed in the grape-entity-matchers gem, specifically on this line:

https://github.com/agileanimal/grape-entity-matchers/blob/v1.0.0/lib/grape_entity_matchers/represent_matcher.rb#L2

rspec/mocks/standalone is only intended to be loaded in a REPL like IRB or in one-off scripts. I pushed a fix in #846 that changes that way standalone is implemented to limit what it affects to just main, and not other objects, but I recommend you work with the grape-entity-matchers author to get that require removed -- it's not needed and has other negative consequences (such as the fact that it leaves "open" an rspec-mocks scope by calling RSpec::Mocks.setup without a corresponding RSpec::Mocks.teardown -- which is an intended thing for a REPL context but not desirable in general).

[francescobbo]

Oh well, I'll open a third issue on that repository, even though it has not been updated for 5 months. For the moment I'll just remove that gem, since it wasn't even actually used 😮

Can't wait for your commit to get released and see how that gem will behave.

Thanks for your help :)