rubocop 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48fd91bc57ba3589a331c3c0141d3e168c7631e5db47238a88cecbd10b12292
-  data.tar.gz: 9393d3cab7e09e86a9276ca4614f8f2c4fc2895f2070bd3364096569c2cd5828
+  metadata.gz: af243a553ad28a14173bdaad5e52f46e61c2d61096c6cab37ae41ccf88cad1ff
+  data.tar.gz: efe4a129082e9e879501b01772d7708a80020ab71b10f24fc2ffff32819d50b3
 SHA512:
-  metadata.gz: 13d85485214ca48904b07a6da11f89d2e2ef33fceab05912fb4c4f4c1e025da4be79139845d13724a749f97eb837b943eef5515639a5116299b6a164d7517944
-  data.tar.gz: 668abbcaedb1f06c43a2e5f61774909d684767659979bc3787c0827ca22adf42be0edf1d30544909a74fc6aac18bcd3758c7c5f77352cb97b51fd96acd24ab18
+  metadata.gz: 536ced62e51af2fa59a347dc416d0af919ebbe04335e37a2011d704c11821d170decaad13bc7f6abe59da23146cdc2be31820458941fa8272c59b266bb852dae
+  data.tar.gz: 3087db4a3f808c630eaf850d1ac371cca4dda687fe1459cf5125e1fc49e55451b4c90fd9fdace47d93049bfa0d569138e361461ead47eac8503553907b47b32c

data/README.md

@@ -53,7 +53,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.27', require: false
+gem 'rubocop', '~> 1.28', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.

data/config/default.yml

@@ -931,7 +931,8 @@ Layout/IndentationWidth:
   VersionAdded: '0.49'
   # Number of spaces for each indentation level.
   Width: 2
-  IgnoredPatterns: []
+  AllowedPatterns: []
+  IgnoredPatterns: [] # deprecated
 
 Layout/InitialIndentation:
   Description: >-
@@ -985,10 +986,11 @@ Layout/LineLength:
   # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
   # directives like '# rubocop: enable ...' when calculating a line's length.
   IgnoreCopDirectives: true
-  # The IgnoredPatterns option is a list of !ruby/regexp and/or string
+  # The AllowedPatterns option is a list of !ruby/regexp and/or string
   # elements. Strings will be converted to Regexp objects. A line that matches
   # any regular expression listed in this option will be ignored by LineLength.
-  IgnoredPatterns: []
+  AllowedPatterns: []
+  IgnoredPatterns: [] # deprecated
 
 Layout/MultilineArrayBraceLayout:
   Description: >-
@@ -1661,7 +1663,9 @@ Lint/DuplicateRegexpCharacterClassElement:
 Lint/DuplicateRequire:
   Description: 'Check for duplicate `require`s and `require_relative`s.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.90'
+  VersionChanged: '1.28'
 
 Lint/DuplicateRescueException:
   Description: 'Checks that there are no repeated exceptions used in `rescue` expressions.'
@@ -2270,10 +2274,11 @@ Lint/UnreachableLoop:
   Enabled: true
   VersionAdded: '0.89'
   VersionChanged: '1.7'
-  IgnoredPatterns:
+  AllowedPatterns:
     # RSpec uses `times` in its message expectations
     # eg. `exactly(2).times`
     - !ruby/regexp /(exactly|at_least|at_most)\(\d+\)\.times/
+  IgnoredPatterns: [] # deprecated
 
 Lint/UnusedBlockArgument:
   Description: 'Checks for unused block arguments.'
@@ -2686,11 +2691,12 @@ Naming/MethodName:
     - camelCase
   # Method names matching patterns are always allowed.
   #
-  #   IgnoredPatterns:
+  #   AllowedPatterns:
   #     - '\A\s*onSelectionBulkChange\s*'
   #     - '\A\s*onSelectionCleared\s*'
   #
-  IgnoredPatterns: []
+  AllowedPatterns: []
+  IgnoredPatterns: [] # deprecated
 
 Naming/MethodParameterName:
   Description: >-
@@ -2790,6 +2796,11 @@ Naming/VariableNumber:
 
 #################### Security ##############################
 
+Security/CompoundHash:
+  Description: 'When overwriting Object#hash to combine values, prefer delegating to Array#hash over writing a custom implementation.'
+  Enabled: pending
+  VersionAdded: '1.28'
+
 Security/Eval:
   Description: 'The use of eval represents a serious security risk.'
   Enabled: true
