rubocop-rspec 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db6a354c4b2a3ba18944c5a6fc3ce076eaec380b3f84b67d3a825ab81a2f18a2
-  data.tar.gz: c15d5bb4a019e0ff6d419058e136959aa54af22a409e302c4cbd012f06960ba6
+  metadata.gz: 63bb2b52f05acc607af023c9e7afa5375d5815cf026b73fda3dc10c8648806d2
+  data.tar.gz: c0bf3717a359f99ec9dd9519f5897c95dcc3e35f592baaad3dc037f1ae25c7d8
 SHA512:
-  metadata.gz: cd09459ea1199299104e462a6592ffe6ecba612f6560e4f5003c13c302cf47a9b21b5da186cb7237378c2187f83c63894fb0a89780ce9c22d328b4cfb9795c81
-  data.tar.gz: 2f24de47526a5719c96772d5c4e557fc37d2cc39472c372e0c3c6d4913a47cee1568bb06547de1d67684d1afd60b8875c7073e162b8e637e5718b4b4f8972839
+  metadata.gz: 4af0c95c0baf2a8dc469767c5455105276ea42f1c66ffadd09760e40eeecd0d362afcc7886b77931f0eafcc3a0785f0126ab4a3924ac4a07b1a8d94344c26d7a
+  data.tar.gz: 3712863da50c7d61207b76a92002432469e7021a87dcc1a4af1a8779581fc6a7b8beb9fc2e2017b8a45adace69f3e7a5dc6f9e9e2d47ca067c84df576cb8919d

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 1.22.0 (2018-01-10)
+
+* Updates `describe_class` to account for RSpecs `:system` wrapper of rails system tests. ([@EliseFitz15][])
+* Add `RSpec/ExpectChange` cop to enforce consistent usage of the change matcher. ([@Darhazer][])
+* Add autocorrect support to `RSpec/LetBeforeExamples`. ([@Darhazer][])
+* Fix `RSpec/InstanceVariable` flagging instance variables inside dynamically defined class. ([@Darhazer][])
+* Add autocorrect support for `RSpec/ReturnFromStub` cop. ([@bquorning][])
+* Add `RSpec/ExampleWithoutDescription` cop. ([@Darhazer][])
+
 ## 1.21.0 (2017-12-13)
 
 * Compatibility with RuboCop v0.52.0. ([@bquorning][])
@@ -280,3 +289,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@walf443]: https://github.com/walf443
 [@pirj]: https://github.com/pirj
 [@telmofcosta]: https://github.com/telmofcosta
+[@EliseFitz15]: https://github.com/EliseFitz15

data/Rakefile

@@ -45,3 +45,22 @@ task confirm_config: :build_config do
 end
 
 task default: %i[build_config coverage internal_investigation confirm_config]
+
+desc 'Generate a new cop template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/rspec_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -104,6 +104,16 @@ RSpec/ExampleLength:
   Max: 5
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleLength
 
+RSpec/ExampleWithoutDescription:
+  Description: Checks for examples without a description.
+  Enabled: true
+  EnforcedStyle: always_allow
+  SupportedStyles:
+  - always_allow
+  - single_line_only
+  - disallow
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWithoutDescription
+
 RSpec/ExampleWording:
   Description: Checks for common mistakes in example descriptions.
   Enabled: true
@@ -122,6 +132,15 @@ RSpec/ExpectActual:
   - spec/routing/**/*
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectActual
 
+RSpec/ExpectChange:
+  Description: Checks for consistent style of change matcher.
+  Enabled: true
+  EnforcedStyle: method_call
+  SupportedStyles:
+  - method_call
+  - block
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectChange
+
 RSpec/ExpectInHook:
   Enabled: true
   Description: Do not use `expect` in hooks such as `before`.

data/lib/rubocop-rspec.rb

@@ -3,81 +3,26 @@ require 'yaml'
 
 require 'rubocop'
 
