Deprecate old-style matchers to avoid adding new specs using them

eregon · eregon · commit 82868a2e474f · 2026-06-06T12:34:41.000+02:00
* See ruby/spec#1350 and #80
diff --git a/lib/mspec/matchers/base.rb b/lib/mspec/matchers/base.rb
@@ -1,3 +1,5 @@
+require 'mspec/utils/deprecate'
+
 module MSpecMatchers
 end
 
diff --git a/lib/mspec/matchers/be_an_instance_of.rb b/lib/mspec/matchers/be_an_instance_of.rb
@@ -21,6 +21,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_an_instance_of(expected)
+    MSpec.deprecate __method__, '.should.instance_of?'
     BeAnInstanceOfMatcher.new(expected)
   end
 end
diff --git a/lib/mspec/matchers/be_ancestor_of.rb b/lib/mspec/matchers/be_ancestor_of.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_ancestor_of(expected)
+    MSpec.deprecate __method__, '.ancestors.should.include?'
     BeAncestorOfMatcher.new(expected)
   end
 end
diff --git a/lib/mspec/matchers/be_empty.rb b/lib/mspec/matchers/be_empty.rb
@@ -15,6 +15,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_empty
+    MSpec.deprecate __method__, '.should.empty?'
     BeEmptyMatcher.new
   end
 end
diff --git a/lib/mspec/matchers/be_false.rb b/lib/mspec/matchers/be_false.rb
@@ -15,6 +15,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_false
+    MSpec.deprecate __method__, '.should == false'
     BeFalseMatcher.new
   end
 end
diff --git a/lib/mspec/matchers/be_kind_of.rb b/lib/mspec/matchers/be_kind_of.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_kind_of(expected)
+    MSpec.deprecate __method__, '.should.is_a?'
     BeKindOfMatcher.new(expected)
   end
 end
diff --git a/lib/mspec/matchers/be_nan.rb b/lib/mspec/matchers/be_nan.rb
@@ -15,6 +15,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_nan
+    MSpec.deprecate __method__, '.should.nan?'
     BeNaNMatcher.new
   end
 end
diff --git a/lib/mspec/matchers/be_nil.rb b/lib/mspec/matchers/be_nil.rb
@@ -15,6 +15,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_nil
+    MSpec.deprecate __method__, '.should == nil'
     BeNilMatcher.new
   end
 end
diff --git a/lib/mspec/matchers/be_true.rb b/lib/mspec/matchers/be_true.rb
@@ -15,6 +15,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_true
+    MSpec.deprecate __method__, '.should == true'
     BeTrueMatcher.new
   end
 end
diff --git a/lib/mspec/matchers/eql.rb b/lib/mspec/matchers/eql.rb
@@ -21,6 +21,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def eql(expected)
+    MSpec.deprecate __method__, '.should.eql?'
     EqlMatcher.new(expected)
   end
 end
diff --git a/lib/mspec/matchers/equal.rb b/lib/mspec/matchers/equal.rb
@@ -21,6 +21,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def equal(expected)
+    MSpec.deprecate __method__, '.should.equal?'
     EqualMatcher.new(expected)
   end
 end
diff --git a/lib/mspec/matchers/have_class_variable.rb b/lib/mspec/matchers/have_class_variable.rb
@@ -7,6 +7,7 @@ class HaveClassVariableMatcher < VariableMatcher
 
 module MSpecMatchers
   private def have_class_variable(variable)
+    MSpec.deprecate __method__, '.should.class_variable_defined?'
     HaveClassVariableMatcher.new(variable)
   end
 end
diff --git a/lib/mspec/matchers/have_constant.rb b/lib/mspec/matchers/have_constant.rb
@@ -7,6 +7,7 @@ class HaveConstantMatcher < VariableMatcher
 
 module MSpecMatchers
   private def have_constant(variable)
+    MSpec.deprecate __method__, '.should.const_defined?'
     HaveConstantMatcher.new(variable)
   end
 end
diff --git a/lib/mspec/matchers/have_instance_method.rb b/lib/mspec/matchers/have_instance_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_instance_method(method, include_super = true)
+    MSpec.deprecate __method__, '.should.method_defined?'
     HaveInstanceMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/have_instance_variable.rb b/lib/mspec/matchers/have_instance_variable.rb
@@ -7,6 +7,7 @@ class HaveInstanceVariableMatcher < VariableMatcher
 
 module MSpecMatchers
   private def have_instance_variable(variable)
+    MSpec.deprecate __method__, '.should.instance_variable_defined?'
     HaveInstanceVariableMatcher.new(variable)
   end
 end
diff --git a/lib/mspec/matchers/have_method.rb b/lib/mspec/matchers/have_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_method(method, include_super = true)
+    MSpec.deprecate __method__, '.should.respond_to?'
     HaveMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/have_private_instance_method.rb b/lib/mspec/matchers/have_private_instance_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_private_instance_method(method, include_super = true)
