rubocop 1.18.0 → 1.56.0

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Enforces the use of `max` or `min` instead of comparison for greater or less.
+      #
+      # NOTE: It can be used if you want to present limit or threshold in Ruby 2.7+.
+      # That it is slow though. So autocorrection will apply generic `max` or `min`:
+      #
+      # [source,ruby]
+      # ----
+      # a.clamp(b..) # Same as `[a, b].max`
+      # a.clamp(..b) # Same as `[a, b].min`
+      # ----
+      #
+      # @safety
+      #   This cop is unsafe because even if a value has `<` or `>` method,
+      #   it is not necessarily `Comparable`.
+      #
+      # @example
+      #
+      #   # bad
+      #   a > b ? a : b
+      #   a >= b ? a : b
+      #
+      #   # good
+      #   [a, b].max
+      #
+      #   # bad
+      #   a < b ? a : b
+      #   a <= b ? a : b
+      #
+      #   # good
+      #   [a, b].min
+      #
+      class MinMaxComparison < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `%<prefer>s` instead.'
+        GRATER_OPERATORS = %i[> >=].freeze
+        LESS_OPERATORS = %i[< <=].freeze
+        COMPARISON_OPERATORS = GRATER_OPERATORS + LESS_OPERATORS
+
+        def on_if(node)
+          lhs, operator, rhs = *node.condition
+          return unless COMPARISON_OPERATORS.include?(operator)
+
+          if_branch = node.if_branch
+          else_branch = node.else_branch
+          preferred_method = preferred_method(operator, lhs, rhs, if_branch, else_branch)
+          return unless preferred_method
+
+          replacement = "[#{lhs.source}, #{rhs.source}].#{preferred_method}"
+
+          add_offense(node, message: format(MSG, prefer: replacement)) do |corrector|
+            autocorrect(corrector, node, replacement)
+          end
+        end
+
+        private
+
+        def preferred_method(operator, lhs, rhs, if_branch, else_branch)
+          if lhs == if_branch && rhs == else_branch
+            GRATER_OPERATORS.include?(operator) ? 'max' : 'min'
+          elsif lhs == else_branch && rhs == if_branch
+            LESS_OPERATORS.include?(operator) ? 'max' : 'min'
+          end
+        end
+
+        def autocorrect(corrector, node, replacement)
+          if node.elsif?
+            corrector.remove(range_between(node.parent.loc.else.begin_pos, node.loc.else.begin_pos))
+            corrector.replace(node.else_branch, replacement)
+          else
+            corrector.replace(node, replacement)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,27 +5,30 @@ module RuboCop
     module Style
       # Checks for `if` expressions that do not have an `else` branch.
       #
+      # NOTE: Pattern matching is allowed to have no `else` branch because unlike `if` and `case`,
+      # it raises `NoMatchingPatternError` if the pattern doesn't match and without having `else`.
+      #
       # Supported styles are: if, case, both.
       #
-      # @example EnforcedStyle: if
-      #   # warn when an `if` expression is missing an `else` branch.
+      # @example EnforcedStyle: both (default)
+      #   # warn when an `if` or `case` expression is missing an `else` branch.
       #
       #   # bad
       #   if condition
       #     statement
       #   end
       #
-      #   # good
-      #   if condition
+      #   # bad
+      #   case var
+      #   when condition
       #     statement
-      #   else
-      #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
       #   # good
-      #   case var
-      #   when condition
+      #   if condition
       #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
       #   # good
@@ -36,59 +39,59 @@ module RuboCop
       #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
-      # @example EnforcedStyle: case
-      #   # warn when a `case` expression is missing an `else` branch.
+      # @example EnforcedStyle: if
+      #   # warn when an `if` expression is missing an `else` branch.
       #
       #   # bad
-      #   case var
-      #   when condition
+      #   if condition
       #     statement
       #   end
       #
       #   # good
