rubocop 0.70.0 → 0.75.0

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

@@ -118,9 +118,9 @@ module RuboCop
 
         def alternative_style
           case style
-          when :hash_rockets then
+          when :hash_rockets
             :ruby19
-          when :ruby19, :ruby19_no_mixed_keys then
+          when :ruby19, :ruby19_no_mixed_keys
             :hash_rockets
           end
         end

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

@@ -27,6 +27,37 @@ module RuboCop
       #   else
       #     action_c
       #   end
+      #
+      # @example AllowIfModifier: false (default)
+      #   # bad
+      #   if condition_a
+      #     action_a
+      #   else
+      #     action_b if condition_b
+      #   end
+      #
+      #   # good
+      #   if condition_a
+      #     action_a
+      #   elsif condition_b
+      #     action_b
+      #   end
+      #
+      # @example AllowIfModifier: true
+      #   # good
+      #   if condition_a
+      #     action_a
+      #   else
+      #     action_b if condition_b
+      #   end
+      #
+      #   # good
+      #   if condition_a
+      #     action_a
+      #   elsif condition_b
+      #     action_b
+      #   end
+      #
       class IfInsideElse < Cop
         MSG = 'Convert `if` nested inside `else` to `elsif`.'
 
@@ -36,9 +67,20 @@ module RuboCop
           else_branch = node.else_branch
 
           return unless else_branch&.if_type? && else_branch&.if?
+          return if allow_if_modifier_in_else_branch?(else_branch)
 
           add_offense(else_branch, location: :keyword)
         end
+
+        private
+
+        def allow_if_modifier_in_else_branch?(else_branch)
+          allow_if_modifier? && else_branch&.modifier_form?
+        end
+
+        def allow_if_modifier?
+          cop_config['AllowIfModifier']
+        end
       end
     end
   end

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

@@ -3,10 +3,13 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for if and unless statements that would fit on one line
-      # if written as a modifier if/unless. The maximum line length is
-      # configured in the `Metrics/LineLength` cop. The tab size is configured
-      # in the `IndentationWidth` of the `Layout/Tab` cop.
+      # Checks for `if` and `unless` statements that would fit on one line if
+      # written as modifier `if`/`unless`. The cop also checks for modifier
+      # `if`/`unless` lines that exceed the maximum line length.
+      #
+      # The maximum line length is configured in the `Metrics/LineLength`
+      # cop. The tab size is configured in the `IndentationWidth` of the
+      # `Layout/Tab` cop.
       #
       # @example
       #   # bad
@@ -18,35 +21,59 @@ module RuboCop
       #     Foo.do_something
       #   end
       #
+      #   do_something_in_a_method_with_a_long_name(arg) if long_condition
+      #
       #   # good
       #   do_stuff(bar) if condition
       #   Foo.do_something unless qux.empty?
+      #
+      #   if long_condition
+      #     do_something_in_a_method_with_a_long_name(arg)
+      #   end
       class IfUnlessModifier < Cop
         include StatementModifier
 
-        MSG = 'Favor modifier `%<keyword>s` usage when having a single-line ' \
-              'body. Another good alternative is the usage of control flow ' \
-              '`&&`/`||`.'
+        MSG_USE_MODIFIER = 'Favor modifier `%<keyword>s` usage when having a ' \
+                           'single-line body. Another good alternative is ' \
+                           'the usage of control flow `&&`/`||`.'
+        MSG_USE_NORMAL =
+          'Modifier form of `%<keyword>s` makes the line too long.'
 
         ASSIGNMENT_TYPES = %i[lvasgn casgn cvasgn
                               gvasgn ivasgn masgn].freeze
 
         def on_if(node)
-          return unless eligible_node?(node)
-          return if named_capture_in_condition?(node)
-
-          add_offense(node, location: :keyword,
-                            message: format(MSG, keyword: node.keyword))
+          msg = if eligible_node?(node)
+                  MSG_USE_MODIFIER unless named_capture_in_condition?(node)
+                elsif node.modifier_form? && too_long_single_line?(node)
+                  MSG_USE_NORMAL
+                end
+          return unless msg
+
+          add_offense(node,
+                      location: :keyword,
+                      message: format(msg, keyword: node.keyword))
         end
 
         def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.source_range, to_modifier_form(node))
-          end
+          replacement = if node.modifier_form?
+                          to_normal_form(node)
+                        else
+                          to_modifier_form(node)
+                        end
+          ->(corrector) { corrector.replace(node.source_range, replacement) }
         end
 
         private
 
+        def too_long_single_line?(node)
+          return false unless max_line_length
+
+          range = node.source_range
+          range.first_line == range.last_line &&
+            range.last_column > max_line_length
+        end
+
         def named_capture_in_condition?(node)
           node.condition.match_with_lvasgn_type?
         end