-require 'rubocop/rspec'
-require 'rubocop/rspec/version'
-require 'rubocop/rspec/inject'
-require 'rubocop/rspec/top_level_describe'
-require 'rubocop/rspec/wording'
-require 'rubocop/rspec/util'
-require 'rubocop/rspec/language'
-require 'rubocop/rspec/language/node_pattern'
-require 'rubocop/rspec/concept'
-require 'rubocop/rspec/example_group'
-require 'rubocop/rspec/example'
-require 'rubocop/rspec/hook'
-require 'rubocop/cop/rspec/cop'
-require 'rubocop/rspec/align_let_brace'
-require 'rubocop/rspec/capybara'
-require 'rubocop/rspec/factory_bot'
+require_relative 'rubocop/rspec'
+require_relative 'rubocop/rspec/version'
+require_relative 'rubocop/rspec/inject'
+require_relative 'rubocop/rspec/top_level_describe'
+require_relative 'rubocop/rspec/wording'
+require_relative 'rubocop/rspec/util'
+require_relative 'rubocop/rspec/language'
+require_relative 'rubocop/rspec/language/node_pattern'
+require_relative 'rubocop/rspec/concept'
+require_relative 'rubocop/rspec/example_group'
+require_relative 'rubocop/rspec/example'
+require_relative 'rubocop/rspec/hook'
+require_relative 'rubocop/cop/rspec/cop'
+require_relative 'rubocop/rspec/align_let_brace'
+require_relative 'rubocop/rspec/capybara'
+require_relative 'rubocop/rspec/factory_bot'
 
 RuboCop::RSpec::Inject.defaults!
 
-# cops
-require 'rubocop/cop/rspec/align_left_let_brace'
-require 'rubocop/cop/rspec/align_right_let_brace'
-require 'rubocop/cop/rspec/any_instance'
-require 'rubocop/cop/rspec/around_block'
-require 'rubocop/cop/rspec/be_eql'
-require 'rubocop/cop/rspec/before_after_all'
-require 'rubocop/cop/rspec/capybara/current_path_expectation'
-require 'rubocop/cop/rspec/capybara/feature_methods'
-require 'rubocop/cop/rspec/context_wording'
-require 'rubocop/cop/rspec/describe_class'
-require 'rubocop/cop/rspec/describe_method'
-require 'rubocop/cop/rspec/describe_symbol'
-require 'rubocop/cop/rspec/described_class'
-require 'rubocop/cop/rspec/empty_example_group'
-require 'rubocop/cop/rspec/empty_line_after_final_let'
-require 'rubocop/cop/rspec/empty_line_after_subject'
-require 'rubocop/cop/rspec/example_length'
-require 'rubocop/cop/rspec/example_wording'
-require 'rubocop/cop/rspec/expect_actual'
-require 'rubocop/cop/rspec/expect_in_hook'
-require 'rubocop/cop/rspec/expect_output'
-require 'rubocop/cop/rspec/factory_bot/dynamic_attribute_defined_statically'
-require 'rubocop/cop/rspec/file_path'
-require 'rubocop/cop/rspec/focus'
-require 'rubocop/cop/rspec/hook_argument'
-require 'rubocop/cop/rspec/implicit_expect'
-require 'rubocop/cop/rspec/instance_spy'
-require 'rubocop/cop/rspec/instance_variable'
-require 'rubocop/cop/rspec/invalid_predicate_matcher'
-require 'rubocop/cop/rspec/it_behaves_like'
-require 'rubocop/cop/rspec/iterated_expectation'
-require 'rubocop/cop/rspec/leading_subject'
-require 'rubocop/cop/rspec/let_before_examples'
-require 'rubocop/cop/rspec/let_setup'
-require 'rubocop/cop/rspec/message_chain'
-require 'rubocop/cop/rspec/message_expectation'
-require 'rubocop/cop/rspec/message_spies'
-require 'rubocop/cop/rspec/multiple_describes'
-require 'rubocop/cop/rspec/multiple_expectations'
-require 'rubocop/cop/rspec/multiple_subjects'
-require 'rubocop/cop/rspec/named_subject'
-require 'rubocop/cop/rspec/nested_groups'
-require 'rubocop/cop/rspec/not_to_not'
-require 'rubocop/cop/rspec/overwriting_setup'
-require 'rubocop/cop/rspec/repeated_description'
-require 'rubocop/cop/rspec/repeated_example'
-require 'rubocop/cop/rspec/return_from_stub'
-require 'rubocop/cop/rspec/scattered_let'
-require 'rubocop/cop/rspec/scattered_setup'
-require 'rubocop/cop/rspec/shared_context'
-require 'rubocop/cop/rspec/single_argument_message_chain'
-require 'rubocop/cop/rspec/subject_stub'
-require 'rubocop/cop/rspec/predicate_matcher'
-require 'rubocop/cop/rspec/verified_doubles'
-require 'rubocop/cop/rspec/void_expect'
+require_relative 'rubocop/cop/rspec_cops'
 
 # We have to register our autocorrect incompatibilies in RuboCop's cops as well
 # so we do not hit infinite loops

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

