rubocop 1.0.0 → 1.4.0

data/lib/rubocop/cop/team.rb

@@ -99,7 +99,12 @@ module RuboCop
       def self.forces_for(cops)
         needed = Hash.new { |h, k| h[k] = [] }
         cops.each do |cop|
-          Array(cop.class.joining_forces).each { |force| needed[force] << cop }
+          forces = cop.class.joining_forces
+          if forces.is_a?(Array)
+            forces.each { |force| needed[force] << cop }
+          elsif forces
+            needed[forces] << cop
+          end
         end
 
         needed.map do |force_class, joining_cops|

data/lib/rubocop/cop/util.rb

@@ -53,7 +53,7 @@ module RuboCop
       end
 
       def on_node(syms, sexp, excludes = [], &block)
-        return to_enum(:on_node, syms, sexp, excludes) unless block_given?
+        return to_enum(:on_node, syms, sexp, excludes) unless block
 
         yield sexp if Array(syms).include?(sexp.type)
         return if Array(excludes).include?(sexp.type)
@@ -62,7 +62,7 @@ module RuboCop
       end
 
       def begins_its_line?(range)
-        (range.source_line =~ /\S/) == range.column
+        range.source_line.index(/\S/) == range.column
       end
 
       # Returns, for example, a bare `if` node if the given node is an `if`
@@ -123,6 +123,10 @@ module RuboCop
           node1.loc.line == node2.loc.line
       end
 
+      def indent(node)
+        ' ' * node.loc.column
+      end
+
       def to_supported_styles(enforced_style)
         enforced_style
           .sub(/^Enforced/, 'Supported')

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

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

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

@@ -61,7 +61,7 @@ module RuboCop
         end
 
         def each_node(&block)
-          return to_enum(__method__) unless block_given?
+          return to_enum(__method__) unless block
 
           yield node if naked_top_level?
           scan_node(node, &block)

data/lib/rubocop/ext/regexp_node.rb

@@ -10,18 +10,26 @@ module RuboCop
       end
       private_constant :ANY
 
-      class << self
-        attr_reader :parsed_cache
-      end
-      @parsed_cache = {}
-
       # @return [Regexp::Expression::Root, nil]
-      def parsed_tree
+      # Note: we extend Regexp nodes to provide `loc` and `expression`
+      # see `ext/regexp_parser`.
+      attr_reader :parsed_tree
+
+      def assign_properties(*)
+        super
+
         str = with_interpolations_blanked
-        Ext::RegexpNode.parsed_cache[str] ||= begin
-          Regexp::Parser.parse(str, options: options)
+        begin
+          @parsed_tree = Regexp::Parser.parse(str, options: options)
         rescue StandardError
-          nil
+          @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
 

data/lib/rubocop/ext/regexp_parser.rb

