rubocop 0.81.0 → 0.85.1

data/lib/rubocop/cop/util.rb

@@ -17,6 +17,10 @@ module RuboCop
         line_source =~ /^\s*#/
       end
 
+      def comment_lines?(node)
+        processed_source[line_range(node)].any? { |line| comment_line?(line) }
+      end
+
       def line_range(node)
         node.first_line..node.last_line
       end
@@ -26,6 +30,26 @@ module RuboCop
           node.loc.end.is?(')')
       end
 
+      def add_parentheses(node, corrector)
+        if node.arguments.empty?
+          corrector.insert_after(node, '()')
+        else
+          corrector.replace(args_begin(node), '(')
+          corrector.insert_after(args_end(node), ')')
+        end
+      end
+
+      def args_begin(node)
+        loc = node.loc
+        selector =
+          node.super_type? || node.yield_type? ? loc.keyword : loc.selector
+        selector.end.resize(1)
+      end
+
+      def args_end(node)
+        node.loc.expression.end
+      end
+
       def on_node(syms, sexp, excludes = [], &block)
         return to_enum(:on_node, syms, sexp, excludes) unless block_given?
 
@@ -84,7 +108,7 @@ module RuboCop
       end
 
       def trim_string_interporation_escape_character(str)
-        str.gsub(/\\\#{(.*?)\}/) { "\#{#{Regexp.last_match(1)}}" }
+        str.gsub(/\\\#\{(.*?)\}/) { "\#{#{Regexp.last_match(1)}}" }
       end
 
       def interpret_string_escapes(string)

data/lib/rubocop/cop/utils/format_string.rb

@@ -97,6 +97,10 @@ module RuboCop
           @format_sequences ||= parse
         end
 
+        def valid?
+          !mixed_formats?
+        end
+
         def named_interpolation?
           format_sequences.any?(&:name)
         end
@@ -114,6 +118,20 @@ module RuboCop
             )
           end
         end
+
+        def mixed_formats?
+          formats = format_sequences.map do |seq|
+            if seq.name
+              :named
+            elsif seq.max_digit_dollar_num
+              :numbered
+            else
+              :unnumbered
+            end
+          end
+
+          formats.uniq.size > 1
+        end
       end
     end
   end

data/lib/rubocop/cop/variable_force.rb

@@ -152,9 +152,7 @@ module RuboCop
       def process_variable_assignment(node)
         name = node.children.first
 
-        unless variable_table.variable_exist?(name)
-          variable_table.declare_variable(name, node)
-        end
+        variable_table.declare_variable(name, node) unless variable_table.variable_exist?(name)
 
         # Need to scan rhs before assignment so that we can mark previous
         # assignments as referenced if rhs has referencing to the variable
@@ -211,9 +209,7 @@ module RuboCop
 
         name = asgn_node.children.first
 
-        unless variable_table.variable_exist?(name)
-          variable_table.declare_variable(name, asgn_node)
-        end
+        variable_table.declare_variable(name, asgn_node) unless variable_table.variable_exist?(name)
 
         # The following statements:
         #
@@ -369,9 +365,7 @@ module RuboCop
           AssignmentReference.new(node)
         when *OPERATOR_ASSIGNMENT_TYPES
           asgn_node = node.children.first
-          if asgn_node.lvasgn_type?
-            VariableReference.new(asgn_node.children.first)
-          end
+          VariableReference.new(asgn_node.children.first) if asgn_node.lvasgn_type?
         end
       end
 

data/lib/rubocop/cop/variable_force/assignment.rb

@@ -10,6 +10,7 @@ module RuboCop
         MULTIPLE_LEFT_HAND_SIDE_TYPE = :mlhs
 
         attr_reader :node, :variable, :referenced, :references
+
         alias referenced? referenced
 
         def initialize(node, variable)

data/lib/rubocop/cop/variable_force/branch.rb

@@ -81,9 +81,7 @@ module RuboCop
           end
 
           def each_ancestor(include_self: false, &block)
-            unless block_given?
-              return to_enum(__method__, include_self: include_self)
-            end
+            return to_enum(__method__, include_self: include_self) unless block_given?
 
             yield self if include_self
             scan_ancestors(&block)

data/lib/rubocop/cop/variable_force/scope.rb

@@ -16,6 +16,7 @@ module RuboCop
         }.freeze
 
         attr_reader :node, :variables, :naked_top_level
