rubocop 0.93.1 → 1.79.2

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,12 +99,11 @@ 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.'
-        MSG_EMPTY = '`%<type>s` condition requires an empty ' \
-                    '`else`-clause.'
+        MSG_NIL = '`%<type>s` condition requires an `else`-clause with `nil` in it.'
+        MSG_EMPTY = '`%<type>s` condition requires an empty `else`-clause.'
 
         def on_normal_if_unless(node)
           return if case_style?
@@ -116,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
@@ -135,6 +143,17 @@ module RuboCop
           end
         end
 
+        def autocorrect(corrector, node)
+          node = node.ancestors.find { |ancestor| ancestor.loc.end } unless node.loc.end
+
+          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
@@ -151,10 +170,6 @@ module RuboCop
           config.for_cop('Style/UnlessElse')
         end
 
-        def empty_else_cop_enabled?
-          empty_else_config.fetch('Enabled')
-        end
-
         def empty_else_style
           return unless empty_else_config.key?('EnforcedStyle')
 

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

@@ -3,27 +3,56 @@
 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?`.
       #
+      # Not defining `respond_to_missing?` will cause metaprogramming
+      # methods like `respond_to?` to behave unexpectedly:
+      #
+      # [source,ruby]
+      # ----
+      # class StringDelegator
+      #   def initialize(string)
+      #     @string = string
+      #   end
+      #
+      #   def method_missing(name, *args)
+      #     @string.send(name, *args)
+      #   end
+      # end
+      #
+      # delegator = StringDelegator.new("foo")
+      # # Claims to not respond to `upcase`.
+      # delegator.respond_to?(:upcase) # => false
+      # # But you can call it.
+      # delegator.upcase # => FOO
+      # ----
+      #
       # @example
-      #   #bad
+      #   # bad
       #   def method_missing(name, *args)
-      #     # ...
+      #     if @delegate.respond_to?(name)
+      #       @delegate.send(name, *args)
+      #     else
+      #       super
+      #     end
       #   end
       #
-      #   #good
+      #   # good
       #   def respond_to_missing?(name, include_private)
-      #     # ...
+      #     @delegate.respond_to?(name) || super
       #   end
       #
       #   def method_missing(name, *args)
-      #     # ...
+      #     if @delegate.respond_to?(name)
+      #       @delegate.send(name, *args)
+      #     else
+      #       super
+      #     end
       #   end
       #
       class MissingRespondToMissing < Base
-        MSG =
-          'When using `method_missing`, define `respond_to_missing?`.'
+        MSG = 'When using `method_missing`, define `respond_to_missing?`.'
 
         def on_def(node)
           return unless node.method?(:method_missing)

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,10 +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
@@ -76,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)
@@ -95,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)
@@ -103,12 +102,9 @@ module RuboCop
         end
 
         def sibling_mixins(send_node)
-          siblings = send_node.parent.each_child_node(:send)
-                              .select(&:macro?)
+          siblings = send_node.parent.each_child_node(:send).select(&:macro?)
 
-          siblings.select do |sibling_node|
-            sibling_node.method?(send_node.method_name)
-          end
+          siblings.select { |sibling_node| sibling_node.method?(send_node.method_name) }
         end
 
         def grouped_style?
@@ -123,22 +119,16 @@ 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
 
         def group_mixins(node, mixins)
-          mixin_names = mixins.reverse.flat_map do |mixin|
-            mixin.arguments.map(&:source)
-          end
+          mixin_names = mixins.reverse.flat_map { |mixin| mixin.arguments.map(&:source) }
 
           "#{node.method_name} #{mixin_names.join(', ')}"
         end
-
-        def indent(node)
-          ' ' * node.loc.column
-        end
       end
     end
   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`.
       #
@@ -41,15 +41,16 @@ module RuboCop
       #     prepend M
       #   end
       class MixinUsage < Base
-        MSG = '`%<statement>s` is used at the top level. Use inside `class` ' \
-              'or `module`.'
+        MSG = '`%<statement>s` is used at the top level. Use inside `class` or `module`.'
         RESTRICT_ON_SEND = %i[include extend prepend].freeze
 
