rubocop 0.78.0 → 1.13.0

data/lib/rubocop/ast_aliases.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# These aliases are for compatibility.
+module RuboCop
+  NodePattern = AST::NodePattern
+  ProcessedSource = AST::ProcessedSource
+  Token = AST::Token
+end

data/lib/rubocop/cached_data.rb

@@ -4,6 +4,7 @@ require 'json'
 
 module RuboCop
   # Converts RuboCop objects to and from the serialization format JSON.
+  # @api private
   class CachedData
     def initialize(filename)
       @filename = filename
@@ -20,6 +21,7 @@ module RuboCop
     private
 
     def serialize_offense(offense)
+      status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
       {
         # Calling #to_s here ensures that the serialization works when using
         # other json serializers such as Oj. Some of these gems do not call
@@ -31,7 +33,7 @@ module RuboCop
         },
         message:  message(offense),
         cop_name: offense.cop_name,
-        status:   :uncorrected
+        status:   status || offense.status
       }
     end
 
@@ -49,9 +51,7 @@ module RuboCop
         location = Parser::Source::Range.new(source_buffer,
                                              o['location']['begin_pos'],
                                              o['location']['end_pos'])
-        Cop::Offense.new(o['severity'], location,
-                         o['message'],
-                         o['cop_name'], o['status'].to_sym)
+        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
       end
     end
   end

data/lib/rubocop/cli.rb

@@ -35,8 +35,8 @@ module RuboCop
       if @options[:init]
         run_command(:init)
       else
-        validate_options_vs_config
         act_on_options
+        validate_options_vs_config
         apply_default_formatter
         execute_runners
       end
@@ -69,24 +69,23 @@ module RuboCop
       if @options[:auto_gen_config]
         run_command(:auto_gen_config)
       else
-        run_command(:execute_runner)
+        run_command(:execute_runner).tap { suggest_extensions }
       end
     end
 
+    def suggest_extensions
+      run_command(:suggest_extensions)
+    end
+
     def validate_options_vs_config
-      if @options[:parallel] &&
-         !@config_store.for(Dir.pwd).for_all_cops['UseCache']
-        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
-                                   'execution, so combining with AllCops: ' \
-                                   'UseCache: false is not allowed.'
-      end
+      return unless @options[:parallel] && !@config_store.for_pwd.for_all_cops['UseCache']
+
+      raise OptionArgumentError, '-P/--parallel uses caching to speed up execution, so combining ' \
+                                 'with AllCops: UseCache: false is not allowed.'
     end
 
     def act_on_options
-      ConfigLoader.debug = @options[:debug]
-      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
-      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
-      ConfigLoader.options_config = @options[:config]
+      set_options_to_config_loader
 
       @config_store.options_config = @options[:config] if @options[:config]
       @config_store.force_default_config! if @options[:force_default_config]
@@ -102,6 +101,13 @@ module RuboCop
       end
     end
 
+    def set_options_to_config_loader
+      ConfigLoader.debug = @options[:debug]
+      ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
+      ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
+      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
+    end
+
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
@@ -117,7 +123,7 @@ module RuboCop
         if @options[:auto_gen_config]
           formatter = 'autogenconf'
         else
-          cfg = @config_store.for(Dir.pwd).for_all_cops
+          cfg = @config_store.for_pwd.for_all_cops
           formatter = cfg['DefaultFormatter'] || 'progress'
         end
         [[formatter, @options[:output_path]]]

data/lib/rubocop/cli/command.rb

@@ -3,6 +3,7 @@
 module RuboCop
   class CLI
     # Home of subcommands in the CLI.
+    # @api private
     module Command
       class << self
         # Find the command with a given name and run it in an environment.

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -4,16 +4,18 @@ module RuboCop
   class CLI
     module Command
       # Generate a configuration file acting as a TODO list.
+      # @api private
       class AutoGenerateConfig < Base
         self.command_name = :auto_gen_config
 
