rubocop 1.5.2 → 1.8.1

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

@@ -66,7 +66,7 @@ module RuboCop
         end
 
         def correct_with_arguments(return_node, corrector)
-          if return_node.arguments.size > 1
+          if return_node.children.size > 1
             add_brackets(corrector, return_node)
           elsif hash_without_braces?(return_node.first_argument)
             add_braces(corrector, return_node.first_argument)

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

@@ -29,6 +29,8 @@ module RuboCop
       #     c + d
       #   end
       class SingleLineBlockParams < Base
+        extend AutoCorrector
+
         MSG = 'Name `%<method>s` block params `|%<params>s|`.'
 
         def on_block(node)
@@ -37,20 +39,41 @@ module RuboCop
           return unless eligible_method?(node)
           return unless eligible_arguments?(node)
 
-          return if args_match?(node.send_node.method_name, node.arguments)
+          method_name = node.send_node.method_name
+          return if args_match?(method_name, node.arguments)
+
+          preferred_block_arguments = build_preferred_arguments_map(node, target_args(method_name))
+          joined_block_arguments = preferred_block_arguments.values.join(', ')
 
-          message = message(node.arguments)
+          message = format(MSG, method: method_name, params: joined_block_arguments)
 
-          add_offense(node.arguments, message: message)
+          add_offense(node.arguments, message: message) do |corrector|
+            autocorrect(corrector, node, preferred_block_arguments, joined_block_arguments)
+          end
         end
 
         private
 
-        def message(node)
-          method_name = node.parent.send_node.method_name
-          arguments   = target_args(method_name).join(', ')
+        def build_preferred_arguments_map(node, preferred_arguments)
+          preferred_arguments_map = {}
+          node.arguments.each_with_index do |current_lvar, index|
+            preferred_argument = preferred_arguments[index]
+            current_argument = current_lvar.source
+            preferred_argument = "_#{preferred_argument}" if current_argument.start_with?('_')
+            preferred_arguments_map[current_argument] = preferred_argument
+          end
+
+          preferred_arguments_map
+        end
+
+        def autocorrect(corrector, node, preferred_block_arguments, joined_block_arguments)
+          corrector.replace(node.arguments, "|#{joined_block_arguments}|")
 
-          format(MSG, method: method_name, params: arguments)
+          node.each_descendant(:lvar) do |lvar|
+            if (preferred_lvar = preferred_block_arguments[lvar.source])
+              corrector.replace(lvar, preferred_lvar)
+            end
+          end
         end
 
         def eligible_arguments?(node)

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

@@ -6,6 +6,12 @@ module RuboCop
       # This cop checks for single-line method definitions that contain a body.
       # It will accept single-line methods with no body.
       #
+      # Endless methods added in Ruby 3.0 are also accepted by this cop.
+      #
+      # If `Style/EndlessMethod` is enabled with `EnforcedStyle: allow` or
+      # `allow_always`, single-line methods will be auto-corrected to endless
+      # methods if there is only one statement in the body.
+      #
       # @example
       #   # bad
       #   def some_method; body end
@@ -15,6 +21,7 @@ module RuboCop
       #   # good
       #   def self.resource_class=(klass); end
       #   def @table.columns; end
+      #   def some_method() = body
       #
       # @example AllowIfMethodIsEmpty: true (default)
       #   # good
@@ -32,6 +39,7 @@ module RuboCop
 
         def on_def(node)
           return unless node.single_line?
+          return if node.endless?
           return if allow_empty? && !node.body
 
           add_offense(node) do |corrector|
@@ -43,6 +51,28 @@ module RuboCop
         private
 
         def autocorrect(corrector, node)
