rubocop 1.90.0 → 1.92.0

data/lib/rubocop/unified_diff.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Renders a unified diff between two versions of a file's source.
+  #
+  # RuboCop has no diffing dependency and this output is meant to be read by
+  # people (and occasionally piped into `git apply`), so the goal is a diff
+  # that is correct and readable, not one that matches `diff -u` byte for byte.
+  #
+  # @api private
+  class UnifiedDiff
+    CONTEXT_LINES = 3
+    NO_NEWLINE_MARKER = "\\n"
+
+    # Finding a minimal diff costs time and memory proportional to the square
+    # of the number of edits. Past this many edits the file was rewritten
+    # rather than corrected, so the changed region is reported as a single
+    # replacement instead.
+    MAX_EDIT_DISTANCE = 400
+
+    def initialize(path, old_source, new_source)
+      @path = path
+      @old_lines = old_source.lines
+      @new_lines = new_source.lines
+    end
+
+    # @return [String] the diff, or an empty string when the sources are identical
+    def to_s
+      return '' if @old_lines == @new_lines
+
+      hunks = hunks_for(edit_script)
+      return '' if hunks.empty?
+
+      ["--- a/#{@path}\n", "+++ b/#{@path}\n", *hunks].join
+    end
+
+    private
+
+    def edit_script
+      prefix = common_prefix_length
+      suffix = common_suffix_length(prefix)
+      old_last = @old_lines.length - suffix
+      new_last = @new_lines.length - suffix
+
+      [
+        *@old_lines[0...prefix].map { |line| [:equal, line] },
+        *middle_script(@old_lines[prefix...old_last], @new_lines[prefix...new_last]),
+        *@old_lines[old_last..].map { |line| [:equal, line] }
+      ]
+    end
+
+    def common_prefix_length
+      length = 0
+      length += 1 while length < @old_lines.length && @old_lines[length] == @new_lines[length]
+      length
+    end
+
+    def common_suffix_length(prefix)
+      length = 0
+      max = [@old_lines.length, @new_lines.length].min - prefix
+      while length < max &&
+            @old_lines[@old_lines.length - 1 - length] == @new_lines[@new_lines.length - 1 - length]
+        length += 1
+      end
+      length
+    end
+
+    def middle_script(old_lines, new_lines)
+      # The region that actually differs is diffed on its own, so the rest of
+      # the algorithm works on these two slices rather than the whole file.
+      @from_lines = old_lines
+      @to_lines = new_lines
+
+      myers_script ||
+        [*old_lines.map { |line| [:delete, line] }, *new_lines.map { |line| [:insert, line] }]
+    end
+
+    # Myers' diff algorithm. Each round `d` extends the furthest reaching path
+    # for every diagonal `k`; the first path to reach the end of both sources
+    # is a shortest edit script, which is then reconstructed from the saved
+    # rounds. Returns `nil` when the sources are too different to bother.
+    def myers_script
+      trace = []
+      furthest = Hash.new(0)
+      max_distance = [@from_lines.length + @to_lines.length, MAX_EDIT_DISTANCE].min
+
+      0.upto(max_distance) do |distance|
+        trace << furthest.dup
+
+        (-distance).step(distance, 2) do |diagonal|
+          furthest[diagonal] = advance(furthest, diagonal, distance)
+
+          return backtrack(trace) if reached_end?(furthest[diagonal], diagonal)
+        end
+      end
+
+      nil
+    end
+
+    def reached_end?(old_index, diagonal)
+      old_index >= @from_lines.length && old_index - diagonal >= @to_lines.length
+    end
+
+    # Picks the better of the two paths reaching this diagonal, then follows
+    # the diagonal as far as the lines match.
+    def advance(furthest, diagonal, distance)
+      old_index = start_of_path(furthest, diagonal, distance)
+
+      follow_diagonal(old_index, old_index - diagonal)
+    end
+
+    # A path arrives at this diagonal either from the one above it (having
+    # inserted a line) or the one below it (having deleted one); whichever
+    # reached further wins.
+    def previous_diagonal(furthest, diagonal, distance)
+      if diagonal == -distance ||
+         (diagonal != distance && furthest[diagonal - 1] < furthest[diagonal + 1])
+        diagonal + 1
+      else
+        diagonal - 1
+      end
+    end
+
+    def start_of_path(furthest, diagonal, distance)
+      previous = previous_diagonal(furthest, diagonal, distance)
+
+      previous > diagonal ? furthest[previous] : furthest[previous] + 1
+    end
+
+    # Matching lines cost nothing, so the path slides along them for free.
+    def follow_diagonal(old_index, new_index)
+      while old_index < @from_lines.length && new_index < @to_lines.length &&
+            @from_lines[old_index] == @to_lines[new_index]
+        old_index += 1
+        new_index += 1
+      end
+
+      old_index
+    end
+
+    def backtrack(trace)
+      script = []
+      position = [@from_lines.length, @to_lines.length]
+
+      trace.each_with_index.reverse_each do |furthest, distance|
+        previous = previous_position(furthest, distance, *position)
+        position = walk_diagonal(script, position, previous)
+        next if distance.zero?
+
+        position = record_edit(script, position, previous)
+      end
+
+      script
+    end
+
+    # Both sides step back together for as long as their lines match.
+    def walk_diagonal(script, position, previous)
+      old_index, new_index = position
+
+      while old_index > previous[0] && new_index > previous[1]
+        old_index -= 1
+        new_index -= 1
+        script.unshift([:equal, @from_lines[old_index]])
+      end
+
+      [old_index, new_index]
+    end
+
+    def record_edit(script, position, previous)
+      old_index, new_index = position
+
+      if old_index == previous[0]
+        new_index -= 1
+        script.unshift([:insert, @to_lines[new_index]])
+      else
+        old_index -= 1
+        script.unshift([:delete, @from_lines[old_index]])
+      end
+
+      [old_index, new_index]
+    end
+
+    def previous_position(furthest, distance, old_index, new_index)
+      previous = previous_diagonal(furthest, old_index - new_index, distance)
+      previous_old = furthest[previous]
+
+      [previous_old, previous_old - previous]
+    end
+
+    def hunks_for(script)
+      changed = script.each_index.reject { |index| script[index].first == :equal }
+      return [] if changed.empty?
+
+      ranges_for(changed, script.length).map { |range| hunk(script, range) }
+    end
+
+    # Every change is shown with a few lines of context around it, and changes
+    # whose context would overlap are shown as a single hunk.
+    def ranges_for(changed, script_length)
+      ranges = []
+
+      changed.each do |index|
+        first = [index - CONTEXT_LINES, 0].max
+        last = [index + CONTEXT_LINES, script_length - 1].min
+
+        if ranges.last && first <= ranges.last.last + 1
+          ranges[-1] = (ranges.last.first..last)
+        else
+          ranges << (first..last)
+        end
+      end
+
+      ranges
+    end
+
+    def hunk(script, range)
+      old_start, new_start = start_positions(script, range.first)
+      old_count = script[range].count { |kind, _| kind != :insert }
+      new_count = script[range].count { |kind, _| kind != :delete }
+      body = script[range].map { |kind, line| formatted_line(kind, line) }
+
+      [
+        "@@ -#{position(old_start, old_count)} +#{position(new_start, new_count)} @@\n",
+        *body
+      ].join
+    end
+
+    def start_positions(script, index)
+      old_line = 1
+      new_line = 1
+
+      script[0...index].each do |entry|
+        old_line += 1 unless entry.first == :insert
+        new_line += 1 unless entry.first == :delete
+      end
+
+      [old_line, new_line]
+    end
+
+    # An empty side is anchored to the line it follows, which is how `diff`
+    # reports a pure insertion or deletion, and a single line drops the count.
+    def position(start, count)
+      case count
+      when 0 then "#{start - 1},0"
+      when 1 then start.to_s
+      else "#{start},#{count}"
+      end
+    end
+
+    def formatted_line(kind, line)
+      marker = { equal: ' ', delete: '-', insert: '+' }.fetch(kind)
+      return "#{marker}#{line}" if line.end_with?("\n")
+
+      "#{marker}#{line}\n#{NO_NEWLINE_MARKER}"
+    end
+  end
+end

