Fix RSpec/IncludeExamples offenses

Author: dvandersluis

spec/rubocop/cop/rspec/base_spec.rb

@@ -113,7 +113,7 @@ def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
         RUBY
       end
 
-      include_examples 'it detects `describe`'
+      it_behaves_like 'it detects `describe`'
     end
 
     context 'when `epic` is set as an alias to example group' do
@@ -133,7 +133,7 @@ def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
         RUBY
       end
 
-      include_examples 'it detects `describe`'
+      it_behaves_like 'it detects `describe`'
     end
   end
 end

spec/rubocop/cop/rspec/empty_line_after_hook_spec.rb

@@ -310,8 +310,8 @@
   end
 
   context 'when AllowConsecutiveOneLiners option has default value `true`' do
-    include_examples 'always require empty line after hook groups'
-    include_examples 'never allows consecutive multiline blocks'
+    it_behaves_like 'always require empty line after hook groups'
+    it_behaves_like 'never allows consecutive multiline blocks'
 
     it 'allows multiple one-liner blocks' do
       expect_offense(<<~RUBY)
@@ -381,8 +381,8 @@
   context 'when AllowConsecutiveOneLiners option `false`' do
     let(:cop_config) { { 'AllowConsecutiveOneLiners' => false } }
 
-    include_examples 'always require empty line after hook groups'
-    include_examples 'never allows consecutive multiline blocks'
+    it_behaves_like 'always require empty line after hook groups'
+    it_behaves_like 'never allows consecutive multiline blocks'
 
     it 'registers an offense for multiple one-liner same hook blocks' do
       expect_offense(<<~RUBY)

spec/rubocop/cop/rspec/hook_argument_spec.rb

@@ -29,10 +29,10 @@
   end
 
   shared_examples 'an example hook' do
-    include_examples 'ignored hooks'
-    include_examples 'detects style', 'before(:each) { foo }', 'each'
-    include_examples 'detects style', 'before(:example) { foo }', 'example'
-    include_examples 'detects style', 'before { foo }', 'implicit'
+    it_behaves_like 'ignored hooks'
+    it_behaves_like 'detects style', 'before(:each) { foo }', 'each'
+    it_behaves_like 'detects style', 'before(:example) { foo }', 'example'
+    it_behaves_like 'detects style', 'before { foo }', 'implicit'
   end
 
   context 'when EnforcedStyle is :implicit' do
@@ -87,7 +87,7 @@
       RUBY
     end
 
-    include_examples 'an example hook'
+    it_behaves_like 'an example hook'
 
     context 'when Ruby 2.7', :ruby27 do
       it 'detects :each for hooks' do
@@ -172,7 +172,7 @@
       RUBY
     end
 
-    include_examples 'an example hook'
+    it_behaves_like 'an example hook'
 
     context 'when Ruby 2.7', :ruby27 do
       it 'does not flag :each for hooks' do
@@ -257,7 +257,7 @@
       RUBY
     end
 
-    include_examples 'an example hook'
+    it_behaves_like 'an example hook'
 
     context 'when Ruby 2.7', :ruby27 do
       it 'does not flag :example for hooks' do

spec/rubocop/cop/rspec/implicit_expect_spec.rb

@@ -40,7 +40,7 @@
       expect_no_offenses('it { is_expected.not_to be_truthy }')
     end
 
-    include_examples 'detects style', 'it { should be_truthy }', 'should'
+    it_behaves_like 'detects style', 'it { should be_truthy }', 'should'
   end
 
   context 'when EnforcedStyle is should' do
@@ -89,12 +89,12 @@
       expect_no_offenses('it { should_not be_truthy }')
     end
 
-    include_examples 'detects style',
-                     'it { is_expected.to be_truthy }',
-                     'is_expected'
+    it_behaves_like 'detects style',
+                    'it { is_expected.to be_truthy }',
+                    'is_expected'
 
-    include_examples 'detects style',
-                     'it { should be_truthy }',
-                     'should'
+    it_behaves_like 'detects style',
+                    'it { should be_truthy }',
+                    'should'
   end
 end

spec/rubocop/cop/rspec/message_expectation_spec.rb

@@ -17,8 +17,8 @@
       expect_no_offenses('allow(foo).to receive(:bar)')
     end
 
-    include_examples 'detects style', 'allow(foo).to receive(:bar)',  'allow'
-    include_examples 'detects style', 'expect(foo).to receive(:bar)', 'expect'
+    it_behaves_like 'detects style', 'allow(foo).to receive(:bar)',  'allow'
+    it_behaves_like 'detects style', 'expect(foo).to receive(:bar)', 'expect'
   end
 
   context 'when EnforcedStyle is expect' do
