rubocop 1.89.0 → 1.90.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e613534eb66c6766aa04d7e1075e0d09aa8a3a78690b8b921583d81ea9fb8e9e
-  data.tar.gz: c65ec7b8f764105d8950cc73c4deca24f6bec976c6c4041b5338f4a97e98645c
+  metadata.gz: 382da6a2b30d9de3a34dfad6d8a2aba1f4c314881d4a7a419d698b58faf07cd4
+  data.tar.gz: 3807b557f0eedb44f81b1a20880649e15b8c76ed31a916756d626a13b391d556
 SHA512:
-  metadata.gz: 400677d5633740bb086f3f6e4c6cb9438423ce5a77ea6bc8a4bd72ff0249332c58370bbd98f809673699806cc2ae8dfde4d95a9313bfb8e465c631b506a18d20
-  data.tar.gz: a08736ea293673d3cebd8185df6b8b0cf718d24d23b772c20c09c1c00e61838c4963245e84074fe0b8732ad5eb32f9f459c3d915fb5a07ad9ee0e0019d2b9a2c
+  metadata.gz: 7654d620f9e6504e76855f15335df419416a8353da06cb55c0a15b1fa123b2cabc170792846e8ee5ab1b122003d14038809f524fdf7a07773d51a69b1faca234
+  data.tar.gz: 296dc584530a8191088320cfcfe2fdd38339da0888aac861b510ba219b50a601bd4bd060b831f9733f12553031c20abd91fdcc7ece654d0e716857ef7eb8cee8

data/config/default.yml

@@ -427,7 +427,7 @@ Layout/ArrayAlignment:
   Description: >-
                  Align the elements of an array literal if they span more than
                  one line.
-  StyleGuide: '#no-double-indent'
+  StyleGuide: '#align-multiline-arrays'
   Enabled: true
   VersionAdded: '0.49'
   VersionChanged: '0.77'
@@ -618,6 +618,12 @@ Layout/EmptyLineAfterMagicComment:
   StyleGuide: '#separate-magic-comments-from-code'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.90'
+  # The minimum number of empty lines required after the last magic comment. Set this
+  # to `2` when using YARD, which otherwise treats the magic comments as documentation
+  # for the first module or class in the file. `Layout/EmptyLines` has to be disabled
+  # for values greater than `1`.
+  NumberOfEmptyLines: 1
 
 Layout/EmptyLineAfterMultilineCondition:
   Description: 'Enforces empty line after multiline condition.'
@@ -1416,6 +1422,7 @@ Layout/SpaceAroundOperators:
   StyleGuide: '#spaces-operators'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.90'
   # When `true`, allows most uses of extra spacing if the intent is to align
   # with an operator on the previous or next line, not counting empty lines
   # or comment lines.
@@ -1659,6 +1666,13 @@ Lint/AmbiguousRegexpLiteral:
   VersionAdded: '0.17'
   VersionChanged: '0.83'
 
+Lint/ArgumentMismatch:
+  Description: >-
+    Checks for calls that pass the wrong number of positional arguments
+    to a method, using the project index.
+  Enabled: pending
+  VersionAdded: '1.90'
+
 Lint/ArrayLiteralInRegexp:
   Description: 'Checks for an array literal interpolated inside a regexp.'
   Enabled: pending
@@ -1734,6 +1748,7 @@ Lint/CopDirectiveSyntax:
   Description: 'Checks that `# rubocop:` directives are strictly formatted.'
   Enabled: pending
   VersionAdded: '1.72'
+  VersionChanged: '1.90'
 
 Lint/DataDefineOverride:
   Description: 'Disallow overriding the `Data` built-in methods via `Data.define`.'
@@ -1849,6 +1864,7 @@ Lint/DeprecatedReference:
 
 Lint/DisjunctiveAssignmentInConstructor:
   Description: 'In constructor, plain assignment is preferred over disjunctive.'
+  StyleGuide: '#disjunctive-assignment-in-constructor'
   Enabled: true
   Safe: false
   VersionAdded: '0.62'
@@ -1893,7 +1909,7 @@ Lint/DuplicateMethods:
   Description: 'Checks for duplicate method definitions.'
   Enabled: true
   VersionAdded: '0.29'
-  VersionChanged: '1.89'
+  VersionChanged: '1.90'
   # Methods that define instance methods by delegation, in the style of
   # Active Support's `delegate` (`delegate :foo, :bar, to: :target`). Register
   # a project's own `delegate`-shaped macros here so the cop recognizes the