data/lib/rubocop/util.rb

@@ -12,5 +12,74 @@ module RuboCop
     ensure
       $VERBOSE = old_verbose
     end
+
+    # The source as it reads back after `File.write`, which in text mode turns
+    # each LF into CRLF on Windows. Cops like `Layout/EndOfLine` have to see
+    # corrected code that way between correction passes, and so does anything
+    # that compares it with what a write leaves on disk. The final `File.write`
+    # still performs the conversion for the file itself.
+    def self.emulate_write_read_cycle(source)
+      return source unless Platform.windows?
+
+      source.encode(source.encoding, crlf_newline: true)
+    end
+
+    # Replaces the contents of `path` without a window in which the file is truncated
+    # but not yet rewritten, so that an interrupted run or a full disk cannot lose
+    # the original: the new contents are written next to the file and renamed over it,
+    # like `ResultCache#save`. `File.write` is used for the temporary file so text-mode
+    # semantics (the CRLF conversion on Windows) stay identical to a direct write.
+    # Where the temporary file cannot be created or renamed for lack of permission,
+    # a direct write is used as before.
+    def self.replace_file_contents(path, contents)
+      # Write through symlinks so that the rename replaces the real file and
+      # the symlink survives.
+      path = File.realpath(path)
+
+      # Opening a read-only file fails without truncating it, keeping the behavior
+      # a direct write always had.
+      return File.write(path, contents) unless File.writable?(path)
+
+      temp_path = "#{path}.#{Process.pid}.#{rand(1_000_000_000)}.rubocop.tmp"
+      begin
+        replace_via_temporary_file(path, temp_path, contents)
+      ensure
+        FileUtils.rm_f(temp_path)
+      end
+    rescue Errno::ENOENT
+      # The file vanished mid-run or is a dangling symlink: recreate it the way
+      # a direct write always has.
+      File.write(path, contents)
+    end
+
+    def self.replace_via_temporary_file(path, temp_path, contents)
+      # The directory refuses new files even though the file itself is writable,
+      # so a direct write is the only option left.
+      return File.write(path, contents) unless write_temporary_file(temp_path, contents)
+
+      begin
+        # A fresh file would get umask-default permissions on rename;
+        # keep the original's.
+        File.chmod(File.stat(path).mode, temp_path)
+        File.rename(temp_path, path)
+      rescue SystemCallError
+        # The replacement was refused, e.g. the file is open in another process on Windows.
+        # The contents already fit on disk, so a direct write is safe once the temporary copy
+        # no longer takes up that space.
+        FileUtils.rm_f(temp_path)
+        File.write(path, contents)
+      end
+    end
+    private_class_method :replace_via_temporary_file
+
+    # Space errors such as `ENOSPC` must propagate: a direct write would then
+    # truncate the file and fail, which is exactly the loss being avoided.
+    def self.write_temporary_file(temp_path, contents)
+      File.write(temp_path, contents)
+      true
+    rescue Errno::EACCES, Errno::EPERM
+      false
+    end
+    private_class_method :write_temporary_file
   end
 end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.90.0'
