rubocop-rspec 1.24.0 → 1.25.0

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.24.0'.freeze
+      STRING = '1.25.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
     Code style checking for RSpec files.
     A plugin for the RuboCop code style enforcing & linting tool.
   DESCRIPTION
-  spec.homepage = 'http://github.com/backus/rubocop-rspec'
+  spec.homepage = 'https://github.com/rubocop-rspec/rubocop-rspec'
   spec.authors = ['John Backus', 'Ian MacLeod', 'Nils Gemeinhardt']
   spec.email = [
     'johncbackus@gmail.com',
@@ -32,6 +32,11 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
+  spec.metadata = {
+    'changelog_uri' => 'https://github.com/rubocop-rspec/rubocop-rspec/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://rubocop-rspec.readthedocs.io/'
+  }
+
   spec.add_runtime_dependency 'rubocop', '>= 0.53.0'
 
   spec.add_development_dependency 'rack'

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

@@ -0,0 +1,33 @@
+RSpec.describe RuboCop::Cop::RSpec::Be do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense for `be` without an argument' do
+    expect_offense(<<-RUBY)
+      it { expect(foo).to be }
+                          ^^ Don't use `be` without an argument.
+    RUBY
+  end
+
+  it 'registers an offense for not_to be' do
+    expect_offense(<<-RUBY)
+      it { expect(foo).not_to be }
+                              ^^ Don't use `be` without an argument.
+      it { expect(foo).to_not be }
+                              ^^ Don't use `be` without an argument.
+    RUBY
+  end
+
+  it 'allows `be` with an argument' do
+    expect_no_offenses(<<-RUBY)
+      it { expect(foo).to be(1) }
+      it { expect(foo).not_to be(0) }
+    RUBY
+  end
+
+  it 'allows specific `be_` matchers' do
+    expect_no_offenses(<<-RUBY)
+      it { expect(foo).to be_truthy }
+      it { expect(foo).not_to be_falsy }
+    RUBY
+  end
+end

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

@@ -1,38 +1,50 @@
-RSpec.describe RuboCop::Cop::RSpec::Capybara::FeatureMethods do
-  subject(:cop) { described_class.new }
+RSpec.describe RuboCop::Cop::RSpec::Capybara::FeatureMethods, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) { { 'EnabledMethods' => [] } }
 
   it 'flags violations for `background`' do
     expect_offense(<<-RUBY)
-      background do; end
-      ^^^^^^^^^^ Use `before` instead of `background`.
+      describe 'some feature' do
+        background do; end
+        ^^^^^^^^^^ Use `before` instead of `background`.
+      end
     RUBY
   end
 
   it 'flags violations for `scenario`' do
     expect_offense(<<-RUBY)
-      scenario 'Foo' do; end
-      ^^^^^^^^ Use `it` instead of `scenario`.
+      RSpec.describe 'some feature' do
+        scenario 'Foo' do; end
+        ^^^^^^^^ Use `it` instead of `scenario`.
+      end
     RUBY
   end
 
   it 'flags violations for `xscenario`' do
     expect_offense(<<-RUBY)
-      RSpec.xscenario 'Foo' do; end
-            ^^^^^^^^^ Use `xit` instead of `xscenario`.
+      describe 'Foo' do
+        RSpec.xscenario 'Baz' do; end
+              ^^^^^^^^^ Use `xit` instead of `xscenario`.
+      end
     RUBY
   end
 
   it 'flags violations for `given`' do
     expect_offense(<<-RUBY)
-      given(:foo) { :foo }
-      ^^^^^ Use `let` instead of `given`.
+      RSpec.describe 'Foo' do
+        given(:foo) { :foo }
+        ^^^^^ Use `let` instead of `given`.
+      end
     RUBY
   end
 
   it 'flags violations for `given!`' do
     expect_offense(<<-RUBY)
-      given!(:foo) { :foo }
-      ^^^^^^ Use `let!` instead of `given!`.
+      describe 'Foo' do
+        given!(:foo) { :foo }
+        ^^^^^^ Use `let!` instead of `given!`.
+      end
     RUBY
   end
 