@@ -3521,6 +3532,16 @@ Style/ExponentialNotation:
     - engineering
     - integral
 
+Style/FetchEnvVar:
+  Description: >-
+                 This cop suggests `ENV.fetch` for the replacement of `ENV[]`.
+  Reference:
+    - https://rubystyle.guide/#hash-fetch-defaults
+  Enabled: pending
+  VersionAdded: '1.28'
+  # Environment variables to be excluded from the inspection.
+  AllowedVars: []
+
 Style/FileRead:
   Description: 'Favor `File.(bin)read` convenience methods.'
   StyleGuide: '#file-read'
@@ -3634,10 +3655,11 @@ Style/GuardClause:
   StyleGuide: '#no-nested-conditionals'
   Enabled: true
   VersionAdded: '0.20'
-  VersionChanged: '0.22'
+  VersionChanged: '1.28'
   # `MinBodyLength` defines the number of lines of the a body of an `if` or `unless`
   # needs to have to trigger this cop
   MinBodyLength: 1
+  AllowConsecutiveConditionals: false
 
 Style/HashAsLastArrayItem:
   Description: >-
@@ -3902,7 +3924,8 @@ Style/MethodCallWithArgsParentheses:
   VersionChanged: '1.7'
   IgnoreMacros: true
   IgnoredMethods: []
-  IgnoredPatterns: []
+  AllowedPatterns: []
+  IgnoredPatterns: [] # deprecated
   IncludedMacros: []
   AllowParenthesesInMultilineCall: false
   AllowParenthesesInChaining: false
@@ -4293,6 +4316,19 @@ Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
 
+Style/ObjectThen:
+  Description: 'Enforces the use of consistent method names `Object#yield_self` or `Object#then`.'
+  StyleGuide: '#object-yield-self-vs-object-then'
+  Enabled: pending
+  VersionAdded: '1.28'
+  # Use `Object#yield_self` or `Object#then`?
+  # Prefer `Object#yield_self` to `Object#then` (yield_self)
+  # Prefer `Object#then` to `Object#yield_self` (then)
+  EnforcedStyle: 'then'
+  SupportedStyles:
+    - then
+    - yield_self
+
 Style/OneLineConditional:
   Description: >-
                  Favor the ternary operator (?:) or multi-line constructs over
@@ -4533,7 +4569,10 @@ Style/RedundantFreeze:
 Style/RedundantInitialize:
   Description: 'Checks for redundant `initialize` methods.'
   Enabled: pending
+  Safe: false
+  AllowComments: true
   VersionAdded: '1.27'
+  VersionChanged: '1.28'
 
 Style/RedundantInterpolation:
   Description: 'Checks for strings that are just an interpolated expression.'
@@ -4774,6 +4813,7 @@ Style/SpecialGlobalVars:
   SupportedStyles:
     - use_perl_names
     - use_english_names
+    - use_builtin_english_names
 
 Style/StabbyLambdaParentheses:
   Description: 'Check for the usage of parentheses around stabby lambda arguments.'
@@ -4903,13 +4943,14 @@ Style/SymbolProc:
   Enabled: true
   Safe: false
   VersionAdded: '0.26'
-  VersionChanged: '1.5'
+  VersionChanged: '1.28'
   AllowMethodsWithArguments: false
   # A list of method names to be ignored by the check.
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   IgnoredMethods:
     - respond_to
     - define_method
+  AllowComments: false
 
 Style/TernaryParentheses:
   Description: 'Checks for use of parentheses around ternary conditions.'

data/config/obsoletion.yml

@@ -152,7 +152,7 @@ changed_parameters:
     alternative: EnforcedStyle
   - cops: Style/MethodCallWithArgsParentheses
     parameters: IgnoredMethodPatterns
-    alternative: IgnoredPatterns
+    alternative: AllowedPatterns
   - cops:
       - Performance/Count
       - Performance/Detect
@@ -191,6 +191,15 @@ changed_parameters:
     parameters: DebuggerReceivers
     reason: "`DebuggerReceivers` is no longer necessary, method receivers should be specified in `DebuggerMethods` instead."
     severity: warning
+  - cops:
+      - Layout/IndentationWidth
+      - Layout/LineLength
+      - Lint/UnreachableLoop
+      - Naming/MethodName
+      - Style/MethodCallWithArgsParentheses
+    parameters: IgnoredPatterns
+    alternative: AllowedPatterns
+    severity: warning
 
 # Enforced styles that have been removed or replaced
 changed_enforced_styles:

data/lib/rubocop/cli/command/suggest_extensions.rb

@@ -42,7 +42,7 @@ module RuboCop
           # 1. On CI
           # 2. When given RuboCop options that it doesn't make sense for
           # 3. For all formatters except specified in `INCLUDED_FORMATTERS'`
-          ENV['CI'] ||
+          ENV.fetch('CI', nil) ||
             @options[:only] || @options[:debug] || @options[:list_target_files] ||
             @options[:out] || @options[:stdin] ||
             !INCLUDED_FORMATTERS.include?(current_formatter)

data/lib/rubocop/cop/gemspec/date_assignment.rb

@@ -10,13 +10,13 @@ module RuboCop
       #
       #   # bad
       #   Gem::Specification.new do |spec|
-      #     s.name = 'your_cool_gem_name'
+      #     spec.name = 'your_cool_gem_name'
       #     spec.date = Time.now.strftime('%Y-%m-%d')
       #   end
       #
       #   # good
       #   Gem::Specification.new do |spec|
-      #     s.name = 'your_cool_gem_name'
+      #     spec.name = 'your_cool_gem_name'
       #   end
       #
       class DateAssignment < Base

data/lib/rubocop/cop/layout/case_indentation.rb

@@ -119,18 +119,34 @@ module RuboCop
 
         def on_case(case_node)
           return if case_node.single_line?
+          return if enforced_style_end? && end_and_last_conditional_same_line?(case_node)
 
           case_node.each_when { |when_node| check_when(when_node, 'when') }
         end
 
         def on_case_match(case_match_node)
           return if case_match_node.single_line?
+          return if enforced_style_end? && end_and_last_conditional_same_line?(case_match_node)
 
           case_match_node.each_in_pattern { |in_pattern_node| check_when(in_pattern_node, 'in') }
         end
 
         private
 
+        def end_and_last_conditional_same_line?(node)
+          end_line = node.loc.end&.line
+          last_conditional_line = if node.loc.else
+                                    node.loc.else.line
+                                  else
+                                    node.child_nodes.last.loc.begin&.line
+                                  end
+          end_line && last_conditional_line && end_line == last_conditional_line
+        end
+
+        def enforced_style_end?
+          cop_config[style_parameter_name] == 'end'
+        end
+
         def check_when(when_node, branch_type)
           when_column = when_node.loc.keyword.column
           base_column = base_column(when_node.parent, style)

data/lib/rubocop/cop/layout/indentation_width.rb

@@ -24,7 +24,7 @@ module RuboCop
       #     end
       #   end
       #
-      # @example IgnoredPatterns: ['^\s*module']
+      # @example AllowedPatterns: ['^\s*module']
       #   # bad
       #   module A
       #   class B
@@ -46,7 +46,7 @@ module RuboCop
         include EndKeywordAlignment
         include Alignment
         include CheckAssignment
-        include IgnoredPattern
+        include AllowedPattern
         include RangeHelp
         extend AutoCorrector
 

data/lib/rubocop/cop/layout/line_length.rb

@@ -60,7 +60,7 @@ module RuboCop
       #   }
       class LineLength < Base
         include CheckLineBreakable
-        include IgnoredPattern
+        include AllowedPattern
         include RangeHelp
         include LineLengthHelp
         extend AutoCorrector
@@ -163,7 +163,7 @@ module RuboCop
 
         def check_line(line, line_index)
           return if line_length(line) <= max
-          return if ignored_line?(line, line_index)
+          return if allowed_line?(line, line_index)
 
           if ignore_cop_directives? && directive_on_source_line?(line_index)
             return check_directive_line(line, line_index)
@@ -173,8 +173,8 @@ module RuboCop
           register_offense(excess_range(nil, line, line_index), line, line_index)
         end
 
-        def ignored_line?(line, line_index)
-          matches_ignored_pattern?(line) ||
+        def allowed_line?(line, line_index)
+          matches_allowed_pattern?(line) ||
             shebang?(line, line_index) ||
             (heredocs && line_in_permitted_heredoc?(line_index.succ))
         end

data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb

@@ -201,14 +201,31 @@ module RuboCop
         def semantic_alignment_node(node)
           return if argument_in_method_call(node, :with_parentheses)
 