-      #   case var
-      #   when condition
+      #   if condition
       #     statement
       #   else
       #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
       #   # good
-      #   if condition
+      #   case var
+      #   when condition
       #     statement
       #   end
       #
       #   # good
-      #   if condition
+      #   case var
+      #   when condition
       #     statement
       #   else
       #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
-      # @example EnforcedStyle: both (default)
-      #   # warn when an `if` or `case` expression is missing an `else` branch.
+      # @example EnforcedStyle: case
+      #   # warn when a `case` expression is missing an `else` branch.
       #
       #   # bad
-      #   if condition
+      #   case var
+      #   when condition
       #     statement
       #   end
       #
-      #   # bad
+      #   # good
       #   case var
       #   when condition
       #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
       #   # good
       #   if condition
       #     statement
-      #   else
-      #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       #
       #   # good
-      #   case var
-      #   when condition
+      #   if condition
       #     statement
       #   else
       #     # the content of `else` branch will be determined by Style/EmptyElse
@@ -96,6 +99,7 @@ module RuboCop
       class MissingElse < Base
         include OnNormalIfUnless
         include ConfigurableEnforcedStyle
+        extend AutoCorrector
 
         MSG = '`%<type>s` condition requires an `else`-clause.'
         MSG_NIL = '`%<type>s` condition requires an `else`-clause with `nil` in it.'
@@ -114,12 +118,18 @@ module RuboCop
           check(node)
         end
 
+        def on_case_match(node)
+          # do nothing.
+        end
+
         private
 
         def check(node)
           return if node.else?
 
-          add_offense(node, message: format(message_template, type: node.type))
+          add_offense(node, message: format(message_template, type: node.type)) do |corrector|
+            autocorrect(corrector, node)
+          end
         end
 
         def message_template
@@ -133,6 +143,15 @@ module RuboCop
           end
         end
 
+        def autocorrect(corrector, node)
+          case empty_else_style
+          when :empty
+            corrector.insert_before(node.loc.end, 'else; nil; ')
+          when :nil
+            corrector.insert_before(node.loc.end, 'else; ')
+          end
+        end
+
         def if_style?
           style == :if
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the presence of `method_missing` without also
+      # Checks for the presence of `method_missing` without also
       # defining `respond_to_missing?`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for grouping of mixins in `class` and `module` bodies.
+      # Checks for grouping of mixins in `class` and `module` bodies.
       # By default it enforces mixins to be placed in separate declarations,
       # but it can be configured to enforce grouping them in one declaration.
       #
@@ -40,7 +40,7 @@ module RuboCop
         def on_class(node)
           begin_node = node.child_nodes.find(&:begin_type?) || node
           begin_node.each_child_node(:send).select(&:macro?).each do |macro|
-            next unless MIXIN_METHODS.include?(macro.method_name)
+            next if !MIXIN_METHODS.include?(macro.method_name) || macro.arguments.empty?
 
             check(macro)
           end
@@ -51,9 +51,9 @@ module RuboCop
         private
 
         def range_to_remove_for_subsequent_mixin(mixins, node)
-          range = node.loc.expression
+          range = node.source_range
           prev_mixin = mixins.each_cons(2) { |m, n| break m if n == node }
-          between = prev_mixin.loc.expression.end.join(range.begin)
+          between = prev_mixin.source_range.end.join(range.begin)
           # if separated from previous mixin with only whitespace?
           unless /\S/.match?(between.source)
             range = range.join(between) # then remove that too
@@ -75,7 +75,7 @@ module RuboCop
           message = format(MSG, mixin: send_node.method_name, suffix: 'a single statement')
 
           add_offense(send_node, message: message) do |corrector|
-            range = send_node.loc.expression
+            range = send_node.source_range
             mixins = sibling_mixins(send_node)
             if send_node == mixins.first
               correction = group_mixins(send_node, mixins)
