rubocop-rspec 1.32.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0fcdb4a1fb882713a667ae92edf352ee496300bd20cbd44c79ec0c79773691f
-  data.tar.gz: 22ed75baf52c414c530edef39ba1a2b361c4e2060711775c093585c7a10ffe53
+  metadata.gz: 53e671fa54f485f07186b567e9e44f7522db1e9508f5f723549c1f50f467ef68
+  data.tar.gz: 5f842a528fb62843a686e9674d4b94f5a44008afbc602c9babfb91ddf90ef4df
 SHA512:
-  metadata.gz: 597bacb5b6c60657a33532a1d625008030338e16f8fca2e42d1a9b0dc4bf76a6e9296d8fb2948ad0947bb522212bc53ef997fc4155168c89e76c66fda4e6ef87
-  data.tar.gz: 9ecac64a0f6cccba7a794125e0e4bd0bd47722f8e5d2a3efed8828709fdc8c682ca09794a74c33d92f6feec90d70b856d2bf1f544d13c51fc4f63d7c398568e1
+  metadata.gz: 1e03a650246098cb4498448db4e91846bb25643ea3673ec54db68678dbe80acefecbc69f20ca484addbea5f8a97a7dd84e3d21205b14da21cc74de45d8048501
+  data.tar.gz: 1d3cfdc4b32495be01056e6435bebaf1c1575bb37bda80973c31095ec4ce2f3556ce90ad9360e81102522869fa57c1f0eb6d005d670820b75df00c70e689131e

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 1.33.0 (2019-05-13)
+
+* Let `RSpec/DescribedClass` pass `Struct` instantiation closures. ([@schmijos][])
+* Fixed `RSpec/ContextWording` missing `context`s with metadata. ([@pirj][])
+* Fix `FactoryBot/AttributeDefinedStatically` not working with an explicit receiver. ([@composerinteralia][])
+* Add `RSpec/Dialect` enforces custom RSpec dialects. ([@gsamokovarov][])
+* Fix redundant blank lines in `RSpec/MultipleSubjects`'s autocorrect. ([@pirj][])
+* Drop support for ruby `2.2`. ([@bquorning][])
+
 ## 1.32.0 (2019-01-27)
 
 * Add `RSpec/Yield` cop, suggesting using the `and_yield` method when stubbing a method, accepting a block. ([@Darhazer][])
@@ -407,3 +416,5 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@RST-J]: https://github.com/RST-J
 [@ypresto]: https://github.com/ypresto
 [@mkenyon]: https://github.com/mkenyon
+[@gsamokovarov]: https://github.com/gsamokovarov
+[@schmijos]: https://github.com/schmijos

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 require 'bundler'

data/config/default.yml

@@ -83,6 +83,12 @@ RSpec/DescribedClass:
   - explicit
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribedClass
 
+RSpec/Dialect:
+  Description: This cop enforces custom RSpec dialects.
+  Enabled: false
+  PreferredMethods: {}
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Dialect
+
 RSpec/EmptyExampleGroup:
   Description: Checks if an example group does not include any tests.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'yaml'
 
@@ -18,6 +20,7 @@ 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/factory_bot'
 require_relative 'rubocop/rspec/final_end_location'
 require_relative 'rubocop/rspec/blank_line_separation'
 

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

@@ -18,7 +18,7 @@ module RuboCop
       #     let(:a)      { b }
       #
       class AlignLeftLetBrace < Cop
-        MSG = 'Align left let brace'.freeze
+        MSG = 'Align left let brace'
 
         def self.autocorrect_incompatible_with
           [Layout::ExtraSpacing]

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

@@ -18,7 +18,7 @@ module RuboCop
       #     let(:a)      { b        }
       #
       class AlignRightLetBrace < Cop
-        MSG = 'Align right let brace'.freeze
+        MSG = 'Align right let brace'
 
         def self.autocorrect_incompatible_with
           [Layout::ExtraSpacing]

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -21,7 +23,7 @@ module RuboCop
       #     end
       #   end
       class AnyInstance < Cop
-        MSG = 'Avoid stubbing using `%<method>s`.'.freeze
+        MSG = 'Avoid stubbing using `%<method>s`.'
 
         def_node_matcher :disallowed_stub, <<-PATTERN
           (send _ ${:any_instance :allow_any_instance_of :expect_any_instance_of} ...)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -24,9 +26,9 @@ module RuboCop
       #     test.run
       #   end
       class AroundBlock < Cop
-        MSG_NO_ARG     = 'Test object should be passed to around block.'.freeze
+        MSG_NO_ARG     = 'Test object should be passed to around block.'
         MSG_UNUSED_ARG = 'You should call `%<arg>s.call` '\
-                         'or `%<arg>s.run`.'.freeze
+                         'or `%<arg>s.run`.'
 
         def_node_matcher :hook, <<-PATTERN
           (block {(send nil? :around) (send nil? :around sym)} (args $...) ...)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -18,10 +20,10 @@ module RuboCop
       #   expect(foo).to be(true)
       #
       class Be < Cop
