Repository navigation
Replace most matchers by obj.should.foo #1350
Description
Looking at this list we'd remove (or maybe deprecate first? but seems unnecessary) in MSpec and migrate usages in ruby/spec for:
be_an_instance_of(C) -> .should.instance_of?(C)
be_ancestor_of -> .ancestors.should.include?
be_empty -> .should.empty?
be_false -> .should == false
be_kind_of(C) -> .should.is_a?(C) or .should.kind_of?(C)
be_nan -> .should.nan?
be_nil -> .should == nil
be_true -> .should == true
eql -> .should.eql?
equal -> .should.equal?
have_class_variable -> .class_variables(false).should.include? BTW the matcher used inherit=true, a bug
have_constant -> .constants(false).should.include? BTW the matcher used inherit=true, a bug
have_instance_method -> .instance_methods(false).should.include? BTW the matcher used inherit=true, a bug
have_instance_variable -> .instance_variables.should.include?
have_method -> .methods(false).should.include? BTW the matcher used inherit=true, a bug
have_private_instance_method -> .private_instance_methods(false).should.include? BTW the matcher used inherit=true, a bug
have_private_method -> .private_methods(false).should.include? BTW the matcher used inherit=true, a bug
have_protected_instance_method -> .protected_instance_methods(false).should.include? BTW the matcher used inherit=true, a bug
have_public_instance_method -> .public_instance_methods(false).should.include? BTW the matcher used inherit=true, a bug
have_singleton_method -> .singleton_methods(false).should.include? BTW the matcher used inherit=true, a bug
include -> .should.include?
be_positive_infinity -> .should.infinite? == 1
be_negative_infinity -> .should.infinite? == -1
respond_to -> .should.respond_to?
We'd keep (because they cannot be expressed easily as .should.foo):
be_close
be_computed_by
be_true_or_false # maybe we should have something like `be_either(true, false)`/`be_one_of(true, false)`
block_caller
complain
include_any_of # 0 usages in ruby/spec, only used in spec/truffle/interop, probably could be replaced or moved there and then removed
match_yaml # only used in library/yaml should be moved there
output_to_fd
output
raise_error # though I would love to find a more consistent syntax, maybe `-> { ... }.should.raise(ArgumentError, "message")` since it wouldn't make sense to do `.should.raise` before and BTW Kernel#raise is a private method.
be_positive_zero # 0.0.equal? 0.0 works but relies on Flonum
be_negative_zero # (-0.0).equal?(-0.0) doesn't work on CRuby (but does on TruffleRuby). Too bad there isn't Float#signum or so
skip
Others:
equal_element -> should move to library/cgi/spec_helper.rb or so since it's only used there
The reasoning is those matchers to be removed do nothing more than just .should.foo and it's far clearer to have the method call literally in the code vs having to "deserialize RSpec notation". See this discussion and this blog post for more thoughts on this.
Right now we use a mix of both but it'd be good to be consistent.
Metadata
Metadata
Assignees
Labels
No labels
Activity
trinistr commentedon Mar 6, 2026
Good idea!
Some thoughts:
should.methodsyntax more. I think linking to it in docs would be good. And just generally point out that it's the recommended method to test stuff, instead of looking for specific matchers.match_yamlis another one that's only used inlibrary/yaml.I think there is potential in
be_one_of(*values)matcher. Even if it's rare to need it, it could be used, for example, forIO::Buffer::HOST_ENDIAN.should be_one_of(IO::Buffer::BIG_ENDIAN, IO::Buffer::LITTLE_ENDIAN).Though this relation this can easily be expressed with
[a, b].should.include?(value), so maybe there is no reason to actually have this orbe_true_or_false?eregon commentedon Mar 6, 2026
Re 1 & 2, yes, we'll need to update CONTRIBUTING.md to reflect this and why not link to the blog post.
good point, updated
Indeed and that's used in some places, but it's not ideal because it reverses the order (the expected value should be on the right and not the left).
So yeah I think we should add
be_one_ofor similar with a better name.Maybe
be_in(a, b)orbe_amongst(a, b)orbe_one_of(a, b).Python has
3 in [1,3] # => Truebut not sure what's a good way to express that in Ruby. I think there was a proposal once to haveObject#in?or so. EDIT: https://bugs.ruby-lang.org/issues/3845eregon commentedon May 7, 2026
This is basically all done now, all usages of matchers to be migrated are migrated (though they don't warn for deprecation yet), I added
.should.raiseand updated CONTRIBUTING.md.What's left is:
be_inor soDeprecate old-style matchers to avoid adding new specs using them
Add specs for Kernel#p return values