+        AUTO_GENERATED_FILE = '.rubocop_todo.yml'
+        YAML_OPTIONAL_DOC_START = /\A---(\s+#|\s*\z)/.freeze
+
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
-        PHASE_1_OVERRIDDEN =
-          '(skipped because the default Layout/LineLength:Max is overridden)'
-        PHASE_1_DISABLED =
-          '(skipped because Layout/LineLength is disabled)'
+        PHASE_1_OVERRIDDEN = '(skipped because the default Layout/LineLength:Max is overridden)'
+        PHASE_1_DISABLED = '(skipped because Layout/LineLength is disabled)'
 
         def run
           add_formatter
@@ -25,11 +27,9 @@ module RuboCop
         private
 
         def maybe_run_line_length_cop
-          if !line_length_enabled?(@config_store.for(Dir.pwd))
+          if !line_length_enabled?(@config_store.for_pwd)
             skip_line_length_cop(PHASE_1_DISABLED)
-          elsif !same_max_line_length?(
-            @config_store.for(Dir.pwd), ConfigLoader.default_configuration
-          )
+          elsif !same_max_line_length?(@config_store.for_pwd, ConfigLoader.default_configuration)
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
           else
             run_line_length_cop
@@ -67,10 +67,7 @@ module RuboCop
           @options.delete(:only)
           @config_store = ConfigStore.new
           # Save the todo configuration of the LineLength cop.
-          IO.read(ConfigLoader::AUTO_GENERATED_FILE)
-            .lines
-            .drop_while { |line| line.start_with?('#') }
-            .join
+          File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
         end
 
         def run_all_cops(line_length_contents)
@@ -78,27 +75,57 @@ module RuboCop
           result = execute_runner
           # This run was made with the current maximum length allowed, so append
           # the saved setting for LineLength.
-          File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
-            f.write(line_length_contents)
-          end
+          File.open(AUTO_GENERATED_FILE, 'a') { |f| f.write(line_length_contents) }
           result
         end
 
         def reset_config_and_auto_gen_file
           @config_store = ConfigStore.new
           @config_store.options_config = @options[:config] if @options[:config]
-          File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
-          ConfigLoader.add_inheritance_from_auto_generated_file
+          File.open(AUTO_GENERATED_FILE, 'w') {} # create or truncate if exists
+          add_inheritance_from_auto_generated_file(@options[:config])
         end
 
         def add_formatter
-          @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                    ConfigLoader::AUTO_GENERATED_FILE]
+          @options[:formatters] << [Formatter::DisabledConfigFormatter, AUTO_GENERATED_FILE]
         end
 
         def execute_runner
           Environment.new(@options, @config_store, @paths).run(:execute_runner)
         end