+          dot_right_above = get_dot_right_above(node)
+          return dot_right_above if dot_right_above
+
+          node = first_call_has_a_dot(node)
+          return if node.loc.dot.line != node.first_line
+
+          node
+        end
+
+        def get_dot_right_above(node)
+          node.each_ancestor.find do |a|
+            dot = a.loc.respond_to?(:dot) && a.loc.dot
+            next unless dot
+
+            dot.line == node.loc.dot.line - 1 && dot.column == node.loc.dot.column
+          end
+        end
+
+        def first_call_has_a_dot(node)
           # descend to root of method chain
           node = node.receiver while node.receiver
           # ascend to first call which has a dot
           node = node.parent
           node = node.parent until node.loc.respond_to?(:dot) && node.loc.dot
 
-          return if node.loc.dot.line != node.first_line
-
           node
         end
 

data/lib/rubocop/cop/layout/trailing_whitespace.rb

@@ -85,7 +85,7 @@ module RuboCop
         end
 
         def whitespace_is_indentation?(range, level)
-          range.source[/ +/].length <= level
+          range.source[/[ \t]+/].length <= level
         end
 
         def whitespace_only?(range)

data/lib/rubocop/cop/lint/duplicate_require.rb

@@ -5,6 +5,10 @@ module RuboCop
     module Lint
       # This cop checks for duplicate `require`s and `require_relative`s.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may break the dependency order
+      #   of `require`.
+      #
       # @example
       #   # bad
       #   require 'foo'
@@ -20,6 +24,9 @@ module RuboCop
       #   require_relative 'foo'
       #
       class DuplicateRequire < Base
+        include RangeHelp
+        extend AutoCorrector
+
         MSG = 'Duplicate `%<method>s` detected.'
         REQUIRE_METHODS = Set.new(%i[require require_relative]).freeze
         RESTRICT_ON_SEND = REQUIRE_METHODS
@@ -39,7 +46,9 @@ module RuboCop
           return unless require_call?(node)
           return if @required[node.parent].add?("#{node.method_name}#{node.first_argument}")
 
-          add_offense(node, message: format(MSG, method: node.method_name))
+          add_offense(node, message: format(MSG, method: node.method_name)) do |corrector|
+            corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+          end
         end
       end
     end

data/lib/rubocop/cop/lint/unreachable_loop.rb

@@ -11,7 +11,7 @@ module RuboCop
       #
       # NOTE: Block methods that are used with `Enumerable`s are considered to be loops.
       #
-      # `IgnoredPatterns` can be used to match against the block receiver in order to allow
+      # `AllowedPatterns` can be used to match against the block receiver in order to allow
       # code that would otherwise be registered as an offense (eg. `times` used not in an
       # `Enumerable` context).
       #
@@ -79,12 +79,12 @@ module RuboCop
       #   # bad
       #   2.times { raise ArgumentError }
       #
-      # @example IgnoredPatterns: [/(exactly|at_least|at_most)\(\d+\)\.times/] (default)
+      # @example AllowedPatterns: [/(exactly|at_least|at_most)\(\d+\)\.times/] (default)
       #
       #   # good
       #   exactly(2).times { raise StandardError }
       class UnreachableLoop < Base
-        include IgnoredPattern
+        include AllowedPattern
 
         MSG = 'This loop will have at most one iteration.'
         CONTINUE_KEYWORDS = %i[next redo].freeze
@@ -107,7 +107,7 @@ module RuboCop
           return false unless node.block_type?
 
           send_node = node.send_node
-          return false if matches_ignored_pattern?(send_node.source)
+          return false if matches_allowed_pattern?(send_node.source)
 
           send_node.enumerable_method? || send_node.enumerator_method? || send_node.method?(:loop)
         end

data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb

@@ -96,7 +96,7 @@ module RuboCop
           end
 
           def compound_assignment(node)
-            # Methods setter can not be detected for multiple assignments
+            # Methods setter cannot be detected for multiple assignments
             # and shorthand assigns, so we'll count them here instead
             children = node.masgn_type? ? node.children[0].children : node.children
 

data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb

@@ -30,8 +30,8 @@ module RuboCop
 
               descendant_length = code_length(descendant)
               length = length - descendant_length + 1