@@ -79,6 +106,15 @@ module RuboCop
           parenthesize?(node) ? "(#{expression})" : expression
         end
 
+        def to_normal_form(node)
+          indentation = ' ' * node.source_range.column
+          <<~RUBY.chomp
+            #{node.keyword} #{node.condition.source}
+            #{indentation}  #{node.body.source}
+            #{indentation}end
+          RUBY
+        end
+
         def first_line_comment(node)
           comment =
             processed_source.find_comment { |c| c.loc.line == node.loc.line }

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

@@ -119,7 +119,7 @@ module RuboCop
         end
 
         def configured_indent
-          ' ' * config.for_cop('IndentationWidth')['Width']
+          ' ' * config.for_cop('Layout/IndentationWidth')['Width']
         end
       end
     end

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

@@ -47,7 +47,7 @@ module RuboCop
           [Style::Not]
         end
 
-        def_node_matcher :inverse_candidate?, <<-PATTERN
+        def_node_matcher :inverse_candidate?, <<~PATTERN
           {
             (send $(send $(...) $_ $...) :!)
             (send (block $(send $(...) $_) $...) :!)
@@ -55,7 +55,7 @@ module RuboCop
           }
         PATTERN
 
-        def_node_matcher :inverse_block?, <<-PATTERN
+        def_node_matcher :inverse_block?, <<~PATTERN
           (block $(send (...) $_) ... { $(send ... :!)
                                         $(send (...) {:!= :!~} ...)
                                         (begin ... $(send ... :!))

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

@@ -62,8 +62,6 @@ module RuboCop
           }
         }.freeze
 
-        def_node_matcher :lambda_node?, '(block $(send nil? :lambda) ...)'
-
         def on_block(node)
           return unless node.lambda?
 

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

@@ -9,7 +9,7 @@ module RuboCop
       #
       # In the default style (require_parentheses), macro methods are ignored.
       # Additional methods can be added to the `IgnoredMethods`
-      # or `IgnoredMethodPatterns` list. These options are
+      # or `IgnoredPatterns` list. These options are
       # valid only in the default style. Macros can be included by
       # either setting `IgnoreMacros` to false or adding specific macros to
       # the `IncludedMacros` list.
@@ -17,7 +17,7 @@ module RuboCop
       # Precedence of options is all follows:
       #
       # 1. `IgnoredMethods`
-      # 2. `IgnoredMethodPatterns`
+      # 2. `IgnoredPatterns`
       # 3. `IncludedMacros`
       #
       # eg. If a method is listed in both
@@ -61,7 +61,7 @@ module RuboCop
       #   # okay with `puts` listed in `IgnoredMethods`
       #   puts 'test'
       #
-      #   # okay with `^assert` listed in `IgnoredMethodPatterns`
+      #   # okay with `^assert` listed in `IgnoredPatterns`
       #   assert_equal 'test', x
       #
       #   # IgnoreMacros: true (default)
@@ -148,7 +148,7 @@ module RuboCop
       class MethodCallWithArgsParentheses < Cop
         include ConfigurableEnforcedStyle
         include IgnoredMethods
-        include IgnoredMethodPatterns
+        include IgnoredPattern
 
         TRAILING_WHITESPACE_REGEX = /\s+\Z/.freeze
 
@@ -186,7 +186,7 @@ module RuboCop
 
         def add_offense_for_require_parentheses(node)
           return if ignored_method?(node.method_name)
-          return if ignored_method_pattern?(node.method_name)
+          return if matches_ignored_pattern?(node.method_name)
           return if eligible_for_parentheses_omission?(node)
           return unless node.arguments? && !node.parenthesized?
 
@@ -348,7 +348,8 @@ module RuboCop
         end
 
         def ambigious_literal?(node)
-          splat?(node) || ternary_if?(node) || regexp_slash_literal?(node)
+          splat?(node) || ternary_if?(node) || regexp_slash_literal?(node) ||
+            unary_literal?(node)
         end
 
         def splat?(node)
@@ -371,6 +372,11 @@ module RuboCop
           node.regexp_type? && node.loc.begin.source == '/'
         end
 
+        def unary_literal?(node)
+          node.numeric_type? && node.sign? ||
+            node.parent&.send_type? && node.parent&.unary_operation?
+        end
+
         def assigned_before?(node, target)
           node.assignment? &&
             node.loc.operator.begin < target.loc.begin

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

@@ -38,7 +38,7 @@ module RuboCop
 
         private
 
-        def_node_matcher :min_max_candidate, <<-PATTERN
+        def_node_matcher :min_max_candidate, <<~PATTERN
           ({array return} (send [$_receiver !nil?] :min) (send [$_receiver !nil?] :max))
         PATTERN
 

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