+
+        def add_inheritance_from_auto_generated_file(config_file)
+          file_string = " #{AUTO_GENERATED_FILE}"
+
+          config_file ||= ConfigLoader::DOTFILE
+
+          if File.exist?(config_file)
+            files = Array(ConfigLoader.load_yaml_configuration(config_file)['inherit_from'])
+
+            return if files.include?(AUTO_GENERATED_FILE)
+
+            files.unshift(AUTO_GENERATED_FILE)
+            file_string = "\n  - #{files.join("\n  - ")}" if files.size > 1
+            rubocop_yml_contents = existing_configuration(config_file)
+          end
+
+          write_config_file(config_file, file_string, rubocop_yml_contents)
+
+          puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{ConfigLoader::DOTFILE}`."
+        end
+
+        def existing_configuration(config_file)
+          File.read(config_file, encoding: Encoding::UTF_8)
+              .sub(/^inherit_from: *[^\n]+/, '')
+              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
+        end
+
+        def write_config_file(file_name, file_string, rubocop_yml_contents)
+          lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
+          doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
+          lines.insert(doc_start_index + 1, "inherit_from:#{file_string}\n")
+          File.open(file_name, 'w') { |f| f.write lines.join("\n") }
+        end
       end
     end
   end

data/lib/rubocop/cli/command/base.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # A subcommand in the CLI.
+      # @api private
       class Base
         attr_reader :env
 
@@ -13,6 +14,7 @@ module RuboCop
           attr_accessor :command_name
 
           def inherited(subclass)
+            super
             @subclasses << subclass
           end
 

data/lib/rubocop/cli/command/execute_runner.rb

@@ -4,9 +4,13 @@ module RuboCop
   class CLI
     module Command
       # Run all the selected cops and report the result.
+      # @api private
       class ExecuteRunner < Base
         include Formatter::TextUtil
 
+        # Combination of short and long formatter names.
+        INTEGRATION_FORMATTERS = %w[h html j json ju junit].freeze
+
         self.command_name = :execute_runner
 
         def run
@@ -18,12 +22,13 @@ module RuboCop
         def execute_runner(paths)
           runner = Runner.new(@options, @config_store)
 
-          all_passed = runner.run(paths)
-          display_warning_summary(runner.warnings)
-          display_error_summary(runner.errors)
-          maybe_print_corrected_source
+          all_pass_or_excluded = with_redirect do
+            all_passed = runner.run(paths)
+            display_summary(runner)
+            all_passed || @options[:auto_gen_config]
+          end
 
-          all_pass_or_excluded = all_passed || @options[:auto_gen_config]
+          maybe_print_corrected_source
 
           if runner.aborting?
             STATUS_INTERRUPTED
@@ -34,6 +39,25 @@ module RuboCop
           end
         end
 
+        def with_redirect
+          if @options[:stderr]
+            orig_stdout = $stdout.dup
+            $stdout.reopen($stderr)
+
+            result = yield
+
+            $stdout.reopen(orig_stdout)
+            result
+          else
+            yield
+          end
+        end
+
+        def display_summary(runner)
+          display_warning_summary(runner.warnings)
+          display_error_summary(runner.errors)
+        end
+
         def display_warning_summary(warnings)
           return if warnings.empty?
 
@@ -55,19 +79,19 @@ module RuboCop
             #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
 
             Mention the following information in the issue report:
-            #{RuboCop::Version.version(true)}
+            #{RuboCop::Version.version(debug: true)}
           WARNING
         end
 
         def maybe_print_corrected_source
-          # If we are asked to autocorrect source code read from stdin, the only
-          # reasonable place to write it is to stdout
-          # Unfortunately, we also write other information to stdout
-          # So a delimiter is needed for tools to easily identify where the
-          # autocorrected source begins
+          # Integration tools (like RubyMine) expect to have only the JSON result
+          # when specifying JSON format. Similar HTML and JUnit are targeted as well.
+          # See: https://github.com/rubocop/rubocop/issues/8673
+          return if INTEGRATION_FORMATTERS.include?(@options[:format])
+
           return unless @options[:stdin] && @options[:auto_correct]
 
-          puts '=' * 20
+          (@options[:stderr] ? $stderr : $stdout).puts '=' * 20
           print @options[:stdin]
         end
       end

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Generate a .rubocop.yml file in the current directory.
+      # @api private
       class InitDotfile < Base
         DOTFILE = ConfigLoader::DOTFILE
 
@@ -27,12 +28,10 @@ module RuboCop
               # RuboCop will start looking for the configuration file in the directory
               # where the inspected file is and continue its way up to the root directory.
               #
-              # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+              # See https://docs.rubocop.org/rubocop/configuration
             DESC
 
-            File.open(DOTFILE, 'w') do |f|
-              f.write(description)
-            end
+            File.open(DOTFILE, 'w') { |f| f.write(description) }
 
             puts "Writing new #{DOTFILE} to #{path}"
 

data/lib/rubocop/cli/command/show_cops.rb

@@ -5,9 +5,17 @@ module RuboCop
     module Command
       # Shows the given cops, or all cops by default, and their configurations
       # for the current directory.
+      # @api private
       class ShowCops < Base
         self.command_name = :show_cops
 
+        def initialize(env)
+          super
+
+          # Load the configs so the require()s are done for custom cops
+          @config = @config_store.for(Dir.pwd)
+        end
+
         def run
           print_available_cops
         end
@@ -15,15 +23,10 @@ module RuboCop
         private
 
         def print_available_cops
-          # Load the configs so the require()s are done for custom cops
-          @config_store.for(Dir.pwd)
-          registry = Cop::Cop.registry
+          registry = Cop::Registry.global
           show_all = @options[:show_cops].empty?
 
-          if show_all
-            puts "# Available cops (#{registry.length}) " \
-                 "+ config for #{Dir.pwd}: "
-          end
+          puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: " if show_all
 
           registry.departments.sort!.each do |department|
             print_cops_of_department(registry, department, show_all)
@@ -37,16 +40,14 @@ module RuboCop
                             selected_cops_of_department(registry, department)
                           end
 
-          if show_all
-            puts "# Department '#{department}' (#{selected_cops.length}):"
-          end
+          puts "# Department '#{department}' (#{selected_cops.length}):" if show_all
 
           print_cop_details(selected_cops)
         end
 
         def print_cop_details(cops)
           cops.each do |cop|
-            puts '# Supports --auto-correct' if cop.new.support_autocorrect?
+            puts '# Supports --auto-correct' if cop.support_autocorrect?
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts
@@ -64,8 +65,8 @@ module RuboCop
         end
 
         def config_lines(cop)
-          cnf = @config_store.for(Dir.pwd).for_cop(cop)
-          cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
+          cnf = @config.for_cop(cop)
+          cnf.to_yaml.lines.to_a.drop(1).map { |line| "  #{line}" }
         end
       end
     end

data/lib/rubocop/cli/command/suggest_extensions.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Suggest RuboCop extensions to install based on Gemfile dependencies.
+      # Only primary dependencies are evaluated, so if a dependency depends on a
+      # gem with an extension, it is not suggested. However, if an extension is
+      # a transitive dependency, it will not be suggested.
+      # @api private
+      class SuggestExtensions < Base
+        # Combination of short and long formatter names.
+        INCLUDED_FORMATTERS = %w[p progress fu fuubar pa pacman].freeze
+
+        self.command_name = :suggest_extensions
+
+        def run
+          return if skip? || extensions.none?
+
+          puts
+          puts 'Tip: Based on detected gems, the following '\
+            'RuboCop extension libraries might be helpful:'
+
+          extensions.sort.each do |extension|
+            puts "  * #{extension} (https://github.com/rubocop/#{extension})"
+          end
+
+          puts
+          puts 'You can opt out of this message by adding the following to your config '\
+            '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions '\
+            'for more options):'
+          puts '  AllCops:'
+          puts '    SuggestExtensions: false'
+
+          puts if @options[:display_time]
+        end
+
+        private
+
+        def skip?
+          # Disable outputting the notification:
+          # 1. On CI
+          # 2. When given RuboCop options that it doesn't make sense for
+          # 3. For all formatters except specified in `INCLUDED_FORMATTERS'`
+          ENV['CI'] ||
+            @options[:only] || @options[:debug] || @options[:list_target_files] ||
+            @options[:out] || @options[:stdin] ||
+            !INCLUDED_FORMATTERS.include?(current_formatter)
+        end
+
+        def current_formatter
+          @options[:format] || @config_store.for_pwd.for_all_cops['DefaultFormatter'] || 'p'
+        end
+
+        def extensions
+          return [] unless lockfile.dependencies.any?
+
+          extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions'] || {}
+          extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys - installed_gems
+        end
+
+        def lockfile
+          @lockfile ||= Lockfile.new
+        end
+
+        def dependent_gems
+          lockfile.dependencies.map(&:name)
+        end
+
+        def installed_gems
+          lockfile.gems.map(&:name)
+        end
+
+        def puts(*args)
+          output = (@options[:stderr] ? $stderr : $stdout)
+          output.puts(*args)
+        end
+      end
+    end
+  end
+end