rubocop 1.13.0 → 1.17.0

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

@@ -35,17 +35,7 @@ module RuboCop
         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?
-
-          # Requires `then` for write `when` and its body on the same line.
-          return if require_then?(node)
-
-          # For arrays and hashes there's no offense
-          return if accept_node_type?(node.body)
+          return if !node.then? || require_then?(node)
 
           range = node.loc.begin
           add_offense(range) do |corrector|
@@ -57,6 +47,7 @@ module RuboCop
 
         private
 
+        # Requires `then` for write `when` and its body on the same line.
         def require_then?(when_node)
           unless when_node.conditions.first.first_line == when_node.conditions.last.last_line
             return true

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

@@ -29,7 +29,6 @@ module RuboCop
       #
       class NegatedIfElseCondition < Base
         include RangeHelp
-        include CommentsHelp
         extend AutoCorrector
 
         MSG = 'Invert the negated condition and swap the %<type>s branches.'
@@ -98,21 +97,30 @@ module RuboCop
           if node.if_branch.nil?
             corrector.remove(range_by_whole_lines(node.loc.else, include_final_newline: true))
           else
-            if_range = node_with_comments(node.if_branch)
-            else_range = node_with_comments(node.else_branch)
+            if_range = if_range(node)
+            else_range = else_range(node)
 
             corrector.replace(if_range, else_range.source)
             corrector.replace(else_range, if_range.source)
           end
         end
 
-        def node_with_comments(node)
-          first_statement = node.begin_type? ? node.children[0] : node
-          return node if processed_source.ast_with_comments[first_statement].empty?
+        # Collect the entire if branch, including whitespace and comments
+        def if_range(node)
+          if node.ternary?
+            node.if_branch
+          else
+            range_between(node.condition.loc.expression.end_pos, node.loc.else.begin_pos)
+          end
+        end
 
-          begin_pos = source_range_with_comment(first_statement).begin_pos
-          end_pos = node.source_range.end_pos
-          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        # Collect the entire else branch, including whitespace and comments
+        def else_range(node)
+          if node.ternary?
+            node.else_branch
+          else
+            range_between(node.loc.else.end_pos, node.loc.end.begin_pos)
+          end
         end
       end
     end

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

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for lambdas that always return nil, which can be replaced
-      # with an empty lambda instead.
+      # This cop checks for lambdas and procs that always return nil,
+      # which can be replaced with an empty lambda or proc instead.
       #
       # @example
       #   # bad
@@ -14,6 +14,12 @@ module RuboCop
       #     next nil
       #   end
       #
+      #   proc { nil }
+      #
+      #   Proc.new do
+      #     break nil
+      #   end
+      #
       #   # good
       #   -> {}
       #
@@ -22,11 +28,15 @@ module RuboCop
       #
       #   -> (x) { nil if x }
       #
+      #   proc {}
+      #
+      #   Proc.new { nil if x }
+      #
       class NilLambda < Base
         extend AutoCorrector
         include RangeHelp
 
-        MSG = 'Use an empty lambda instead of always returning nil.'
+        MSG = 'Use an empty %<type>s instead of always returning nil.'
 
         # @!method nil_return?(node)
         def_node_matcher :nil_return?, <<~PATTERN
@@ -34,19 +44,26 @@ module RuboCop
         PATTERN
 
         def on_block(node)
-          return unless node.lambda?
+          return unless node.lambda? || node.proc?
           return unless nil_return?(node.body)
 
-          add_offense(node) do |corrector|
-            range = if node.single_line?
-                      range_with_surrounding_space(range: node.body.loc.expression)
-                    else
-                      range_by_whole_lines(node.body.loc.expression, include_final_newline: true)
-                    end
-
-            corrector.remove(range)
+          message = format(MSG, type: node.lambda? ? 'lambda' : 'proc')
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node)
           end
         end
+
+        private
+
+        def autocorrect(corrector, node)
+          range = if node.single_line?
+                    range_with_surrounding_space(range: node.body.loc.expression)
+                  else
+                    range_by_whole_lines(node.body.loc.expression, include_final_newline: true)
+                  end
+
+          corrector.remove(range)
+        end
       end
     end
   end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks if the quotes used for quoted symbols match the configured defaults.
