rubocop-grantbirki 1.75.2

data/config/internal_affairs.yml

@@ -0,0 +1,31 @@
+# Configuration for InternalAffairs cops. This file will be
+# automatically loaded when `rubocop/cop/internal_affairs` is required.
+# Only do this when developing custom cops or a RuboCop extension.
+
+InternalAffairs/CopDescription:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleHeredocDelimiter:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleDescription:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/NodeTypeGroup:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/OnSendWithoutOnCSend:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UndefinedConfig:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UselessMessageAssertion:
+  Include:
+    - '**/*_spec.rb'

data/config/obsoletion.yml

@@ -0,0 +1,240 @@
+# Configuration of obsolete/deprecated cops used by `ConfigObsoletion`
+
+# Cops that were renamed
+renamed:
+  Layout/AlignArguments: Layout/ArgumentAlignment
+  Layout/AlignArray: Layout/ArrayAlignment
+  Layout/AlignHash: Layout/HashAlignment
+  Layout/AlignParameters: Layout/ParameterAlignment
+  Layout/IndentArray: Layout/FirstArrayElementIndentation
+  Layout/IndentAssignment: Layout/AssignmentIndentation
+  Layout/IndentFirstArgument: Layout/FirstArgumentIndentation
+  Layout/IndentFirstArrayElement: Layout/FirstArrayElementIndentation
+  Layout/IndentFirstHashElement: Layout/FirstHashElementIndentation
+  Layout/IndentFirstParameter: Layout/FirstParameterIndentation
+  Layout/IndentHash: Layout/FirstHashElementIndentation
+  Layout/IndentHeredoc: Layout/HeredocIndentation
+  Layout/LeadingBlankLines: Layout/LeadingEmptyLines
+  Layout/Tab: Layout/IndentationStyle
+  Layout/TrailingBlankLines: Layout/TrailingEmptyLines
+  Lint/BlockAlignment: Layout/BlockAlignment
+  Lint/DefEndAlignment: Layout/DefEndAlignment
+  Lint/DuplicatedKey: Lint/DuplicateHashKey
+  Lint/EndAlignment: Layout/EndAlignment
+  Lint/EndInMethod: Style/EndBlock
+  Lint/Eval: Security/Eval
+  Lint/HandleExceptions: Lint/SuppressedException
+  Lint/MultipleCompare: Lint/MultipleComparison
+  Lint/StringConversionInInterpolation: Lint/RedundantStringCoercion
+  Lint/UnneededCopDisableDirective: Lint/RedundantCopDisableDirective
+  Lint/UnneededCopEnableDirective: Lint/RedundantCopEnableDirective
+  Lint/UnneededRequireStatement: Lint/RedundantRequireStatement
+  Lint/UnneededSplatExpansion: Lint/RedundantSplatExpansion
+  Metrics/LineLength: Layout/LineLength
+  Naming/UncommunicativeBlockParamName: Naming/BlockParameterName
+  Naming/UncommunicativeMethodParamName: Naming/MethodParameterName
+  Style/AccessorMethodName: Naming/AccessorMethodName
+  Style/AsciiIdentifiers: Naming/AsciiIdentifiers
+  Style/ClassAndModuleCamelCase: Naming/ClassAndModuleCamelCase
+  Style/ConstantName: Naming/ConstantName
+  Style/DeprecatedHashMethods: Style/PreferredHashMethods
+  Style/FileName: Naming/FileName
+  Style/FlipFlop: Lint/FlipFlop
+  Style/MethodCallParentheses: Style/MethodCallWithoutArgsParentheses
+  Style/MethodName: Naming/MethodName
+  Style/OpMethod: Naming/BinaryOperatorParameterName
+  Style/PredicateName:
+    new_name: Naming/PredicateName
+    severity: warning
+  Style/SingleSpaceBeforeFirstArg: Layout/SpaceBeforeFirstArg
+  Style/UnneededCapitalW: Style/RedundantCapitalW
+  Style/UnneededCondition: Style/RedundantCondition
+  Style/UnneededInterpolation: Style/RedundantInterpolation
+  Style/UnneededPercentQ: Style/RedundantPercentQ
+  Style/UnneededSort: Style/RedundantSort
+  Style/VariableName: Naming/VariableName
+  Style/VariableNumber: Naming/VariableNumber
+
+# Cops that were removed
+removed:
+  Gemspec/DateAssignment:
+    alternatives: Gemspec/DeprecatedAttributeAssignment
+  Layout/SpaceAfterControlKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Layout/SpaceBeforeModifierKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Lint/InvalidCharacterLiteral:
+    reason: it was never being actually triggered
+  Lint/RescueWithoutErrorClass:
+    alternatives: Style/RescueStandardError
+  Lint/SpaceBeforeFirstArg:
+    reason: >
+      it was a duplicate of `Layout/SpaceBeforeFirstArg`. Please use
+      `Layout/SpaceBeforeFirstArg` instead
+  Lint/UselessComparison:
+    reason: >
+      it has been superseded by
+      `Lint/BinaryOperatorWithIdenticalOperands`. Please use
+      `Lint/BinaryOperatorWithIdenticalOperands` instead
+  Style/BracesAroundHashParameters: true
+  Style/MethodMissingSuper:
+    reason: >
+      it has been superseded by `Lint/MissingSuper`. Please use
+      `Lint/MissingSuper` instead
+  Style/SpaceAfterControlKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Style/SpaceBeforeModifierKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Style/TrailingComma:
+    alternatives:
+      - Style/TrailingCommaInArguments
+      - Style/TrailingCommaInArrayLiteral
+      - Style/TrailingCommaInHashLiteral
+  Style/TrailingCommaInLiteral:
+    alternatives:
+      - Style/TrailingCommaInArrayLiteral
+      - Style/TrailingCommaInHashLiteral
+
+# Cops split into multiple other cops
+split:
+  Style/MethodMissing:
+    alternatives:
+      - Style/MethodMissingSuper
+      - Style/MissingRespondToMissing
+
+# Cops that were extracted into a different gem
+extracted:
+  Performance/*: rubocop-performance
+  Rails/*: rubocop-rails
+
+# Cop parameters that have been changed
+# Can be treated as a warning instead of a failure with `severity: warning`
+changed_parameters:
+  - cops:
+      - Layout/SpaceAroundOperators
+      - Style/SpaceAroundOperators
+    parameters: MultiSpaceAllowedForOperators
+    reason: >
+      If your intention was to allow extra spaces for alignment, please
+      use `AllowForAlignment: true` instead.
+  - cops: Style/Encoding
+    parameters:
+      - EnforcedStyle
+      - SupportedStyles
+      - AutoCorrectEncodingComment
+    reason: '`Style/Encoding` no longer supports styles. The "never" behavior is always assumed.'
+  - cops: Style/IfUnlessModifier
+    parameters: MaxLineLength
+    reason: >
+      `Style/IfUnlessModifier: MaxLineLength` has been removed.
+      Use `Layout/LineLength: Max` instead
+  - cops: Style/WhileUntilModifier
+    parameters: MaxLineLength
+    reason: >
+      `Style/WhileUntilModifier: MaxLineLength` has been removed.
+      Use `Layout/LineLength: Max` instead
+  - cops: AllCops
+    parameters: RunRailsCops
+    reason: |-
+      Use the following configuration instead:
+      Rails:
+        Enabled: true
+  - cops: Layout/CaseIndentation
+    parameters: IndentWhenRelativeTo
+    alternative: EnforcedStyle
+  - cops:
+      - Lint/BlockAlignment
+      - Layout/BlockAlignment
+      - Lint/EndAlignment
+      - Layout/EndAlignment
+      - Lint/DefEndAlignment
+      - Layout/DefEndAlignment
+    parameters: AlignWith
+    alternative: EnforcedStyleAlignWith
+  - cops: Rails/UniqBeforePluck
+    parameters: EnforcedMode
+    alternative: EnforcedStyle
+  - cops: Style/MethodCallWithArgsParentheses
+    parameters: IgnoredMethodPatterns
+    alternative: AllowedPatterns
+  - cops:
+      - Performance/Count
+      - Performance/Detect
+    parameters: SafeMode
+    reason: "`SafeMode` has been removed. Use `SafeAutoCorrect` instead."
+  - cops: Bundler/GemComment
+    parameters: Whitelist
+    alternative: IgnoredGems
+  - cops:
+      - Lint/SafeNavigationChain
+      - Lint/SafeNavigationConsistency
+      - Style/NestedParenthesizedCalls
+      - Style/SafeNavigation
+      - Style/TrivialAccessors
+    parameters: Whitelist
+    alternative: AllowedMethods
+  - cops: Style/IpAddresses
+    parameters: Whitelist
+    alternative: AllowedAddresses
+  - cops: Naming/HeredocDelimiterNaming
+    parameters: Blacklist
+    alternative: ForbiddenDelimiters
+  - cops: Naming/PredicateName
+    parameters: NamePrefixBlacklist
+    alternative: ForbiddenPrefixes
+  - cops: Naming/PredicateName
+    parameters: NameWhitelist
+    alternative: AllowedMethods
+  - cops:
+      - Metrics/BlockLength
+      - Metrics/MethodLength
+    parameters: ExcludedMethods
+    alternatives:
+      - AllowedMethods
+      - AllowedPatterns
+    severity: warning
+  - cops: Lint/Debugger
+    parameters: DebuggerReceivers
+    reason: "`DebuggerReceivers` is no longer necessary, method receivers should be specified in `DebuggerMethods` instead."
+    severity: warning
+  - cops:
+      - Layout/IndentationWidth
+      - Layout/LineLength
+      - Lint/UnreachableLoop
+      - Naming/MethodName
+      - Style/MethodCallWithArgsParentheses
+    parameters: IgnoredPatterns
+    alternative: AllowedPatterns
+    severity: warning
+  - cops:
+      - Lint/AmbiguousBlockAssociation
+      - Lint/NumberConversion
+      - Metrics/AbcSize
+      - Metrics/BlockLength
+      - Metrics/CyclomaticComplexity
+      - Metrics/MethodLength
+      - Metrics/PerceivedComplexity
+      - Style/BlockDelimiters
+      - Style/ClassEqualityComparison
+      - Style/FormatStringToken
+      - Style/MethodCallWithArgsParentheses
+      - Style/MethodCallWithoutArgsParentheses
+      - Style/NumericPredicate
+      - Style/SymbolLiteral
+    parameters: IgnoredMethods
+    alternatives:
+      - AllowedMethods
+      - AllowedPatterns
+    severity: warning
+  - cops: Style/ArgumentsForwarding
+    parameters: AllowOnlyRestArgument
+    reason: "`AllowOnlyRestArgument` has no effect with TargetRubyVersion >= 3.2."
+    severity: warning
+    minimum_ruby_version: 3.2
+
+# Enforced styles that have been removed or replaced
+changed_enforced_styles:
+  - cops: Layout/IndentationConsistency
+    parameters: EnforcedStyle
+    value: rails
+    alternative: indented_internal_methods

data/exe/rubocop

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'rubocop/server'
+server_cli = RuboCop::Server::CLI.new
+exit_status = server_cli.run
+exit exit_status if server_cli.exit?
+
+if RuboCop::Server.running?
+  exit_status = RuboCop::Server::ClientCommand::Exec.new.run
+else
+  require 'rubocop'
+
+  cli = RuboCop::CLI.new
+
+  time_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  exit_status = cli.run
+  elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - time_start
+
+  puts "Finished in #{elapsed_time} seconds" if cli.options[:debug] || cli.options[:display_time]
+end
+exit exit_status

data/lib/rubocop/arguments_env.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This is a class that reads optional command line arguments to rubocop from environment variable.
+  # @api private
+  class ArgumentsEnv
+    def self.read_as_arguments
+      if (arguments = ENV.fetch('RUBOCOP_OPTS', '')).empty?
+        []
+      else
+        require 'shellwords'
+
+        Shellwords.split(arguments)
+      end
+    end
+  end
+end

data/lib/rubocop/arguments_file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This is a class that reads optional command line arguments to rubocop from .rubocop file.
+  # @api private
+  class ArgumentsFile
+    def self.read_as_arguments
+      if File.exist?('.rubocop') && !File.directory?('.rubocop')
+        require 'shellwords'
+
+        File.read('.rubocop').shellsplit
+      else
+        []
+      end
+    end
+  end
+end

data/lib/rubocop/ast_aliases.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# These aliases are for compatibility.
+module RuboCop
+  NodePattern = AST::NodePattern
+  ProcessedSource = AST::ProcessedSource
+  Token = AST::Token
+end

data/lib/rubocop/cache_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class represents the cache config of the caching RuboCop runs.
+  # @api private
+  class CacheConfig
+    def self.root_dir
+      root = ENV.fetch('RUBOCOP_CACHE_ROOT', nil)
+      root ||= yield
+      root ||= if ENV.key?('XDG_CACHE_HOME')
+                 # Include user ID in the path to make sure the user has write
+                 # access.
+                 File.join(ENV.fetch('XDG_CACHE_HOME'), Process.uid.to_s)
+               else
+                 # On FreeBSD, the /home path is a symbolic link to /usr/home
+                 # and the $HOME environment variable returns the /home path.
+                 #
+                 # As $HOME is a built-in environment variable, FreeBSD users
+                 # always get a warning message.
+                 #
+                 # To avoid raising warn log messages on FreeBSD, we retrieve
+                 # the real path of the home folder.
+                 File.join(File.realpath(Dir.home), '.cache')
+               end
+
+      File.join(root, 'rubocop_cache')
+    end
+  end
+end

data/lib/rubocop/cached_data.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RuboCop
+  # Converts RuboCop objects to and from the serialization format JSON.
+  # @api private
+  class CachedData
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def from_json(text)
+      deserialize_offenses(JSON.parse(text))
+    end
+
+    def to_json(offenses)
+      JSON.dump(offenses.map { |o| serialize_offense(o) })
+    end
+
+    private
+
+    def serialize_offense(offense)
+      status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
+      {
+        # 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.
+        severity: offense.severity.to_s,
+        location: {
+          begin_pos: offense.location.begin_pos,
+          end_pos: offense.location.end_pos
+        },
+        message:  message(offense),
+        cop_name: offense.cop_name,
+        status:   status || offense.status
+      }
+    end
+
+    def message(offense)
+      # JSON.dump will fail if the offense message contains text which is not
+      # valid UTF-8
+      offense.message.dup.force_encoding(::Encoding::UTF_8).scrub
+    end
+
+    # Restore an offense object loaded from a JSON file.
+    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)
+      end
+    end
+
+    def location_from_source_buffer(offense)
+      begin_pos = offense['location']['begin_pos']
+      end_pos = offense['location']['end_pos']
+      if begin_pos.zero? && end_pos.zero?
+        Cop::Offense::NO_LOCATION
+      else
+        Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
+      end
+    end
+
+    # Delay creation until needed. Some type of offenses will have no buffer associated with them
+    # and be global only. For these, trying to create the buffer will likely fail, for example
+    # because of unknown encoding comments.
+    def source_buffer
+      @source_buffer ||= begin
+        source = File.read(@filename, encoding: Encoding::UTF_8)
+        Parser::Source::Buffer.new(@filename, source: source)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Generate a configuration file acting as a TODO list.
+      # @api private
+      class AutoGenerateConfig < Base
+        self.command_name = :auto_gen_config
+
+        AUTO_GENERATED_FILE = '.rubocop_todo.yml'
+        YAML_OPTIONAL_DOC_START = /\A---(\s+#|\s*\z)/.freeze
+        PLACEHOLDER = '###rubocop:inherit_here'
+
+        PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
+        PHASE_2 = 'Phase 2 of 2: run all cops'
+
+        PHASE_1_OVERRIDDEN = '(skipped because the default Layout/LineLength:Max is overridden)'
+        PHASE_1_DISABLED = '(skipped because Layout/LineLength is disabled)'
+        PHASE_1_SKIPPED_ONLY_COPS =
+          '(skipped because a list of cops is passed to the `--only` flag)'
+        PHASE_1_SKIPPED_ONLY_EXCLUDE =
+          '(skipped because only excludes will be generated due to `--auto-gen-only-exclude` flag)'
+
+        def run
+          add_formatter
+          reset_config_and_auto_gen_file
+          line_length_contents = maybe_run_line_length_cop
+          run_all_cops(line_length_contents)
+        end
+
+        private
+
+        def maybe_run_line_length_cop
+          if only_exclude?
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_EXCLUDE)
+          elsif !line_length_enabled?(@config_store.for_pwd)
+            skip_line_length_cop(PHASE_1_DISABLED)
+          elsif !same_max_line_length?(@config_store.for_pwd, ConfigLoader.default_configuration)
+            skip_line_length_cop(PHASE_1_OVERRIDDEN)
+          elsif options_has_only_flag?
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_COPS)
+          else
+            run_line_length_cop
+          end
+        end
+
+        def skip_line_length_cop(reason)
+          puts Rainbow("#{PHASE_1} #{reason}").yellow
+          ''
+        end
+
+        def line_length_enabled?(config)
+          line_length_cop(config)['Enabled']
+        end
+
+        def same_max_line_length?(config1, config2)
+          max_line_length(config1) == max_line_length(config2)
+        end
+
+        def max_line_length(config)
+          line_length_cop(config)['Max']
+        end
+
+        def line_length_cop(config)
+          config.for_cop('Layout/LineLength')
+        end
+
+        def options_has_only_flag?
+          @options[:only]
+        end
+
+        def only_exclude?
+          @options[:auto_gen_only_exclude]
+        end
+
+        # Do an initial run with only Layout/LineLength so that cops that
+        # depend on Layout/LineLength:Max get the correct value for that
+        # parameter.
+        def run_line_length_cop
+          puts Rainbow(PHASE_1).yellow
+          @options[:only] = ['Layout/LineLength']
+          execute_runner
+          @options.delete(:only)
+          @config_store = ConfigStore.new
+          @config_store.options_config = @options[:config] if @options[:config]
+          # Save the todo configuration of the LineLength cop.
+          File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
+        end
+
+        def run_all_cops(line_length_contents)
+          puts Rainbow(PHASE_2).yellow
+          result = execute_runner
+          # This run was made with the current maximum length allowed, so append
+          # the saved setting for LineLength.
+          File.open(AUTO_GENERATED_FILE, 'a') { |f| f.write(line_length_contents) }
+          result
+        end
+
+        def reset_config_and_auto_gen_file
+          @config_store = ConfigStore.new
+          @config_store.options_config = @options[:config] if @options[:config]
+          File.open(AUTO_GENERATED_FILE, 'w') {} # create or truncate if exists
+          add_inheritance_from_auto_generated_file(@options[:config])
+        end
+
+        def add_formatter
+          @options[:formatters] << [Formatter::DisabledConfigFormatter, AUTO_GENERATED_FILE]
+        end
+
+        def execute_runner
+          Environment.new(@options, @config_store, @paths).run(:execute_runner)
+        end
+
+        def add_inheritance_from_auto_generated_file(config_file)
+          file_string = " #{relative_path_to_todo_from_options_config}"
+
+          config_file ||= ConfigFinder::DOTFILE
+
+          if File.exist?(config_file)
+            files = Array(ConfigLoader.load_yaml_configuration(config_file)['inherit_from'])
+
+            return if files.include?(relative_path_to_todo_from_options_config)
+
+            files.unshift(relative_path_to_todo_from_options_config)
+            file_string = "\n  - #{files.join("\n  - ")}" if files.size > 1
+            rubocop_yml_contents = existing_configuration(config_file)
+          end
+
+          write_config_file(config_file, file_string, rubocop_yml_contents)
+
+          puts "Added inheritance from `#{relative_path_to_todo_from_options_config}` " \
+               "in `#{ConfigFinder::DOTFILE}`."
+        end
+
+        def existing_configuration(config_file)
+          File.read(config_file, encoding: Encoding::UTF_8)
+              .sub(/^inherit_from: *[^\n]+/, PLACEHOLDER)
+              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, PLACEHOLDER)
+        end
+
+        def write_config_file(file_name, file_string, rubocop_yml_contents)
+          lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
+          unless rubocop_yml_contents&.include?(PLACEHOLDER)
+            doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
+            lines.insert(doc_start_index + 1, PLACEHOLDER)
+          end
+          File.write(file_name, lines.join("\n")
+                                     .sub(/#{PLACEHOLDER}\n*/o, "inherit_from:#{file_string}\n\n")
+                                     .sub(/\n\n+\Z/, "\n"))
+        end
+
+        def relative_path_to_todo_from_options_config
+          return AUTO_GENERATED_FILE unless @options[:config]
+
+          base = Pathname.new(Dir.pwd)
+          config_dir = Pathname.new(@options[:config]).realpath.dirname
+
+          # Don't have the path start with `/`
+          return AUTO_GENERATED_FILE if config_dir == base
+
+          "#{base.relative_path_from(config_dir)}/#{AUTO_GENERATED_FILE}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # A subcommand in the CLI.
+      # @api private
+      class Base
+        attr_reader :env
+
+        @subclasses = []
+
+        class << self
+          attr_accessor :command_name
+
+          def inherited(subclass)
+            super
+            @subclasses << subclass
+          end
+
+          def by_command_name(name)
+            @subclasses.detect { |s| s.command_name == name }
+          end
+        end
+
+        def initialize(env)
+          @env = env
+          @options = env.options
+          @config_store = env.config_store
+          @paths = env.paths
+        end
+      end
+    end
+  end
+end