rubocop 0.82.0 → 1.18.4

data/lib/rubocop/name_similarity.rb

@@ -2,20 +2,28 @@
 
 module RuboCop
   # Common functionality for finding names that are similar to a given name.
+  # @api private
   module NameSimilarity
-    MINIMUM_SIMILARITY_TO_SUGGEST = 0.9
+    module_function
 
-    def find_similar_name(target_name, scope)
-      names = collect_variable_like_names(scope)
-      names.delete(target_name)
+    def find_similar_name(target_name, names)
+      similar_names = find_similar_names(target_name, names)
+
+      similar_names.first
+    end
 
-      scores = names.each_with_object({}) do |name, hash|
-        score = StringUtil.similarity(target_name, name)
-        hash[name] = score if score >= MINIMUM_SIMILARITY_TO_SUGGEST
-      end
+    def find_similar_names(target_name, names)
+      # DidYouMean::SpellChecker is not available in all versions of Ruby, and
+      # even on versions where it *is* available (>= 2.3), it is not always
+      # required correctly. So we do a feature check first.
+      # See: https://github.com/rubocop/rubocop/issues/7979
+      return [] unless defined?(DidYouMean::SpellChecker)
+
+      names = names.dup
+      names.delete(target_name)
 
-      most_similar_name, _max_score = scores.max_by { |_, score| score }
-      most_similar_name
+      spell_checker = DidYouMean::SpellChecker.new(dictionary: names)
+      spell_checker.correct(target_name)
     end
   end
 end

data/lib/rubocop/options.rb

@@ -5,14 +5,16 @@ require 'shellwords'
 
 module RuboCop
   class IncorrectCopNameError < StandardError; end
+
   class OptionArgumentError < StandardError; end
 
   # This class handles command line options.
+  # @api private
   class Options
     E_STDIN_NO_PATH = '-s/--stdin requires exactly one path, relative to the ' \
-      'root of the project. RuboCop will use this path to determine which ' \
-      'cops are enabled (via eg. Include/Exclude), and so that certain cops ' \
-      'like Naming/FileName can be checked.'
+                      'root of the project. RuboCop will use this path to determine which ' \
+                      'cops are enabled (via eg. Include/Exclude), and so that certain cops ' \
+                      'like Naming/FileName can be checked.'
     EXITING_OPTIONS = %i[version verbose_version show_cops].freeze
     DEFAULT_MAXIMUM_EXCLUSION_ITEMS = 15
 
@@ -64,10 +66,11 @@ module RuboCop
         add_configuration_options(opts)
         add_formatting_options(opts)
 
-        option(opts, '-r', '--require FILE') { |f| require f }
+        option(opts, '-r', '--require FILE') { |f| require_feature(f) }
 
         add_severity_option(opts)
         add_flags_with_optional_args(opts)
+        add_cache_options(opts)
         add_boolean_flags(opts)
         add_aliases(opts)
 
@@ -83,20 +86,20 @@ module RuboCop
 
     def add_cop_selection_csv_option(option, opts)
       option(opts, "--#{option} [COP1,COP2,...]") do |list|
-        @options[:"#{option}"] =
-          if list.empty?
-            ['']
-          else
-            list.split(',').map do |c|
-              Cop::Cop.qualified_cop_name(c, "--#{option} option")
-            end
-          end
+        unless list
+          message = "--#{option} argument should be [COP1,COP2,...]."
+
+          raise OptionArgumentError, message
+        end
+
+        @options[:"#{option}"] = list.empty? ? [''] : list.split(',')
       end
     end
 
     def add_configuration_options(opts)
       option(opts, '-c', '--config FILE')
       option(opts, '--force-exclusion')
+      option(opts, '--only-recognized-file-types')
       option(opts, '--ignore-parent-exclusion')
       option(opts, '--force-default-config')
       add_auto_gen_options(opts)
@@ -105,20 +108,17 @@ module RuboCop
     def add_auto_gen_options(opts)
       option(opts, '--auto-gen-config')
 
-      option(opts, '--exclude-limit COUNT') do
-        @validator.validate_exclude_limit_option
+      option(opts, '--regenerate-todo') do
+        @options.replace(ConfigRegeneration.new.options.merge(@options))
       end
 
-      option(opts, '--disable-uncorrectable')
+      option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
 
-      option(opts, '--no-offense-counts') do
-        @options[:no_offense_counts] = true
-      end
+      option(opts, '--disable-uncorrectable')
 
-      option(opts, '--auto-gen-only-exclude')
-      option(opts, '--no-auto-gen-timestamp') do
-        @options[:no_auto_gen_timestamp] = true
-      end
+      option(opts, '--[no-]offense-counts')
+      option(opts, '--[no-]auto-gen-only-exclude')
+      option(opts, '--[no-]auto-gen-timestamp')
 
       option(opts, '--init')
     end
