rubocop-rspec 1.27.0 → 1.28.0

data/lib/rubocop/cop/rspec/missing_example_group_argument.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that the first argument to an example group is not empty.
+      #
+      # @example
+      #   # bad
+      #   describe do
+      #   end
+      #
+      #   RSpec.describe do
+      #   end
+      #
+      #   # good
+      #   describe TestedClass do
+      #   end
+      #
+      #   describe "A feature example" do
+      #   end
+      class MissingExampleGroupArgument < Cop
+        MSG = 'The first argument to `%<method>s` should not be empty.'.freeze
+
+        def on_block(node)
+          return unless example_group?(node)
+          return if node.send_node.arguments?
+
+          add_offense(node, location: :expression,
+                            message: format(MSG, method: node.method_name))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/multiple_expectations.rb

@@ -77,7 +77,7 @@ module RuboCop
         private
 
         def example_with_aggregated_failures?(node)
-          example = node.children.first
+          example = node.send_node
 
           (aggregated_failures_by_default? ||
             with_aggregated_failures?(example)) &&

data/lib/rubocop/cop/rspec/multiple_subjects.rb

@@ -36,10 +36,6 @@ module RuboCop
       class MultipleSubjects < Cop
         MSG = 'Do not set more than one subject per example group'.freeze
 
-        def_node_matcher :named_subject?, <<-PATTERN
-          (block (send nil? :subject $sym) args ...)
-        PATTERN
-
         def on_block(node)
           return unless example_group?(node)
 
@@ -62,6 +58,10 @@ module RuboCop
 
         private
 
+        def named_subject?(node)
+          node.send_node.arguments?
+        end
+
         def rename_autocorrect(node)
           lambda do |corrector|
             corrector.replace(node.send_node.loc.selector, 'let')

data/lib/rubocop/cop/rspec/nested_groups.rb

@@ -104,7 +104,7 @@ module RuboCop
           find_nested_contexts(node.parent) do |context, nesting|
             self.max = nesting
             add_offense(
-              context.children.first,
+              context.send_node,
               location: :expression,
               message: message(nesting)
             )

data/lib/rubocop/cop/rspec/pending.rb

@@ -64,7 +64,7 @@ module RuboCop
         end
 
         def skip_symbol?(symbol_node)
-          symbol_node == SKIP_SYMBOL || symbol_node == PENDING_SYMBOL
+          [SKIP_SYMBOL, PENDING_SYMBOL].include?(symbol_node)
         end
       end
     end

data/lib/rubocop/cop/rspec/receive_never.rb

@@ -0,0 +1,43 @@
+module RuboCop
+  module Cop
+    module RSpec
+      # Prefer `not_to receive(...)` over `receive(...).never`.
+      #
+      # @example
+      #
+      #     # bad
+      #     expect(foo).to receive(:bar).never
+      #
+      #     # good
+      #     expect(foo).not_to receive(:bar)
+      #
+      class ReceiveNever < Cop
+        include RangeHelp
+
+        MSG = 'Use `not_to receive` instead of `never`.'.freeze
+
+        def_node_search :method_on_stub?, '(send nil? :receive ...)'
+
+        def on_send(node)
+          return unless node.method_name == :never && method_on_stub?(node)
+
+          add_offense(
+            node,
+            location: :selector
+          )
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.parent.loc.selector, 'not_to')
+            range = range_between(
+              node.loc.dot.begin_pos,
+              node.loc.selector.end_pos
+            )
+            corrector.remove(range)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/scattered_let.rb

@@ -29,8 +29,6 @@ module RuboCop
       class ScatteredLet < Cop
         MSG = 'Group all let/let! blocks in the example group together.'.freeze
 
-        def_node_matcher :let?, Helpers::ALL.block_pattern
-
         def on_block(node)
           return unless example_group_with_body?(node)
 

data/lib/rubocop/cop/rspec/shared_context.rb

@@ -68,11 +68,11 @@ module RuboCop
 
         def on_block(node)
           context_with_only_examples(node) do
-            add_shared_item_offense(node, MSG_EXAMPLES)
+            add_shared_item_offense(node.send_node, MSG_EXAMPLES)
           end
 
           examples_with_only_context(node) do
-            add_shared_item_offense(node, MSG_CONTEXT)
+            add_shared_item_offense(node.send_node, MSG_CONTEXT)
           end
         end
 
@@ -100,7 +100,7 @@ module RuboCop
 
         def add_shared_item_offense(node, message)
           add_offense(
-            node.children.first,
+            node,
             location: :expression,
             message: message
           )

data/lib/rubocop/cop/rspec/void_expect.rb

@@ -44,7 +44,7 @@ module RuboCop
           parent = expect.parent
           return true unless parent
           return true if parent.begin_type?