+    MSpec.deprecate __method__, '.private_instance_methods(false).should.include?'
     HavePrivateInstanceMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/have_private_method.rb b/lib/mspec/matchers/have_private_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_private_method(method, include_super = true)
+    MSpec.deprecate __method__, '.private_methods(false).should.include?'
     HavePrivateMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/have_protected_instance_method.rb b/lib/mspec/matchers/have_protected_instance_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_protected_instance_method(method, include_super = true)
+    MSpec.deprecate __method__, '.protected_instance_methods(false).should.include?'
     HaveProtectedInstanceMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/have_public_instance_method.rb b/lib/mspec/matchers/have_public_instance_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_public_instance_method(method, include_super = true)
+    MSpec.deprecate __method__, '.public_instance_methods(false).should.include?'
     HavePublicInstanceMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/have_singleton_method.rb b/lib/mspec/matchers/have_singleton_method.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def have_singleton_method(method, include_super = true)
+    MSpec.deprecate __method__, '.singleton_methods(false).should.include?'
     HaveSingletonMethodMatcher.new method, include_super
   end
 end
diff --git a/lib/mspec/matchers/include.rb b/lib/mspec/matchers/include.rb
@@ -26,6 +26,7 @@ def negative_failure_message
 # Cannot override #include at the toplevel in MRI
 module MSpecMatchers
   private def include(*expected)
+    MSpec.deprecate __method__, '.should.include?'
     IncludeMatcher.new(*expected)
   end
 end
diff --git a/lib/mspec/matchers/infinity.rb b/lib/mspec/matchers/infinity.rb
@@ -19,10 +19,12 @@ def negative_failure_message
 
 module MSpecMatchers
   private def be_positive_infinity
+    MSpec.deprecate __method__, '.should.infinite? == 1'
     InfinityMatcher.new(1)
   end
 
   private def be_negative_infinity
+    MSpec.deprecate __method__, '.should.infinite? == -1'
     InfinityMatcher.new(-1)
   end
 end
diff --git a/lib/mspec/matchers/raise_error.rb b/lib/mspec/matchers/raise_error.rb
@@ -116,6 +116,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def raise_error(exception = Exception, message = nil, options = nil, &block)
+    MSpec.deprecate __method__, '.should.raise'
     RaiseErrorMatcher.new(exception, message, options, &block)
   end
 
diff --git a/lib/mspec/matchers/respond_to.rb b/lib/mspec/matchers/respond_to.rb
@@ -19,6 +19,7 @@ def negative_failure_message
 
 module MSpecMatchers
   private def respond_to(expected)
+    MSpec.deprecate __method__, '.should.respond_to?'
     RespondToMatcher.new(expected)
   end
 end
diff --git a/spec/fixtures/should.rb b/spec/fixtures/should.rb
@@ -40,7 +40,7 @@ def finish
 # Specs
 describe "MSpec expectation method #should" do
   it "accepts a matcher" do
-    :sym.should be_kind_of(Symbol)
+    0.4.should be_close(0.5, 0.2)
   end
 
   it "causes a failure to be recorded" do
@@ -59,7 +59,7 @@ def finish
 
 describe "MSpec expectation method #should_not" do
   it "accepts a matcher" do
-    "sym".should_not be_kind_of(Symbol)
+    0.1.should_not be_close(0.5, 0.2)
   end
 
   it "causes a failure to be recorded" do
diff --git a/spec/matchers/raise_error_spec.rb b/spec/matchers/raise_error_spec.rb
@@ -19,7 +19,7 @@ class UnexpectedException < Exception; end
     ensure_mspec_method(-> {}.method(:should))
 
     run = false
-    -> { raise ExpectedException }.should PublicMSpecMatchers.raise_error { |error|
+    -> { raise ExpectedException }.should.raise { |error|
       expect(error.class).to eq(ExpectedException)
       run = true
     }
@@ -30,7 +30,7 @@ class UnexpectedException < Exception; end
     ensure_mspec_method(-> {}.method(:should))
 
     run = false
-    -> { raise ExpectedException }.should PublicMSpecMatchers.raise_error do |error|
+    -> { raise ExpectedException }.should.raise do |error|
       expect(error.class).to eq(ExpectedException)
       run = true
     end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -62,9 +62,4 @@ def ensure_mspec_method(method)
   expect(file).to start_with(File.expand_path('../../lib/mspec', __FILE__ ))
 end
 
-PublicMSpecMatchers = Class.new {
-  include MSpecMatchers
-  public :raise_error
-}.new
-
 BACKTRACE_QUOTE = RUBY_VERSION >= "3.4" ? "'" : "`"

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+require 'mspec/utils/deprecate'`
	`2`	`+`
`1`	`3`	`module MSpecMatchers`
`2`	`4`	`end`
`3`	`5`