+      # By default uses the same configuration as `Style/StringLiterals`.
+      #
+      # String interpolation is always kept in double quotes.
+      #
+      # Note: `Lint/SymbolConversion` can be used in parallel to ensure that symbols
+      # are not quoted that don't need to be. This cop is for configuring the quoting
+      # style to use for symbols that require quotes.
+      #
+      # @example EnforcedStyle: same_as_string_literals (default) / single_quotes
+      #   # bad
+      #   :"abc-def"
+      #
+      #   # good
+      #   :'abc-def'
+      #   :"#{str}"
+      #   :"a\'b"
+      #
+      # @example EnforcedStyle: double_quotes
+      #   # bad
+      #   :'abc-def'
+      #
+      #   # good
+      #   :"abc-def"
+      #   :"#{str}"
+      #   :"a\'b"
+      class QuotedSymbols < Base
+        include ConfigurableEnforcedStyle
+        include SymbolHelp
+        include StringLiteralsHelp
+        extend AutoCorrector
+
+        MSG_SINGLE = "Prefer single-quoted symbols when you don't need string interpolation " \
+          'or special symbols.'
+        MSG_DOUBLE = 'Prefer double-quoted symbols unless you need single quotes to ' \
+          'avoid extra backslashes for escaping.'
+
+        def on_sym(node)
+          return unless quoted?(node)
+
+          message = style == :single_quotes ? MSG_SINGLE : MSG_DOUBLE
+
+          if wrong_quotes?(node)
+            add_offense(node, message: message) do |corrector|
+              opposite_style_detected
+              autocorrect(corrector, node)
+            end
+          else
+            correct_style_detected
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          str = if hash_colon_key?(node)
+                  # strip quotes
+                  correct_quotes(node.source[1..-2])
+                else
+                  # strip leading `:` and quotes
+                  ":#{correct_quotes(node.source[2..-2])}"
+                end
+
+          corrector.replace(node, str)
+        end
+
+        def hash_colon_key?(node)
+          # Is the node a hash key with the colon style?
+          hash_key?(node) && node.parent.colon?
+        end
+
+        def correct_quotes(str)
+          if style == :single_quotes
+            to_string_literal(str)
+          else
+            str.inspect
+          end
+        end
+
+        def style
+          return super unless super == :same_as_string_literals
+
+          string_literals_config = config.for_cop('Style/StringLiterals')
+          return :single_quotes unless string_literals_config['Enabled']
+
+          string_literals_config['EnforcedStyle'].to_sym
+        end
+
+        def alternative_style
+          (supported_styles - [style, :same_as_string_literals]).first
+        end
+
+        def quoted?(sym_node)
+          sym_node.source.match?(/\A:?(['"]).*?\1\z/m)
+        end
+
+        def wrong_quotes?(node)
+          return super if hash_key?(node)
+
+          super(node.source[1..-1])
+        end
+      end
+    end
+  end
+end

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

@@ -23,6 +23,7 @@ module RuboCop
       #   # good
       #   raise StandardError, 'message'
       #   fail 'message'
+      #   raise MyCustomError
       #   raise MyCustomError.new(arg1, arg2, arg3)
       #   raise MyKwArgError.new(key1: val1, key2: val2)
       #
@@ -37,6 +38,7 @@ module RuboCop
       #
       #   # good
       #   raise StandardError.new('message')
+      #   raise MyCustomError
       #   raise MyCustomError.new(arg1, arg2, arg3)
       #   fail 'message'
       class RaiseArgs < Base

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

@@ -110,7 +110,7 @@ module RuboCop
           first_child = node.children.first
 
           source = first_child.source
-          source = "(#{source})" if first_child.if_type?
+          source = "(#{source})" if first_child.if_type? && first_child.modifier_form?
 
           corrector.replace(offense_range, source)
           corrector.remove(range_between(offense_range.end_pos, first_child.source_range.end_pos))

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

@@ -92,7 +92,7 @@ module RuboCop
 
         def on_masgn(node)
           lhs, rhs = *node
-          lhs.children.each { |child| add_lhs_to_local_variables_scopes(rhs, child.to_a.first) }
+          add_masgn_lhs_variables(rhs, lhs)
         end
 
         def on_lvasgn(node)
@@ -106,7 +106,7 @@ module RuboCop
 
           return if allowed_send_node?(node)
 
-          add_offense(node) do |corrector|
+          add_offense(node.receiver) do |corrector|
             corrector.remove(node.receiver)
             corrector.remove(node.loc.dot)
           end
@@ -116,6 +116,22 @@ module RuboCop
           add_scope(node, @local_variables_scopes[node])
         end
 
+        def on_if(node)
+          # Allow conditional nodes to use `self` in the condition if that variable
+          # name is used in an `lvasgn` or `masgn` within the `if`.
+          node.child_nodes.each do |child_node|
+            lhs, _rhs = *child_node
+
+            if child_node.lvasgn_type?
+              add_lhs_to_local_variables_scopes(node.condition, lhs)
+            elsif child_node.masgn_type?
+              add_masgn_lhs_variables(node.condition, lhs)
+            end
+          end
+        end
+        alias on_while on_if
+        alias on_until on_if
+
         private
 
         def add_scope(node, local_variables = [])
@@ -163,6 +179,12 @@ module RuboCop
             @local_variables_scopes[rhs] << lhs
           end
         end
+
+        def add_masgn_lhs_variables(rhs, lhs)
+          lhs.children.each do |child|
+            add_lhs_to_local_variables_scopes(rhs, child.to_a.first)
+          end
+        end
       end
     end
   end

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

@@ -117,7 +117,7 @@ module RuboCop
         def allowed_percent_r_literal?(node)
           style == :slashes && contains_disallowed_slash?(node) ||
             style == :percent_r ||
-            allowed_mixed_percent_r?(node)
+            allowed_mixed_percent_r?(node) || omit_parentheses_style?(node)
         end
 
         def allowed_mixed_percent_r?(node)
@@ -149,6 +149,14 @@ module RuboCop
           config.for_cop('Style/PercentLiteralDelimiters') ['PreferredDelimiters']['%r'].chars
         end
 
+        def omit_parentheses_style?(node)
+          return false unless node.parent&.call_type?
+
+          enforced_style = config.for_cop('Style/MethodCallWithArgsParentheses')['EnforcedStyle']
+
+          enforced_style == 'omit_parentheses'
+        end
+
         def correct_delimiters(node, corrector)
           replacement = calculate_replacement(node)
           corrector.replace(node.loc.begin, replacement.first)

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

@@ -68,6 +68,7 @@ module RuboCop
           return false unless endless_method_config['Enabled']
           return false if endless_method_config['EnforcedStyle'] == 'disallow'
           return false unless body_node
+          return false if body_node.parent.assignment_method?
 
           !(body_node.begin_type? || body_node.kwbegin_type?)
         end
@@ -115,15 +116,19 @@ module RuboCop
         end
 
         def method_body_source(method_body)
-          if !method_body.send_type? || method_body.arguments.empty? || method_body.parenthesized?
-            method_body.source
-          else
+          if require_parentheses?(method_body)
             arguments_source = method_body.arguments.map(&:source).join(', ')
             body_source = "#{method_body.method_name}(#{arguments_source})"
 
             method_body.receiver ? "#{method_body.receiver.source}.#{body_source}" : body_source
+          else
+            method_body.source
           end
         end
+
+        def require_parentheses?(method_body)
+          method_body.send_type? && !method_body.arguments.empty? && !method_body.comparison_method?
+        end
       end
     end
   end

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

@@ -80,10 +80,7 @@ module RuboCop
         def autocorrect(corrector, node, if_branch)
           corrector.wrap(node.condition, '(', ')') if node.condition.or_type?
 
-          if node.unless?
-            corrector.replace(node.loc.keyword, 'if')
-            corrector.insert_before(node.condition, '!')
-          end
+          correct_from_unless_to_if(corrector, node) if node.unless?
 
           and_operator = if_branch.unless? ? ' && !' : ' && '
           if if_branch.modifier_form?
@@ -94,6 +91,17 @@ module RuboCop
           end
         end
 
+        def correct_from_unless_to_if(corrector, node)
+          corrector.replace(node.loc.keyword, 'if')
+
+          condition = node.condition
+          if condition.send_type? && condition.comparison_method? && !condition.parenthesized?
+            corrector.wrap(node.condition, '!(', ')')
+          else
+            corrector.insert_before(node.condition, '!')
+          end
+        end
+
         def correct_for_guard_condition_style(corrector, node, if_branch, and_operator)
           outer_condition = node.condition
           correct_outer_condition(corrector, outer_condition)
@@ -136,7 +144,8 @@ module RuboCop
         end
 
         def requrie_parentheses?(condition)
-          condition.send_type? && !condition.arguments.empty? && !condition.parenthesized?
+          condition.send_type? && !condition.arguments.empty? && !condition.parenthesized? &&
+            !condition.comparison_method?
         end
 
         def arguments_range(node)

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

@@ -29,6 +29,7 @@ module RuboCop
       class StringLiterals < Base
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
+        include StringHelp
         extend AutoCorrector
 
         MSG_INCONSISTENT = 'Inconsistent quote style.'

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

@@ -22,6 +22,7 @@ module RuboCop
       class StringLiteralsInInterpolation < Base
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
+        include StringHelp
         extend AutoCorrector
 
         def autocorrect(corrector, node)