rubocop 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec2d9f7ba4857375232c4e42ea44accdb38b2873c83315f3029a546e315622e0
-  data.tar.gz: 01df5c9957cca7c79cf8cab073c1bae675d684761561835d6d93f554f3743905
+  metadata.gz: 86b427813730f667d5978bd4b4ca7e8f6766adf4ddf713e413cf07a0345b84b2
+  data.tar.gz: ede1028f4ebe7b6b1cd59de4d604e655c7115d928d38393ebd7febdbbff5b3e7
 SHA512:
-  metadata.gz: 55a5a8deae643b6d76dc5220c7136a7c5413ecb93ca85ec61dcd3aa9ff0adb3c1ab356ec81f72273771ab3125317fc105bfcaf0c7e1e1ae07f6295c7fa33c26e
-  data.tar.gz: 642d925df9f18c6c42b532eb0193965c6a85a93bd9339523757882eb6e9029052161a32bbc4421e454a210fe2ab5318ae64459dc4a9d792ee0cb5e4b259568ff
+  metadata.gz: b5e3ca723e7530916204e9bfce59bec1452232765a0903093ba2b4783fc35f109e655251c2fce8e3b08dbebcf4a4e67a4301b00c8113d45f5f0bb2a63cc4be7f
+  data.tar.gz: d91068c77da3ea787a5c36c287f1913bc94c23d98fc315604883cb21742f4c1031014e10c9470c67dca2fa3dfdc41eb848134f0a9565ff5a82e65aed5d6d2cf3

data/README.md