+
         alias naked_top_level? naked_top_level
 
         def initialize(node)

data/lib/rubocop/cop/variable_force/variable.rb

@@ -11,6 +11,7 @@ module RuboCop
 
         attr_reader :name, :declaration_node, :scope,
                     :assignments, :references, :captured_by_block
+
         alias captured_by_block? captured_by_block
 
         def initialize(name, declaration_node, scope)
@@ -46,9 +47,7 @@ module RuboCop
           @assignments.reverse_each do |assignment|
             next if consumed_branches.include?(assignment.branch)
 
-            unless assignment.run_exclusively_with?(reference)
-              assignment.reference!(node)
-            end
+            assignment.reference!(node) unless assignment.run_exclusively_with?(reference)
 
             # Modifier if/unless conditions are special. Assignments made in
             # them do not put the assigned variable in scope to the left of the
@@ -59,9 +58,7 @@ module RuboCop
 
             break if !assignment.branch || assignment.branch == reference.branch
 
-            unless assignment.branch.may_run_incompletely?
-              consumed_branches << assignment.branch
-            end
+            consumed_branches << assignment.branch unless assignment.branch.may_run_incompletely?
           end
         end
         # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity

data/lib/rubocop/ext/processed_source.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to AST::ProcessedSource for our cached comment_config
+    module ProcessedSource
+      def comment_config
+        @comment_config ||= CommentConfig.new(self)
+      end
+
+      def disabled_line_ranges
+        comment_config.cop_disabled_line_ranges
+      end
+    end
+  end
+end
+
+RuboCop::ProcessedSource.include RuboCop::Ext::ProcessedSource

data/lib/rubocop/formatter/base_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Layout/LineLength
-
 module RuboCop
   module Formatter
     # Abstract base class for formatter, implements all public API methods.
@@ -41,8 +39,6 @@ module RuboCop
     # * `#finished`
     #
     class BaseFormatter
-      # rubocop:enable Layout/LineLength
-
       # @api public
       #
       # @!attribute [r] output

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -59,9 +59,7 @@ module RuboCop
       def command
         command = 'rubocop --auto-gen-config'
 
-        if @options[:auto_gen_only_exclude]
-          command += ' --auto-gen-only-exclude'
-        end
+        command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
         if @exclude_limit_option
           command +=
@@ -70,9 +68,7 @@ module RuboCop
         end
         command += ' --no-offense-counts' if @options[:no_offense_counts]
 
-        if @options[:no_auto_gen_timestamp]
-          command += ' --no-auto-gen-timestamp'
-        end
+        command += ' --no-auto-gen-timestamp' if @options[:no_auto_gen_timestamp]
 
         command
       end
@@ -116,14 +112,10 @@ module RuboCop
       end
 
       def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
-        if @show_offense_counts
-          output_buffer.puts "# Offense count: #{offense_count}"
-        end
+        output_buffer.puts "# Offense count: #{offense_count}" if @show_offense_counts
 
         cop_class = Cop::Cop.registry.find_by_cop_name(cop_name)
-        if cop_class&.new&.support_autocorrect?
-          output_buffer.puts '# Cop supports --auto-correct.'
-        end
+        output_buffer.puts '# Cop supports --auto-correct.' if cop_class&.new&.support_autocorrect?
 
         default_cfg = default_config(cop_name)
         return unless default_cfg

