rubocop 0.72.0 → 0.76.0

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

@@ -98,7 +98,7 @@ module RuboCop
       end
 
       def fix_escaped_content(word_node, escape, delimiters)
-        content = word_node.children.first.to_s
+        content = +word_node.children.first.to_s
         content = escape_string(content) if escape
         substitute_escaped_delimiters(content, delimiters)
         content

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

@@ -40,7 +40,7 @@ module RuboCop
         MSG = '`%<assignment>s` method calls already given on line '\
               '%<line_of_first_occurrence>d of the gemspec.'
 
-        def_node_search :gem_specification, <<-PATTERN
+        def_node_search :gem_specification, <<~PATTERN
           (block
             (send
               (const
@@ -49,7 +49,7 @@ module RuboCop
               (arg $_)) ...)
         PATTERN
 
-        def_node_search :assignment_method_declarations, <<-PATTERN
+        def_node_search :assignment_method_declarations, <<~PATTERN
           (send
             (lvar #match_block_variable_name?) #assignment_method? ...)
         PATTERN

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

@@ -97,7 +97,7 @@ module RuboCop
           node.method_name
         end
 
-        def_node_search :dependency_declarations, <<-PATTERN
+        def_node_search :dependency_declarations, <<~PATTERN
           (send (lvar _) {:add_dependency :add_runtime_dependency :add_development_dependency} ...)
         PATTERN
       end

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

@@ -41,7 +41,7 @@ module RuboCop
               '(%<target_ruby_version>s, which may be specified in ' \
               '.rubocop.yml) should be equal.'
 
-        def_node_search :required_ruby_version, <<-PATTERN
+        def_node_search :required_ruby_version, <<~PATTERN
           (send _ :required_ruby_version= ${(str _) (array (str _))})
         PATTERN
 

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

@@ -30,7 +30,7 @@ module RuboCop
 
         def_node_matcher :ruby_version?, '(const nil? :RUBY_VERSION)'
 
-        def_node_search :gem_specification?, <<-PATTERN
+        def_node_search :gem_specification?, <<~PATTERN
           (block
             (send
               (const

data/lib/rubocop/cop/generator.rb

@@ -10,10 +10,10 @@ module RuboCop
       # Note: RDoc 5.1.0 or lower has the following issue.
       # https://github.com/rubocop-hq/rubocop/issues/7043
       #
-      # The following `String#strip_indent` can be replaced with
+      # The following `String#gsub` can be replaced with
       # squiggly heredoc when RuboCop supports Ruby 2.5 or higher
       # (RDoc 6.0 or higher).
-      SOURCE_TEMPLATE = <<-RUBY.strip_indent
+      SOURCE_TEMPLATE = <<-RUBY.gsub(/^ {8}/, '')
         # frozen_string_literal: true
 
         # TODO: when finished, run `rake generate_cops_documentation` to update the docs
@@ -61,9 +61,9 @@ module RuboCop
                 # See https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/node_pattern.rb
                 #
                 # For example
-                MSG = 'Use `#good_method` instead of `#bad_method`.'.freeze
+                MSG = 'Use `#good_method` instead of `#bad_method`.'
 
-                def_node_matcher :bad_method?, <<-PATTERN
+                def_node_matcher :bad_method?, <<~PATTERN
                   (send nil? :bad_method ...)
                 PATTERN
 

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

@@ -12,7 +12,6 @@ module RuboCop
             Description: 'TODO: Write a description of the cop.'
             Enabled: true
             VersionAdded: '%<version_added>s'
-
         YAML
 
         def initialize(configuration_file_path:, badge:, version_added:)
@@ -23,8 +22,13 @@ module RuboCop
         end
 
         def inject
-          configuration_entries.insert(find_target_line,
-                                       new_configuration_entry)
+          target_line = find_target_line
+          if target_line
+            configuration_entries.insert(target_line,
+                                         new_configuration_entry + "\n")
+          else
+            configuration_entries.push("\n" + new_configuration_entry)
+          end
 
           File.write(configuration_file_path, configuration_entries.join)
 
@@ -49,7 +53,8 @@ module RuboCop
 
             return index if badge.to_s < line
           end
-          configuration_entries.size - 1
+
+          nil
         end
 
         def cop_name_line?(yaml)

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

@@ -54,7 +54,7 @@ module RuboCop
               elsif in_the_same_department
                 break index
               end
-            end
+            end || require_entries.size
           end
         end
 

data/lib/rubocop/cop/internal_affairs/node_destructuring.rb

@@ -19,11 +19,11 @@ module RuboCop
         MSG = 'Use the methods provided with the node extensions instead ' \
               'of manually destructuring nodes.'
 
-        def_node_matcher :node_variable?, <<-PATTERN
+        def_node_matcher :node_variable?, <<~PATTERN
           {(lvar [#node_suffix? _]) (send nil? [#node_suffix? _])}
         PATTERN
 
-        def_node_matcher :node_destructuring?, <<-PATTERN
+        def_node_matcher :node_destructuring?, <<~PATTERN
           {(masgn (mlhs ...) {(send #node_variable? :children) (array (splat #node_variable?))})}
         PATTERN
 

data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb

@@ -16,7 +16,7 @@ module RuboCop
       class NodeTypePredicate < Cop
         MSG = 'Use `#%<type>s_type?` to check node type.'
 
-        def_node_matcher :node_type_check, <<-PATTERN
+        def_node_matcher :node_type_check, <<~PATTERN
           (send (send $_ :type) :== (sym $_))
         PATTERN
 

data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb

@@ -33,11 +33,11 @@ module RuboCop
 
         private
 
-        def_node_matcher :node_type_check, <<-PATTERN
+        def_node_matcher :node_type_check, <<~PATTERN
           (send nil? :add_offense $_node $hash)
         PATTERN
 
-        def_node_matcher :offending_location_argument, <<-PATTERN
+        def_node_matcher :offending_location_argument, <<~PATTERN
           (pair (sym :location) $(send (send $_node :loc) $_keyword))
         PATTERN
 

data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb

@@ -21,7 +21,7 @@ module RuboCop
 
         MSG = 'Redundant location argument to `#add_offense`.'
 
-        def_node_matcher :redundant_location_argument, <<-PATTERN
+        def_node_matcher :redundant_location_argument, <<~PATTERN
           (send nil? :add_offense _
             (hash <$(pair (sym :location) (sym :expression)) ...>)
           )

data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb

@@ -24,11 +24,11 @@ module RuboCop
 
         MSG = 'Redundant message argument to `#add_offense`.'
 
-        def_node_matcher :node_type_check, <<-PATTERN
+        def_node_matcher :node_type_check, <<~PATTERN
           (send nil? :add_offense $_node $hash)
         PATTERN
 
-        def_node_matcher :redundant_message_argument, <<-PATTERN
+        def_node_matcher :redundant_message_argument, <<~PATTERN
           (pair
             (sym :message)
             ${(const nil? :MSG) (send nil? :message) (send nil? :message _)})

data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb

@@ -16,11 +16,11 @@ module RuboCop
       class UselessMessageAssertion < Cop
         MSG = 'Do not specify cop behavior using `described_class::MSG`.'
 
-        def_node_search :described_class_msg, <<-PATTERN
+        def_node_search :described_class_msg, <<~PATTERN
           (const (send nil? :described_class) :MSG)
         PATTERN
 
-        def_node_matcher :rspec_expectation_on_msg?, <<-PATTERN
+        def_node_matcher :rspec_expectation_on_msg?, <<~PATTERN
           (send (send nil? :expect #contains_described_class_msg?) :to ...)
         PATTERN
 

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

@@ -220,14 +220,18 @@ module RuboCop
 
         private
 
+        def reset!
+          self.offences_by = {}
+          self.column_deltas = Hash.new { |hash, key| hash[key] = {} }
+        end
+
         def double_splat?(node)
           node.children.last.is_a?(Symbol)
         end
 
         def check_pairs(node)
           first_pair = node.pairs.first
-          self.offences_by = {}
-          self.column_deltas = Hash.new { |hash, key| hash[key] = {} }
+          reset!
 
           alignment_for(first_pair).each do |alignment|
             delta = alignment.deltas_for_first_pair(first_pair, node)

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

@@ -44,8 +44,8 @@ module RuboCop
       #
       #   foo.bar
       #     .each do
-      #        baz
-      #      end
+      #       baz
+      #     end
       #
       # @example EnforcedStyleAlignWith: start_of_line
       #   # bad
@@ -67,7 +67,7 @@ module RuboCop
 
         MSG = '%<current>s is not aligned with %<prefer>s%<alt_prefer>s.'
 
-        def_node_matcher :block_end_align_target?, <<-PATTERN
+        def_node_matcher :block_end_align_target?, <<~PATTERN
           {assignment?
            splat
            and

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

@@ -142,7 +142,7 @@ module RuboCop
         MSG = '`%<category>s` is supposed to appear before ' \
               '`%<previous>s`.'
 
-        def_node_matcher :visibility_block?, <<-PATTERN
+        def_node_matcher :visibility_block?, <<~PATTERN
           (send nil? { :private :protected :public })
         PATTERN
 

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

@@ -191,7 +191,7 @@ module RuboCop
         end
 
         def indentation_width
-          @config.for_cop('IndentationWidth')['Width'] || 2
+          @config.for_cop('Layout/IndentationWidth')['Width'] || 2
         end
 
         def line_break_after_left_paren?(left_paren, elements)

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

@@ -55,23 +55,20 @@ module RuboCop
         # of correcting, saving the file, parsing and inspecting again, and
         # then correcting one more line, and so on.
         def autocorrect_preceding_comments(comment)
-          corrections = []
-          line_no = comment.loc.line
-          column = comment.loc.column
           comments = processed_source.comments
-          (comments.index(comment) - 1).downto(0) do |ix|
-            previous_comment = comments[ix]
-            break unless should_correct?(previous_comment, column, line_no - 1)
+          index = comments.index(comment)
 
-            corrections << autocorrect_one(previous_comment)
-            line_no -= 1
-          end
-          corrections
+          comments[0..index]
+            .reverse_each
+            .each_cons(2)
+            .take_while { |below, above| should_correct?(above, below) }
+            .map { |_, above| autocorrect_one(above) }
         end
 
-        def should_correct?(comment, column, line_no)
-          loc = comment.loc
-          loc.line == line_no && loc.column == column
+        def should_correct?(preceding_comment, reference_comment)
+          loc = preceding_comment.loc
+          ref_loc = reference_comment.loc
+          loc.line == ref_loc.line - 1 && loc.column == ref_loc.column
         end
 
         def autocorrect_one(comment)

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

@@ -103,19 +103,12 @@ module RuboCop
         private
 
         def concat_consecutive_comments(comments)
-          prev_line = nil
+          consecutive_comments =
+            comments.chunk_while { |i, j| i.loc.line.succ == j.loc.line }
 
-          comments.each_with_object([]) do |comment, concatenated_comments|
-            if prev_line && comment.loc.line == prev_line.next
-              last_concatenated_comment = concatenated_comments.last
-
-              last_concatenated_comment[0] << comment_text(comment)
-              last_concatenated_comment[1] << comment
-            else
-              concatenated_comments << [comment_text(comment).dup, [comment]]
-            end
-
-            prev_line = comment.loc.line
+          consecutive_comments.map do |chunk|
+            joined_text = chunk.map { |c| comment_text(c) }.join
+            [joined_text, chunk]
           end
         end
 
@@ -141,11 +134,9 @@ module RuboCop
           cop_config['AllowMarginComment']
         end
 
-        def current_token(node)
+        def current_token(comment)
           processed_source.find_token do |token|
-            token.pos.column == node.loc.column &&
-              token.pos.last_column == node.loc.last_column &&
-              token.line == node.loc.line
+            token.pos == comment.loc.expression
           end
         end
 

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

@@ -45,7 +45,7 @@ module RuboCop
           return if correct_style?(node)
 
           if node.modifier_form? && last_argument_is_heredoc?(node)
-            heredoc_node = last_argument(node)
+            heredoc_node = last_heredoc_argument(node)
 
             return if next_line_empty?(heredoc_line(node, heredoc_node))
 
@@ -109,16 +109,27 @@ module RuboCop
 
         def last_argument_is_heredoc?(node)
           last_children = node.if_branch
-
           return false unless last_children&.send_type?
 
-          last_argument = last_argument(node)
-
-          last_argument.respond_to?(:heredoc?) && last_argument.heredoc?
+          heredoc?(last_heredoc_argument(node))
         end
 
-        def last_argument(node)
-          node.if_branch.children.last
+        def last_heredoc_argument(node)
+          n = if node.respond_to?(:if_branch)
+                node.if_branch.children.last
+              else
+                node
+              end
+
+          return n if heredoc?(n)
+          return unless n.respond_to?(:arguments)
+
+          n.arguments.each do |argument|
+            node = last_heredoc_argument(argument)
+            return node if node
+          end
+
+          return last_heredoc_argument(n.receiver) if n.respond_to?(:receiver)
         end
 
         def heredoc_line(node, heredoc_node)
@@ -129,6 +140,10 @@ module RuboCop
           node.last_line + num_of_heredoc_lines + END_OF_HEREDOC_LINE
         end
 
+        def heredoc?(node)
+          node.respond_to?(:heredoc?) && node.heredoc?
+        end
+
         def offense_location(node)
           if node.loc.respond_to?(:end) && node.loc.end
             :end

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

@@ -55,8 +55,8 @@ module RuboCop
           source
             .comments
             .take_while { |comment| comment.loc.line < source.ast.loc.line }
-            .select     { |comment| MagicComment.parse(comment.text).any?  }
-            .last
+            .reverse
+            .find { |comment| MagicComment.parse(comment.text).any? }
         end
       end
     end

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

@@ -36,7 +36,7 @@ module RuboCop
       #
       #   end
       #
-      # @example Enforcedstyle: beginning_only
+      # @example EnforcedStyle: beginning_only
       #   # good
       #
       #   class Foo
@@ -46,7 +46,7 @@ module RuboCop
       #     end
       #   end
       #
-      # @example Enforcedstyle: ending_only
+      # @example EnforcedStyle: ending_only
       #   # good
       #
       #   class Foo

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

@@ -45,9 +45,7 @@ module RuboCop
         MSG_MISSING = 'Carriage return character missing.'
 
         def investigate(processed_source)
-          last_token = processed_source.tokens.last
-          last_line =
-            last_token ? last_token.line : processed_source.lines.length
+          last_line = last_line(processed_source)
 
           processed_source.raw_source.each_line.with_index do |line, index|
             break if index >= last_line
@@ -81,6 +79,13 @@ module RuboCop
           else MSG_MISSING if line !~ /\r$/
           end
         end
+
+        private
+
+        def last_line(processed_source)
+          last_token = processed_source.tokens.last
+          last_token ? last_token.line : processed_source.lines.length
+        end
       end
     end
   end