-          return true if parent.block_type? && parent.children[2] == expect
+          return true if parent.block_type? && parent.body == expect
         end
       end
     end

data/lib/rubocop/cop/rspec_cops.rb

@@ -1,9 +1,8 @@
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
 
+require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/create_list'
-require_relative 'rspec/factory_bot/dynamic_attribute_defined_statically'
-require_relative 'rspec/factory_bot/static_attribute_defined_dynamically'
 
 begin
   require_relative 'rspec/rails/http_status'
@@ -20,9 +19,9 @@ require_relative 'rspec/be_eql'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/context_wording'
 require_relative 'rspec/describe_class'
-require_relative 'rspec/described_class'
 require_relative 'rspec/describe_method'
 require_relative 'rspec/describe_symbol'
+require_relative 'rspec/described_class'
 require_relative 'rspec/empty_example_group'
 require_relative 'rspec/empty_line_after_example_group'
 require_relative 'rspec/empty_line_after_final_let'
@@ -50,6 +49,7 @@ require_relative 'rspec/let_setup'
 require_relative 'rspec/message_chain'
 require_relative 'rspec/message_expectation'
 require_relative 'rspec/message_spies'
+require_relative 'rspec/missing_example_group_argument'
 require_relative 'rspec/multiple_describes'
 require_relative 'rspec/multiple_expectations'
 require_relative 'rspec/multiple_subjects'
@@ -60,6 +60,7 @@ require_relative 'rspec/overwriting_setup'
 require_relative 'rspec/pending'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/receive_counts'
+require_relative 'rspec/receive_never'
 require_relative 'rspec/repeated_description'
 require_relative 'rspec/repeated_example'
 require_relative 'rspec/return_from_stub'

data/lib/rubocop/rspec/align_let_brace.rb

@@ -4,9 +4,7 @@ module RuboCop
   module RSpec
     # Shared behavior for aligning braces for single line lets
     class AlignLetBrace
-      extend NodePattern::Macros
-
-      def_node_matcher :let?, Language::Helpers::ALL.block_pattern
+      include RuboCop::RSpec::Language::NodePattern
 
       def initialize(root, token)
         @root  = root

data/lib/rubocop/rspec/blank_line_separation.rb

@@ -25,6 +25,12 @@ module RuboCop
         source_range(processed_source.buffer, last_line, start, content_length)
       end
 
+      def last_child?(node)
+        return true unless node.parent && node.parent.begin_type?
+
+        node.equal?(node.parent.children.last)
+      end
+
       def autocorrect(node)
         lambda do |corrector|
           missing_separating_line(node) do |location|

data/lib/rubocop/rspec/example_group.rb

@@ -14,13 +14,6 @@ module RuboCop
         ExampleGroups::ALL + SharedGroups::ALL + Includes::ALL
       ).block_pattern
 
-      # @!method hook?(node)
-      #
-      #   Detect if node is `before`, `after`, `around`
-      def_node_matcher :hook?, Hooks::ALL.block_pattern
-
-      def_node_matcher :subject?, Subject::ALL.block_pattern
-
       def subjects
         subjects_in_scope(node)
       end

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -14,6 +14,12 @@ module RuboCop
         PATTERN
 
         def_node_matcher :example?, Examples::ALL.block_pattern
+
+        def_node_matcher :hook?, Hooks::ALL.block_pattern
+
+        def_node_matcher :let?, Helpers::ALL.block_pattern
+
+        def_node_matcher :subject?, Subject::ALL.block_pattern
       end
     end
   end

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.27.0'.freeze
+      STRING = '1.28.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.version = RuboCop::RSpec::Version::STRING
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.require_paths = ['lib']
   spec.files = Dir[
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
     'documentation_uri' => 'https://rubocop-rspec.readthedocs.io/'
   }
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.56.0'
+  spec.add_runtime_dependency 'rubocop', '>= 0.58.0'
 
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rake'

data/spec/project/project_requires_spec.rb

@@ -1,8 +1,18 @@
 RSpec.describe 'Project requires' do
   it 'alphabetizes cop requires' do
-    source   = SpecHelper::ROOT.join('lib', 'rubocop-rspec.rb').read
-    requires = source.split("\n").grep(%r{rubocop/cop/rspec/[^(?:cop)]})
+    source   = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec_cops.rb')
+    captures = source.read.scan(%r{^(require_relative 'rspec/(.*?/)?(.*?)')$})
 
-    expect(requires.join("\n")).to eql(requires.sort.join("\n"))
+    require_statements = captures.map(&:first)
+    sorted_require_statements =
+      captures.sort_by do |_require_statement, cop_category, name|
+        [cop_category || 'rspec', name]
+      end.map(&:first)
+
+    aggregate_failures do
+      # Sanity check that we actually discovered require statements.
+      expect(captures).not_to be_empty
+      expect(require_statements).to eql(sorted_require_statements)
+    end
   end
 end

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