@@ -94,7 +94,7 @@ module RuboCop
           message = format(MSG, mixin: send_node.method_name, suffix: 'separate statements')
 
           add_offense(send_node, message: message) do |corrector|
-            range = send_node.loc.expression
+            range = send_node.source_range
             correction = separate_mixins(send_node)
 
             corrector.replace(range, correction)
@@ -119,7 +119,7 @@ module RuboCop
           arguments = node.arguments.reverse
           mixins = ["#{node.method_name} #{arguments.first.source}"]
 
-          arguments[1..-1].inject(mixins) do |replacement, arg|
+          arguments[1..].inject(mixins) do |replacement, arg|
             replacement << "#{indent(node)}#{node.method_name} #{arg.source}"
           end.join("\n")
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks that `include`, `extend` and `prepend` statements appear
+      # Checks that `include`, `extend` and `prepend` statements appear
       # inside classes and modules, not at the top level, so as to not affect
       # the behavior of `Object`.
       #

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

@@ -3,10 +3,19 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for use of `extend self` or `module_function` in a
-      # module.
+      # Checks for use of `extend self` or `module_function` in a module.
       #
-      # Supported styles are: module_function, extend_self, forbidden.
+      # Supported styles are: `module_function` (default), `extend_self` and `forbidden`.
+      #
+      # A couple of things to keep in mind:
+      #
+      # - `forbidden` style prohibits the usage of both styles
+      # - in default mode (`module_function`), the cop won't be activated when the module
+      #   contains any private methods
+      #
+      # @safety
+      #   Autocorrection is unsafe (and is disabled by default) because `extend self`
+      #   and `module_function` do not behave exactly the same.
       #
       # @example EnforcedStyle: module_function (default)
       #   # bad
@@ -21,10 +30,6 @@ module RuboCop
       #     # ...
       #   end
       #
-      # In case there are private methods, the cop won't be activated.
-      # Otherwise, it forces to change the flow of the default code.
-      #
-      # @example EnforcedStyle: module_function (default)
       #   # good
       #   module Test
       #     extend self
@@ -33,6 +38,13 @@ module RuboCop
       #     # ...
       #   end
       #
+      #   # good
+      #   module Test
+      #     class << self
+      #       # ...
+      #     end
+      #   end
+      #
       # @example EnforcedStyle: extend_self
       #   # bad
       #   module Test
@@ -46,7 +58,12 @@ module RuboCop
       #     # ...
       #   end
       #
-      # The option `forbidden` prohibits the usage of both styles.
+      #   # good
+      #   module Test
+      #     class << self
+      #       # ...
+      #     end
+      #   end
       #
       # @example EnforcedStyle: forbidden
       #   # bad
@@ -69,8 +86,12 @@ module RuboCop
       #     # ...
       #   end
       #
-      # These offenses are not safe to auto-correct since there are different
-      # implications to each approach.
+      #   # good
+      #   module Test
+      #     class << self
+      #       # ...
+      #     end
+      #   end
       class ModuleFunction < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
@@ -118,10 +139,10 @@ module RuboCop
         end
 
         def check_module_function(nodes)
-          private_directive = nodes.any? { |node| private_directive?(node) }
+          return if nodes.any? { |node| private_directive?(node) }
 
           nodes.each do |node|
-            yield node if extend_self_node?(node) && !private_directive
+            yield node if extend_self_node?(node)
           end
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for chaining of a block after another block that spans
+      # Checks for chaining of a block after another block that spans
       # multiple lines.
       #
       # @example
@@ -31,7 +31,7 @@ module RuboCop
           node.send_node.each_node(:send) do |send_node|
             receiver = send_node.receiver
 
-            next unless receiver&.block_type? && receiver&.multiline?
+            next unless (receiver&.block_type? || receiver&.numblock_type?) && receiver&.multiline?
 
             range = range_between(receiver.loc.end.begin_pos, node.send_node.source_range.end_pos)
 