+    STRING = '1.92.0'
 
     MSG = '%<version>s (using %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -27,6 +27,7 @@ require_relative 'rubocop/ext/regexp_parser'
 require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/ext/processed_source'
 
+require_relative 'rubocop/changed_files'
 require_relative 'rubocop/error'
 require_relative 'rubocop/file_finder'
 require_relative 'rubocop/file_patterns'
@@ -34,10 +35,11 @@ require_relative 'rubocop/name_similarity'
 require_relative 'rubocop/path_util'
 require_relative 'rubocop/platform'
 require_relative 'rubocop/string_interpreter'
+require_relative 'rubocop/unified_diff'
 require_relative 'rubocop/util'
 require_relative 'rubocop/warning'
 
-# rubocop:disable Style/RequireOrder
+# rubocop:disable Style/RequireOrder -- ordered by load dependency, not alphabetically
 
 require_relative 'rubocop/project_index_loader'
 require_relative 'rubocop/cop/util'
@@ -53,6 +55,8 @@ require_relative 'rubocop/cop/base'
 require_relative 'rubocop/cop/cop'
 require_relative 'rubocop/cop/commissioner'
 require_relative 'rubocop/cop/documentation'
+require_relative 'rubocop/cop/cop_documentation'
+require_relative 'rubocop/cop/cop_explanation'
 require_relative 'rubocop/cop/corrector'
 require_relative 'rubocop/cop/correctors'
 require_relative 'rubocop/cop/force'