@@ -136,6 +136,9 @@ module RuboCop
           @options[:output_path] = path
         end
       end
+
+      option(opts, '--display-time')
+      option(opts, '--display-only-failed')
     end
 
     def add_severity_option(opts)
@@ -154,28 +157,38 @@ module RuboCop
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    def add_cache_options(opts)
+      option(opts, '-C', '--cache FLAG')
+      option(opts, '--cache-root DIR') { @validator.validate_cache_enabled_for_cache_root }
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def add_boolean_flags(opts)
       option(opts, '-F', '--fail-fast')
-      option(opts, '-C', '--cache FLAG')
       option(opts, '-d', '--debug')
       option(opts, '-D', '--[no-]display-cop-names')
       option(opts, '-E', '--extra-details')
       option(opts, '-S', '--display-style-guide')
-      option(opts, '-a', '--auto-correct')
+      option(opts, '-a', '--auto-correct') { @options[:safe_auto_correct] = true }
+      option(opts, '--safe-auto-correct') do
+        warn '--safe-auto-correct is deprecated; use --auto-correct'
+        @options[:safe_auto_correct] = @options[:auto_correct] = true
+      end
+      option(opts, '-A', '--auto-correct-all') { @options[:auto_correct] = true }
       option(opts, '--disable-pending-cops')
       option(opts, '--enable-pending-cops')
       option(opts, '--ignore-disable-comments')
 
       option(opts, '--safe')
 
+      option(opts, '--stderr')
       option(opts, '--[no-]color')
 
       option(opts, '-v', '--version')
       option(opts, '-V', '--verbose-version')
-      option(opts, '-P', '--parallel')
+      option(opts, '-P', '--[no-]parallel')
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def add_aliases(opts)
       option(opts, '-l', '--lint') do
@@ -187,9 +200,6 @@ module RuboCop
         @options[:only] << 'Layout'
         @options[:auto_correct] = true
       end
-      option(opts, '--safe-auto-correct') do
-        @options[:auto_correct] = true
-      end
     end
 
     def add_list_options(opts)
@@ -211,26 +221,36 @@ module RuboCop
     # e.g. [..., '--auto-correct', ...] to :auto_correct.
     def long_opt_symbol(args)
       long_opt = args.find { |arg| arg.start_with?('--') }
-      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '')
-                     .tr('-', '_').gsub(/[\[\]]/, '').to_sym
+      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
+    end
+
+    def require_feature(file)
+      # If any features were added on the CLI from `--require`,
+      # add them to the config.
+      ConfigLoader.add_loaded_features(file)
+      require file
     end
   end
 
   # Validates option arguments and the options' compatibility with each other.
+  # @api private
   class OptionsValidator
     class << self
+      SYNTAX_DEPARTMENTS = %w[Syntax Lint/Syntax].freeze
+      private_constant :SYNTAX_DEPARTMENTS
+
       # Cop name validation must be done later than option parsing, so it's not
       # called from within Options.
       def validate_cop_list(names)
         return unless names
 
-        cop_names = Cop::Cop.registry.names
-        departments = Cop::Cop.registry.departments.map(&:to_s)
+        cop_names = Cop::Registry.global.names
+        departments = Cop::Registry.global.departments.map(&:to_s)
 
         names.each do |name|
           next if cop_names.include?(name)
           next if departments.include?(name)
-          next if %w[Syntax Lint/Syntax].include?(name)
+          next if SYNTAX_DEPARTMENTS.include?(name)
 
           raise IncorrectCopNameError, format_message_from(name, cop_names)
         end
@@ -241,10 +261,7 @@ module RuboCop
       def format_message_from(name, cop_names)
         message = 'Unrecognized cop or department: %<name>s.'
         message_with_candidate = "%<message>s\nDid you mean? %<candidate>s"
-        corrections = cop_names.select do |cn|
-          score = StringUtil.similarity(cn, name)
-          score >= NameSimilarity::MINIMUM_SIMILARITY_TO_SUGGEST
-        end.sort
+        corrections = NameSimilarity.find_similar_names(name, cop_names)
 
         if corrections.empty?
           format(message, name: name)
@@ -260,36 +277,31 @@ module RuboCop
     end
 
     def validate_cop_options
-      %i[only except].each do |opt|
-        OptionsValidator.validate_cop_list(@options[opt])
-      end
+      %i[only except].each { |opt| OptionsValidator.validate_cop_list(@options[opt]) }
     end
 
     # rubocop:disable Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_redundant_disable?
-        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot ' \
-                                   'be used with --only.'
-      end
-      if except_syntax?
-        raise OptionArgumentError, 'Syntax checking cannot be turned off.'
+        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot be used with --only.'
       end
