rubocop 0.78.0 → 1.13.0

data/lib/rubocop/core_ext/string.rb

@@ -2,7 +2,7 @@
 
 # Extensions to the core String class
 class String
-  unless method_defined? :blank?
+  unless method_defined?(:blank?) && ' '.blank?
     # Checks whether a string is blank. A string is considered blank if it
     # is either empty or contains only whitespace characters.
     #
@@ -17,7 +17,7 @@ class String
     # @example
     #   '  test'.blank? #=> false
     def blank?
-      empty? || strip.empty?
+      empty? || lstrip.empty?
     end
   end
 end

data/lib/rubocop/directive_comment.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class wraps the `Parser::Source::Comment` object that represents a
+  # special `rubocop:disable` and `rubocop:enable` comment and exposes what
+  # cops it contains.
+  class DirectiveComment
+    # @api private
+    REDUNDANT_COP = 'Lint/RedundantCopDisableDirective'
+    # @api private
+    COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
+    # @api private
+    COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
+    # @api private
+    COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
+    # @api private
+    DIRECTIVE_COMMENT_REGEXP = Regexp.new(
+      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
+        .gsub(' ', '\s*')
+    )
+
+    def self.before_comment(line)
+      line.split(DIRECTIVE_COMMENT_REGEXP).first
+    end
+
+    attr_reader :comment, :mode, :cops
+
+    def initialize(comment)
+      @comment = comment
+      @mode, @cops = match_captures
+    end
+
+    # Checks if this directive relates to single line
+    def single_line?
+      !self.class.before_comment(comment.text).empty?
+    end
+
+    # Checks if this directive contains all the given cop names
+    def match?(cop_names)
+      parsed_cop_names.uniq.sort == cop_names.uniq.sort
+    end
+
+    def range
+      comment.location.expression
+    end
+
+    # Returns match captures to directive comment pattern
+    def match_captures
+      @match_captures ||= comment.text.match(DIRECTIVE_COMMENT_REGEXP)&.captures
+    end
+
+    # Checks if this directive disables cops
+    def disabled?
+      %w[disable todo].include?(mode)
+    end
+
+    # Checks if this directive enables cops
+    def enabled?
+      mode == 'enable'
+    end
+
+    # Checks if this directive enables all cops
+    def enabled_all?
+      !disabled? && all_cops?
+    end
+
+    # Checks if all cops specified in this directive
+    def all_cops?
+      cops == 'all'
+    end
+
+    # Returns array of specified in this directive cop names
+    def cop_names
+      @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
+    end
+
+    # Returns line number for directive
+    def line_number
+      comment.loc.expression.line
+    end
+
+    private
+
+    def parsed_cop_names
+      (cops || '').split(/,\s*/)
+    end
+
+    def all_cop_names
+      Cop::Registry.global.names - [REDUNDANT_COP]
+    end
+  end
+end

data/lib/rubocop/error.rb

@@ -12,6 +12,7 @@ module RuboCop
   # A wrapper to display errored location of analyzed file.
   class ErrorWithAnalyzedFileLocation < Error
     def initialize(cause:, node:, cop:)
+      super()
       @cause = cause
       @cop = cop
       @location = node.is_a?(RuboCop::AST::Node) ? node.loc : node

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/ext/regexp_node.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to AST::RegexpNode for our cached parsed regexp info
+    module RegexpNode
+      ANY = Object.new
+      def ANY.==(_)
+        true
+      end
+      private_constant :ANY
+
+      # @return [Regexp::Expression::Root, nil]
+      # Note: we extend Regexp nodes to provide `loc` and `expression`
+      # see `ext/regexp_parser`.
+      attr_reader :parsed_tree
+
+      if Gem::Version.new(Regexp::Parser::VERSION) >= Gem::Version.new('2.0')
+        def assign_properties(*)
+          super
+
+          str = with_interpolations_blanked
+          @parsed_tree = begin
+            Regexp::Parser.parse(str, options: options)
+          rescue StandardError
+            nil
+          end
+          origin = loc.begin.end
+          @parsed_tree&.each_expression(true) { |e| e.origin = origin }
+        end
+      # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
+      # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+      else
+        def assign_properties(*)
+          super
+
+          str = with_interpolations_blanked
+          begin
+            @parsed_tree = Regexp::Parser.parse(str, options: options)
+          rescue StandardError
+            @parsed_tree = nil
+          else
+            origin = loc.begin.end
+            source = @parsed_tree.to_s
+            @parsed_tree.each_expression(true) do |e|
+              e.origin = origin
+              e.source = source
+            end
+          end
+        end
+      end
+
+      def each_capture(named: ANY)
+        return enum_for(__method__, named: named) unless block_given?
+
+        parsed_tree&.traverse do |event, exp, _index|
+          yield(exp) if event == :enter &&
+                        named == exp.respond_to?(:name) &&
+                        exp.respond_to?(:capturing?) &&
+                        exp.capturing?
+        end
+
+        self
+      end
+
+      private
+
+      def with_interpolations_blanked
+        # Ignore the trailing regopt node
+        children[0...-1].map do |child|
+          source = child.source
+
+          # We don't want to consider the contents of interpolations as part of the pattern source,
+          # but need to preserve their width, to allow offsets to correctly line up with the
+          # original source: spaces have no effect, and preserve width.
+          if child.begin_type?
+            ' ' * source.length
+          else
+            source
+          end
+        end.join
+      end
+
+      AST::RegexpNode.include self
+    end
+  end
+end