@@ -1901,6 +1917,14 @@ Lint/DuplicateMethods:
   # is `true`.
   DelegatingMethods:
     - delegate
+  # Cross-file duplicates (detected with `AllCops/UseProjectIndex`) whose other
+  # definition lives in a file matching one of these patterns are not reported.
+  # Useful for files that redefine application methods but are never loaded
+  # together with them, such as standalone scripts. Patterns follow the same
+  # glob (or regexp) semantics as `Exclude` and are matched against the other
+  # file's path relative to the directory of the config file; absolute patterns
+  # are matched against the absolute path.
+  AllowedCrossFilePaths: []
 
 Lint/DuplicateRegexpCharacterClassElement:
   Description: 'Checks for duplicate elements in Regexp character classes.'
@@ -2140,7 +2164,7 @@ Lint/MissingCopEnableDirective:
   Description: 'Checks for a `# rubocop:enable` after `# rubocop:disable`.'
   Enabled: true
   VersionAdded: '0.52'
-  VersionChanged: '1.88'
+  VersionChanged: '1.90'
   # Maximum number of consecutive lines the cop can be disabled for.
   # 0 allows only single-line disables
   # 1 would mean the maximum allowed is the following:
@@ -2167,6 +2191,7 @@ Lint/MixedCaseRange:
 
 Lint/MixedRegexpCaptureTypes:
   Description: 'Do not mix named captures and numbered captures in a Regexp literal.'
+  StyleGuide: '#do-not-mix-named-and-numbered-captures'
   Enabled: true
   VersionAdded: '0.85'
 
@@ -2323,6 +2348,7 @@ Lint/RedundantCopEnableDirective:
   Description: Checks for rubocop:enable comments that can be removed.
   Enabled: true
   VersionAdded: '0.76'
+  VersionChanged: '1.90'
 
 Lint/RedundantDirGlobSort:
   Description: 'Checks for redundant `sort` method to `Dir.glob` and `Dir[]`.'
@@ -2505,6 +2531,7 @@ Lint/ShadowedException:
   Description: >-
                   Avoid rescuing a higher level exception
                   before a lower level exception.
+  StyleGuide: '#exception-ordering'
   Enabled: true
   VersionAdded: '0.41'
 
@@ -2527,6 +2554,13 @@ Lint/StructNewOverride:
   Enabled: true
   VersionAdded: '0.81'
 
+Lint/SuperArgumentMismatch:
+  Description: >-
+    Checks for `super` calls that pass the wrong number of positional
+    arguments to the overridden implementation, using the project index.
+  Enabled: pending
+  VersionAdded: '1.90'
+
 Lint/SuppressedException:
   Description: "Don't suppress exceptions."
   StyleGuide: '#dont-hide-exceptions'
@@ -2617,6 +2651,7 @@ Lint/UnexpectedBlockArity:
 
 Lint/UnifiedInteger:
   Description: 'Use Integer instead of Fixnum or Bignum.'
+  StyleGuide: '#integer-type-checking'
   Enabled: true
   VersionAdded: '0.43'
 
@@ -2679,7 +2714,10 @@ Lint/UnusedPrivateMethod:
   # would be reported as false positives. It is intended for occasional
   # dead-code sweeps rather than permanent enforcement.
   Enabled: false
+  AllowedNames: []
+  AllowedPatterns: []
   VersionAdded: '1.89'
+  VersionChanged: '1.90'
 
 Lint/UriEscapeUnescape:
   Description: >-
@@ -2718,6 +2756,7 @@ Lint/UselessConstantScoping:
   Description: 'Checks for useless constant scoping.'
   Enabled: pending
   VersionAdded: '1.72'
+  VersionChanged: '1.90'
 
 Lint/UselessDefaultValueArgument:
   Description: 'Checks for usage of `fetch` or `Array.new` with default value argument and block.'
@@ -3415,6 +3454,7 @@ Style/ArrayCoercion:
 
 Style/ArrayFirstLast:
   Description: 'Use `arr.first` and `arr.last` instead of `arr[0]` and `arr[-1]`.'
+  StyleGuide: '#first-and-last'
   References:
     - '#first-and-last'
   Enabled: false
@@ -3878,6 +3918,7 @@ Style/ConditionalAssignment:
                  Use the return value of `if` and `case` statements for
                  assignment to a variable and variable comparison instead
                  of assigning that variable inside of each branch.
+  StyleGuide: '#use-if-case-returns'
   Enabled: true
   VersionAdded: '0.36'
   VersionChanged: '0.47'
