rubocop-rspec 1.32.0 → 1.33.0

data/spec/rubocop/cop/rspec/around_block_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::AroundBlock do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/be_eql_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::BeEql do
   subject(:cop) { described_class.new }
 
@@ -8,6 +10,11 @@ RSpec.describe RuboCop::Cop::RSpec::BeEql do
       it { expect(foo).to eql(false) }
                           ^^^ Prefer `be` over `eql`.
     RUBY
+
+    expect_correction(<<-RUBY)
+      it { expect(foo).to be(true) }
+      it { expect(foo).to be(false) }
+    RUBY
   end
 
   it 'registers an offense for `eql` when argument is an integer' do
@@ -17,6 +24,11 @@ RSpec.describe RuboCop::Cop::RSpec::BeEql do
       it { expect(foo).to eql(123) }
                           ^^^ Prefer `be` over `eql`.
     RUBY
+
+    expect_correction(<<-RUBY)
+      it { expect(foo).to be(0) }
+      it { expect(foo).to be(123) }
+    RUBY
   end
 
   it 'registers an offense for `eql` when argument is a float' do
@@ -26,6 +38,11 @@ RSpec.describe RuboCop::Cop::RSpec::BeEql do
       it { expect(foo).to eql(1.23) }
                           ^^^ Prefer `be` over `eql`.
     RUBY
+
+    expect_correction(<<-RUBY)
+      it { expect(foo).to be(1.0) }
+      it { expect(foo).to be(1.23) }
+    RUBY
   end
 
   it 'registers an offense for `eql` when argument is a symbol' do
@@ -33,6 +50,10 @@ RSpec.describe RuboCop::Cop::RSpec::BeEql do
       it { expect(foo).to eql(:foo) }
                           ^^^ Prefer `be` over `eql`.
     RUBY
+
+    expect_correction(<<-RUBY)
+      it { expect(foo).to be(:foo) }
+    RUBY
   end
 
   it 'registers an offense for `eql` when argument is nil' do
@@ -40,6 +61,10 @@ RSpec.describe RuboCop::Cop::RSpec::BeEql do
       it { expect(foo).to eql(nil) }
                           ^^^ Prefer `be` over `eql`.
     RUBY
+
+    expect_correction(<<-RUBY)
+      it { expect(foo).to be(nil) }
+    RUBY
   end
 
   it 'does not register an offense for `eql` when argument is a string' do
@@ -53,8 +78,4 @@ RSpec.describe RuboCop::Cop::RSpec::BeEql do
       it { expect(foo).to_not eql(1) }
     RUBY
   end
-
-  include_examples 'autocorrect',
-                   'it { expect(foo).to eql(1) }',
-                   'it { expect(foo).to be(1) }'
 end

data/spec/rubocop/cop/rspec/be_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::Be do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/before_after_all_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::BeforeAfterAll do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/capybara/current_path_expectation_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::Capybara::CurrentPathExpectation do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::Capybara::FeatureMethods, :config do
   subject(:cop) { described_class.new(config) }
 

data/spec/rubocop/cop/rspec/context_wording_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::ContextWording, :config do
   subject(:cop) { described_class.new(config) }
 
@@ -41,6 +43,36 @@ RSpec.describe RuboCop::Cop::RSpec::ContextWording, :config do
     RUBY
   end
 
+  context 'with metadata hash' do
+    it 'finds context without separate `when` at the beginning' do
+      expect_offense(<<-RUBY)
+        context 'whenever you do', legend: true do
+                ^^^^^^^^^^^^^^^^^ Start context description with 'when', or 'with'.
+        end
+      RUBY
+    end
+  end
+
+  context 'with symbol metadata' do
+    it 'finds context without separate `when` at the beginning' do
+      expect_offense(<<-RUBY)
+        context 'whenever you do', :legend do
+                ^^^^^^^^^^^^^^^^^ Start context description with 'when', or 'with'.
+        end
+      RUBY
+    end
+  end
+
+  context 'with mixed metadata' do
+    it 'finds context without separate `when` at the beginning' do
+      expect_offense(<<-RUBY)
+        context 'whenever you do', :legend, myth: true do
+                ^^^^^^^^^^^^^^^^^ Start context description with 'when', or 'with'.
+        end
+      RUBY
+    end
+  end
+
   context 'when configured' do
     let(:cop_config) { { 'Prefixes' => %w[if] } }
 

