rubocop 0.52.1 → 0.53.0

data/lib/rubocop/cop/variable_force.rb

@@ -432,7 +432,7 @@ module RuboCop
       #     (send nil :puts
       #       (lvar :foo)))
       #
-      # So the the method argument nodes need to be processed
+      # So the method argument nodes need to be processed
       # in current scope.
       #
       # Same thing.

data/lib/rubocop/file_finder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RuboCop
+  # Common methods for finding files.
+  module FileFinder
+    def self.root_level=(level)
+      @root_level = level
+    end
+
+    def self.root_level?(path)
+      @root_level == path.to_s
+    end
+
+    def find_file_upwards(filename, start_dir, use_home: false)
+      traverse_files_upwards(filename, start_dir, use_home) do |file|
+        # minimize iteration for performance
+        return file if file
+      end
+    end
+
+    def find_files_upwards(filename, start_dir, use_home: false)
+      files = []
+      traverse_files_upwards(filename, start_dir, use_home) do |file|
+        files << file
+      end
+      files
+    end
+
+    private
+
+    def traverse_files_upwards(filename, start_dir, use_home)
+      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?
+      end
+
+      return unless use_home && ENV.key?('HOME')
+      file = File.join(Dir.home, filename)
+      yield(file) if File.exist?(file)
+    end
+  end
+end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -5,15 +5,15 @@ 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
-      HEADING =
-        ['# This configuration was generated by',
-         '# `%s`',
-         "# on #{Time.now} using RuboCop version #{Version.version}.",
-         '# The point is for the user to remove these configuration records',
-         '# one by one as the offenses are removed from the code base.',
-         '# Note that changes in the inspected code, or installation of new',
-         '# versions of RuboCop, may require this file to be generated again.']
-        .join("\n")
+      HEADING = <<-COMMENTS.strip_indent
+        # This configuration was generated by
+        # `%<command>s`
+        # %<timestamp>susing RuboCop version #{Version.version}.
+        # The point is for the user to remove these configuration records
+        # one by one as the offenses are removed from the code base.
+        # Note that changes in the inspected code, or installation of new
+        # versions of RuboCop, may require this file to be generated again.
+      COMMENTS
 
       @config_to_allow_offenses = {}
       @detected_styles = {}
@@ -32,9 +32,8 @@ module RuboCop
 
       def file_started(_file, _file_info)
         @exclude_limit_option = @options[:exclude_limit]
-        @exclude_limit = (
-          @exclude_limit_option ||
-          RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS).to_i
+        @exclude_limit = Integer(@exclude_limit_option ||
+          RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS)
         @show_offense_counts = !@options[:no_offense_counts]
       end
 
@@ -47,7 +46,7 @@ module RuboCop
       end
 
       def finished(_inspected_files)
-        output.puts HEADING % command
+        output.puts format(HEADING, command: command, timestamp: timestamp)
 
         # Syntax isn't a real cop and it can't be disabled.
         @cops_with_offenses.delete('Lint/Syntax')
@@ -62,13 +61,23 @@ module RuboCop
       def command
         command = 'rubocop --auto-gen-config'
         if @exclude_limit_option
-          command += format(' --exclude-limit %d', @exclude_limit_option.to_i)
+          command +=
+            format(' --exclude-limit %<limit>d',
+                   limit: Integer(@exclude_limit_option))
         end
         command += ' --no-offense-counts' if @options[:no_offense_counts]
 
+        if @options[:no_auto_gen_timestamp]
+          command += ' --no-auto-gen-timestamp'
+        end
+
         command
       end
 
+      def timestamp
+        @options[:no_auto_gen_timestamp] ? '' : "on #{Time.now} "
+      end
+
       def output_offenses
         @cops_with_offenses.sort.each do |cop_name, offense_count|
           output_cop(cop_name, offense_count)

data/lib/rubocop/formatter/fuubar_style_formatter.rb

@@ -11,7 +11,7 @@ module RuboCop
     class FuubarStyleFormatter < ClangStyleFormatter
       RESET_SEQUENCE = "\e[0m".freeze
 
-      def initialize(*)
+      def initialize(*output)
         @severest_offense = nil
 
         super

data/lib/rubocop/formatter/html_formatter.rb

@@ -12,7 +12,7 @@ module RuboCop
     class HTMLFormatter < BaseFormatter
       ELLIPSES = '<span class="extra-code">...</span>'.freeze
       TEMPLATE_PATH =
-        File.expand_path('../../../../assets/output.html.erb', __FILE__)
+        File.expand_path('../../../assets/output.html.erb', __dir__)
 
       Color = Struct.new(:red, :green, :blue, :alpha) do
         def to_s
@@ -53,7 +53,14 @@ module RuboCop
         context = ERBContext.new(files, summary)
 
         template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