data/lib/rubocop/ext/regexp_parser.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions for `regexp_parser` gem
+    module RegexpParser
+      # Source map for RegexpParser nodes
+      class Map < ::Parser::Source::Map
+        attr_reader :body, :quantifier, :begin, :end
+
+        def initialize(expression, body:, quantifier: nil, begin_l: nil, end_l: nil)
+          @begin = begin_l
+          @end = end_l
+          @body = body
+          @quantifier = quantifier
+          super(expression)
+        end
+      end
+
+      module Expression
+        # Add `expression` and `loc` to all `regexp_parser` nodes
+        module Base
+          attr_accessor :origin
+
+          if Gem::Version.new(Regexp::Parser::VERSION) >= Gem::Version.new('2.0')
+            # Shortcut to `loc.expression`
+            def expression
+              @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
+            end
+          # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
+          # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+          else
+            attr_accessor :source
+
+            def start_index
+              # ts is a byte index; convert it to a character index
+              @start_index ||= source.byteslice(0, ts).length
+            end
+
+            # Shortcut to `loc.expression`
+            def expression
+              end_pos = start_index + full_length
+              @expression ||= origin.adjust(begin_pos: start_index, end_pos: end_pos)
+            end
+          end
+
+          # @returns a location map like `parser` does, with:
+          #   - expression: complete expression
+          #   - quantifier: for `+`, `{1,2}`, etc.
+          #   - begin/end: for `[` and `]` (only CharacterSet for now)
+          #
+          # E.g.
+          #     [a-z]{2,}
+          #     ^^^^^^^^^ expression
+          #          ^^^^ quantifier
+          #     ^^^^^     body
+          #     ^         begin
+          #         ^     end
+          #
+          # Please open issue if you need other locations
+          def loc
+            @loc ||= Map.new(expression, **build_location)
+          end
+
+          private
+
+          def build_location
+            return { body: expression } unless (q = quantifier)
+
+            body = expression.adjust(end_pos: -q.text.length)
+            q_loc = expression.with(begin_pos: body.end_pos)
+            { body: body, quantifier: q_loc }
+          end
+        end
+
+        # Provide `CharacterSet` with `begin` and `end` locations.
+        module CharacterSet
+          def build_location
+            h = super
+            body = h[:body]
+            h.merge!(
+              begin_l: body.with(end_pos: body.begin_pos + 1),
+              end_l: body.with(begin_pos: body.end_pos - 1)
+            )
+          end
+        end
+      end
+      ::Regexp::Expression::Base.include Expression::Base
+      ::Regexp::Expression::CharacterSet.include Expression::CharacterSet
+    end
+  end
+end

data/lib/rubocop/file_finder.rb

@@ -4,38 +4,37 @@ require 'pathname'
 
 module RuboCop
   # Common methods for finding files.
+  # @api private
   module FileFinder
     def self.root_level=(level)
       @root_level = level
     end
 
-    def self.root_level?(path)
-      @root_level == path.to_s
+    def self.root_level?(path, stop_dir)
+      (@root_level || stop_dir) == path.to_s
     end
 
-    def find_file_upwards(filename, start_dir)
-      traverse_files_upwards(filename, start_dir) do |file|
+    def find_file_upwards(filename, start_dir, stop_dir = nil)
+      traverse_files_upwards(filename, start_dir, stop_dir) do |file|
         # minimize iteration for performance
         return file if file
       end
     end
 
-    def find_files_upwards(filename, start_dir)
-      files = []
-      traverse_files_upwards(filename, start_dir) do |file|
-        files << file
-      end
-      files
+    def find_last_file_upwards(filename, start_dir, stop_dir = nil)
+      last_file = nil
+      traverse_files_upwards(filename, start_dir, stop_dir) { |file| last_file = file }
+      last_file
     end
 
     private
 
-    def traverse_files_upwards(filename, start_dir)
+    def traverse_files_upwards(filename, start_dir, stop_dir)
       Pathname.new(start_dir).expand_path.ascend do |dir|
-        break if FileFinder.root_level?(dir)
-
         file = dir + filename
         yield(file.to_s) if file.exist?
+
+        break if FileFinder.root_level?(dir, stop_dir)
       end
     end
   end

data/lib/rubocop/formatter/auto_gen_config_formatter.rb