-              # Subtract 2 length of opening and closing brace if method argument omits hash braces.
-              length -= 2 if descendant.hash_type? && !descendant.braces?
+              # Subtract length of opening and closing brace if method argument omits hash braces.
+              length -= omit_length(descendant) if descendant.hash_type? && !descendant.braces?
             end
 
             length
@@ -153,6 +153,20 @@ module RuboCop
           def count_comments?
             @count_comments
           end
+
+          def omit_length(descendant)
+            parent = descendant.parent
+            return 0 if another_args?(parent)
+
+            [
+              parent.loc.begin.end_pos != descendant.loc.expression.begin_pos,
+              parent.loc.end.begin_pos != descendant.loc.expression.end_pos
+            ].count(true)
+          end
+
+          def another_args?(node)
+            node.call_type? && node.arguments.count > 1
+          end
         end
       end
     end

data/lib/rubocop/cop/mixin/allowed_pattern.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This module encapsulates the ability to ignore certain lines when
+    # parsing.
+    module AllowedPattern
+      private
+
+      def allowed_line?(line)
+        line = if line.respond_to?(:source_line)
+                 line.source_line
+               elsif line.respond_to?(:node)
+                 line.node.source_range.source_line
+               end
+
+        matches_allowed_pattern?(line)
+      end
+
+      # @deprecated Use allowed_line? instead
+      alias ignored_line? allowed_line?
+
+      def matches_allowed_pattern?(line)
+        allowed_patterns.any? { |pattern| Regexp.new(pattern).match?(line) }
+      end
+
+      # @deprecated Use matches_allowed_pattern?? instead
+      alias matches_ignored_pattern? matches_allowed_pattern?
+
+      def allowed_patterns
+        # Since there could be a pattern specified in the default config, merge the two
+        # arrays together.
+        Array(cop_config['AllowedPatterns']).concat(Array(cop_config['IgnoredPatterns']))
+      end
+    end
+
+    # @deprecated IgnoredPattern class has been replaced with AllowedPattern.
+    IgnoredPattern = AllowedPattern
+  end
+end

data/lib/rubocop/cop/mixin/comments_help.rb

@@ -46,17 +46,19 @@ module RuboCop
       # Returns the end line of a node, which might be a comment and not part of the AST
       # End line is considered either the line at which another node starts, or
       # the line at which the parent node ends.
+      # rubocop:disable Metrics/AbcSize
       def find_end_line(node)
         if node.if_type? && node.loc.else
           node.loc.else.line
         elsif (next_sibling = node.right_sibling)
           next_sibling.loc.line
         elsif (parent = node.parent)
-          parent.loc.end.line
+          parent.loc.end ? parent.loc.end.line : parent.loc.line
         else
           node.loc.end.line
         end
       end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/rubocop/cop/naming/method_name.rb

@@ -6,10 +6,10 @@ module RuboCop
       # This cop makes sure that all methods use the configured style,
       # snake_case or camelCase, for their names.
       #
-      # This cop has `IgnoredPatterns` configuration option.
+      # This cop has `AllowedPatterns` configuration option.
       #
       #   Naming/MethodName:
-      #     IgnoredPatterns:
+      #     AllowedPatterns:
       #       - '\A\s*onSelectionBulkChange\s*'
       #       - '\A\s*onSelectionCleared\s*'
       #
@@ -30,7 +30,7 @@ module RuboCop
       #   def fooBar; end
       class MethodName < Base
         include ConfigurableNaming
-        include IgnoredPattern
+        include AllowedPattern
         include RangeHelp
 
         MSG = 'Use %<style>s for method names.'
@@ -46,14 +46,14 @@ module RuboCop
 
           attrs.last.each do |name_item|
             name = attr_name(name_item)
-            next if !name || matches_ignored_pattern?(name)
+            next if !name || matches_allowed_pattern?(name)
 
             check_name(node, name, range_position(node))
           end
         end
 
         def on_def(node)
-          return if node.operator_method? || matches_ignored_pattern?(node.method_name)
+          return if node.operator_method? || matches_allowed_pattern?(node.method_name)
 
           check_name(node, node.method_name, node.loc.name)
         end

data/lib/rubocop/cop/offense.rb

@@ -217,7 +217,7 @@ module RuboCop
       alias eql? ==
 
       def hash
-        COMPARISON_ATTRIBUTES.reduce(0) { |hash, attribute| hash ^ public_send(attribute).hash }
+        COMPARISON_ATTRIBUTES.map { |attribute| public_send(attribute) }.hash
       end
 
       # @api public