data/spec/rubocop/cop/rspec/describe_class_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::DescribeClass do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/describe_method_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::DescribeMethod do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/describe_symbol_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::DescribeSymbol do
   subject(:cop) { described_class.new }
 

data/spec/rubocop/cop/rspec/described_class_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
   subject(:cop) { described_class.new(config) }
 
@@ -112,6 +114,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
         describe MyClass do
           Class.new  { foo = MyClass }
           Module.new { bar = MyClass }
+          Struct.new { lol = MyClass }
 
           def method
             include MyClass
@@ -121,7 +124,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
             include MyClass
           end
 
-          module MyModle
+          module MyModule
             include MyClass
           end
         end

data/spec/rubocop/cop/rspec/dialect_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::RSpec::Dialect, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) do
+    {
+      'PreferredMethods' => {
+        'context' => 'describe'
+      }
+    }
+  end
+
+  it 'allows describe blocks' do
+    expect_no_offenses(<<-RUBY)
+      describe 'display name presence' do
+      end
+    RUBY
+  end
+
+  it 'allows calling methods named context in examples' do
+    expect_no_offenses(<<-RUBY)
+      it 'tests common context invocations' do
+        expect(request.context).to be_empty?
+      end
+    RUBY
+  end
+
+  it 'registers an offense for context blocks' do
+    expect_offense(<<-RUBY)
+      context 'display name presence' do
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `describe` over `context`.
+      end
+    RUBY
+
+    expect_correction(<<-RUBY)
+      describe 'display name presence' do
+      end
+    RUBY
+  end
+
+  it 'registers an offense for RSpec.context blocks' do
+    expect_offense(<<-RUBY)
+      RSpec.context 'context' do
+      ^^^^^^^^^^^^^^^^^^^^^^^ Prefer `describe` over `context`.
+        it 'tests common context invocations' do
+          expect(request.context).to be_empty?
+        end
+      end
+    RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe 'context' do
+        it 'tests common context invocations' do
+          expect(request.context).to be_empty?
+        end
+      end
+    RUBY
+  end
+
+  context 'without preferred methods' do
+    let(:cop_config) do
+      {
+        'PreferredMethods' => {}
+      }
+    end
+
+    it 'allows all methods blocks' do
+      expect_no_offenses(<<-RUBY)
+        context 'is important' do
+          specify 'for someone to work' do
+            everyone.should have_some_leeway
+          end
+        end
+      RUBY
+    end
+  end
+end

data/spec/rubocop/cop/rspec/empty_line_after_example_group_spec.rb

@@ -13,6 +13,16 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterExampleGroup do
         end
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe Foo do
+        describe '#bar' do
+        end
+
+        describe '#baz' do
+        end
+      end
+    RUBY
   end
 
   it 'highlights single line formulations correctly' do
@@ -24,6 +34,15 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterExampleGroup do
         end
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe Foo do
+        describe('#bar') { }
+
+        describe '#baz' do
+        end
+      end
+    RUBY
   end
 
   it 'checks for empty line after context' do
@@ -36,6 +55,16 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterExampleGroup do
         end
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.context 'foo' do
+        context 'bar' do
+        end
+
+        context 'baz' do
+        end
+      end
+    RUBY
   end
 
   it 'approves empty line after describe' do
@@ -75,28 +104,18 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterExampleGroup do
         end
       end
     RUBY
-  end
 
-  bad_example = <<-RUBY
-    RSpec.describe Foo do
-      describe '#bar' do
-      end
-      describe '#baz' do
-      end
-    end
-  RUBY
-
-  good_example = <<-RUBY
-    RSpec.describe Foo do
-      describe '#bar' do
-      end
+    expect_correction(<<-RUBY)
+      if RUBY_VERSION < 2.3
+        describe 'skips checks under old ruby' do
+        end
+      else
+        describe 'first check' do
+        end
 