+          if correct_to_endless?(node.body)
+            correct_to_endless(corrector, node)
+          else
+            correct_to_multiline(corrector, node)
+          end
+        end
+
+        def allow_empty?
+          cop_config['AllowIfMethodIsEmpty']
+        end
+
+        def correct_to_endless?(body_node)
+          endless_method_config = config.for_cop('Style/EndlessMethod')
+
+          return false unless endless_method_config['Enabled']
+          return false if endless_method_config['EnforcedStyle'] == 'disallow'
+          return false unless body_node
+
+          !(body_node.begin_type? || body_node.kwbegin_type?)
+        end
+
+        def correct_to_multiline(corrector, node)
           each_part(node.body) do |part|
             LineBreakCorrector.break_line_before(
               range: part, node: node, corrector: corrector,
@@ -58,8 +88,10 @@ module RuboCop
           move_comment(node, corrector)
         end
 
-        def allow_empty?
-          cop_config['AllowIfMethodIsEmpty']
+        def correct_to_endless(corrector, node)
+          arguments = node.arguments.any? ? node.arguments.source : '()'
+          replacement = "def #{node.method_name}#{arguments} = #{node.body.source}"
+          corrector.replace(node, replacement)
         end
 
         def each_part(body)

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

@@ -63,24 +63,23 @@ module RuboCop
         end
 
         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
 
-          corrector.wrap(node.condition, '(', ')') if node.condition.or_type?
-
           and_operator = if_branch.unless? ? ' && !' : ' && '
           if if_branch.modifier_form?
-            correct_for_gurad_condition_style(corrector, node, if_branch, and_operator)
+            correct_for_guard_condition_style(corrector, node, if_branch, and_operator)
           else
             correct_for_basic_condition_style(corrector, node, if_branch, and_operator)
+            correct_for_comment(corrector, node, if_branch)
           end
-
-          correct_for_comment(corrector, node, if_branch)
         end
 
-        def correct_for_gurad_condition_style(corrector, node, if_branch, and_operator)
+        def correct_for_guard_condition_style(corrector, node, if_branch, and_operator)
           condition = if_branch.condition
           corrector.insert_after(node.condition, replacement_condition(and_operator, condition))
 
@@ -95,18 +94,25 @@ module RuboCop
           )
           corrector.replace(range, and_operator)
           corrector.remove(range_by_whole_lines(node.loc.end, include_final_newline: true))
-          corrector.wrap(if_branch.condition, '(', ')') if if_branch.condition.or_type?
+          corrector.wrap(if_branch.condition, '(', ')') if wrap_condition?(if_branch.condition)
         end
 
         def correct_for_comment(corrector, node, if_branch)
-          comments = processed_source.comments_before_line(if_branch.source_range.line)
+          return if config.for_cop('Style/IfUnlessModifier')['Enabled']
+
+          comments = processed_source.ast_with_comments[if_branch]
           comment_text = comments.map(&:text).join("\n") << "\n"
 
           corrector.insert_before(node.loc.keyword, comment_text) unless comments.empty?
         end
 
+        def wrap_condition?(node)
+          node.or_type? ||
+            (node.send_type? && node.arguments.any? && !node.parenthesized?)
+        end
+
         def replacement_condition(and_operator, condition)
-          if condition.or_type?
+          if wrap_condition?(condition)
             "#{and_operator}(#{condition.source})"
           else
             "#{and_operator}#{condition.source}"

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

@@ -26,10 +26,6 @@ module RuboCop
       #   puts $LAST_MATCH_INFO
       #   puts $IGNORECASE
       #   puts $ARGV # or ARGV
-      #   puts $MATCH
-      #   puts $PREMATCH
-      #   puts $POSTMATCH
-      #   puts $LAST_PAREN_MATCH
       #
       # @example EnforcedStyle: use_perl_names
       #   # good
@@ -51,10 +47,6 @@ module RuboCop
       #   puts $~
       #   puts $=
       #   puts $*
-      #   puts $&
-      #   puts $`
-      #   puts $'
-      #   puts $+
       #
       class SpecialGlobalVars < Base
         include ConfigurableEnforcedStyle
@@ -85,11 +77,7 @@ module RuboCop
           :$? => [:$CHILD_STATUS],
           :$~ => [:$LAST_MATCH_INFO],
           :$= => [:$IGNORECASE],