@@ -53,10 +65,55 @@ RSpec.describe RuboCop::Cop::RSpec::Capybara::FeatureMethods do
     RUBY
   end
 
-  include_examples 'autocorrect', 'background { }',    'before { }'
-  include_examples 'autocorrect', 'scenario { }',      'it { }'
-  include_examples 'autocorrect', 'xscenario { }',     'xit { }'
-  include_examples 'autocorrect', 'given(:foo) { }',   'let(:foo) { }'
-  include_examples 'autocorrect', 'given!(:foo) { }',  'let!(:foo) { }'
-  include_examples 'autocorrect', 'RSpec.feature { }', 'RSpec.describe { }'
+  it 'ignores feature calls outside spec' do
+    expect_no_offenses(<<-RUBY)
+      FactoryBot.define do
+        factory :company do
+          feature { "a company" }
+          background { Faker::Lorem.sentence }
+        end
+      end
+    RUBY
+  end
+
+  context 'with configured `EnabledMethods`' do
+    let(:cop_config) { { 'EnabledMethods' => %w[feature] } }
+
+    it 'ignores usage of the enabled method' do
+      expect_no_offenses(<<-RUBY)
+        RSpec.feature 'feature is enabled' do; end
+      RUBY
+    end
+
+    it 'flags other methods' do
+      expect_offense(<<-RUBY)
+        RSpec.feature 'feature is enabled' do
+          given(:foo) { :foo }
+          ^^^^^ Use `let` instead of `given`.
+        end
+      RUBY
+    end
+  end
+
+  shared_examples 'autocorrect_spec' do |original, corrected|
+    original = <<-RUBY
+      describe Foo do
+        #{original}
+      end
+    RUBY
+    corrected = <<-RUBY
+      describe Foo do
+        #{corrected}
+      end
+    RUBY
+
+    include_examples 'autocorrect', original, corrected
+  end
+
+  include_examples 'autocorrect_spec', 'background { }',    'before { }'
+  include_examples 'autocorrect_spec', 'scenario { }',      'it { }'
+  include_examples 'autocorrect_spec', 'xscenario { }',     'xit { }'
+  include_examples 'autocorrect_spec', 'given(:foo) { }',   'let(:foo) { }'
+  include_examples 'autocorrect_spec', 'given!(:foo) { }',  'let!(:foo) { }'
+  include_examples 'autocorrect_spec', 'RSpec.feature { }', 'RSpec.describe { }'
 end

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

@@ -23,10 +23,6 @@ RSpec.describe RuboCop::Cop::RSpec::Cop do
     stub_const('RuboCop::RSpec', Module.new)
     # rubocop:disable ClassAndModuleChildren
     class RuboCop::RSpec::FakeCop < described_class
-      def self.name
-        'RuboCop::RSpec::FakeCop'
-      end
-
       def on_send(node)
         add_offense(node, location: :expression, message: 'I flag everything')
       end

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

@@ -190,7 +190,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
     end
 
     it 'checks for the use of described class with module' do
-      skip
+      pending
 
       expect_offense(<<-RUBY)
         module MyNamespace

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

@@ -78,5 +78,13 @@ RSpec.describe RuboCop::Cop::RSpec::ExampleWithoutDescription, :config do
         ^^ Add a description.
       RUBY
     end
+
+    it 'ignores `it` with a description' do
+      expect_no_offenses(<<-RUBY)
+        it 'is good' do
+          expect(subject).to be_good
+        end
+      RUBY
+    end
   end
 end

data/spec/rubocop/cop/rspec/factory_bot/create_list_spec.rb