@@ -42,6 +42,8 @@ module RuboCop
             break
           end
         end
+
+        alias on_numblock on_block
       end
     end
   end

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

@@ -19,8 +19,8 @@ module RuboCop
         include Alignment
         extend AutoCorrector
 
-        MSG = 'Favor a normal %<keyword>s-statement over a modifier' \
-              ' clause in a multiline statement.'
+        MSG = 'Favor a normal %<keyword>s-statement over a modifier ' \
+              'clause in a multiline statement.'
 
         def on_if(node)
           return unless node.modifier_form? && node.body.multiline?
@@ -40,10 +40,6 @@ module RuboCop
           [condition, indented_body, indented_end].join("\n")
         end
 
-        def configured_indentation_width
-          super || 2
-        end
-
         def indented_body(body, node)
           body_source = "#{offset(node)}#{body.source}"
           body_source.each_line.map do |line|

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

@@ -29,7 +29,7 @@ module RuboCop
           return unless non_modifier_then?(node)
 
           add_offense(node.loc.begin, message: format(MSG, keyword: node.keyword)) do |corrector|
-            corrector.remove(range_with_surrounding_space(range: node.loc.begin, side: :left))
+            corrector.remove(range_with_surrounding_space(node.loc.begin, side: :left))
           end
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks uses of the `then` keyword in multi-line `in` statement.
+      # Checks uses of the `then` keyword in multi-line `in` statement.
       #
       # @example
       #   # bad
@@ -41,9 +41,7 @@ module RuboCop
 
           range = node.loc.begin
           add_offense(range) do |corrector|
-            corrector.remove(
-              range_with_surrounding_space(range: range, side: :left, newlines: false)
-            )
+            corrector.remove(range_with_surrounding_space(range, side: :left, newlines: false))
           end
         end
 
@@ -51,10 +49,10 @@ module RuboCop
 
         # Requires `then` for write `in` and its body on the same line.
         def require_then?(in_pattern_node)
-          return true if in_pattern_node.pattern.first_line != in_pattern_node.pattern.last_line
+          return true unless in_pattern_node.pattern.single_line?
           return false unless in_pattern_node.body
 
-          in_pattern_node.loc.line == in_pattern_node.body.loc.line
+          same_line?(in_pattern_node, in_pattern_node.body)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks expressions wrapping styles for multiline memoization.
+      # Checks expressions wrapping styles for multiline memoization.
       #
       # @example EnforcedStyle: keyword (default)
       #   # bad
@@ -31,6 +31,7 @@ module RuboCop
       #     baz
       #   )
       class MultilineMemoization < Base
+        include Alignment
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
@@ -75,11 +76,10 @@ module RuboCop
         end
 
         def keyword_begin_str(node, node_buf)
-          indent = config.for_cop('Layout/IndentationWidth')['Width'] || 2
           if node_buf.source[node.loc.begin.end_pos] == "\n"
             'begin'
           else
-            "begin\n#{' ' * (node.loc.column + indent)}"
+            "begin\n#{' ' * (node.loc.column + configured_indentation_width)}"
           end
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for method signatures that span multiple lines.
+      # Checks for method signatures that span multiple lines.
       #
       # @example
       #
@@ -28,14 +28,17 @@ module RuboCop
           return unless node.arguments?
           return if opening_line(node) == closing_line(node)
           return if correction_exceeds_max_line_length?(node)
+          return unless (begin_of_arguments = node.arguments.loc.begin)
 
-          add_offense(node) { |corrector| autocorrect(corrector, node) }
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node, begin_of_arguments)
+          end
         end
         alias on_defs on_def
 
         private
 
-        def autocorrect(corrector, node)
+        def autocorrect(corrector, node, begin_of_arguments)
           arguments = node.arguments
           joined_arguments = arguments.map(&:source).join(', ')
           last_line_source_of_arguments = last_line_source_of_arguments(arguments)