-      describe '#baz' do
+        describe 'second check' do
+        end
       end
-    end
-  RUBY
-
-  include_examples 'autocorrect',
-                   bad_example,
-                   good_example
+    RUBY
+  end
 end

data/spec/rubocop/cop/rspec/empty_line_after_final_let_spec.rb

@@ -12,6 +12,15 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterFinalLet do
         it { expect(a).to eq(b) }
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe User do
+        let(:a) { a }
+        let(:b) { b }
+
+        it { expect(a).to eq(b) }
+      end
+    RUBY
   end
 
   it 'check for empty line after the last `let!`' do
@@ -25,6 +34,17 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterFinalLet do
         it { expect(a).to eq(b) }
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe User do
+        let(:a) { a }
+        let!(:b) do
+          b
+        end
+
+        it { expect(a).to eq(b) }
+      end
+    RUBY
   end
 
   it 'approves empty line after let' do
@@ -60,6 +80,40 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterFinalLet do
         it { expect(a).to eq(b) }
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe User do
+        let(:a) { a }
+        let(:b) { b }
+        # end of setup
+
+        it { expect(a).to eq(b) }
+      end
+    RUBY
+  end
+
+  it 'flags missing empty line after a multiline comment after last let' do
+    expect_offense(<<-RUBY)
+      RSpec.describe User do
+        let(:a) { a }
+        let(:b) { b }
+        # a multiline comment marking
+        # the end of setup
+        ^^^^^^^^^^^^^^^^^^ Add an empty line after the last `let` block.
+        it { expect(a).to eq(b) }
+      end
+    RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe User do
+        let(:a) { a }
+        let(:b) { b }
+        # a multiline comment marking
+        # the end of setup
+
+        it { expect(a).to eq(b) }
+      end
+    RUBY
   end
 
   it 'ignores empty lines between the lets' do
@@ -74,6 +128,18 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterFinalLet do
         it { expect(a).to eq(b) }
       end
     RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe User do
+        let(:a) { a }
+
+        subject { described_class }
+
+        let!(:b) { b }
+
+        it { expect(a).to eq(b) }
+      end
+    RUBY
   end
 
   it 'handles let in tests' do
@@ -156,76 +222,18 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterFinalLet do
         end
       end
     RUBY
-  end
-
-  bad_example = <<-RUBY
-  RSpec.describe User do
-    let(:params) { foo }
-    it 'has a new line' do
-    end
-  end
-  RUBY
-
-  good_example = <<-RUBY
-  RSpec.describe User do
-    let(:params) { foo }
 
-    it 'has a new line' do
-    end
-  end
-  RUBY
-
-  include_examples 'autocorrect',
-                   bad_example,
-                   good_example
-
-  bad_example = <<-RUBY
-  RSpec.describe User do
-    let(:params) { foo }
-    # a multiline comment marking
-    # the end of setup
-    it 'has a new line' do
-    end
-  end
-  RUBY
-
-  good_example = <<-RUBY
-  RSpec.describe User do
-    let(:params) { foo }
-    # a multiline comment marking
-    # the end of setup
-
-    it 'has a new line' do
-    end
-  end
-  RUBY
-
-  include_examples 'autocorrect',
-                   bad_example,
-                   good_example
-
-  bad_example = <<-RUBY
-  RSpec.describe User do
-    let(:params) { <<-DOC }
-     I'm super annoying!
-    DOC
-    it 'has a new line' do
-    end
-  end
-  RUBY
-
-  good_example = <<-RUBY
-  RSpec.describe User do
-    let(:params) { <<-DOC }
-     I'm super annoying!
-    DOC
+    expect_correction(<<-RUBY)
+      RSpec.describe 'silly heredoc syntax' do
+        let(:foo) { <<-BAR }
+        hello
+        world
+        BAR
 
-    it 'has a new line' do
-    end
+        it 'has tricky syntax' do
+          expect(foo).to eql("  hello\n  world\n")
+        end
+      end
+    RUBY
   end
-  RUBY
-
-  include_examples 'autocorrect',
-                   bad_example,
-                   good_example
 end