@@ -44,11 +44,15 @@ module RuboCop
         MSG = '`%<statement>s` is used at the top level. Use inside `class` ' \
               'or `module`.'
 
-        def_node_matcher :include_statement, <<-PATTERN
+        def_node_matcher :include_statement, <<~PATTERN
           (send nil? ${:include :extend :prepend}
             const)
         PATTERN
 
+        def_node_matcher :wrapped_macro_scope?, <<~PATTERN
+          {({sclass class module block} ... ({begin if} ...))}
+        PATTERN
+
         def on_send(node)
           include_statement(node) do |statement|
             return if node.argument? ||
@@ -62,7 +66,13 @@ module RuboCop
         private
 
         def accepted_include?(node)
-          node.parent && node.macro?
+          node.parent && (node.macro? || ascend_macro_scope?(node.parent))
+        end
+
+        def ascend_macro_scope?(ancestor)
+          return true if wrapped_macro_scope?(ancestor)
+
+          ancestor.parent && ascend_macro_scope?(ancestor.parent)
         end
 
         def belongs_to_class_or_module?(node)

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

@@ -73,7 +73,7 @@ module RuboCop
         end
 
         def keyword_begin_str(node, node_buf)
-          indent = config.for_cop('IndentationWidth')['Width'] || 2
+          indent = config.for_cop('Layout/IndentationWidth')['Width'] || 2
           if node_buf.source[node.loc.begin.end_pos] == "\n"
             'begin'
           else

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks uses of the `then` keyword
+      # in multi-line when statements.
+      #
+      # @example
+      #   # bad
+      #   case foo
+      #   when bar then
+      #   end
+      #
+      #   # good
+      #   case foo
+      #   when bar
+      #   end
+      #
+      #   # good
+      #   case foo
+      #   when bar then do_something
+      #   end
+      #
+      class MultilineWhenThen < Cop
+        include RangeHelp
+
+        MSG = 'Do not use `then` for multiline `when` statement.'
+
+        def on_when(node)
+          # Without `then`, there's no offense
+          return unless node.then?
+
+          # Single line usage of `then` is not an offense
+          return if !node.children.last.nil? && !node.multiline? && node.then?
+
+          # With more than one statements after then, there's not offense
+          return if node.children.last&.begin_type?
+
+          add_offense(node, location: :begin)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(
+              range_with_surrounding_space(
+                range: node.loc.begin, side: :left
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module RuboCop
         private
 
         def_node_matcher :simple_double_comparison?, '(send $lvar :== $lvar)'
-        def_node_matcher :simple_comparison?, <<-PATTERN
+        def_node_matcher :simple_comparison?, <<~PATTERN
           {(send $lvar :== _)
            (send _ :== $lvar)}
         PATTERN

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

@@ -143,13 +143,13 @@ module RuboCop
           end
         end
 
-        def_node_matcher :splat_value, <<-PATTERN
+        def_node_matcher :splat_value, <<~PATTERN
           (array (splat $_))
         PATTERN
 
         # Some of these patterns may not actually return an immutable object,
         # but we want to consider them immutable for this cop.
-        def_node_matcher :operation_produces_immutable_object?, <<-PATTERN
+        def_node_matcher :operation_produces_immutable_object?, <<~PATTERN
           {
             (const _ _)
             (send (const nil? :Struct) :new ...)
@@ -165,7 +165,7 @@ module RuboCop
           }
         PATTERN
 
-        def_node_matcher :range_enclosed_in_parentheses?, <<-PATTERN
+        def_node_matcher :range_enclosed_in_parentheses?, <<~PATTERN
           (begin ({irange erange} _ _))
         PATTERN
       end

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

@@ -73,12 +73,28 @@ module RuboCop
         end
 
         def right_hand_operand(node, left_hand_keyword)
-          expr = node.condition.source
-          expr = "(#{expr})" if requires_parens?(node.condition)
+          condition = node.condition
+
+          expr = if condition.send_type? && !condition.arguments.empty? &&
+                    !condition.operator_method?
+                   add_parentheses_to_method_arguments(condition)
+                 else
+                   condition.source
+                 end
+          expr = "(#{expr})" if requires_parens?(condition)
           expr = "!#{expr}" unless left_hand_keyword == node.keyword
           expr
         end
 
+        def add_parentheses_to_method_arguments(send_node)
+          expr = +''
+          expr << "#{send_node.receiver.source}." if send_node.receiver
+          expr << send_node.method_name.to_s
+          expr << "(#{send_node.arguments.map(&:source).join(', ')})"
+
+          expr
+        end
+
         def requires_parens?(node)
           node.or_type? ||
             !(RuboCop::AST::Node::COMPARISON_OPERATORS & node.children).empty?