@@ -3938,7 +3979,7 @@ Style/DataInheritance:
 
 Style/DateTime:
   Description: 'Use Time over DateTime.'
-  StyleGuide: '#date-time'
+  StyleGuide: '#no-datetime'
   Enabled: false
   VersionAdded: '0.51'
   VersionChanged: '0.92'
@@ -3971,14 +4012,23 @@ Style/DirEmpty:
   Enabled: pending
   VersionAdded: '1.48'
 
+Style/DirectiveScope:
+  Description: >-
+                 Checks for directive scopes that can be expressed with the
+                 tighter `disable-next` form.
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '1.90'
+
 Style/DisableCopsWithinSourceCodeDirective:
   Description: >-
                  Forbids disabling/enabling cops within source code.
   Enabled: false
   VersionAdded: '0.82'
-  VersionChanged: '1.89'
+  VersionChanged: '1.90'
   AllowedCops: []
   DisallowedCops: []
+  AllowTrailingComment: false
 
 Style/DocumentDynamicEvalDefinition:
   Description: >-
@@ -4051,6 +4101,7 @@ Style/EmptyCaseCondition:
 
 Style/EmptyClassDefinition:
   Description: 'Enforces consistent style for empty class definitions.'
+  StyleGuide: '#single-line-classes'
   Enabled: pending
   VersionAdded: '1.84'
   VersionChanged: '1.86'
@@ -4216,12 +4267,14 @@ Style/FileEmpty:
 
 Style/FileNull:
   Description: 'Use `File::NULL` instead of hardcoding "dev/null".'
+  StyleGuide: '#null-devices'
   Enabled: pending
   SafeAutoCorrect: false
   VersionAdded: '1.69'
 
 Style/FileOpen:
   Description: 'Checks for `File.open` without a block, which can leak file descriptors.'
+  StyleGuide: '#auto-release-resources'
   Enabled: pending
   Safe: false
   VersionAdded: '1.85'
@@ -4286,6 +4339,7 @@ Style/FormatString:
 
 Style/FormatStringToken:
   Description: 'Use a consistent style for format string tokens.'
+  StyleGuide: '#named-format-tokens'
   Enabled: true
   VersionAdded: '0.49'
   VersionChanged: '1.74'
@@ -4475,6 +4529,7 @@ Style/HashSyntax:
 
 Style/HashTransformKeys:
   Description: 'Prefer `transform_keys` over `each_with_object`, `map`, or `to_h`.'
+  StyleGuide: '#hash-transform-methods'
   Enabled: true
   VersionAdded: '0.80'
   VersionChanged: '0.90'
@@ -4482,6 +4537,7 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Description: 'Prefer `transform_values` over `each_with_object`, `map`, or `to_h`.'
+  StyleGuide: '#hash-transform-methods'
   Enabled: true
   VersionAdded: '0.80'
   VersionChanged: '0.90'
@@ -4652,7 +4708,7 @@ Style/KeywordArgumentsMerging:
 
 Style/KeywordParametersOrder:
   Description: 'Enforces that optional keyword parameters are placed at the end of the parameters list.'
-  StyleGuide: '#keyword-parameters-order'
+  StyleGuide: '#keyword-arguments-order'
   Enabled: true
   VersionAdded: '0.90'
   VersionChanged: '1.7'
@@ -4685,6 +4741,7 @@ Style/LineEndConcatenation:
   Description: >-
                  Use \ instead of + or << to concatenate two string literals at
                  line end.
+  StyleGuide: '#heredoc-long-strings'
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.18'
@@ -4982,7 +5039,7 @@ Style/NegatedIfElseCondition:
 
 Style/NegatedUnless:
   Description: 'Favor if over unless for negative conditions.'
-  StyleGuide: '#if-for-negatives'
+  StyleGuide: '#unless-for-negatives'
   Enabled: true
   VersionAdded: '0.69'
   EnforcedStyle: both
@@ -5185,6 +5242,7 @@ Style/ObjectThen:
 
 Style/OneClassPerFile:
   Description: 'Checks that each source file defines at most one top-level class or module.'
+  StyleGuide: '#one-class-per-file'
   Enabled: pending
   VersionAdded: '1.85'
   VersionChanged: '1.86'
@@ -5550,6 +5608,7 @@ Style/RedundantInterpolationUnfreeze:
 
 Style/RedundantLineContinuation:
   Description: 'Checks for redundant line continuation.'
+  StyleGuide: '#no-trailing-backslash'
   Enabled: pending
   VersionAdded: '1.49'
 