data/lib/rubocop/formatter/formatter_set.rb

@@ -11,7 +11,6 @@ module RuboCop
       BUILTIN_FORMATTERS_FOR_KEYS = {
         '[a]utogenconf' => AutoGenConfigFormatter,
         '[c]lang'       => ClangStyleFormatter,
-        '[d]isabled'    => DisabledLinesFormatter,
         '[e]macs'       => EmacsStyleFormatter,
         '[fi]les'       => FileListFormatter,
         '[fu]ubar'      => FuubarStyleFormatter,
@@ -88,9 +87,7 @@ module RuboCop
 
         raise %(No formatter for "#{specified_key}") if matching_keys.empty?
 
-        if matching_keys.size > 1
-          raise %(Cannot determine formatter for "#{specified_key}")
-        end
+        raise %(Cannot determine formatter for "#{specified_key}") if matching_keys.size > 1
 
         BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first]
       end

data/lib/rubocop/formatter/junit_formatter.rb

@@ -35,19 +35,29 @@ module RuboCop
         #
         # In the future, it would be preferable to return only enabled cops.
         Cop::Cop.all.each do |cop|
+          target_offenses = offenses_for_cop(offenses, cop)
+
+          next unless relevant_for_output?(options, target_offenses)
+
           REXML::Element.new('testcase', @testsuite).tap do |testcase|
             testcase.attributes['classname'] = classname_attribute_value(file)
             testcase.attributes['name'] = cop.cop_name
 
-            target_offenses = offenses.select do |offense|
-              offense.cop_name == cop.cop_name
-            end
-
             add_failure_to(testcase, target_offenses, cop.cop_name)
           end
         end
       end
 
+      def relevant_for_output?(options, target_offenses)
+        !options[:display_only_failed] || target_offenses.any?
+      end
+
+      def offenses_for_cop(all_offenses, cop)
+        all_offenses.select do |offense|
+          offense.cop_name == cop.cop_name
+        end
+      end
+
       def classname_attribute_value(file)
         file.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
       end

data/lib/rubocop/formatter/pacman_formatter.rb

@@ -69,7 +69,7 @@ module RuboCop
         regex = /#{Regexp.quote(PACMAN)}|#{Regexp.quote(PACDOT)}/
         @progress_line = @progress_line.sub(regex, character)
         output.printf("%<line>s\r", line: @progress_line)
-        return unless @progress_line[-1] =~ /ᗣ|\./
+        return unless /ᗣ|\./.match?(@progress_line[-1])
 
         @repetitions += 1
         output.puts

data/lib/rubocop/magic_comment.rb

@@ -133,7 +133,7 @@ module RuboCop
     # @see https://www.gnu.org/software/emacs/manual/html_node/emacs/Specify-Coding.html
     # @see https://git.io/vMCXh Emacs handling in Ruby's parse.y
     class EmacsComment < EditorComment
-      FORMAT    = /\-\*\-(.+)\-\*\-/.freeze
+      FORMAT    = /-\*-(.+)-\*-/.freeze
       SEPARATOR = ';'
       OPERATOR  = ':'
 

data/lib/rubocop/name_similarity.rb

@@ -3,19 +3,22 @@
 module RuboCop
   # Common functionality for finding names that are similar to a given name.
   module NameSimilarity
-    MINIMUM_SIMILARITY_TO_SUGGEST = 0.9
+    module_function
 
-    def find_similar_name(target_name, scope)
-      names = collect_variable_like_names(scope)
+    def find_similar_name(target_name, names)
+      similar_names = find_similar_names(target_name, names)
+
+      similar_names.first
+    end
+
+    def find_similar_names(target_name, names)
+      names = names.dup
       names.delete(target_name)
 
-      scores = names.each_with_object({}) do |name, hash|
-        score = StringUtil.similarity(target_name, name)
-        hash[name] = score if score >= MINIMUM_SIMILARITY_TO_SUGGEST
-      end
+      spell_checker = DidYouMean::SpellChecker.new(dictionary: names)
+      similar_names = spell_checker.correct(target_name)
 