+        # @!method include_statement(node)
         def_node_matcher :include_statement, <<~PATTERN
           (send nil? ${:include :extend :prepend}
             const)
         PATTERN
 
+        # @!method in_top_level_scope?(node)
         def_node_matcher :in_top_level_scope?, <<~PATTERN
           {
             root?                        # either at the top level

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,21 +86,27 @@ 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
 
-        MODULE_FUNCTION_MSG =
-          'Use `module_function` instead of `extend self`.'
-        EXTEND_SELF_MSG =
-          'Use `extend self` instead of `module_function`.'
-        FORBIDDEN_MSG =
-          'Do not use `module_function` or `extend self`.'
+        MODULE_FUNCTION_MSG = 'Use `module_function` instead of `extend self`.'
+        EXTEND_SELF_MSG = 'Use `extend self` instead of `module_function`.'
+        FORBIDDEN_MSG = 'Do not use `module_function` or `extend self`.'
 
+        # @!method module_function_node?(node)
         def_node_matcher :module_function_node?, '(send nil? :module_function)'
+
+        # @!method extend_self_node?(node)
         def_node_matcher :extend_self_node?, '(send nil? :extend self)'
+
+        # @!method private_directive?(node)
         def_node_matcher :private_directive?, '(send nil? :private ...)'
 
         def on_module(node)
@@ -116,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
@@ -28,13 +28,12 @@ module RuboCop
         MSG = 'Avoid multi-line chains of blocks.'
 
         def on_block(node)
-          node.send_node.each_node(:send) do |send_node|
+          node.send_node.each_node(:call) do |send_node|
             receiver = send_node.receiver
 
-            next unless receiver&.block_type? && receiver&.multiline?
+            next unless receiver&.any_block_type? && receiver.multiline?
 
-            range = range_between(receiver.loc.end.begin_pos,
-                                  node.send_node.source_range.end_pos)
+            range = range_between(receiver.loc.end.begin_pos, node.send_node.source_range.end_pos)
 
             add_offense(range)
 
@@ -43,6 +42,9 @@ module RuboCop
             break
           end
         end
+
+        alias on_numblock on_block
+        alias on_itblock on_block
       end
     end
   end

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

@@ -19,15 +19,17 @@ 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 if part_of_ignored_node?(node)
           return unless node.modifier_form? && node.body.multiline?
 
           add_offense(node, message: format(MSG, keyword: node.keyword)) do |corrector|
             corrector.replace(node, to_normal_if(node))
           end
+          ignore_node(node)
         end
 
         private
@@ -40,10 +42,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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks uses of the `then` keyword in multi-line `in` statement.
+      #
+      # @example
+      #   # bad
+      #   case expression
+      #   in pattern then
+      #   end
+      #
+      #   # good
+      #   case expression
+      #   in pattern
+      #   end
+      #
+      #   # good
+      #   case expression
+      #   in pattern then do_something
+      #   end
+      #
+      #   # good
+      #   case expression
+      #   in pattern then do_something(arg1,
+      #                                arg2)
+      #   end
+      #
+      class MultilineInPatternThen < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.7
+
+        MSG = 'Do not use `then` for multiline `in` statement.'
+
+        def on_in_pattern(node)
+          return if !node.then? || require_then?(node)
+
+          range = node.loc.begin
+          add_offense(range) do |corrector|
+            corrector.remove(range_with_surrounding_space(range, side: :left, newlines: false))
+          end
+        end
+
+        private
+
+        # Requires `then` for write `in` and its body on the same line.
+        def require_then?(in_pattern_node)
+          return true unless in_pattern_node.pattern.single_line?
+          return false unless in_pattern_node.body
+
+          same_line?(in_pattern_node, in_pattern_node.body)
+        end
+      end
+    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
 
@@ -38,11 +39,11 @@ module RuboCop
         BRACES_MSG = 'Wrap multiline memoization blocks in `(` and `)`.'
 
         def on_or_asgn(node)
-          _lhs, rhs = *node
+          rhs = node.expression
 
           return unless bad_rhs?(rhs)
 
-          add_offense(node.source_range) do |corrector|
+          add_offense(node) do |corrector|
             if style == :keyword
               keyword_autocorrect(rhs, corrector)
             else
@@ -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