@@ -19,12 +19,12 @@ module RuboCop
       # @example
       #   # bad
       #   context 'the display name not present' do
-      #     ...
+      #     # ...
       #   end
       #
       #   # good
       #   context 'when the display name is not present' do
-      #     ...
+      #     # ...
       #   end
       class ContextWording < Cop
         MSG = 'Start context description with %<prefixes>s.'.freeze

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

@@ -36,7 +36,7 @@ module RuboCop
         def_node_matcher :rails_metadata?, <<-PATTERN
           (pair
             (sym :type)
-            (sym {:request :feature :routing :view}))
+            (sym {:request :feature :system :routing :view}))
         PATTERN
 
         def_node_matcher :shared_group?, <<-PATTERN

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

@@ -16,7 +16,7 @@ module RuboCop
       #     ...
       #   end
       #
-      # See https://github.com/rspec/rspec-core/issues/1610
+      # @see https://github.com/rspec/rspec-core/issues/1610
       class DescribeSymbol < Cop
         MSG = 'Avoid describing symbols.'.freeze
 

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

@@ -81,10 +81,9 @@ module RuboCop
         def find_usage(node, &block)
           yield(node) if offensive?(node)
 
-          return unless node.is_a?(Parser::AST::Node)
           return if scope_change?(node) || node.const_type?
 
-          node.children.each do |child|
+          node.each_child_node do |child|
             find_usage(child, &block)
           end
         end
@@ -116,8 +115,7 @@ module RuboCop
           if style == :described_class
             node.eql?(@described_class)
           else
-            _receiver, method_name, *_args = *node
-            method_name == :described_class
+            node.method_name == :described_class
           end
         end
       end

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

@@ -7,19 +7,15 @@ module RuboCop
       #
       # @example
       #   # bad
-      #     let(:foo) { bar }
-      #     let(:something) { other }
-      #     it do
-      #       ...
-      #     end
+      #   let(:foo) { bar }
+      #   let(:something) { other }
+      #   it { does_something }
       #
       #   # good
-      #     let(:foo) { bar }
-      #     let(:something) { other }
+      #   let(:foo) { bar }
+      #   let(:something) { other }
       #
-      #     it do
-      #       ...
-      #     end
+      #   it { does_something }
       class EmptyLineAfterFinalLet < Cop
         MSG = 'Add an empty line after the last `let` block.'.freeze
 

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

@@ -7,13 +7,13 @@ module RuboCop
       #
       # @example
       #   # bad
-      #     subject(:obj) { described_class }
-      #     let(:foo) { bar }
+      #   subject(:obj) { described_class }
+      #   let(:foo) { bar }
       #
       #   # good
-      #     subject(:obj) { described_class }
+      #   subject(:obj) { described_class }
       #
