rubocop 0.93.1 → 1.3.1

data/lib/rubocop/cop/corrector.rb

@@ -9,6 +9,8 @@ module RuboCop
     # The nodes modified by the corrections should be part of the
     # AST of the source_buffer.
     class Corrector < ::Parser::Source::TreeRewriter
+      NOOP_CONSUMER = ->(diagnostic) {} # noop
+
       # @param source [Parser::Source::Buffer, or anything
       #                leading to one via `(processed_source.)buffer`]
       #
@@ -23,7 +25,7 @@ module RuboCop
         )
 
         # Don't print warnings to stderr if corrections conflict with each other
-        diagnostics.consumer = ->(diagnostic) {}
+        diagnostics.consumer = NOOP_CONSUMER
       end
 
       alias rewrite process # Legacy

data/lib/rubocop/cop/correctors/percent_literal_corrector.rb

@@ -89,7 +89,7 @@ module RuboCop
         begin_line_num = previous_line_num - base_line_num + 1
         end_line_num = node.first_line - base_line_num + 1
         lines = source_in_lines[begin_line_num...end_line_num]
-        "\n#{(lines.join("\n").split(node.source).first || '')}"
+        "\n#{lines.join("\n").split(node.source).first || ''}"
       end
 
       def fix_escaped_content(word_node, escape, delimiters)

data/lib/rubocop/cop/force.rb

@@ -31,7 +31,7 @@ module RuboCop
         cops.each do |cop|
           next unless cop.respond_to?(method_name)
 
-          cop.send(method_name, *args)
+          cop.public_send(method_name, *args)
         end
       end
 

data/lib/rubocop/cop/gemspec/duplicated_assignment.rb

@@ -34,7 +34,7 @@ module RuboCop
       #     spec.add_runtime_dependency('parallel', '~> 1.10')
       #     spec.add_runtime_dependency('parser', '>= 2.3.3.1', '< 3.0')
       #   end
-      class DuplicatedAssignment < Cop
+      class DuplicatedAssignment < Base
         include RangeHelp
 
         MSG = '`%<assignment>s` method calls already given on line '\
@@ -54,7 +54,7 @@ module RuboCop
             (lvar #match_block_variable_name?) #assignment_method? ...)
         PATTERN
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
           duplicated_assignment_method_nodes.each do |nodes|
@@ -96,7 +96,7 @@ module RuboCop
             assignment: assignment,
             line_of_first_occurrence: line_of_first_occurrence
           )
-          add_offense(node, location: offense_location, message: message)
+          add_offense(offense_location, message: message)
         end
       end
     end

data/lib/rubocop/cop/gemspec/required_ruby_version.rb

@@ -45,7 +45,7 @@ module RuboCop
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = '~> 2.5'
       #   end
-      class RequiredRubyVersion < Cop
+      class RequiredRubyVersion < Base
         include RangeHelp
 
         NOT_EQUAL_MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
@@ -64,7 +64,7 @@ module RuboCop
         PATTERN
 
         # rubocop:disable Metrics/AbcSize
-        def investigate(processed_source)
+        def on_new_investigation
           version_def = required_ruby_version(processed_source.ast).first
 
           if version_def
@@ -72,13 +72,12 @@ module RuboCop
             return if !ruby_version || ruby_version == target_ruby_version.to_s
 
             add_offense(
-              processed_source.ast,
-              location: version_def.loc.expression,
+              version_def.loc.expression,
               message: not_equal_message(ruby_version, target_ruby_version)
             )
           else
             range = source_range(processed_source.buffer, 1, 0)
-            add_offense(nil, location: range, message: MISSING_MSG)
+            add_offense(range, message: MISSING_MSG)
           end
         end
         # rubocop:enable Metrics/AbcSize

data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb

@@ -25,7 +25,7 @@ module RuboCop
       #     spec.add_runtime_dependency 'gem_a'
       #   end
       #
-      class RubyVersionGlobalsUsage < Cop
+      class RubyVersionGlobalsUsage < Base
         MSG = 'Do not use `RUBY_VERSION` in gemspec file.'
 
         def_node_matcher :ruby_version?, '(const {cbase nil?} :RUBY_VERSION)'

data/lib/rubocop/cop/generator.rb