@@ -0,0 +1,140 @@
+RSpec.describe RuboCop::Cop::RSpec::FactoryBot::CreateList, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) do
+    { 'EnforcedStyle' => enforced_style }
+  end
+
+  context 'when EnforcedStyle is :create_list' do
+    let(:enforced_style) { :create_list }
+
+    it 'flags usage of n.times with no arguments' do
+      expect_offense(<<-RUBY)
+        3.times { create :user }
+        ^^^^^^^ Prefer create_list.
+      RUBY
+    end
+
+    it 'flags usage of n.times when FactoryGirl.create is used' do
+      expect_offense(<<-RUBY)
+        3.times { FactoryGirl.create :user }
+        ^^^^^^^ Prefer create_list.
+      RUBY
+    end
+
+    it 'flags usage of n.times when FactoryBot.create is used' do
+      expect_offense(<<-RUBY)
+        3.times { FactoryBot.create :user }
+        ^^^^^^^ Prefer create_list.
+      RUBY
+    end
+
+    it 'ignores create method of other object' do
+      expect_no_offenses(<<-RUBY)
+        3.times { SomeFactory.create :user }
+      RUBY
+    end
+
+    it 'ignores create in other block' do
+      expect_no_offenses(<<-RUBY)
+        allow(User).to receive(:create) { create :user }
+      RUBY
+    end
+
+    it 'flags n.times with argument' do
+      expect_offense(<<-RUBY)
+        3.times { |n| create :user, created_at: n.days.ago }
+        ^^^^^^^ Prefer create_list.
+      RUBY
+    end
+
+    it 'ignores n.times when there is no create call inside' do
+      expect_no_offenses(<<-RUBY)
+        3.times { do_something }
+      RUBY
+    end
+
+    it 'ignores n.times when there is other calls but create' do
+      expect_no_offenses(<<-RUBY)
+        used_passwords = []
+        3.times do
+          u = create :user
+          expect(used_passwords).not_to include(u.password)
+          used_passwords << u.password
+        end
+      RUBY
+    end
+
+    it 'flags FactoryGirl.create calls with a block' do
+      expect_offense(<<-RUBY)
+        3.times do
+        ^^^^^^^ Prefer create_list.
+          create(:user) { |user| create :account, user: user }
+        end
+      RUBY
+    end
+
+    include_examples 'autocorrect',
+                     '5.times { create :user }',
+                     'create_list :user, 5'
+
+    include_examples 'autocorrect',
+                     '5.times { create(:user, :trait) }',
+                     'create_list(:user, 5, :trait)'
+
+    include_examples 'autocorrect',
+                     '5.times { create :user, :trait, key: val }',
+                     'create_list :user, 5, :trait, key: val'
+
+    include_examples 'autocorrect',
+                     '5.times { FactoryGirl.create :user }',
+                     'FactoryGirl.create_list :user, 5'
+  end
+
+  context 'when EnforcedStyle is :n_times' do
+    let(:enforced_style) { :n_times }
+
+    it 'flags usage of create_list' do
+      expect_offense(<<-RUBY)
+        create_list :user, 3
+        ^^^^^^^^^^^ Prefer 3.times.
+      RUBY
+    end
+
+    it 'flags usage of FactoryGirl.create_list' do
+      expect_offense(<<-RUBY)
+       FactoryGirl.create_list :user, 3
+                   ^^^^^^^^^^^ Prefer 3.times.
+      RUBY
+    end
+
+    it 'flags usage of FactoryGirl.create_list with a block' do
+      expect_offense(<<-RUBY)
+       FactoryGirl.create_list(:user, 3) { |user| user.points = rand(1000) }
+                   ^^^^^^^^^^^ Prefer 3.times.
+      RUBY
+    end
+
+    it 'ignores create method of other object' do
+      expect_no_offenses(<<-RUBY)
+        SomeFactory.create_list :user, 3
+      RUBY
+    end
+
+    include_examples 'autocorrect',
+                     'create_list :user, 5',
+                     '5.times { create :user }'
+
+    include_examples 'autocorrect',
+                     'create_list(:user, 5, :trait)',
+                     '5.times { create(:user, :trait) }'
+
+    include_examples 'autocorrect',
+                     'create_list :user, 5, :trait, key: val',
+                     '5.times { create :user, :trait, key: val }'
+
+    include_examples 'autocorrect',
+                     'FactoryGirl.create_list :user, 5',
+                     '5.times { FactoryGirl.create :user }'
+  end
+end

data/spec/rubocop/cop/rspec/factory_bot/dynamic_attribute_defined_statically_spec.rb

@@ -55,7 +55,6 @@ RSpec.describe RuboCop::Cop::RSpec::FactoryBot::DynamicAttributeDefinedStaticall
               comments_count 0
               title "Static"
               description { FFaker::Lorem.paragraph(10) }