@@ -37,7 +37,7 @@
       expect_no_offenses('expect(foo).to receive(:bar)')
     end
 
-    include_examples 'detects style', 'expect(foo).to receive(:bar)', 'expect'
-    include_examples 'detects style', 'allow(foo).to receive(:bar)',  'allow'
+    it_behaves_like 'detects style', 'expect(foo).to receive(:bar)', 'expect'
+    it_behaves_like 'detects style', 'allow(foo).to receive(:bar)',  'allow'
   end
 end

spec/rubocop/cop/rspec/message_spies_spec.rb

@@ -67,11 +67,11 @@
       expect_no_offenses('expect(foo).to have_received(:bar)')
     end
 
-    include_examples 'detects style', 'expect(foo).to receive(:bar)', 'receive'
+    it_behaves_like 'detects style', 'expect(foo).to receive(:bar)', 'receive'
 
-    include_examples 'detects style',
-                     'expect(foo).to have_received(:bar)',
-                     'have_received'
+    it_behaves_like 'detects style',
+                    'expect(foo).to have_received(:bar)',
+                    'have_received'
   end
 
   context 'when EnforcedStyle is receive' do
@@ -140,10 +140,10 @@
       expect_no_offenses('expect(foo).to receive(:bar)')
     end
 
-    include_examples 'detects style', 'expect(foo).to receive(:bar)', 'receive'
+    it_behaves_like 'detects style', 'expect(foo).to receive(:bar)', 'receive'
 
-    include_examples 'detects style',
-                     'expect(foo).to have_received(:bar)',
-                     'have_received'
+    it_behaves_like 'detects style',
+                    'expect(foo).to have_received(:bar)',
+                    'have_received'
   end
 end

spec/rubocop/cop/rspec/predicate_matcher_spec.rb

@@ -186,7 +186,7 @@
     context 'when strict is true' do
       let(:strict) { true }
 
-      include_examples 'inflected common'
+      it_behaves_like 'inflected common'
 
       it 'accepts strict checking boolean matcher' do
         expect_no_offenses(<<~RUBY)
@@ -203,7 +203,7 @@
     context 'when strict is false' do
       let(:strict) { false }
 
-      include_examples 'inflected common'
+      it_behaves_like 'inflected common'
 
       it 'registers an offense for a predicate method in actual' do
         expect_offense(<<~RUBY)
@@ -489,13 +489,13 @@
     context 'when strict is true' do
       let(:strict) { true }
 
-      include_examples 'explicit', 'be(true)', 'be(false)'
+      it_behaves_like 'explicit', 'be(true)', 'be(false)'
     end
 
     context 'when strict is false' do
       let(:strict) { false }
 
-      include_examples 'explicit', 'be_truthy', 'be_falsey'
+      it_behaves_like 'explicit', 'be_truthy', 'be_falsey'
     end
   end
 end

spec/rubocop/cop/rspec/subject_declaration_spec.rb

@@ -51,10 +51,10 @@
     end
   end
 
-  include_examples 'flag unclear subject declaration', :subject
-  include_examples 'flag unclear subject declaration', 'subject'
-  include_examples 'flag unclear subject declaration', :subject!
-  include_examples 'flag unclear subject declaration', 'subject!'
+  it_behaves_like 'flag unclear subject declaration', :subject
+  it_behaves_like 'flag unclear subject declaration', 'subject'
+  it_behaves_like 'flag unclear subject declaration', :subject!
+  it_behaves_like 'flag unclear subject declaration', 'subject!'
 
   context 'when subject helper is used directly' do
     it 'does not register an offense on named subject' do

spec/rubocop/rspec/hook_spec.rb

@@ -64,14 +64,14 @@ def hook(source)
       end
     end
 
-    include_examples 'standardizes scope', 'before(:each) { }',    :each
-    include_examples 'standardizes scope', 'around(:example) { }', :each
-    include_examples 'standardizes scope', 'after { }',            :each
+    it_behaves_like 'standardizes scope', 'before(:each) { }',    :each
+    it_behaves_like 'standardizes scope', 'around(:example) { }', :each
+    it_behaves_like 'standardizes scope', 'after { }',            :each
 
-    include_examples 'standardizes scope', 'before(:all) { }',     :context
-    include_examples 'standardizes scope', 'around(:context) { }', :context
+    it_behaves_like 'standardizes scope', 'before(:all) { }',     :context
+    it_behaves_like 'standardizes scope', 'around(:context) { }', :context
 
-    include_examples 'standardizes scope', 'after(:suite) { }', :suite
+    it_behaves_like 'standardizes scope', 'after(:suite) { }', :suite
   end
 
   describe '#metadata' do