@@ -8,7 +8,7 @@ module RuboCop
     # and spec file when given a valid qualified cop name.
     # @api private
     class Generator
-      # Note: RDoc 5.1.0 or lower has the following issue.
+      # NOTE: RDoc 5.1.0 or lower has the following issue.
       # https://github.com/rubocop-hq/rubocop/issues/7043
       #
       # The following `String#gsub` can be replaced with
@@ -17,7 +17,6 @@ module RuboCop
       SOURCE_TEMPLATE = <<-RUBY.gsub(/^ {8}/, '')
         # frozen_string_literal: true
 
-        # TODO: when finished, run `rake generate_cops_documentation` to update the docs
         module RuboCop
           module Cop
             module %<department>s
@@ -134,7 +133,7 @@ module RuboCop
       end
 
       def inject_config(config_file_path: 'config/default.yml',
-                        version_added: bump_minor_version)
+                        version_added: '<<next>>')
         injector =
           ConfigurationInjector.new(configuration_file_path: config_file_path,
                                     badge: badge,
@@ -213,12 +212,6 @@ module RuboCop
           .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
           .downcase
       end
-
-      def bump_minor_version
-        versions = RuboCop::Version::STRING.split('.')
-
-        "#{versions[0]}.#{versions[1].succ}"
-      end
     end
   end
 end

data/lib/rubocop/cop/generator/configuration_injector.rb

@@ -14,7 +14,7 @@ module RuboCop
             VersionAdded: '%<version_added>s'
         YAML
 
-        def initialize(configuration_file_path:, badge:, version_added:)
+        def initialize(configuration_file_path:, badge:, version_added: '<<next>>')
           @configuration_file_path = configuration_file_path
           @badge = badge
           @version_added = version_added

data/lib/rubocop/cop/layout/block_alignment.rb

@@ -210,10 +210,9 @@ module RuboCop
         end
 
         def alt_start_msg(start_loc, source_line_column)
-          if style != :either
-            ''
-          elsif start_loc.line == source_line_column[:line] &&
-                start_loc.column == source_line_column[:column]
+          if style != :either ||
+             (start_loc.line == source_line_column[:line] &&
+                 start_loc.column == source_line_column[:column])
             ''
           else
             " or #{format_source_line_column(source_line_column)}"

data/lib/rubocop/cop/layout/class_structure.rb

@@ -147,6 +147,10 @@ module RuboCop
         MSG = '`%<category>s` is supposed to appear before ' \
               '`%<previous>s`.'
 
+        def_node_matcher :dynamic_constant?, <<~PATTERN
+          (casgn nil? _ (send ...))
+        PATTERN
+
         # Validates code style on class declaration.
         # Add offense when find a node out of expected order.
         def on_class(class_node)
@@ -168,11 +172,10 @@ module RuboCop
 
         # Autocorrect by swapping between two nodes autocorrecting them
         def autocorrect(corrector, node)
-          node_classification = classify(node)
           previous = node.left_siblings.find do |sibling|
-            classification = classify(sibling)
-            !ignore?(classification) && node_classification != classification
+            !ignore_for_autocorrect?(node, sibling)
           end
+          return unless previous
 
           current_range = source_range_with_comment(node)
           previous_range = source_range_with_comment(previous)
@@ -241,6 +244,15 @@ module RuboCop
             expected_order.index(classification).nil?
         end
 
+        def ignore_for_autocorrect?(node, sibling)
+          classification = classify(node)
+          sibling_class = classify(sibling)
+
+          ignore?(sibling_class) ||
+            classification == sibling_class ||
+            dynamic_constant?(node)
+        end
+
         def humanize_node(node)
           if node.def_type?
             return :initializer if node.method?(:initialize)
@@ -265,6 +277,9 @@ module RuboCop
         end
 
         def end_position_for(node)
+          heredoc = find_heredoc(node)
+          return heredoc.location.heredoc_end.end_pos + 1 if heredoc
+
           end_line = buffer.line_for_position(node.loc.expression.end_pos)
           buffer.line_range(end_line).end_pos
         end
@@ -284,6 +299,10 @@ module RuboCop
           buffer.line_range(node.loc.line).begin_pos - 1
         end
 
+        def find_heredoc(node)
+          node.each_node(:str, :dstr, :xstr).find(&:heredoc?)
+        end
+
         def buffer
           processed_source.buffer
         end

data/lib/rubocop/cop/layout/def_end_alignment.rb

@@ -46,7 +46,7 @@ module RuboCop
         alias on_defs on_def
 
         def on_send(node)
-          return if !node.def_modifier? || node.method?(:using)
+          return unless node.def_modifier?
 
           method_def = node.each_descendant(:def, :defs).first
           expr = node.source_range

data/lib/rubocop/cop/layout/else_alignment.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Layout
       # This cop checks the alignment of else keywords. Normally they should
-      # be aligned with an if/unless/while/until/begin/def keyword, but there
+      # be aligned with an if/unless/while/until/begin/def/rescue keyword, but there
       # are special cases when they should follow the same rules as the
       # alignment of end.
       #
@@ -93,7 +93,13 @@ module RuboCop
           case parent.type
           when :def, :defs then base_for_method_definition(parent)
           when :kwbegin then parent.loc.begin
-          when :block then parent.send_node.source_range
+          when :block
+            assignment_node = assignment_node(parent)
+            if same_line?(parent, assignment_node)
+              assignment_node.source_range
+            else
+              parent.send_node.source_range
+            end
           else node.loc.keyword
           end
         end
@@ -136,6 +142,13 @@ module RuboCop
           )
           add_offense(else_range, location: else_range, message: message)
         end