-        MSG = 'Don\'t use `be` without an argument.'.freeze
+        MSG = 'Don\'t use `be` without an argument.'
 
         def_node_matcher :be_without_args, <<-PATTERN
-          (send _ {:to :not_to :to_not} $(send nil? :be))
+          (send _ #{Runners::ALL.node_pattern_union} $(send nil? :be))
         PATTERN
 
         def on_send(node)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -34,7 +36,7 @@ module RuboCop
       # coerce objects for comparison.
       #
       class BeEql < Cop
-        MSG = 'Prefer `be` over `eql`.'.freeze
+        MSG = 'Prefer `be` over `eql`.'
 
         def_node_matcher :eql_type_with_identity, <<-PATTERN
           (send _ :to $(send nil? :eql {true false int float sym nil_type?}))

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

@@ -27,7 +27,7 @@ module RuboCop
         MSG = 'Beware of using `%<hook>s` as it may cause state to leak '\
               'between tests. If you are using `rspec-rails`, and '\
               '`use_transactional_fixtures` is enabled, then records created '\
-              'in `%<hook>s` are not automatically rolled back.'.freeze
+              'in `%<hook>s` are not automatically rolled back.'
 
         def_node_matcher :before_or_after_all, <<-PATTERN
           $(send _ {:before :after} (sym {:all :context}))

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -24,7 +26,7 @@ module RuboCop
         class CurrentPathExpectation < Cop
           MSG = 'Do not set an RSpec expectation on `current_path` in ' \
                 'Capybara feature specs - instead, use the ' \
-                '`have_current_path` matcher on `page`'.freeze
+                '`have_current_path` matcher on `page`'
 
           def_node_matcher :expectation_set_on_current_path, <<-PATTERN
             (send nil? :expect (send {(send nil? :page) nil?} :current_path))
@@ -33,13 +35,13 @@ module RuboCop
           # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
           def_node_matcher :as_is_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path ${:to :not_to :to_not}
+              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
               ${(send nil? :eq ...) (send nil? :match (regexp ...))})
           PATTERN
 
           def_node_matcher :regexp_str_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path ${:to :not_to :to_not}
+              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
               $(send nil? :match (str $_)))
           PATTERN
 

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -41,7 +41,7 @@ module RuboCop
         #     end
         #   end
         class FeatureMethods < Cop