-          :$* => %i[$ARGV ARGV],
-          :$& => [:$MATCH],
-          :$` => [:$PREMATCH],
-          :$' => [:$POSTMATCH],
-          :$+ => [:$LAST_PAREN_MATCH]
+          :$* => %i[$ARGV ARGV]
         }
 
         PERL_VARS =

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

@@ -11,6 +11,10 @@ module RuboCop
       # In those cases, it might be useful to extract statements to local
       # variables or methods which you can then interpolate in a string.
       #
+      # NOTE: When concatenation between two strings is broken over multiple
+      # lines, this cop does not register an offense; instead,
+      # `Style/LineEndConcatenation` will pick up the offense if enabled.
+      #
       # @example
       #   # bad
       #   email_with_name = user.name + ' <' + user.email + '>'
@@ -19,6 +23,10 @@ module RuboCop
       #   email_with_name = "#{user.name} <#{user.email}>"
       #   email_with_name = format('%s <%s>', user.name, user.email)
       #
+      #   # accepted, line-end concatenation
+      #   name = 'First' +
+      #     'Last'
+      #
       class StringConcatenation < Base
         include Util
         extend AutoCorrector
@@ -39,6 +47,7 @@ module RuboCop
 
         def on_send(node)
           return unless string_concatenation?(node)
+          return if line_end_concatenation?(node)
 
           topmost_plus_node = find_topmost_plus_node(node)
 
@@ -58,6 +67,16 @@ module RuboCop
 
         private
 
+        def line_end_concatenation?(node)
+          # If the concatenation happens at the end of the line,
+          # and both the receiver and argument are strings, allow
+          # `Style/LineEndConcatenation` to handle it instead.
+          node.receiver.str_type? &&
+            node.first_argument.str_type? &&
+            node.multiline? &&
+            node.source =~ /\+\s*\n/
+        end
+
         def find_topmost_plus_node(node)
           current = node
           while (parent = current.parent) && plus_node?(parent)
@@ -97,7 +116,7 @@ module RuboCop
             parts.map do |part|
               if part.str_type?
                 if single_quoted?(part)
-                  part.value.gsub('\\') { '\\\\' }
+                  part.value.gsub(/(\\|")/, '\\\\\&')
                 else
                   part.value.inspect[1..-2]
                 end

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

@@ -26,9 +26,10 @@ module RuboCop
       #   "Just some text"
       #   "No special chars or interpolation"
       #   "Every string in #{project} uses double_quotes"
-      class StringLiterals < Cop
+      class StringLiterals < Base
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
+        extend AutoCorrector
 
         MSG_INCONSISTENT = 'Inconsistent quote style.'
 
@@ -46,7 +47,7 @@ module RuboCop
           quote_styles = detect_quote_styles(node)
 
           if quote_styles.size > 1
-            add_offense(node, message: MSG_INCONSISTENT)
+            register_offense(node, message: MSG_INCONSISTENT)
           else
             check_multiline_quote_style(node, quote_styles[0])
           end
@@ -54,11 +55,17 @@ module RuboCop
           ignore_node(node)
         end
 
-        def autocorrect(node)
-          StringLiteralCorrector.correct(node, style)
+        private
+
+        def autocorrect(corrector, node)
+          StringLiteralCorrector.correct(corrector, node, style)
         end
 
-        private
+        def register_offense(node, message: nil)
+          add_offense(node, message: message || message(node)) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
 
         def all_string_literals?(nodes)
           nodes.all? { |n| n.str_type? || n.dstr_type? }
@@ -99,14 +106,13 @@ module RuboCop
         end
 
         def check_multiline_quote_style(node, quote)
-          range = node.source_range
           children = node.children
           if unexpected_single_quotes?(quote)
             all_children_with_quotes = children.all? { |c| wrong_quotes?(c) }
-            add_offense(node, location: range) if all_children_with_quotes
+            register_offense(node) if all_children_with_quotes
           elsif unexpected_double_quotes?(quote) &&
                 !accept_child_double_quotes?(children)
-            add_offense(node, location: range)
+            register_offense(node)
           end
         end
 

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

@@ -19,12 +19,13 @@ module RuboCop
       #
       #   # good
       #   result = "Tests #{success ? "PASS" : "FAIL"}"
-      class StringLiteralsInInterpolation < Cop
+      class StringLiteralsInInterpolation < Base
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
+        extend AutoCorrector
 
-        def autocorrect(node)
-          StringLiteralCorrector.correct(node, style)
+        def autocorrect(corrector, node)
+          StringLiteralCorrector.correct(corrector, node, style)
         end
 
         private

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

@@ -22,11 +22,12 @@ module RuboCop
         SUPER_TYPES = %i[super zsuper].freeze
 
         def_node_matcher :proc_node?, '(send (const {nil? cbase} :Proc) :new)'
+        def_node_matcher :symbol_proc_receiver?, '{(send ...) (super ...) zsuper}'
         def_node_matcher :symbol_proc?, <<~PATTERN
-          ({block numblock}
-            ${(send ...) (super ...) zsuper}
-            ${(args (arg _)) %Integer}
-            (send (lvar _var) $_))
+          {
+            (block $#symbol_proc_receiver? $(args (arg _var)) (send (lvar _var) $_))
+            (numblock $#symbol_proc_receiver? $1 (send (lvar :_1) $_))
+          }
         PATTERN
 
         def self.autocorrect_incompatible_with

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

@@ -41,12 +41,10 @@ module RuboCop
               'having a single-line body.'
 
         def on_while(node)
-          return unless node.multiline? && single_line_as_modifier?(node)
+          return unless single_line_as_modifier?(node)
 
           add_offense(node.loc.keyword, message: format(MSG, keyword: node.keyword)) do |corrector|
-            oneline = "#{node.body.source} #{node.keyword} #{node.condition.source}"
-
-            corrector.replace(node, oneline)
+            corrector.replace(node, to_modifier_form(node))
           end
         end
         alias on_until on_while

data/lib/rubocop/cop/util.rb

@@ -33,7 +33,9 @@ module RuboCop
       end
 
       def add_parentheses(node, corrector)
-        if node.arguments.empty?
+        if !node.respond_to?(:arguments)
+          corrector.wrap(node, '(', ')')
+        elsif node.arguments.empty?
           corrector.insert_after(node, '()')
         else
           corrector.replace(args_begin(node), '(')

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -27,6 +27,8 @@ module RuboCop
             "[Todo] #{offense.message}"
           elsif offense.corrected?
             "[Corrected] #{offense.message}"
+          elsif offense.correctable?
+            "[Correctable] #{offense.message}"
           else
             offense.message
           end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -90,6 +90,8 @@ module RuboCop
             green('[Todo] ')
           elsif offense.corrected?
             green('[Corrected] ')
+          elsif offense.correctable?
+            yellow('[Correctable] ')
           else
             ''
           end

data/lib/rubocop/formatter/tap_formatter.rb

@@ -71,6 +71,8 @@ module RuboCop
             '[Todo] '
           elsif offense.corrected?
             '[Corrected] '
+          elsif offense.correctable?
+            '[Correctable] '
           else
             ''
           end

data/lib/rubocop/lockfile.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Encapsulation of a lockfile for use when checking for gems.
+  # Does not actually resolve gems, just parses the lockfile.
+  # @api private
+  class Lockfile
+    # Gems that the bundle depends on
+    def dependencies
+      return [] unless parser
+
+      parser.dependencies.values
+    end
+
+    # All activated gems, including transitive dependencies
+    def gems
+      return [] unless parser
+
+      # `Bundler::LockfileParser` returns `Bundler::LazySpecification` objects
+      # which are not resolved, so extract the dependencies from them
+      parser.dependencies.values.concat(parser.specs.flat_map(&:dependencies))
+    end
+
+    def includes_gem?(name)
+      gems.any? { |gem| gem.name == name }
+    end
+
+    private
+
+    def parser
+      return unless defined?(Bundler) && Bundler.default_lockfile
+      return @parser if defined?(@parser)
+
+      lockfile = Bundler.read_file(Bundler.default_lockfile)
+      @parser = lockfile ? Bundler::LockfileParser.new(lockfile) : nil
+    rescue Bundler::BundlerError
+      nil
+    end
+  end
+end