-              tag Tag::MAGIC
               recent_statuses [:published, :draft]
               meta_tags(like_count: 2)
               other_tags({ foo: nil })
@@ -67,6 +66,17 @@ RSpec.describe RuboCop::Cop::RSpec::FactoryBot::DynamicAttributeDefinedStaticall
         RUBY
       end
 
+      it 'accepts const as a static value' do
+        expect_no_offenses(<<-RUBY)
+          #{factory_bot}.define do
+            factory(:post, class: PrivatePost) do
+              tag Tag::MAGIC
+              options({priority: Priotity::HIGH})
+            end
+          end
+        RUBY
+      end
+
       it 'does not add offense if out of factory girl block' do
         expect_no_offenses(<<-RUBY)
           status [:draft, :published].sample

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

@@ -22,6 +22,21 @@ RSpec.describe RuboCop::Cop::RSpec::NestedGroups, :config do
     RUBY
   end
 
+  it 'support --auto-gen-config' do
+    inspect_source(<<-RUBY, 'spec/foo_spec.rb')
+      describe MyClass do
+        context 'when foo' do
+          context 'when bar' do
+            context 'when baz' do
+            end
+          end
+        end
+      end
+    RUBY
+
+    expect(cop.config_to_allow_offenses).to eq('Max' => 4)
+  end
+
   it 'ignores non-spec context methods' do
     expect_no_offenses(<<-RUBY)
       class MyThingy

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

@@ -0,0 +1,162 @@
+RSpec.describe RuboCop::Cop::RSpec::Pending do
+  subject(:cop) { described_class.new }
+
+  it 'flags xcontext' do
+    expect_offense(<<-RUBY)
+      xcontext 'test' do
+      ^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags xdescribe' do
+    expect_offense(<<-RUBY)
+      xdescribe 'test' do
+      ^^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags xexample' do
+    expect_offense(<<-RUBY)
+      xexample 'test' do
+      ^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags xfeature' do
+    expect_offense(<<-RUBY)
+      xfeature 'test' do
+      ^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags xit' do
+    expect_offense(<<-RUBY)
+      xit 'test' do
+      ^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags xscenario' do
+    expect_offense(<<-RUBY)
+      xscenario 'test' do
+      ^^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags xspecify' do
+    expect_offense(<<-RUBY)
+      xspecify 'test' do
+      ^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags skip inside of an it' do
+    expect_offense(<<-RUBY)
+      it 'test' do
+        skip
+        ^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags skip blocks' do
+    expect_offense(<<-RUBY)
+      skip 'test' do
+      ^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags blocks with skip symbol metadata' do
+    expect_offense(<<-RUBY)
+      it 'test', :skip do
+      ^^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags blocks with pending symbol metadata' do
+    expect_offense(<<-RUBY)
+      it 'test', :pending do
+      ^^^^^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags blocks with skip: true metadata' do
+    expect_offense(<<-RUBY)
+      it 'test', skip: true do
+      ^^^^^^^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'flags pending blocks' do
+    expect_offense(<<-RUBY)
+      pending 'test' do
+      ^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
+  it 'does not flag describe' do
+    expect_no_offenses(<<-RUBY)
+      describe 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag example' do
+    expect_no_offenses(<<-RUBY)
+      example 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag scenario' do
+    expect_no_offenses(<<-RUBY)
+      scenario 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag specify' do
+    expect_no_offenses(<<-RUBY)
+      specify 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag feature' do
+    expect_no_offenses(<<-RUBY)
+      feature 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag context' do
+    expect_no_offenses(<<-RUBY)
+      context 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag it' do
+    expect_no_offenses(<<-RUBY)
+      it 'test' do; end
+    RUBY
+  end
+
+  it 'does not flag it with skip: false metadata' do
+    expect_no_offenses(<<-RUBY)
+      it 'test', skip: false do; end
+    RUBY
+  end
+
+  it 'does not flag example_group' do
+    expect_no_offenses(<<-RUBY)
+      example_group 'test' do; end
+    RUBY
+  end
+end