@@ -5586,6 +5645,7 @@ Style/RedundantRegexpConstructor:
 
 Style/RedundantRegexpEscape:
   Description: 'Checks for redundant escapes in Regexps.'
+  StyleGuide: '#limit-escapes'
   Enabled: true
   VersionAdded: '0.85'
 
@@ -6039,6 +6099,12 @@ Style/TernaryParentheses:
     - require_parentheses_when_complex
   AllowSafeAssignment: true
 
+Style/TimeNow:
+  Description: 'Prefer `Time.now` over `Time.new` when retrieving the current system time.'
+  StyleGuide: '#time-now'
+  Enabled: pending
+  VersionAdded: '1.90'
+
 Style/TopLevelMethodDefinition:
   Description: 'Looks for top-level method definitions.'
   StyleGuide: '#top-level-methods'
@@ -6129,6 +6195,7 @@ Style/TrailingUnderscoreVariable:
   Description: >-
                  Checks for the usage of unneeded trailing underscores at the
                  end of parallel variable assignment.
+  StyleGuide: '#trailing-underscore-variables'
   Enabled: true
   VersionAdded: '0.31'
   VersionChanged: '0.35'

data/exe/rubocop

@@ -8,7 +8,7 @@ server_cli = RuboCop::Server::CLI.new
 exit_status = server_cli.run
 exit exit_status if server_cli.exit?
 
-if RuboCop::Server.running?
+if RuboCop::Server.forward_to_server?
   exit_status = RuboCop::Server::ClientCommand::Exec.new.run
 else
   require 'rubocop'

data/lib/rubocop/cached_data.rb

@@ -22,7 +22,7 @@ module RuboCop
 
     def serialize_offense(offense)
       status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
-      {
+      hash = {
         # Calling #to_s here ensures that the serialization works when using
         # other json serializers such as Oj. Some of these gems do not call
         # #to_s implicitly.
@@ -35,6 +35,10 @@ module RuboCop
         cop_name: offense.cop_name,
         status:   status || offense.status
       }
+      # Only offenses suppressed by a directive can carry one, so keep the key out of the
+      # common case rather than writing a null for every cached offense.
+      hash[:justification] = offense.justification if offense.justification
+      hash
     end
 
     def message(offense)
@@ -47,7 +51,8 @@ module RuboCop
     def deserialize_offenses(offenses)
       offenses.map! do |o|
         location = location_from_source_buffer(o)
-        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
+        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym,
+                         justification: o['justification'])
       end
     end
 

data/lib/rubocop/cli/command/execute_runner.rb

@@ -30,6 +30,10 @@ module RuboCop
 
           maybe_print_corrected_source
 
+          merge_todo_audit_status(runner_status(runner, all_pass_or_excluded))
+        end
+
+        def runner_status(runner, all_pass_or_excluded)
           if runner.aborting?
             STATUS_INTERRUPTED
           elsif all_pass_or_excluded && runner.errors.empty?
@@ -39,6 +43,33 @@ module RuboCop
           end
         end
 
+        def merge_todo_audit_status(status)
+          return status if status == STATUS_INTERRUPTED || !@options[:report_unused_todo_entries]
+
+          audit_status = report_unused_todo_entries
+          status == STATUS_SUCCESS ? audit_status : status
+        end
+
+        def report_unused_todo_entries
+          audit = TodoAudit.new(@config_store, @options)
+          unused = audit.unused_entries
+
+          if unused.nil?
+            warn Rainbow("No `#{audit.todo_file}` found; nothing to audit.").yellow
+            return STATUS_SUCCESS
+          end
+          return STATUS_SUCCESS if unused.empty?
+
+          print_unused_todo_entries(audit.todo_file, unused)
+          STATUS_OFFENSES
+        end
+
+        def print_unused_todo_entries(todo_file, unused)
+          noun = unused.size == 1 ? 'entry' : 'entries'
+          warn Rainbow("\n#{unused.size} unused todo #{noun} found in `#{todo_file}`:").red
+          unused.each { |entry| warn "  #{entry.cop_name}: #{entry.path}" }
+        end
+
         def with_redirect
           if @options[:stderr]
             orig_stdout = $stdout

data/lib/rubocop/cli.rb

@@ -35,7 +35,7 @@ module RuboCop
     # @param args [Array<String>] command line arguments
     # @return [Integer] UNIX exit code
     #
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
       time_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