+
+        def assignment_node(node)
+          assignment_node = node.ancestors.first
+          return unless assignment_node&.assignment?
+
+          assignment_node
+        end
       end
     end
   end

data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb

@@ -141,6 +141,7 @@ module RuboCop
         def previous_line_empty?(send_line)
           previous_line = previous_line_ignoring_comments(processed_source,
                                                           send_line)
+          return true unless previous_line
 
           block_start?(send_line) ||
             class_def?(send_line) ||

data/lib/rubocop/cop/layout/end_alignment.rb

@@ -137,10 +137,10 @@ module RuboCop
         def asgn_variable_align_with(outer_node, inner_node)
           expr = outer_node.source_range
 
-          if !line_break_before_keyword?(expr, inner_node)
-            range_between(expr.begin_pos, inner_node.loc.keyword.end_pos)
-          else
+          if line_break_before_keyword?(expr, inner_node)
             inner_node.loc.keyword
+          else
+            range_between(expr.begin_pos, inner_node.loc.keyword.end_pos)
           end
         end
 

data/lib/rubocop/cop/layout/extra_spacing.rb

@@ -56,8 +56,7 @@ module RuboCop
           aligned = Set[locs.first.line, locs.last.line]
           locs.each_cons(3) do |before, loc, after|
             col = loc.column
-            aligned << loc.line if col == before.column || # rubocop:disable Style/MultipleComparison
-                                   col == after.column
+            aligned << loc.line if col == before.column || col == after.column
           end
           aligned
         end

data/lib/rubocop/cop/layout/hash_alignment.rb

@@ -296,13 +296,13 @@ module RuboCop
           # just give each lambda the same reference and they would all get the
           # last value of each. A local variable fixes the problem.
 
-          if !node.value
-            delta_value = delta[:key] || 0
-            correct_no_value(corrector, delta_value, node.source_range)
-          else
+          if node.value
             correct_key_value(corrector, delta, node.key.source_range,
                               node.value.source_range,
                               node.loc.operator)
+          else
+            delta_value = delta[:key] || 0
+            correct_no_value(corrector, delta_value, node.source_range)
           end
         end
 

data/lib/rubocop/cop/layout/line_length.rb

@@ -88,6 +88,10 @@ module RuboCop
           end
         end
 
+        def correctable?
+          super && !breakable_range.nil?
+        end
+
         def autocorrect(range)
           return if range.nil?
 
@@ -98,6 +102,8 @@ module RuboCop
 
         private
 
+        attr_accessor :breakable_range
+
         def check_for_breakable_node(node)
           breakable_node = extract_breakable_node(node, max)
           return if breakable_node.nil?
@@ -195,7 +201,8 @@ module RuboCop
         def register_offense(loc, line, line_index)
           message = format(MSG, length: line_length(line), max: max)
 