@@ -45,7 +45,7 @@ gem 'rubocop', require: false
 ```
 
 RuboCop is stable between major versions, both in terms of API and cop configuration.
-We aim the ease the maintenance of RuboCop extensions and the upgrades between RuboCop
+We aim to ease the maintenance of RuboCop extensions and the upgrades between RuboCop
 releases. All big changes are reserved for major releases.
 To prevent an unwanted RuboCop update you might want to use a conservative version lock
 in your `Gemfile`:

data/config/default.yml

@@ -3521,6 +3521,9 @@ Style/IfWithBooleanLiteralBranches:
   Description: 'Checks for redundant `if` with boolean literal branches.'
   Enabled: pending
   VersionAdded: '1.9'
+  SafeAutoCorrect: false
+  AllowedMethods:
+    - nonzero?
 
 Style/IfWithSemicolon:
   Description: 'Do not use if x; .... Use the ternary operator instead.'

data/lib/rubocop.rb

@@ -35,6 +35,7 @@ require_relative 'rubocop/cop/offense'
 require_relative 'rubocop/cop/message_annotator'
 require_relative 'rubocop/cop/ignored_node'
 require_relative 'rubocop/cop/autocorrect_logic'
+require_relative 'rubocop/cop/exclude_limit'
 require_relative 'rubocop/cop/badge'
 require_relative 'rubocop/cop/registry'
 require_relative 'rubocop/cop/base'

data/lib/rubocop/config.rb

@@ -34,7 +34,10 @@ module RuboCop
     end
 
     def self.create(hash, path, check: true)
-      new(hash, path).tap { |config| config.check if check }
+      config = new(hash, path)
+      config.check if check
+
+      config
     end
 
     def loaded_features

data/lib/rubocop/cop/base.rb

@@ -34,6 +34,7 @@ module RuboCop
     class Base # rubocop:disable Metrics/ClassLength
       extend RuboCop::AST::Sexp
       extend NodePattern::Macros
+      extend ExcludeLimit
       include RuboCop::AST::Sexp
       include Util
       include IgnoredNode

data/lib/rubocop/cop/exclude_limit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Allows specified configuration options to have an exclude limit
+  # ie. a maximum value tracked that it can be used by `--auto-gen-config`.
+  module ExcludeLimit
+    # Sets up a configuration option to have an exclude limit tracked.
+    # The parameter name given is transformed into a method name (eg. `Max`
+    # becomes `self.max=` and `MinDigits` becomes `self.min_digits=`).
+    def exclude_limit(parameter_name, method_name: transform(parameter_name))
+      define_method("#{method_name}=") do |value|
+        cfg = config_to_allow_offenses
+        cfg[:exclude_limit] ||= {}
+        current_max = cfg[:exclude_limit][parameter_name]
+        value = [current_max, value].max if current_max
+        cfg[:exclude_limit][parameter_name] = value
+      end
+    end
+
+    private
+
+    def transform(parameter_name)
+      parameter_name.gsub(/(?<!\A)(?=[A-Z])/, '_').downcase
+    end
+  end
+end

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

@@ -88,7 +88,7 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Use empty lines between %<type>s definitions.'
+        MSG = 'Expected %<expected>s between %<type>s definitions; found %<actual>d.'
 
         def self.autocorrect_incompatible_with
           [Layout::EmptyLines]
@@ -107,19 +107,21 @@ module RuboCop
         end
 
         def check_defs(nodes)
-          return if blank_lines_between?(*nodes)
+          count = blank_lines_count_between(*nodes)
+
+          return if line_count_allowed?(count)
           return if multiple_blank_lines_groups?(*nodes)
           return if nodes.all?(&:single_line?) &&
                     cop_config['AllowAdjacentOneLineDefs']
 
           correction_node = nodes.last
           location = correction_node.loc.keyword.join(correction_node.loc.name)
-          add_offense(location, message: message(correction_node)) do |corrector|
-            autocorrect(corrector, *nodes)
+          add_offense(location, message: message(correction_node, count: count)) do |corrector|
+            autocorrect(corrector, *nodes, count)
           end
         end
 
-        def autocorrect(corrector, prev_def, node)
+        def autocorrect(corrector, prev_def, node, count)
           # finds position of first newline
           end_pos = end_loc(prev_def).end_pos
           source_buffer = end_loc(prev_def).source_buffer
@@ -128,8 +130,6 @@ module RuboCop
           # Handle the case when multiple one-liners are on the same line.
           newline_pos = end_pos + 1 if newline_pos > node.source_range.begin_pos
 
-          count = blank_lines_count_between(prev_def, node)
-
           if count > maximum_empty_lines
             autocorrect_remove_lines(corrector, newline_pos, count)
           else
@@ -157,14 +157,22 @@ module RuboCop
           cop_config['EmptyLineBetweenModuleDefs'] && node.module_type?
         end
 
-        def message(node)
-          type = case node.type
-                 when :def, :defs
-                   :method
-                 else
-                   node.type
-                 end
-          format(MSG, type: type)
+        def message(node, count: nil)
+          type = node_type(node)
+
+          format(MSG,
+                 type: type,
+                 expected: expected_lines,
+                 actual: count)
+        end
+
+        def expected_lines
+          if allowance_range?
+            "#{minimum_empty_lines..maximum_empty_lines} empty lines"
+          else
+            lines = maximum_empty_lines == 1 ? 'line' : 'lines'
+            "#{maximum_empty_lines} empty #{lines}"
+          end
         end
 
         def multiple_blank_lines_groups?(first_def_node, second_def_node)
@@ -176,8 +184,7 @@ module RuboCop
           blank_start > non_blank_end
         end
 
-        def blank_lines_between?(first_def_node, second_def_node)
-          count = blank_lines_count_between(first_def_node, second_def_node)
+        def line_count_allowed?(count)
           (minimum_empty_lines..maximum_empty_lines).cover?(count)
         end
 
@@ -230,6 +237,19 @@ module RuboCop
 
           corrector.insert_after(where_to_insert, "\n" * difference)
         end
+
+        def node_type(node)
+          case node.type
+          when :def, :defs
+            :method
+          else
+            node.type
+          end
+        end
+
+        def allowance_range?
+          minimum_empty_lines != maximum_empty_lines
+        end
       end
     end
   end

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

@@ -4,11 +4,14 @@ module RuboCop
   module Cop
     module Layout
       # This cop checks the indentation of the first argument in a method call.
-      # Arguments after the first one are checked by Layout/ArgumentAlignment,
+      # Arguments after the first one are checked by `Layout/ArgumentAlignment`,
       # not by this cop.
       #
       # For indenting the first parameter of method _definitions_, check out
-      # Layout/FirstParameterIndentation.
+      # `Layout/FirstParameterIndentation`.
+      #
+      # This cop will respect `Layout/ArgumentAlignment` and will not work when
+      # `EnforcedStyle: with_fixed_indentation` is specified for `Layout/ArgumentAlignment`.
       #
       # @example
       #
@@ -149,6 +152,7 @@ module RuboCop
         MSG = 'Indent the first argument one step more than %<base>s.'
 
         def on_send(node)
+          return if enforce_first_argument_with_fixed_indentation?
           return if !node.arguments? || node.operator_method?
 
           indent = base_indentation(node) + configured_indentation_width
@@ -250,6 +254,16 @@ module RuboCop
         def on_new_investigation
           @comment_lines = nil
         end
+
+        def enforce_first_argument_with_fixed_indentation?
+          return false unless argument_alignment_config['Enabled']
+
+          argument_alignment_config['EnforcedStyle'] == 'with_fixed_indentation'
+        end
+
+        def argument_alignment_config
+          config.for_cop('Layout/ArgumentAlignment')
+        end
       end
     end
   end

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

@@ -60,12 +60,13 @@ module RuboCop
       #   }
       class LineLength < Base
         include CheckLineBreakable
-        include ConfigurableMax
         include IgnoredPattern
         include RangeHelp
         include LineLengthHelp
         extend AutoCorrector
 
+        exclude_limit 'Max'
+
         MSG = 'Line is too long. [%<length>d/%<max>d]'
 
         def on_block(node)

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

@@ -39,12 +39,17 @@ module RuboCop
 
             range_between(receiver_end_pos, selector_begin_pos)
           elsif node.method?(:[]=)
-            end_pos = node.receiver.source_range.end_pos
+            offense_range_for_assignment(node, begin_pos)
+          end
+        end
 
-            return if begin_pos - end_pos == 1
+        def offense_range_for_assignment(node, begin_pos)
+          end_pos = node.receiver.source_range.end_pos
 
-            range_between(end_pos, begin_pos - 1)
-          end
+          return if begin_pos - end_pos == 1 ||
+                    (range = range_between(end_pos, begin_pos - 1)).source == '['
+
+          range
         end
 
         def register_offense(range)

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

@@ -37,6 +37,11 @@ module RuboCop
         DO_NOT_USE_MSG = 'Do not use `%<bad>s`%<deprecated_message>s.'
 
         def on_const(node)
+          # FIXME: Workaround for "`undefined method `expression' for nil:NilClass`" when processing
+          #        `__ENCODING__`. It is better to be able to work without this condition.
+          #        Maybe further investigation of RuboCop AST will lead to an essential solution.
+          return unless node.loc
+
           constant = node.absolute? ? consntant_name(node, node.short_name.to_s) : node.source
           return unless (deprecated_constant = deprecated_constants[constant])
 

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