@@ -1,5 +1,5 @@
-RSpec.describe RuboCop::Cop::RSpec::BeforeAfterAll, :config do
-  subject(:cop) { described_class.new(config) }
+RSpec.describe RuboCop::Cop::RSpec::BeforeAfterAll do
+  subject(:cop) { described_class.new }
 
   def message(hook)
     "Beware of using `#{hook}` as it may cause state to leak between tests. "\

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

@@ -62,6 +62,21 @@ RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterExampleGroup do
     RUBY
   end
 
+  it 'handles describes in an if block' do
+    expect_offense(<<-RUBY)
+      if RUBY_VERSION < 2.3
+        describe 'skips checks under old ruby' do
+        end
+      else
+        describe 'first check' do
+        end
+        ^^^ Add an empty line after `describe`.
+        describe 'second check' do
+        end
+      end
+    RUBY
+  end
+
   bad_example = <<-RUBY
     RSpec.describe Foo do
       describe '#bar' do

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

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::RSpec::FactoryBot::AttributeDefinedStatically do # rubocop:disable Metrics/LineLength
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense for offending code' do
+    expect_offense(<<-RUBY)
+      FactoryBot.define do
+        factory :post do
+          title "Something"
+          ^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          published_at 1.day.from_now
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          status [:draft, :published].sample
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          created_at 1.day.ago
+          ^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          update_times [Time.current]
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          meta_tags(foo: Time.current)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+        end
+      end
+    RUBY
+  end
+
+  it 'registers an offense in a trait' do
+    expect_offense(<<-RUBY)
+      FactoryBot.define do
+        factory :post do
+          trait :published do
+            title "Something"
+            ^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+            published_at 1.day.from_now
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          end
+        end
+      end
+    RUBY
+  end
+
+  it 'registers an offense in a transient block' do
+    expect_offense(<<-RUBY)
+      FactoryBot.define do
+        factory :post do
+          transient do
+            title "Something"
+            ^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+            published_at 1.day.from_now
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use a block to declare attribute values.
+          end
+        end
+      end
+    RUBY
+  end
+
+  it 'accepts valid factory definitions' do
+    expect_no_offenses(<<-RUBY)
+      FactoryBot.define do
+        factory :post do
+          trait :published do
+            published_at { 1.day.from_now }
+          end
+          created_at { 1.day.ago }
+          status { :draft }
+          comments_count { 0 }
+          title { "Static" }
+          description { FFaker::Lorem.paragraph(10) }
+          recent_statuses { [] }
+          tags { { like_count: 2 } }
+
+          before(:create, &:initialize_something)
+          after(:create, &:rebuild_cache)
+        end
+      end
+    RUBY
+  end
+
+  it 'does not add offense if out of factory bot block' do
+    expect_no_offenses(<<-RUBY)
+      status [:draft, :published].sample
+      published_at 1.day.from_now
+      created_at 1.day.ago
+      update_times [Time.current]
+      meta_tags(foo: Time.current)
+    RUBY
+  end
+
+  it 'accepts valid association definitions' do
+    expect_no_offenses(<<-RUBY)
+      FactoryBot.define do
+        factory :post do
+          author age: 42, factory: :user
+        end
+      end
+    RUBY
+  end
+
+  it 'accepts valid sequence definition' do
+    expect_no_offenses(<<-RUBY)
+      FactoryBot.define do
+        factory :post do
+          sequence :negative_numbers, &:-@
+        end
+      end
+    RUBY
+  end
+
+  bad = <<-RUBY
+    FactoryBot.define do
+      factory :post do
+        title "Something"
+        comments_count 0
+        tag Tag::MAGIC
+        recent_statuses []
+        status([:draft, :published].sample)
+        published_at 1.day.from_now
+        created_at(1.day.ago)
+        updated_at Time.current
+        update_times [Time.current]
+        meta_tags(foo: Time.current)
+        other_tags({ foo: Time.current })
+        options color: :blue
+
+        trait :old do
+          published_at 1.week.ago
+        end
+      end
+    end
+  RUBY
+
+  corrected = <<-RUBY
+    FactoryBot.define do
+      factory :post do
+        title { "Something" }
+        comments_count { 0 }
+        tag { Tag::MAGIC }
+        recent_statuses { [] }
+        status { [:draft, :published].sample }
+        published_at { 1.day.from_now }
+        created_at { 1.day.ago }
+        updated_at { Time.current }
+        update_times { [Time.current] }
+        meta_tags { { foo: Time.current } }
+        other_tags { { foo: Time.current } }
+        options { { color: :blue } }
+
+        trait :old do
+          published_at { 1.week.ago }
+        end
+      end
+    end
+  RUBY
+
+  include_examples 'autocorrect', bad, corrected
+end