-          breakable_range = breakable_range_by_line_index[line_index]
+          self.breakable_range = breakable_range_by_line_index[line_index]
+
           add_offense(breakable_range, location: loc, message: message) do
             self.max = line_length(line)
           end

data/lib/rubocop/cop/layout/space_around_block_parameters.rb

@@ -54,17 +54,11 @@ module RuboCop
         end
 
         def check_inside_pipes(arguments)
-          opening_pipe, closing_pipe = pipes(arguments)
-
           case style
           when :no_space
-            check_no_space_style_inside_pipes(arguments.children,
-                                              opening_pipe,
-                                              closing_pipe)
+            check_no_space_style_inside_pipes(arguments)
           when :space
-            check_space_style_inside_pipes(arguments.children,
-                                           opening_pipe,
-                                           closing_pipe)
+            check_space_style_inside_pipes(arguments)
           end
         end
 
@@ -76,22 +70,29 @@ module RuboCop
                       closing_pipe, 'after closing `|`')
         end
 
-        def check_no_space_style_inside_pipes(args, opening_pipe, closing_pipe)
+        def check_no_space_style_inside_pipes(arguments)
+          args = arguments.children
+          opening_pipe, closing_pipe = pipes(arguments)
+
           first = args.first.source_range
           last = args.last.source_range
 
           check_no_space(opening_pipe.end_pos, first.begin_pos,
                          'Space before first')
-          check_no_space(last_end_pos_inside_pipes(last),
+          check_no_space(last_end_pos_inside_pipes(arguments, last),
                          closing_pipe.begin_pos, 'Space after last')
         end
 
-        def check_space_style_inside_pipes(args, opening_pipe, closing_pipe)
-          check_opening_pipe_space(args, opening_pipe)
-          check_closing_pipe_space(args, closing_pipe)
+        def check_space_style_inside_pipes(arguments)
+          opening_pipe, closing_pipe = pipes(arguments)
+
+          check_opening_pipe_space(arguments, opening_pipe)
+          check_closing_pipe_space(arguments, closing_pipe)
         end
 
-        def check_opening_pipe_space(args, opening_pipe)
+        def check_opening_pipe_space(arguments, opening_pipe)
+          args = arguments.children
+
           first_arg = args.first
           range = first_arg.source_range
 
@@ -101,9 +102,11 @@ module RuboCop
                          'Extra space before first')
         end
 
-        def check_closing_pipe_space(args, closing_pipe)
+        def check_closing_pipe_space(arguments, closing_pipe)
+          args = arguments.children
+
           last         = args.last.source_range
-          last_end_pos = last_end_pos_inside_pipes(last)
+          last_end_pos = last_end_pos_inside_pipes(arguments, last)
 
           check_space(last_end_pos, closing_pipe.begin_pos, last,
                       'after last block parameter')
@@ -111,9 +114,12 @@ module RuboCop
                          'Extra space after last')
         end
 
-        def last_end_pos_inside_pipes(range)
+        def last_end_pos_inside_pipes(arguments, range)
           pos = range.end_pos
-          range.source_buffer.source[pos] == ',' ? pos + 1 : pos
+          num = pos - arguments.source_range.begin_pos
+          trailing_comma_index = arguments.source[num..-1].index(',')
+
+          trailing_comma_index ? pos + trailing_comma_index + 1 : pos
         end
 
         def check_each_arg(args)

data/lib/rubocop/cop/layout/space_around_operators.rb

@@ -5,6 +5,8 @@ module RuboCop
     module Layout
       # Checks that operators have space around them, except for ** which
       # should or shouldn't have surrounding space depending on configuration.
+      # It allows vertical alignment consisting of one or more whitespace
+      # around operators.
       #
       # This cop has `AllowForAlignment` option. When `true`, allows most
       # uses of extra spacing if the intent is to align with an operator on
@@ -207,7 +209,8 @@ module RuboCop
           token            = Token.new(operator, nil, operator.source)
           align_preceding  = aligned_with_preceding_assignment(token)
 
-          return align_preceding == :no unless align_preceding == :none
+          return false if align_preceding == :yes ||
+                          aligned_with_subsequent_assignment(token) == :none
 
           aligned_with_subsequent_assignment(token) != :yes
         end