@@ -28,6 +28,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[to_sym intern].freeze
 
         def on_send(node)
+          return unless node.receiver
           return unless node.receiver.str_type? || node.receiver.sym_type?
 
           register_offense(node, correction: node.receiver.value.to_sym.inspect)
@@ -59,7 +60,7 @@ module RuboCop
         end
 
         def properly_quoted?(source, value)
-          return true unless source.match?(/['"]/)
+          return true if !source.match?(/['"]/) || value.end_with?('=')
 
           source == value ||
             # `Symbol#inspect` uses double quotes, but allow single-quoted
@@ -87,7 +88,7 @@ module RuboCop
           # will be ignored.
           return unless node.value.to_s.match?(/\A[a-z0-9_]/i)
 
-          correction = node.value.inspect.delete(':')
+          correction = node.value.inspect.gsub(/\A:/, '')
           return if properly_quoted?(node.source, correction)
 
           register_offense(

data/lib/rubocop/cop/message_annotator.rb

@@ -85,8 +85,11 @@ module RuboCop
         end
       end
 
+      # Returns the base style guide URL from AllCops or the specific department
+      #
+      # @return [String] style guide URL
       def style_guide_base_url
-        department_name = cop_name.split('/').first
+        department_name = cop_name.split('/')[0..-2].join('/')
 
         config.for_department(department_name)['StyleGuideBaseURL'] ||
           config.for_all_cops['StyleGuideBaseURL']

data/lib/rubocop/cop/metrics/block_nesting.rb

@@ -12,13 +12,13 @@ module RuboCop
       #
       # The maximum level of nesting allowed is configurable.
       class BlockNesting < Base
-        include ConfigurableMax
-
         NESTING_BLOCKS = %i[
           case if while while_post
           until until_post for resbody
         ].freeze
 
+        exclude_limit 'Max'
+
         def on_new_investigation
           return if processed_source.blank?
 

data/lib/rubocop/cop/metrics/parameter_lists.rb

@@ -51,7 +51,8 @@ module RuboCop
       #   end
       #
       class ParameterLists < Base
-        include ConfigurableMax
+        exclude_limit 'Max'
+        exclude_limit 'MaxOptionalParameters'
 
         MSG = 'Avoid parameter lists longer than %<max>d parameters. ' \
               '[%<count>d/%<max>d]'
@@ -70,7 +71,9 @@ module RuboCop
             count: optargs.count
           )
 
-          add_offense(node, message: message)
+          add_offense(node, message: message) do
+            self.max_optional_parameters = optargs.count
+          end
         end
         alias on_defs on_def
 

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

@@ -4,10 +4,12 @@ module RuboCop
   module Cop
     # Common functionality for checking length of code segments.
     module CodeLength
-      include ConfigurableMax
+      extend ExcludeLimit
 
       MSG = '%<label>s has too many lines. [%<length>d/%<max>d]'
 
+      exclude_limit 'Max'
+
       private
 
       def message(length, max_length)

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

@@ -4,6 +4,7 @@ module RuboCop
   module Cop
     # Handles `Max` configuration parameters, especially setting them to an
     # appropriate value with --auto-gen-config.
+    # @deprecated Use `exclude_limit ParameterName` instead.
     module ConfigurableMax
       private
 

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

@@ -6,10 +6,12 @@ module RuboCop
     #
     # This module handles measurement and reporting of complexity in methods.
     module MethodComplexity
-      include ConfigurableMax
       include IgnoredMethods
       include Metrics::Utils::RepeatedCsendDiscount
       extend NodePattern::Macros
+      extend ExcludeLimit
+
+      exclude_limit 'Max'
 
       # Ensure cops that include `MethodComplexity` have the config
       # `attr_accessor`s that `ignored_method?` needs.

data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb

@@ -71,7 +71,7 @@ module RuboCop
 
         def directive_cops(comment)
           match = CommentConfig::COMMENT_DIRECTIVE_REGEXP.match(comment.text)
-          match[2] ? match[2].split(',').map(&:strip) : []
+          match && match[2] ? match[2].split(',').map(&:strip) : []
         end
 
         def allowed_cops

data/lib/rubocop/cop/style/eval_with_location.rb

@@ -64,7 +64,7 @@ module RuboCop
           return if node.method?(:eval) && !valid_eval_receiver?(node.receiver)
 
           code = node.arguments.first
-          return unless code.str_type? || code.dstr_type?
+          return unless code && (code.str_type? || code.dstr_type?)
 
           file, line = file_and_line(node)
 

data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb

@@ -6,6 +6,8 @@ module RuboCop
       # This cop checks for redundant `if` with boolean literal branches.
       # It checks only conditions to return boolean value (`true` or `false`) for safe detection.
       # The conditions to be checked are comparison methods, predicate methods, and double negative.
+      # However, auto-correction is unsafe because there is no guarantee that all predicate methods
+      # will return boolean value. Those methods can be allowed with `AllowedMethods` config.
       #
       # @example
       #   # bad
@@ -21,10 +23,16 @@ module RuboCop
       #   # good
       #   foo == bar
       #
+      # @example AllowedMethods: ['nonzero?']
+      #   # good
+      #   num.nonzero? ? true : false
+      #
       class IfWithBooleanLiteralBranches < Base
+        include AllowedMethods
         extend AutoCorrector
 
         MSG = 'Remove redundant %<keyword>s with boolean literal branches.'
+        MSG_FOR_ELSIF = 'Use `else` instead of redundant `elsif` with boolean literal branches.'
 
         def_node_matcher :if_with_boolean_literal_branches?, <<~PATTERN
           (if #return_boolean_value? {(true) (false) | (false) (true)})
@@ -35,25 +43,40 @@ module RuboCop
           return unless if_with_boolean_literal_branches?(node)
 
           condition = node.condition
-          range, keyword = if node.ternary?
-                             range = condition.source_range.end.join(node.source_range.end)
-
-                             [range, 'ternary operator']
-                           else
-                             keyword = node.loc.keyword
-
-                             [keyword, "`#{keyword.source}`"]
-                           end
+          range, keyword = offense_range_with_keyword(node, condition)
 
-          add_offense(range, message: format(MSG, keyword: keyword)) do |corrector|
+          add_offense(range, message: message(node, keyword)) do |corrector|
             replacement = replacement_condition(node, condition)
 
-            corrector.replace(node, replacement)
+            if node.elsif?
+              corrector.insert_before(node, "else\n")
+              corrector.replace(node, "#{indent(node.if_branch)}#{replacement}")
+            else
+              corrector.replace(node, replacement)
+            end
           end
         end
 
         private
 
+        def offense_range_with_keyword(node, condition)
+          if node.ternary?
+            range = condition.source_range.end.join(node.source_range.end)
+
+            [range, 'ternary operator']
+          else
+            keyword = node.loc.keyword
+
+            [keyword, "`#{keyword.source}`"]
+          end
+        end
+
+        def message(node, keyword)
+          message_template = node.elsif? ? MSG_FOR_ELSIF : MSG
+
+          format(message_template, keyword: keyword)
+        end
+
         def return_boolean_value?(condition)
           if condition.begin_type?
             return_boolean_value?(condition.children.first)
@@ -68,6 +91,7 @@ module RuboCop
 
         def assume_boolean_value?(condition)
           return false unless condition.send_type?
+          return false if allowed_method?(condition.method_name)
 
           condition.comparison_method? || condition.predicate_method? || double_negative?(condition)
         end

data/lib/rubocop/cop/style/nil_comparison.rb

@@ -50,7 +50,9 @@ module RuboCop
                          end
 
               corrector.replace(node, new_code)
-              corrector.wrap(node, '(', ')') if node.parent&.method?(:!)
+
+              parent = node.parent
+              corrector.wrap(node, '(', ')') if parent.respond_to?(:method?) && parent.method?(:!)
             end
           end
         end

data/lib/rubocop/cop/style/numeric_literals.rb

@@ -28,10 +28,6 @@ module RuboCop
       #   10_000_00 # typical representation of $10,000 in cents
       #
       class NumericLiterals < Base
-        # The parameter is called MinDigits (meaning the minimum number of
-        # digits for which an offense can be registered), but essentially it's
-        # a Max parameter (the maximum number of something that's allowed).
-        include ConfigurableMax
         include IntegerNode
         extend AutoCorrector
 
@@ -39,6 +35,11 @@ module RuboCop
               'separate every 3 digits with them.'
         DELIMITER_REGEXP = /[eE.]/.freeze
 
+        # The parameter is called MinDigits (meaning the minimum number of
+        # digits for which an offense can be registered), but essentially it's
+        # a Max parameter (the maximum number of something that's allowed).
+        exclude_limit 'MinDigits'
+
         def on_int(node)
           check(node)
         end
@@ -49,10 +50,6 @@ module RuboCop
 
         private
 
-        def max_parameter_name
-          'MinDigits'
-        end
-
         def check(node)
           int = integer_part(node)
 
@@ -62,7 +59,7 @@ module RuboCop
 
           case int
           when /^\d+$/
-            return unless (self.max = int.size + 1)
+            return unless (self.min_digits = int.size + 1)
 
             register_offense(node)
           when /\d{4}/, short_group_regex

data/lib/rubocop/cop/style/numeric_predicate.rb

@@ -8,7 +8,7 @@ module RuboCop
       # These can be replaced by their respective predicate methods.
       # The cop can also be configured to do the reverse.
       #
-      # The cop disregards `#nonzero?` as it its value is truthy or falsey,
+      # The cop disregards `#nonzero?` as its value is truthy or falsey,
       # but not `true` and `false`, and thus not always interchangeable with
       # `!= 0`.
       #

data/lib/rubocop/cop/style/single_line_methods.rb

@@ -63,6 +63,8 @@ module RuboCop
         end
 
         def correct_to_endless?(body_node)
+          return false if target_ruby_version < 3.0
+
           endless_method_config = config.for_cop('Style/EndlessMethod')
 
           return false unless endless_method_config['Enabled']

data/lib/rubocop/cop/style/sole_nested_conditional.rb

@@ -112,11 +112,11 @@ module RuboCop
         def correct_outer_condition(corrector, condition)
           return unless requrie_parentheses?(condition)
 
-          range = range_between(
-            condition.loc.selector.end_pos, condition.first_argument.source_range.begin_pos
-          )
+          end_pos = condition.loc.selector.end_pos
+          begin_pos = condition.first_argument.source_range.begin_pos
+          return if end_pos > begin_pos
 
-          corrector.replace(range, '(')
+          corrector.replace(range_between(end_pos, begin_pos), '(')
           corrector.insert_after(condition.last_argument.source_range, ')')
         end
 

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -13,6 +13,7 @@ module RuboCop
       include PathUtil
 
       COLOR_FOR_SEVERITY = {
+        info:       :gray,
         refactor:   :yellow,
         convention: :yellow,
         warning:    :magenta,
@@ -76,7 +77,7 @@ module RuboCop
       end
 
       def colored_severity_code(offense)
-        color = COLOR_FOR_SEVERITY[offense.severity.name]
+        color = COLOR_FOR_SEVERITY.fetch(offense.severity.name)
         colorize(offense.severity.code, color)
       end
 

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.9.0'
+    STRING = '1.9.1'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -242,6 +242,7 @@ files:
 - lib/rubocop/cop/correctors/string_literal_corrector.rb
 - lib/rubocop/cop/correctors/unused_arg_corrector.rb
 - lib/rubocop/cop/documentation.rb
+- lib/rubocop/cop/exclude_limit.rb
 - lib/rubocop/cop/force.rb
 - lib/rubocop/cop/gemspec/duplicated_assignment.rb
 - lib/rubocop/cop/gemspec/ordered_dependencies.rb