@@ -9,7 +9,8 @@ module RuboCop
 
         report_summary(inspected_files.size,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
     end
   end

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/clang_style_formatter.rb

@@ -29,7 +29,7 @@ module RuboCop
 
           report_line(offense.location)
           report_highlighted_area(offense.highlighted_area)
-        rescue IndexError # rubocop:disable Lint/SuppressedException
+        rescue IndexError
           # range is not on a valid line; perhaps the source file is empty
         end
       end
@@ -49,8 +49,10 @@ module RuboCop
       end
 
       def report_highlighted_area(highlighted_area)
-        output.puts("#{' ' * highlighted_area.begin_pos}" \
-                    "#{'^' * highlighted_area.size}")
+        space_area  = highlighted_area.source_buffer.slice(0...highlighted_area.begin_pos)
+        source_area = highlighted_area.source
+        output.puts("#{' ' * Unicode::DisplayWidth.of(space_area)}" \
+                    "#{'^' * Unicode::DisplayWidth.of(source_area)}")
       end
     end
   end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -5,6 +5,8 @@ module RuboCop
     # This formatter displays a YAML configuration file where all cops that
     # detected any offenses are configured to not detect the offense.
     class DisabledConfigFormatter < BaseFormatter
+      include PathUtil
+
       HEADING = <<~COMMENTS
         # This configuration was generated by
         # `%<command>s`
@@ -32,7 +34,6 @@ module RuboCop
         @exclude_limit_option = @options[:exclude_limit]
         @exclude_limit = Integer(@exclude_limit_option ||
           RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS)
-        @show_offense_counts = !@options[:no_offense_counts]
       end
 
       def file_finished(file, offenses)
@@ -56,29 +57,31 @@ module RuboCop
 
       private
 
+      def show_timestamp?
+        @options.fetch(:auto_gen_timestamp, true)
+      end
+
+      def show_offense_counts?
+        @options.fetch(:offense_counts, true)
+      end
+
       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 +=
-            format(' --exclude-limit %<limit>d',
-                   limit: Integer(@exclude_limit_option))
+          command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
         end
-        command += ' --no-offense-counts' if @options[:no_offense_counts]
+        command += ' --no-offense-counts' unless show_offense_counts?
 
-        if @options[:no_auto_gen_timestamp]
-          command += ' --no-auto-gen-timestamp'
-        end
+        command += ' --no-auto-gen-timestamp' unless show_timestamp?
 
         command
       end
 
       def timestamp
-        @options[:no_auto_gen_timestamp] ? '' : "on #{Time.now} "
+        show_timestamp? ? "on #{Time.now.utc} " : ''
       end
 
       def output_offenses
@@ -106,8 +109,7 @@ module RuboCop
 
         # In case auto_gen_only_exclude is set, only modify the maximum if the
         # files are not excluded one by one.
-        if !@options[:auto_gen_only_exclude] ||
-           @files_with_offenses[cop_name].size > @exclude_limit
+        if !@options[:auto_gen_only_exclude] || @files_with_offenses[cop_name].size > @exclude_limit
           cfg.merge!(cfg[:exclude_limit])
         end
 
@@ -116,14 +118,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
+        cop_class = Cop::Registry.global.find_by_cop_name(cop_name)
+        output_buffer.puts '# Cop supports --auto-correct.' if cop_class&.support_autocorrect?
 
         default_cfg = default_config(cop_name)
         return unless default_cfg
@@ -143,9 +141,7 @@ module RuboCop
 
       def output_cop_param_comments(output_buffer, params, default_cfg)
         config_params = params.reject { |p| p.start_with?('Supported') }
-        output_buffer.puts(
-          "# Configuration parameters: #{config_params.join(', ')}."
-        )
+        output_buffer.puts("# Configuration parameters: #{config_params.join(', ')}.")
 
         params.each do |param|
           value = default_cfg[param]
@@ -196,15 +192,28 @@ module RuboCop
       end
 
       def excludes(offending_files, cop_name, parent)
-        # Exclude properties in .rubocop_todo.yml override default ones, as well
-        # as any custom excludes in .rubocop.yml, so in order to retain those
-        # excludes we must copy them.
-        # There can be multiple .rubocop.yml files in subdirectories, but we
-        # just look at the current working directory
+        # Exclude properties in .rubocop_todo.yml override default ones, as well as any custom
+        # excludes in .rubocop.yml, so in order to retain those excludes we must copy them.
+        # There can be multiple .rubocop.yml files in subdirectories, but we just look at the
+        # current working directory.
         config = ConfigStore.new.for(parent)
         cfg = config[cop_name] || {}
 
-        ((cfg['Exclude'] || []) + offending_files).uniq
+        if merge_mode_for_exclude?(config) || merge_mode_for_exclude?(cfg)
+          offending_files
+        else
+          cop_exclude = cfg['Exclude']
+          if cop_exclude && cop_exclude != default_config(cop_name)['Exclude']
+            warn "`#{cop_name}: Exclude` in `#{smart_path(config.loaded_path)}` overrides a " \
+                 'generated `Exclude` in `.rubocop_todo.yml`. Either remove ' \
+                 "`#{cop_name}: Exclude` or add `inherit_mode: merge: - Exclude`."
+          end
+          ((cop_exclude || []) + offending_files).uniq
+        end
+      end
+
+      def merge_mode_for_exclude?(cfg)
+        Array(cfg.to_h.dig('inherit_mode', 'merge')).include?('Exclude')
       end
 
       def output_exclude_path(output_buffer, exclude_path, parent)