-      #     let(:foo) { bar }
+      #   let(:foo) { bar }
       class EmptyLineAfterSubject < Cop
         MSG = 'Add empty line after `subject`.'.freeze
 

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for examples without a description.
+      #
+      # RSpec allows for auto-generated example descriptions when there is no
+      # description provided or the description is an empty one.
+      #
+      # This cop removes empty descriptions.
+      # It also defines whether auto-generated description is allowed, based
+      # on the configured style.
+      #
+      # This cop can be configured using the `EnforcedStyle` option
+      #
+      # @example `EnforcedStyle: always_allow`
+      #   # bad
+      #   it('') { is_expected.to be_good }
+      #   it '' do
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      #
+      #   # good
+      #   it { is_expected.to be_good }
+      #   it do
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      #
+      # @example `EnforcedStyle: single_line_only`
+      #   # bad
+      #   it('') { is_expected.to be_good }
+      #   it do
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      #
+      #   # good
+      #   it { is_expected.to be_good }
+      #
+      # @example `EnforcedStyle: disallow`
+      #   # bad
+      #   it { is_expected.to be_good }
+      #   it do
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      class ExampleWithoutDescription < Cop
+        include ConfigurableEnforcedStyle
+
+        MSG_DEFAULT_ARGUMENT = 'Omit the argument when you want to ' \
+                               'have auto-generated description.'.freeze
+        MSG_ADD_DESCRIPTION  = 'Add a description.'.freeze
+
+        def_node_matcher :example?, Examples::ALL.send_pattern
+        def_node_matcher :example_description, '(send nil? _ $(str $_))'
+
+        def on_send(node)
+          return unless example?(node)
+
+          check_example_without_description(node)
+
+          example_description(node) do |message_node, message|
+            return unless message.to_s.empty?
+
+            add_offense(message_node, message: MSG_DEFAULT_ARGUMENT)
+          end
+        end
+
+        private
+
+        def check_example_without_description(node)
+          _send, _method, arg = *node
+          return unless arg.nil?
+          return unless disallow_empty_description?(node)
+
+          add_offense(node, message: MSG_ADD_DESCRIPTION)
+        end
+
+        def disallow_empty_description?(node)
+          style == :disallow ||
+            (style == :single_line_only && node.parent.multiline?)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for consistent style of change matcher.
+      #
+      # Enforces either passing object and attribute as arguments to the matcher
+      # or passing a block that reads the attribute value.
+      #
+      # This cop can be configured using the `EnforcedStyle` option.
+      #
+      # @example `EnforcedStyle: block`
+      #   # bad
+      #   expect(run).to change(Foo, :bar)
+      #
+      #   # good
+      #   expect(run).to change { Foo.bar }
+      #
+      # @example `EnforcedStyle: method_call`
+      #   # bad
+      #   expect(run).to change { Foo.bar }
+      #   expect(run).to change { foo.baz }
+      #
+      #   # good
+      #   expect(run).to change(Foo, :bar)
+      #   expect(run).to change(foo, :baz)
+      #   # also good when there are arguments or chained method calls
+      #   expect(run).to change { Foo.bar(:count) }
+      #   expect(run).to change { user.reload.name }
+      #
+      class ExpectChange < Cop
+        include ConfigurableEnforcedStyle
+
+        MSG_BLOCK = 'Prefer `change(%<obj>s, :%<attr>s)`.'.freeze
+        MSG_CALL = 'Prefer `change { %<obj>s.%<attr>s }`.'.freeze
+
+        def_node_matcher :expect_change_with_arguments, <<-PATTERN
+          (send nil? :change ({const send} nil? $_) (sym $_))
+        PATTERN
+
+        def_node_matcher :expect_change_with_block, <<-PATTERN
+          (block
+            (send nil? :change)
+            (args)
+            (send ({const send} nil? $_) $_)
+          )
+        PATTERN
+
+        def on_send(node)
+          return unless style == :block
+
+          expect_change_with_arguments(node) do |receiver, message|
+            add_offense(
+              node,
+              message: format(MSG_CALL, obj: receiver, attr: message)
+            )
+          end
+        end
+
+        def on_block(node)
+          return unless style == :method_call
+
+          expect_change_with_block(node) do |receiver, message|
+            add_offense(
+              node,
+              message: format(MSG_BLOCK, obj: receiver, attr: message)
+            )
+          end
+        end
+
+        def autocorrect(node)
+          if style == :block
+            autocorrect_method_call_to_block(node)
+          else
+            autocorrect_block_to_method_call(node)
+          end
+        end
+
+        private
+
+        def autocorrect_method_call_to_block(node)
+          lambda do |corrector|
+            expect_change_with_arguments(node) do |receiver, message|
+              replacement = "change { #{receiver}.#{message} }"
+              corrector.replace(node.loc.expression, replacement)
+            end
+          end
+        end
+
+        def autocorrect_block_to_method_call(node)
+          lambda do |corrector|
+            expect_change_with_block(node) do |receiver, message|
+              replacement = "change(#{receiver}, :#{message})"
+              corrector.replace(node.loc.expression, replacement)
+            end
+          end
+        end
+      end
+    end
+  end
+end