@@ -112,14 +116,18 @@ require_relative 'rubocop/target_finder'
 require_relative 'rubocop/directive_comment'
 require_relative 'rubocop/comment_config/directive_range'
 require_relative 'rubocop/comment_config/disable_next'
+require_relative 'rubocop/comment_config/push_pop'
 require_relative 'rubocop/comment_config'
 require_relative 'rubocop/result_cache'
+require_relative 'rubocop/offense_limit'
 require_relative 'rubocop/runner'
 require_relative 'rubocop/cli'
 require_relative 'rubocop/cli/command'
 require_relative 'rubocop/cli/environment'
 require_relative 'rubocop/cli/command/base'
 require_relative 'rubocop/cli/command/auto_generate_config'
+require_relative 'rubocop/cli/command/cop_names'
+require_relative 'rubocop/cli/command/explain'
 require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/lsp'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.90.0
+  version: 1.92.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -107,7 +107,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.9.3
+        version: 2.11.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -117,7 +117,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.9.3
+        version: 2.11.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -201,11 +201,14 @@ files:
 - lib/rubocop/ast_aliases.rb
 - lib/rubocop/cache_config.rb
 - lib/rubocop/cached_data.rb
+- lib/rubocop/changed_files.rb
 - lib/rubocop/cli.rb
 - lib/rubocop/cli/command.rb
 - lib/rubocop/cli/command/auto_generate_config.rb
 - lib/rubocop/cli/command/base.rb
+- lib/rubocop/cli/command/cop_names.rb
 - lib/rubocop/cli/command/execute_runner.rb
+- lib/rubocop/cli/command/explain.rb
 - lib/rubocop/cli/command/init_dotfile.rb
 - lib/rubocop/cli/command/list_enabled_cops_for.rb
 - lib/rubocop/cli/command/lsp.rb
@@ -218,6 +221,7 @@ files:
 - lib/rubocop/comment_config.rb
 - lib/rubocop/comment_config/directive_range.rb
 - lib/rubocop/comment_config/disable_next.rb
+- lib/rubocop/comment_config/push_pop.rb
 - lib/rubocop/config.rb
 - lib/rubocop/config_finder.rb
 - lib/rubocop/config_loader.rb
@@ -248,6 +252,8 @@ files:
 - lib/rubocop/cop/bundler/ordered_gems.rb
 - lib/rubocop/cop/commissioner.rb
 - lib/rubocop/cop/cop.rb
+- lib/rubocop/cop/cop_documentation.rb
+- lib/rubocop/cop/cop_explanation.rb
 - lib/rubocop/cop/corrector.rb
 - lib/rubocop/cop/correctors.rb
 - lib/rubocop/cop/correctors/alignment_corrector.rb
@@ -502,6 +508,7 @@ files:
 - lib/rubocop/cop/lint/literal_assignment_in_condition.rb
 - lib/rubocop/cop/lint/literal_in_interpolation.rb
 - lib/rubocop/cop/lint/loop.rb
+- lib/rubocop/cop/lint/misplaced_magic_comment.rb
 - lib/rubocop/cop/lint/missing_cop_enable_directive.rb
 - lib/rubocop/cop/lint/missing_super.rb
 - lib/rubocop/cop/lint/mixed_case_range.rb
@@ -640,6 +647,7 @@ files:
 - lib/rubocop/cop/mixin/empty_lines_around_body.rb
 - lib/rubocop/cop/mixin/empty_parameter.rb
 - lib/rubocop/cop/mixin/end_keyword_alignment.rb
+- lib/rubocop/cop/mixin/endless_method_body_help.rb
 - lib/rubocop/cop/mixin/endless_method_rewriter.rb
 - lib/rubocop/cop/mixin/enforce_superclass.rb
 - lib/rubocop/cop/mixin/first_element_line_break.rb
@@ -672,6 +680,7 @@ files:
 - lib/rubocop/cop/mixin/on_normal_if_unless.rb
 - lib/rubocop/cop/mixin/ordered_gem_node.rb
 - lib/rubocop/cop/mixin/parentheses.rb