-          MSG = 'Use `%<replacement>s` instead of `%<method>s`.'.freeze
+          MSG = 'Use `%<replacement>s` instead of `%<method>s`.'
 
           # https://git.io/v7Kwr
           MAP = {
@@ -55,13 +55,13 @@ module RuboCop
 
           def_node_matcher :spec?, <<-PATTERN
             (block
-              (send {(const nil? :RSpec) nil?} {:describe :feature} ...)
+              (send #{RSPEC} {:describe :feature} ...)
             ...)
           PATTERN
 
           def_node_matcher :feature_method, <<-PATTERN
             (block
-              $(send {(const nil? :RSpec) nil?} ${#{MAP.keys.map(&:inspect).join(' ')}} ...)
+              $(send #{RSPEC} ${#{MAP.keys.map(&:inspect).join(' ')}} ...)
             ...)
           PATTERN
 

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

@@ -27,10 +27,10 @@ module RuboCop
       #     # ...
       #   end
       class ContextWording < Cop
-        MSG = 'Start context description with %<prefixes>s.'.freeze
+        MSG = 'Start context description with %<prefixes>s.'
 
         def_node_matcher :context_wording, <<-PATTERN
-          (block (send _ { :context :shared_context } $(str #bad_prefix?)) ...)
+          (block (send #{RSPEC} { :context :shared_context } $(str #bad_prefix?) ...) ...)
         PATTERN
 
         def on_block(node)

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

@@ -20,17 +20,17 @@ module RuboCop
         include RuboCop::RSpec::TopLevelDescribe
 
         MSG = 'The first argument to describe should be '\
-              'the class or module being tested.'.freeze
+              'the class or module being tested.'
 
         def_node_matcher :valid_describe?, <<-PATTERN
           {
-            (send {(const nil? :RSpec) nil?} :describe const ...)
-            (send {(const nil? :RSpec) nil?} :describe)
+            (send #{RSPEC} :describe const ...)
+            (send #{RSPEC} :describe)
           }
         PATTERN
 
         def_node_matcher :describe_with_metadata, <<-PATTERN
-          (send {(const nil? :RSpec) nil?} :describe
+          (send #{RSPEC} :describe
             !const
             ...
             (hash $...))

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

@@ -21,10 +21,10 @@ module RuboCop
         include RuboCop::RSpec::Util
 
         MSG = 'The second argument to describe should be the method '\
-              "being tested. '#instance' or '.class'.".freeze
+              "being tested. '#instance' or '.class'."
 
         def on_top_level_describe(_node, (_, second_arg))
-          return unless second_arg && second_arg.str_type?
+          return unless second_arg&.str_type?
           return if second_arg.str_content.start_with?('#', '.')
 
           add_offense(second_arg, location: :expression)

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

@@ -18,10 +18,10 @@ module RuboCop
       #
       # @see https://github.com/rspec/rspec-core/issues/1610
       class DescribeSymbol < Cop
-        MSG = 'Avoid describing symbols.'.freeze
+        MSG = 'Avoid describing symbols.'
 
         def_node_matcher :describe_symbol?, <<-PATTERN
-          (send {(const nil? :RSpec) nil?} :describe $sym ...)
+          (send #{RSPEC} :describe $sym ...)
         PATTERN
 
         def on_send(node)

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

@@ -36,11 +36,11 @@ module RuboCop
         include RuboCop::RSpec::TopLevelDescribe
         include ConfigurableEnforcedStyle
 
-        DESCRIBED_CLASS = 'described_class'.freeze
-        MSG             = 'Use `%<replacement>s` instead of `%<src>s`.'.freeze
+        DESCRIBED_CLASS = 'described_class'
+        MSG             = 'Use `%<replacement>s` instead of `%<src>s`.'
 
         def_node_matcher :common_instance_exec_closure?, <<-PATTERN
-          (block (send (const nil? {:Class :Module}) :new ...) ...)
+          (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
         def_node_matcher :rspec_block?,

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # This cop enforces custom RSpec dialects.
+      #
+      # A dialect can be based on the following RSpec methods:
+      #
+      # - describe, context, feature, example_group
+      # - xdescribe, xcontext, xfeature
+      # - fdescribe, fcontext, ffeature
+      # - shared_examples, shared_examples_for, shared_context
+      # - it, specify, example, scenario, its
+      # - fit, fspecify, fexample, fscenario, focus
+      # - xit, xspecify, xexample, xscenario, skip
+      # - pending
+      # - prepend_before, before, append_before,
+      # - around
+      # - prepend_after, after, append_after
+      # - let, let!
+      # - subject, subject!
+      # - expect, is_expected, expect_any_instance_of
+      #
+      # By default all of the RSpec methods and aliases are allowed. By setting
+      # a config like:
+      #
+      #   RSpec/Dialect:
+      #     PreferredMethods:
+      #       context: describe
+      #
+      # You can expect the following behavior:
+      #
+      # @example
+      #   # bad
+      #   context 'display name presence' do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   describe 'display name presence' do
+      #     # ...
+      #   end
+      class Dialect < Cop
+        include MethodPreference
+
+        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
+
+        def_node_matcher :rspec_method?, ALL.send_pattern
+
+        def on_send(node)
+          return unless rspec_method?(node)
+          return unless preferred_methods[node.method_name]
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            current = node.loc.selector
+            preferred = preferred_method(current.source)
+
+            corrector.replace(current, preferred)
+          end
+        end
+
+        private
+
+        def message(node)
+          format(MSG, prefer: preferred_method(node.method_name),
+                      current: node.method_name)
+        end
+      end
+    end
+  end
+end

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

@@ -58,7 +58,7 @@ module RuboCop
       #   end
       #
       class EmptyExampleGroup < Cop
-        MSG = 'Empty example group detected.'.freeze
+        MSG = 'Empty example group detected.'
 
         def_node_search :contains_example?, <<-PATTERN
           {

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

@@ -26,7 +26,7 @@ module RuboCop
       class EmptyLineAfterExampleGroup < Cop
         include RuboCop::RSpec::BlankLineSeparation
 
-        MSG = 'Add an empty line after `%<example_group>s`.'.freeze
+        MSG = 'Add an empty line after `%<example_group>s`.'
 
         def on_block(node)
           return unless example_group?(node)

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

@@ -19,7 +19,7 @@ module RuboCop
       class EmptyLineAfterFinalLet < Cop
         include RuboCop::RSpec::BlankLineSeparation
 
-        MSG = 'Add an empty line after the last `let` block.'.freeze
+        MSG = 'Add an empty line after the last `let` block.'
 
         def on_block(node)
           return unless example_group_with_body?(node)

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

@@ -36,7 +36,7 @@ module RuboCop
       class EmptyLineAfterHook < Cop
         include RuboCop::RSpec::BlankLineSeparation
 
-        MSG = 'Add an empty line after `%<hook>s`.'.freeze
+        MSG = 'Add an empty line after `%<hook>s`.'
 
         def on_block(node)
           return unless hook?(node)

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

@@ -17,7 +17,7 @@ module RuboCop
       class EmptyLineAfterSubject < Cop
         include RuboCop::RSpec::BlankLineSeparation
 
-        MSG = 'Add empty line after `subject`.'.freeze
+        MSG = 'Add empty line after `subject`.'
 
         def on_block(node)
           return unless subject?(node) && !in_spec_block?(node)