+      raise OptionArgumentError, 'Syntax checking cannot be turned off.' if except_syntax?
       unless boolean_or_empty_cache?
         raise OptionArgumentError, '-C/--cache argument must be true or false'
       end
 
       if display_only_fail_level_offenses_with_autocorrect?
         raise OptionArgumentError, '--autocorrect cannot be used with ' \
-          '--display-only-fail-level-offenses'
+                                   '--display-only-fail-level-offenses'
       end
       validate_auto_gen_config
       validate_auto_correct
-      validate_parallel
+      validate_display_only_failed
+      disable_parallel_when_invalid_option_combo
 
       return if incompatible_options.size <= 1
 
-      raise OptionArgumentError, 'Incompatible cli options: ' \
-                                 "#{incompatible_options.inspect}"
+      raise OptionArgumentError, "Incompatible cli options: #{incompatible_options.inspect}"
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -298,54 +310,56 @@ module RuboCop
 
       message = '--%<flag>s can only be used together with --auto-gen-config.'
 
-      %i[exclude_limit no_offense_counts no_auto_gen_timestamp
+      %i[exclude_limit offense_counts auto_gen_timestamp
          auto_gen_only_exclude].each do |option|
         if @options.key?(option)
-          raise OptionArgumentError,
-                format(message, flag: option.to_s.tr('_', '-'))
+          raise OptionArgumentError, format(message, flag: option.to_s.tr('_', '-'))
         end
       end
     end
 
+    def validate_display_only_failed
+      return unless @options.key?(:display_only_failed)
+      return if @options[:format] == 'junit'
+
+      raise OptionArgumentError,
+            format('--display-only-failed can only be used together with --format junit.')
+    end
+
     def validate_auto_correct
       return if @options.key?(:auto_correct)
       return unless @options.key?(:disable_uncorrectable)
 
       raise OptionArgumentError,
-            format('--%<flag>s can only be used together with --auto-correct.',
-                   flag: '--disable-uncorrectable')
+            format('--disable-uncorrectable can only be used together with --auto-correct.')
     end
 
-    def validate_parallel
+    def disable_parallel_when_invalid_option_combo
       return unless @options.key?(:parallel)
 
-      if @options[:cache] == 'false'
-        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
-                                   'execution, so combining with --cache ' \
-                                   'false is not allowed.'
+      invalid_options = [
+        { name: :auto_gen_config, value: true, flag: '--auto-gen-config' },
+        { name: :fail_fast, value: true, flag: '-F/--fail-fast.' },
+        { name: :auto_correct, value: true, flag: '--auto-correct.' },
+        { name: :cache, value: 'false', flag: '--cache false' }
+      ]
+
+      invalid_flags = invalid_options.each_with_object([]) do |option, flags|
+        # `>` rather than `>=` because `@options` will also contain `parallel: true`
+        flags << option[:flag] if @options > { option[:name] => option[:value] }
       end
 
-      validate_parallel_with_combo_option
-    end
+      return if invalid_flags.empty?
 
-    def validate_parallel_with_combo_option
-      combos = {
-        auto_gen_config: '-P/--parallel uses caching to speed up execution, ' \
-                         'while --auto-gen-config needs a non-cached run, ' \
-                         'so they cannot be combined.',
-        fail_fast: '-P/--parallel cannot be combined with -F/--fail-fast.',
-        auto_correct: '-P/--parallel cannot be combined with --auto-correct.'
-      }
+      @options.delete(:parallel)
 
-      combos.each do |key, msg|
-        raise OptionArgumentError, msg if @options.key?(key)
-      end
+      puts '-P/--parallel is being ignored because ' \
+           "it is not compatible with #{invalid_flags.join(', ')}"
     end
 
     def only_includes_redundant_disable?
       @options.key?(:only) &&
-        (@options[:only] & %w[Lint/RedundantCopDisableDirective
-                              RedundantCopDisableDirective]).any?
+        (@options[:only] & %w[Lint/RedundantCopDisableDirective RedundantCopDisableDirective]).any?
     end
 
     def display_only_fail_level_offenses_with_autocorrect?
@@ -353,8 +367,7 @@ module RuboCop
     end
 
     def except_syntax?
-      @options.key?(:except) &&
-        (@options[:except] & %w[Lint/Syntax Syntax]).any?
+      @options.key?(:except) && (@options[:except] & %w[Lint/Syntax Syntax]).any?
     end
 
     def boolean_or_empty_cache?
@@ -372,12 +385,18 @@ module RuboCop
       # of option order.
       raise OptionParser::MissingArgument
     end
+
+    def validate_cache_enabled_for_cache_root
+      return unless @options[:cache] == 'false'
+
+      raise OptionArgumentError, '--cache-root can not be used with --cache false'
+    end
   end
 
   # This module contains help texts for command line options.
+  # @api private
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
-    # rubocop:disable Layout/LineLength
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
 
     TEXT = {
@@ -389,17 +408,20 @@ module RuboCop
       config:                           'Specify configuration file.',
       auto_gen_config:                  ['Generate a configuration file acting as a',
                                          'TODO list.'],
-      no_offense_counts:                ['Do not include offense counts in configuration',
-                                         'file generated by --auto-gen-config.'],
-      no_auto_gen_timestamp:
-                                        ['Do not include the date and time when',
-                                         'the --auto-gen-config was run in the file it',
-                                         'generates.'],
+      regenerate_todo:                  ['Regenerate the TODO configuration file using',
+                                         'the last configuration. If there is no existing',
+                                         'TODO file, acts like --auto-gen-config.'],
+      offense_counts:                   ['Include offense counts in configuration',
+                                         'file generated by --auto-gen-config.',
+                                         'Default is true.'],
+      auto_gen_timestamp:
+                                        ['Include the date and time when the --auto-gen-config',
+                                         'was run in the file it generates. Default is true.'],
       auto_gen_only_exclude:
                                         ['Generate only Exclude parameters and not Max',
                                          'when running --auto-gen-config, except if the',
                                          'number of files with offenses is bigger than',
-                                         'exclude-limit.'],
+                                         'exclude-limit. Default is false.'],
       exclude_limit:                    ['Used together with --auto-gen-config to',
                                          'set the limit for how many Exclude',
                                          "properties to generate. Default is #{MAX_EXCL}."],
@@ -409,6 +431,9 @@ module RuboCop
       force_exclusion:                  ['Force excluding files specified in the',
                                          'configuration `Exclude` even if they are',
                                          'explicitly passed as arguments.'],
+      only_recognized_file_types:       ['Inspect files given on the command line only if',
+                                         'they are listed in AllCops/Include parameters',
+                                         'of user configuration or default configuration.'],
       ignore_disable_comments:          ['Run cops even when they are disabled locally',
                                          'with a comment.'],
       ignore_parent_exclusion:          ['Prevent from inheriting AllCops/Exclude from',
@@ -425,8 +450,11 @@ module RuboCop
                                          'This option applies to the previously',
                                          'specified --format, or the default format',
                                          'if no format is specified.'],
-      fail_level:                       ['Minimum severity (A/R/C/W/E/F) for exit',
+      fail_level:                       ['Minimum severity (A/I/R/C/W/E/F) for exit',
                                          'with error code.'],
+      display_time:                     'Display elapsed time in seconds.',
+      display_only_failed:              ['Only output offense messages. Omit passing',
+                                         'cops. Only valid for --format junit.'],
       display_only_fail_level_offenses:
                                         ['Only output offense messages at',
                                          'the specified --fail-level or above'],
@@ -439,6 +467,10 @@ module RuboCop
       cache:                            ["Use result caching (FLAG=true) or don't",
                                          '(FLAG=false), default determined by',
                                          'configuration parameter AllCops: UseCache.'],
+      cache_root:                       ['Set the cache root directory.',
+                                         'Takes precedence over the configuration',
+                                         'parameter AllCops: CacheRootDirectory and',
+                                         'the $RUBOCOP_CACHE_ROOT environment variable.'],
       debug:                            'Display debug info.',
       display_cop_names:                ['Display cop names in offense messages.',
                                          'Default is true.'],
@@ -448,19 +480,22 @@ module RuboCop
       extra_details:                    'Display extra details in offense messages.',
       lint:                             'Run only lint cops.',
       safe:                             'Run only safe cops.',
+      stderr:                           ['Write all output to stderr except for the',
+                                         'autocorrected source. This is especially useful',
+                                         'when combined with --auto-correct and --stdin.'],
       list_target_files:                'List all files RuboCop will inspect.',
-      auto_correct:                     'Auto-correct offenses.',
-      safe_auto_correct:                'Run auto-correct only when it\'s safe.',
+      auto_correct:                     'Auto-correct offenses (only when it\'s safe).',
+      safe_auto_correct:                '(same, deprecated)',
+      auto_correct_all:                 'Auto-correct offenses (safe and unsafe)',
       fix_layout:                       'Run only layout cops, with auto-correct on.',
       color:                            'Force color output on or off.',
       version:                          'Display version.',
       verbose_version:                  'Display verbose version.',
       parallel:                         ['Use available CPUs to execute inspection in',
-                                         'parallel.'],
+                                         'parallel. Default is false.'],
       stdin:                            ['Pipe source from STDIN, using FILE in offense',
                                          'reports. This is useful for editor integration.'],
       init:                             'Generate a .rubocop.yml file in the current directory.'
     }.freeze
-    # rubocop:enable Layout/LineLength
   end
 end