-      most_similar_name, _max_score = scores.max_by { |_, score| score }
-      most_similar_name
+      similar_names
     end
   end
 end

data/lib/rubocop/options.rb

@@ -83,6 +83,12 @@ module RuboCop
 
     def add_cop_selection_csv_option(option, opts)
       option(opts, "--#{option} [COP1,COP2,...]") do |list|
+        unless list
+          message = "--#{option} argument should be [COP1,COP2,...]."
+
+          raise OptionArgumentError, message
+        end
+
         @options[:"#{option}"] =
           if list.empty?
             ['']
@@ -97,6 +103,7 @@ module RuboCop
     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)
@@ -136,6 +143,8 @@ module RuboCop
           @options[:output_path] = path
         end
       end
+
+      option(opts, '--display-only-failed')
     end
 
     def add_severity_option(opts)
@@ -154,6 +163,7 @@ module RuboCop
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def add_boolean_flags(opts)
       option(opts, '-F', '--fail-fast')
       option(opts, '-C', '--cache FLAG')
@@ -162,6 +172,8 @@ module RuboCop
       option(opts, '-E', '--extra-details')
       option(opts, '-S', '--display-style-guide')
       option(opts, '-a', '--auto-correct')
+      option(opts, '--disable-pending-cops')
+      option(opts, '--enable-pending-cops')
       option(opts, '--ignore-disable-comments')
 
       option(opts, '--safe')
@@ -172,6 +184,7 @@ module RuboCop
       option(opts, '-V', '--verbose-version')
       option(opts, '-P', '--parallel')
     end
+    # rubocop:enable Metrics/MethodLength
 
     def add_aliases(opts)
       option(opts, '-l', '--lint') do
@@ -237,10 +250,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)
@@ -267,9 +277,7 @@ module RuboCop
         raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot ' \
                                    'be used with --only.'
       end
-      if except_syntax?
-        raise OptionArgumentError, 'Syntax checking cannot be turned off.'
-      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
@@ -280,6 +288,7 @@ module RuboCop
       end
       validate_auto_gen_config
       validate_auto_correct
+      validate_display_only_failed
       validate_parallel
 
       return if incompatible_options.size <= 1
@@ -303,13 +312,20 @@ module RuboCop
       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
@@ -362,7 +378,7 @@ module RuboCop
     end
 
     def validate_exclude_limit_option
-      return if @options[:exclude_limit] =~ /^\d+$/
+      return if /^\d+$/.match?(@options[:exclude_limit])
 
       # Emulate OptionParser's behavior to make failures consistent regardless
       # of option order.
@@ -373,7 +389,6 @@ module RuboCop
   # This module contains help texts for command line options.
   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 = {
@@ -405,6 +420,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',
@@ -423,6 +441,8 @@ module RuboCop
                                          'if no format is specified.'],
       fail_level:                       ['Minimum severity (A/R/C/W/E/F) for exit',
                                          'with error code.'],
+      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'],
@@ -438,7 +458,9 @@ module RuboCop
       debug:                            'Display debug info.',
       display_cop_names:                ['Display cop names in offense messages.',
                                          'Default is true.'],
+      disable_pending_cops:             'Run without pending cops.',
       display_style_guide:              'Display style guide URLs in offense messages.',
+      enable_pending_cops:              'Run with pending cops.',
       extra_details:                    'Display extra details in offense messages.',
       lint:                             'Run only lint cops.',
       safe:                             'Run only safe cops.',
@@ -455,6 +477,5 @@ module RuboCop
                                          'reports. This is useful for editor integration.'],
       init:                             'Generate a .rubocop.yml file in the current directory.'
     }.freeze
-    # rubocop:enable Layout/LineLength
   end
 end