@@ -47,7 +50,7 @@ module RuboCop
           end
 
           corrector.remove(arguments_range(node))
-          corrector.insert_after(arguments.loc.begin, joined_arguments)
+          corrector.insert_after(begin_of_arguments, joined_arguments)
         end
 
         def last_line_source_of_arguments(arguments)
@@ -59,7 +62,7 @@ module RuboCop
             node.first_argument.source_range.begin_pos, node.last_argument.source_range.end_pos
           )
 
-          range_with_surrounding_space(range: range, side: :left)
+          range_with_surrounding_space(range, side: :left)
         end
 
         def opening_line(node)
@@ -75,7 +78,7 @@ module RuboCop
         end
 
         def indentation_width(node)
-          processed_source.line_indentation(node.loc.expression.line)
+          processed_source.line_indentation(node.source_range.line)
         end
 
         def definition_width(node)

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

@@ -3,10 +3,11 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for multi-line ternary op expressions.
+      # Checks for multi-line ternary op expressions.
       #
       # NOTE: `return if ... else ... end` is syntax error. If `return` is used before
-      # multiline ternary operator expression, it cannot be auto-corrected.
+      # multiline ternary operator expression, it will be autocorrected to single-line
+      # ternary operator. The same is true for `break`, `next`, and method call.
       #
       # @example
       #   # bad
@@ -18,6 +19,10 @@ module RuboCop
       #       b :
       #       c
       #
+      #   return cond ?
+      #          b :
+      #          c
+      #
       #   # good
       #   a = cond ? b : c
       #   a = if cond
@@ -25,20 +30,48 @@ module RuboCop
       #   else
       #     c
       #   end
+      #
+      #   return cond ? b : c
+      #
       class MultilineTernaryOperator < Base
+        include CommentsHelp
         extend AutoCorrector
 
-        MSG = 'Avoid multi-line ternary operators, use `if` or `unless` instead.'
+        MSG_IF = 'Avoid multi-line ternary operators, use `if` or `unless` instead.'
+        MSG_SINGLE_LINE = 'Avoid multi-line ternary operators, use single-line instead.'
+        SINGLE_LINE_TYPES = %i[return break next send].freeze
 
         def on_if(node)
           return unless offense?(node)
 
-          add_offense(node) do |corrector|
-            # `return if ... else ... end` is syntax error. If `return` is used before
-            # multiline ternary operator expression, it cannot be auto-corrected.
-            next unless offense?(node) && !node.parent.return_type?
+          message = enforce_single_line_ternary_operator?(node) ? MSG_SINGLE_LINE : MSG_IF
+
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        def offense?(node)
+          node.ternary? && node.multiline?
+        end
 
-            corrector.replace(node, <<~RUBY.chop)
+        def autocorrect(corrector, node)
+          return unless offense?(node)
+
+          corrector.replace(node, replacement(node))
+          return unless (parent = node.parent)
+          return unless (comments_in_condition = comments_in_condition(node))
+
+          corrector.insert_before(parent, comments_in_condition)
+        end
+
+        def replacement(node)
+          if enforce_single_line_ternary_operator?(node)
+            "#{node.condition.source} ? #{node.if_branch.source} : #{node.else_branch.source}"
+          else
+            <<~RUBY.chop
               if #{node.condition.source}
                 #{node.if_branch.source}
               else
@@ -48,10 +81,18 @@ module RuboCop
           end
         end
 
-        private
+        def comments_in_condition(node)
+          comments_in_range(node).map do |comment|
+            "#{comment.source}\n"
+          end.join
+        end
 
-        def offense?(node)
-          node.ternary? && node.multiline?
+        def enforce_single_line_ternary_operator?(node)
+          SINGLE_LINE_TYPES.include?(node.parent&.type) && !use_assignment_method?(node.parent)
+        end
+
+        def use_assignment_method?(node)
+          node.send_type? && node.assignment_method?
         end
       end
     end