-        erb = ERB.new(template, nil, '-')
+
+        # The following condition is workaround for until Ruby 2.6 is released.
+        # https://github.com/ruby/ruby/commit/cc777d09f44fa909a336ba14f3aa802ffe16e010
+        erb = if RUBY_VERSION >= '2.6'
+                ERB.new(template, trim_mode: '-')
+              else
+                ERB.new(template, nil, '-')
+              end
         html = erb.result(context.binding)
 
         output.write html
@@ -73,7 +80,7 @@ module RuboCop
         }.freeze
 
         LOGO_IMAGE_PATH =
-          File.expand_path('../../../../assets/logo.png', __FILE__)
+          File.expand_path('../../../assets/logo.png', __dir__)
 
         attr_reader :files, :summary
 
@@ -120,8 +127,8 @@ module RuboCop
           location.first_line == location.last_line ? '' : " #{ELLIPSES}"
         end
 
-        def escape(s)
-          CGI.escapeHTML(s)
+        def escape(string)
+          CGI.escapeHTML(string)
         end
 
         def base64_encoded_logo_image

data/lib/rubocop/formatter/json_formatter.rb

@@ -46,7 +46,7 @@ module RuboCop
 
       def hash_for_file(file, offenses)
         {
-          path:     relative_path(file),
+          path:     smart_path(file),
           offenses: offenses.map { |o| hash_for_offense(o) }
         }
       end

data/lib/rubocop/node_pattern.rb

@@ -369,7 +369,7 @@ module RuboCop
         if method.end_with?('(') # is there an arglist?
           args = compile_args(tokens)
           method = method[0..-2] # drop the trailing (
-          "(#{method}(#{cur_node}#{'.type' if seq_head}),#{args.join(',')})"
+          "(#{method}(#{cur_node}#{'.type' if seq_head},#{args.join(',')}))"
         else
           "(#{method}(#{cur_node}#{'.type' if seq_head}))"
         end
@@ -384,10 +384,13 @@ module RuboCop
       end
 
       def compile_args(tokens)
-        args = []
-        args << compile_arg(tokens.shift) until tokens.first == ')'
-        tokens.shift # drop the )
-        args
+        index = tokens.find_index { |token| token == ')' }
+
+        tokens.slice!(0..index).each_with_object([]) do |token, args|
+          next if [')', ','].include?(token)
+
+          args << compile_arg(token)
+        end
       end
 
       def compile_arg(token)

data/lib/rubocop/options.rb

@@ -18,7 +18,7 @@ module RuboCop
 
     def parse(command_line_args)
       args = args_from_file.concat(args_from_env).concat(command_line_args)
-      define_options(args).parse!(args)
+      define_options.parse!(args)
 
       @validator.validate_compatibility
 
@@ -51,13 +51,13 @@ module RuboCop
       Shellwords.split(ENV.fetch('RUBOCOP_OPTS', ''))
     end
 
-    def define_options(args)
+    def define_options
       OptionParser.new do |opts|
         opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
 
         add_list_options(opts)
         add_only_options(opts)
-        add_configuration_options(opts, args)
+        add_configuration_options(opts)
         add_formatting_options(opts)
 
         option(opts, '-r', '--require FILE') { |f| require f }
@@ -89,13 +89,13 @@ module RuboCop
       end
     end
 
-    def add_configuration_options(opts, args)
+    def add_configuration_options(opts)
       option(opts, '-c', '--config FILE')
 
       option(opts, '--auto-gen-config')
 
       option(opts, '--exclude-limit COUNT') do
-        @validator.validate_exclude_limit_option(args)
+        @validator.validate_exclude_limit_option
       end
 
       option(opts, '--force-exclusion')
@@ -106,6 +106,10 @@ module RuboCop
       option(opts, '--no-offense-counts') do
         @options[:no_offense_counts] = true
       end
+
+      option(opts, '--no-auto-gen-timestamp') do
+        @options[:no_auto_gen_timestamp] = true
+      end
     end
 
     def add_formatting_options(opts)
@@ -206,18 +210,18 @@ module RuboCop
       private
 
       def format_message_from(name, cop_names)
-        message = 'Unrecognized cop or department: %{name}.'
-        message_with_candidate = "#{message}\nDid you mean? %{candidate}"
+        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
 
         if corrections.empty?
-          format message, name: name
+          format(message, name: name)
         else
-          format message_with_candidate, name: name,
-                                         candidate: corrections.join(', ')
+          format(message_with_candidate, message: format(message, name: name),
+                                         candidate: corrections.join(', '))
         end
       end
     end
@@ -228,7 +232,8 @@ module RuboCop
 
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_unneeded_disable?
-        raise ArgumentError, 'Lint/UnneededDisable can not be used with --only.'
+        raise ArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
+                             'be used with --only.'
       end
       if except_syntax?
         raise ArgumentError, 'Syntax checking can not be turned off.'
@@ -236,10 +241,7 @@ module RuboCop
       unless boolean_or_empty_cache?
         raise ArgumentError, '-C/--cache argument must be true or false'
       end