@@ -0,0 +1,84 @@
+# 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, :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
+            @expression ||= begin
+              origin.adjust(begin_pos: start_index, end_pos: start_index + full_length)
+            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 ||= begin
+              Map.new(expression, **build_location)
+            end
+          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/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`
@@ -195,15 +197,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)

data/lib/rubocop/formatter/formatter_set.rb

@@ -14,6 +14,7 @@ module RuboCop
         '[e]macs'       => EmacsStyleFormatter,
         '[fi]les'       => FileListFormatter,
         '[fu]ubar'      => FuubarStyleFormatter,
+        '[g]ithub'      => GitHubActionsFormatter,
         '[h]tml'        => HTMLFormatter,
         '[j]son'        => JSONFormatter,
         '[ju]nit'       => JUnitFormatter,
@@ -30,7 +31,7 @@ module RuboCop
 
       FORMATTER_APIS.each do |method_name|
         define_method(method_name) do |*args|
-          each { |f| f.send(method_name, *args) }
+          each { |f| f.public_send(method_name, *args) }
         end
       end
 

data/lib/rubocop/formatter/git_hub_actions_formatter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter formats report data as GitHub Workflow commands resulting
+    # in GitHub check annotations when run within GitHub Actions.
+    class GitHubActionsFormatter < BaseFormatter
+      ESCAPE_MAP = {
+        '%' => '%25',
+        "\n" => '%0A',
+        "\r" => '%0D'
+      }.freeze
+
+      def file_finished(file, offenses)
+        offenses.each { |offense| report_offense(file, offense) }
+      end
+
+      private
+
+      def github_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+      end
+
+      def minimum_severity_to_fail
+        @minimum_severity_to_fail ||= begin
+          name = options.fetch(:fail_level, :refactor)
+          RuboCop::Cop::Severity.new(name)
+        end
+      end
+
+      def github_severity(offense)
+        offense.severity < minimum_severity_to_fail ? 'warning' : 'error'
+      end
+
+      def report_offense(file, offense)
+        output.printf(
+          "\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s\n",
+          severity: github_severity(offense),
+          file: file,
+          line: offense.line,
+          column: offense.real_column,
+          message: github_escape(offense.message)
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/magic_comment.rb

@@ -194,7 +194,7 @@ module RuboCop
     class SimpleComment < MagicComment
       # Match `encoding` or `coding`
       def encoding
-        extract(/\A\s*\#.*\b(?:en)?coding: (#{TOKEN})/i)
+        extract(/\A\s*\#.*\b(?:en)?coding: (#{TOKEN})/io)
       end
 
       private
@@ -207,7 +207,7 @@ module RuboCop
       # Case-insensitive and dashes/underscores are acceptable.
       # @see https://git.io/vM7Mg
       def extract_frozen_string_literal
-        extract(/\A\s*#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/i)
+        extract(/\A\s*#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/io)
       end
     end
   end

data/lib/rubocop/options.rb

@@ -5,6 +5,7 @@ require 'shellwords'
 
 module RuboCop
   class IncorrectCopNameError < StandardError; end
+
   class OptionArgumentError < StandardError; end
 
   # This class handles command line options.
@@ -145,6 +146,7 @@ module RuboCop
         end
       end
 
+      option(opts, '--display-time')
       option(opts, '--display-only-failed')
     end
 
@@ -194,6 +196,7 @@ module RuboCop
 
       option(opts, '--safe')
 
+      option(opts, '--stderr')
       option(opts, '--[no-]color')
 
       option(opts, '-v', '--version')
@@ -469,6 +472,7 @@ module RuboCop
                                          'if no format is specified.'],
       fail_level:                       ['Minimum severity (A/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:
@@ -496,6 +500,9 @@ 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 (only when it\'s safe).',
       safe_auto_correct:                '(same, deprecated)',

data/lib/rubocop/rake_task.rb

@@ -22,7 +22,7 @@ module RuboCop
 
       task(name, *args) do |_, task_args|
         RakeFileUtils.verbose(verbose) do
-          yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+          yield(*[self, task_args].slice(0, task_block.arity)) if task_block
           run_cli(verbose, full_options)
         end
       end
@@ -66,7 +66,7 @@ module RuboCop
 
         task(:auto_correct, *args) do |_, task_args|
           RakeFileUtils.verbose(verbose) do
-            yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+            yield(*[self, task_args].slice(0, task_block.arity)) if task_block
             options = full_options.unshift('--auto-correct-all')
             options.delete('--parallel')
             run_cli(verbose, options)

data/lib/rubocop/rspec/shared_contexts.rb

@@ -138,3 +138,7 @@ end
 RSpec.shared_context 'ruby 2.7', :ruby27 do
   let(:ruby_version) { 2.7 }
 end
+
+RSpec.shared_context 'ruby 3.0', :ruby30 do
+  let(:ruby_version) { 3.0 }
+end

data/lib/rubocop/runner.rb

@@ -64,7 +64,7 @@ module RuboCop
     # instances that each inspects its allotted group of files.
     def warm_cache(target_files)
       puts 'Running parallel inspection' if @options[:debug]
-      Parallel.each(target_files, &method(:file_offenses))
+      Parallel.each(target_files) { |target_file| file_offenses(target_file) }
     end
 
     def find_target_files(paths)

data/lib/rubocop/target_finder.rb

@@ -94,7 +94,7 @@ module RuboCop
     end
 
     def wanted_dir_patterns(base_dir, exclude_pattern, flags)
-      dirs = Dir.glob(File.join(base_dir, '*/'), flags)
+      dirs = Dir.glob(File.join(base_dir.gsub('/**/', '/\**/'), '*/'), flags)
                 .reject do |dir|
                   dir.end_with?('/./', '/../') || File.fnmatch?(exclude_pattern, dir, flags)
                 end

data/lib/rubocop/target_ruby.rb

@@ -112,6 +112,70 @@ module RuboCop
       end
     end
 
+    # The target ruby version may be found in a .gemspec file.
+    # @api private
+    class GemspecFile < Source
+      extend NodePattern::Macros
+
+      GEMSPEC_EXTENSION = '.gemspec'
+
+      def_node_search :required_ruby_version, <<~PATTERN
+        (send _ :required_ruby_version= $_)
+      PATTERN
+
+      def_node_matcher :gem_requirement?, <<~PATTERN
+        (send (const(const _ :Gem):Requirement) :new $str)
+      PATTERN
+
+      def name
+        "`required_ruby_version` parameter (in #{gemspec_filename})"
+      end
+
+      private
+
+      def find_version
+        file = gemspec_filepath
+        return unless file && File.file?(file)
+
+        version = version_from_gemspec_file(file)
+        return if version.nil?
+
+        requirement = version.children.last
+        return version_from_array(version) if version.array_type?
+        return version_from_array(requirement) if gem_requirement? version
+
+        version_from_str(version.str_content)
+      end
+
+      def gemspec_filename
+        @gemspec_filename ||= begin
+          basename = Pathname.new(@config.base_dir_for_path_parameters).basename.to_s
+          "#{basename}#{GEMSPEC_EXTENSION}"
+        end
+      end
+
+      def gemspec_filepath
+        @gemspec_filepath ||=
+          @config.find_file_upwards(gemspec_filename, @config.base_dir_for_path_parameters)
+      end
+
+      def version_from_gemspec_file(file)
+        processed_source = ProcessedSource.from_file(file, DEFAULT_VERSION)
+        required_ruby_version(processed_source.ast).first
+      end
+
+      def version_from_array(array)
+        versions = array.children.map { |v| version_from_str(v.is_a?(String) ? v : v.str_content) }
+        versions.compact.min
+      end
+
+      def version_from_str(str)
+        str.match(/^(?:>=|<=)?\s*(?<version>\d+(?:\.\d+)*)/) do |md|
+          md[:version].to_f
+        end
+      end
+    end
+
     # If all else fails, a default version will be picked.
     # @api private
     class Default < Source
@@ -130,7 +194,7 @@ module RuboCop
       KNOWN_RUBIES
     end
 
-    SOURCES = [RuboCopConfig, RubyVersionFile, BundlerLockFile, Default].freeze
+    SOURCES = [RuboCopConfig, RubyVersionFile, BundlerLockFile, GemspecFile, Default].freeze
     private_constant :SOURCES
 
     def initialize(config)