@@ -80,11 +80,10 @@ module RuboCop
         puts "Finished in #{elapsed_time.round(5)} seconds"
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     private
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize
     def profile_if_needed
       return yield unless @options[:profile]
 
@@ -116,7 +115,6 @@ module RuboCop
       end
       status
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def require_gem(name)
       require name

data/lib/rubocop/comment_config/directive_range.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CommentConfig
+    # A disabled line range that remembers the directive comment that opened
+    # it. Value-equal to a plain `Range`, so consumers comparing or hashing
+    # ranges are unaffected.
+    # @api private
+    class DirectiveRange < Range
+      attr_reader :directive
+
+      def initialize(first_line, last_line, directive)
+        super(first_line, last_line)
+        @directive = directive
+      end
+    end
+
+    # The per-cop state accumulated while analyzing directives: the disabled
+    # ranges so far, plus the line and directive of the currently open
+    # disable, if any.
+    # @api private
+    CopAnalysis = Struct.new(:line_ranges, :start_line_number, :start_directive) do
+      # The open range (if any) closed at the given line, appended to the
+      # accumulated ranges, each remembering the directive that opened it.
+      def close(line)
+        return line_ranges unless start_line_number
+
+        line_ranges + [DirectiveRange.new(start_line_number, line, start_directive)]
+      end
+    end
+  end
+end

data/lib/rubocop/comment_config/disable_next.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CommentConfig
+    # Handling of `disable-next` directives: computing the statement scope
+    # they apply to and tracking directives that attached to nothing.
+    # The scope is the whole statement starting on the next line bearing
+    # code. Comment-only lines between the directive and the code chain (so
+    # several directives can stack), while a blank line breaks the attachment.
+    # @api private
+    module DisableNext
+      # `disable-next` directives that suppress nothing: nothing follows
+      # them, or they sit at the end of a code line.
+      def detached_next_directives
+        cop_disabled_line_ranges # ensure the analysis that collects them ran
+        @detached_next_directives
+      end
+
+      # The line range of the statement a `disable-next` directive on the
+      # given line scopes to (or would scope to), or `nil` when no statement
+      # is attached. A directive is only honored on a comment-only line.
+      # Stacked directives share the target, so the computation is memoized.
+      # @api private
+      def statement_scope_after(line)
+        return nil unless comment_only_line?(line)
+
+        code_line = attached_code_line(line)
+        return nil unless code_line
+
+        (@statement_bounds ||= {})[code_line] ||= statement_bounds_at(code_line)
+      end
+
+      private
+
+      def apply_disable_next(analyses, directive)
+        bounds = statement_scope_after(directive.line_number)
+        return @detached_next_directives << directive unless bounds
+
+        range = DirectiveRange.new(bounds.begin, bounds.end, directive)
+        directive.cop_names.each do |cop_name|
+          add_next_range(analyses, qualified_cop_name(cop_name), range)
+        end
+      end
+
+      def add_next_range(analyses, cop_name, range)
+        analysis = analyses[cop_name]
+        analyses[cop_name] = CopAnalysis.new(analysis.line_ranges + [range],
+                                             analysis.start_line_number, analysis.start_directive)
+      end
+
+      def attached_code_line(directive_line)
+        ((directive_line + 1)..processed_source.lines.size).each do |line|
+          return line unless comment_only_line?(line)
+          return nil if processed_source[line - 1].blank?
+        end
+
+        nil
+      end
+
+      def statement_bounds_at(line)
+        statement = statement_starting_at(line)
+        # A code line where no statement starts (e.g. a lone `end`) scopes
+        # the directive to that line alone.
+        return (line..line) unless statement
+
+        (line..statement_end_line(statement))
+      end
+
+      def statement_start_line?(node, line)
+        # Synthetic nodes (e.g. parentheses-less argument lists) have no
+        # source range. `begin` nodes are sequences of statements, not
+        # statements themselves - taking one would scope the directive to
+        # everything up to the last statement of the sequence.
+        node.source_range && node.first_line == line && !node.begin_type?
+      end
+
+      def statement_starting_at(line)
+        ast = processed_source.ast
+        return nil unless ast
+
+        ast.each_node.select { |node| statement_start_line?(node, line) }.max_by(&:last_line)
+      end
+
+      def statement_end_line(statement)
+        statement.each_node.filter_map do |node|
+          next unless node.source_range
+
+          heredoc?(node) ? node.loc.heredoc_end.line : node.last_line
+        end.max
+      end
+
+      def heredoc?(node)
+        node.respond_to?(:heredoc?) && node.heredoc?
+      end
+    end
+  end
+end