-      if no_offense_counts_without_auto_gen_config?
-        raise ArgumentError, '--no-offense-counts can only be used together ' \
-                             'with --auto-gen-config.'
-      end
+      validate_auto_gen_config
       validate_parallel
 
       return if incompatible_options.size <= 1
@@ -247,6 +249,18 @@ module RuboCop
                            "#{incompatible_options.inspect}"
     end
 
+    def validate_auto_gen_config
+      return if @options.key?(:auto_gen_config)
+
+      message = '--%<flag>s can only be used together with --auto-gen-config.'
+
+      %i[exclude_limit no_offense_counts no_auto_gen_timestamp].each do |option|
+        if @options.key?(option)
+          raise ArgumentError, format(message, flag: option.to_s.tr('_', '-'))
+        end
+      end
+    end
+
     def validate_parallel
       return unless @options.key?(:parallel)
 
@@ -269,7 +283,8 @@ module RuboCop
 
     def only_includes_unneeded_disable?
       @options.key?(:only) &&
-        (@options[:only] & %w[Lint/UnneededDisable UnneededDisable]).any?
+        (@options[:only] & %w[Lint/UnneededCopDisableDirective
+                              UnneededCopDisableDirective]).any?
     end
 
     def except_syntax?
@@ -281,27 +296,15 @@ module RuboCop
       !@options.key?(:cache) || %w[true false].include?(@options[:cache])
     end
 
-    def no_offense_counts_without_auto_gen_config?
-      @options.key?(:no_offense_counts) && !@options.key?(:auto_gen_config)
-    end
-
     def incompatible_options
       @incompatible_options ||= @options.keys & Options::EXITING_OPTIONS
     end
 
-    def validate_exclude_limit_option(args)
-      if @options[:exclude_limit] !~ /^\d+$/
-        # Emulate OptionParser's behavior to make failures consistent regardless
-        # of option order.
-        raise OptionParser::MissingArgument
-      end
-
-      # --exclude-limit is valid if there's a parsed or yet unparsed
-      # --auto-gen-config.
-      return if @options[:auto_gen_config] || args.include?('--auto-gen-config')
-
-      raise ArgumentError,
-            '--exclude-limit can only be used with --auto-gen-config.'
+    def validate_exclude_limit_option
+      return if @options[:exclude_limit] =~ /^\d+$/
+      # Emulate OptionParser's behavior to make failures consistent regardless
+      # of option order.
+      raise OptionParser::MissingArgument
     end
   end
 
@@ -319,6 +322,10 @@ module RuboCop
                              '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.'],
       exclude_limit:        ['Used together with --auto-gen-config to',
                              'set the limit for how many Exclude',
                              "properties to generate. Default is #{MAX_EXCL}."],

data/lib/rubocop/path_util.rb

@@ -15,7 +15,11 @@ module RuboCop
       end
 
       path_name = Pathname.new(File.expand_path(path))
-      path_name.relative_path_from(Pathname.new(base_dir)).to_s
+      begin
+        path_name.relative_path_from(Pathname.new(base_dir)).to_s
+      rescue ArgumentError
+        path
+      end
     end
 
     def smart_path(path)
@@ -43,13 +47,6 @@ module RuboCop
       end
     end
 
-    def find_file_upwards(filename, start_dir = PathUtil.pwd)
-      Pathname(File.expand_path(start_dir)).ascend do |dir|
-        file = File.join(dir, filename)
-        return file if File.exist?(file)
-      end
-    end
-
     # Returns true for an absolute Unix or Windows path.
     def absolute?(path)
       path =~ %r{\A([A-Z]:)?/}

data/lib/rubocop/processed_source.rb

@@ -78,8 +78,61 @@ module RuboCop
       Digest::MD5.hexdigest(@raw_source)
     end
 
+    def each_comment
+      comments.each { |comment| yield comment }
+    end
+
+    def find_comment
+      comments.find { |comment| yield comment }
+    end
+
+    def each_token
+      tokens.each { |token| yield token }
+    end
+
+    def find_token
+      tokens.find { |token| yield token }
+    end
+
+    def file_path
+      buffer.name
+    end
+
+    def blank?
+      ast.nil?
+    end
+
+    def commented?(source_range)
+      comment_lines.include?(source_range.line)
+    end
+
+    def comment_on_line?(line)
+      comments.any? { |c| c.loc.line == line }
+    end
+
+    def comments_before_line(line)
+      comments.select { |c| c.location.line <= line }
+    end
+
+    def start_with?(string)
+      return false if self[0].nil?
+      self[0].start_with?(string)
+    end
+
+    def preceding_line(token)
+      lines[token.line - 2]
+    end
+
+    def following_line(token)
+      lines[token.line]
+    end
+
     private
 
+    def comment_lines
+      @comment_lines ||= comments.map { |c| c.location.line }
+    end
+
     def parse(source, ruby_version)
       buffer_name = @path || STRING_SOURCE_NAME
       @buffer = Parser::Source::Buffer.new(buffer_name, 1)