+- lib/rubocop/cop/mixin/pattern_matching_help.rb
 - lib/rubocop/cop/mixin/percent_array.rb
 - lib/rubocop/cop/mixin/percent_literal.rb
 - lib/rubocop/cop/mixin/preceding_following_alignment.rb
@@ -785,7 +794,6 @@ files:
 - lib/rubocop/cop/style/document_dynamic_eval_definition.rb
 - lib/rubocop/cop/style/documentation.rb
 - lib/rubocop/cop/style/documentation_method.rb
-- lib/rubocop/cop/style/double_cop_disable_directive.rb
 - lib/rubocop/cop/style/double_negation.rb
 - lib/rubocop/cop/style/each_for_simple_loop.rb
 - lib/rubocop/cop/style/each_with_object.rb
@@ -1073,6 +1081,7 @@ files:
 - lib/rubocop/formatter/pacman_formatter.rb
 - lib/rubocop/formatter/progress_formatter.rb
 - lib/rubocop/formatter/quiet_formatter.rb
+- lib/rubocop/formatter/sarif_formatter.rb
 - lib/rubocop/formatter/simple_text_formatter.rb
 - lib/rubocop/formatter/tap_formatter.rb
 - lib/rubocop/formatter/text_util.rb
@@ -1088,8 +1097,13 @@ files:
 - lib/rubocop/lsp/severity.rb
 - lib/rubocop/lsp/stdin_runner.rb
 - lib/rubocop/magic_comment.rb
+- lib/rubocop/mcp/autocorrection_request.rb
+- lib/rubocop/mcp/explain_tool.rb
+- lib/rubocop/mcp/scope.rb
 - lib/rubocop/mcp/server.rb
+- lib/rubocop/mcp/source_files.rb
 - lib/rubocop/name_similarity.rb
+- lib/rubocop/offense_limit.rb
 - lib/rubocop/options.rb
 - lib/rubocop/path_util.rb
 - lib/rubocop/pending_cops_reporter.rb
@@ -1131,6 +1145,7 @@ files:
 - lib/rubocop/target_finder.rb
 - lib/rubocop/target_ruby.rb
 - lib/rubocop/todo_audit.rb
+- lib/rubocop/unified_diff.rb
 - lib/rubocop/util.rb
 - lib/rubocop/version.rb
 - lib/rubocop/warning.rb
@@ -1142,9 +1157,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://rubocop.org/
-  changelog_uri: https://github.com/rubocop/rubocop/releases/tag/v1.90.0
+  changelog_uri: https://github.com/rubocop/rubocop/releases/tag/v1.92.0
   source_code_uri: https://github.com/rubocop/rubocop/
-  documentation_uri: https://docs.rubocop.org/rubocop/1.90/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.92/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Lint/RedundantCopDisableDirective
-# rubocop:disable Style/DoubleCopDisableDirective
-
-module RuboCop
-  module Cop
-    module Style
-      # Detects double disable comments on one line. This is mostly to catch
-      # automatically generated comments that need to be regenerated.
-      #
-      # @example
-      #   # bad
-      #   def f # rubocop:disable Style/For # rubocop:disable Metrics/AbcSize
-      #   end
-      #
-      #   # good
-      #   # rubocop:disable Metrics/AbcSize
-      #   def f # rubocop:disable Style/For
-      #   end
-      #   # rubocop:enable Metrics/AbcSize
-      #
-      #   # if both fit on one line
-      #   def f # rubocop:disable Style/For, Metrics/AbcSize
-      #   end
-      #
-      class DoubleCopDisableDirective < Base
-        extend AutoCorrector
-
-        # rubocop:enable Style/For, Style/DoubleCopDisableDirective
-        # rubocop:enable Lint/RedundantCopDisableDirective, Metrics/AbcSize
-        MSG = 'More than one disable comment on one line.'
-
-        def on_new_investigation
-          processed_source.comments.each do |comment|
-            next unless comment.text.scan(/# rubocop:(?:disable|todo)/).size > 1
-
-            add_offense(comment) do |corrector|
-              corrector.replace(comment, comment.text.gsub(%r{ # rubocop:(disable|todo)}, ','))
-            end
-          end
-        end
-      end
-    end
-  end
-end