Class: RuboCop::CLI

# File 'lib/rubocop/cli.rb', line 22

attr_reader :options, :config_store

# File 'lib/rubocop/cli.rb', line 194

def apply_default_formatter
  # This must be done after the options have already been processed,
  # because they can affect how ConfigStore behaves
  @options[:formatters] ||= begin
    if @options[:auto_gen_config]
      formatter = 'autogenconf'
    else
      cfg = @config_store.for_pwd.for_all_cops
      formatter = cfg['DefaultFormatter'] || 'progress'
    end
    [[formatter, @options[:output_path]]]
  end
end

# File 'lib/rubocop/cli.rb', line 121

def execute_runners
  if @options[:auto_gen_config]
    run_command(:auto_gen_config)
  else
    run_command(:execute_runner).tap { suggest_extensions }
  end
end

# File 'lib/rubocop/cli.rb', line 178

def handle_editor_mode
  RuboCop::LSP.enable if @options[:editor_mode]
end

# File 'lib/rubocop/cli.rb', line 183

def handle_exiting_options
  return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }

  run_command(:version) if @options[:version] || @options[:verbose_version]
  run_command(:show_cops) if @options[:show_cops]
  run_command(:show_docs_url) if @options[:show_docs_url]
  run_command(:lsp) if @options[:lsp]
  raise Finished
end

# File 'lib/rubocop/cli.rb', line 140

def parallel_by_default!
  # See https://github.com/rubocop/rubocop/pull/4537 for JRuby and Windows constraints.
  return if RUBY_ENGINE != 'ruby' || RuboCop::Platform.windows?

  if (@options.keys - DEFAULT_PARALLEL_OPTIONS).empty? &&
     @config_store.for_pwd.for_all_cops['UseCache'] != false
    puts 'Use parallel by default.' if @options[:debug]

    @options[:parallel] = true
  end
end

# File 'lib/rubocop/cli.rb', line 76

def profile_if_needed
  return yield unless @options[:profile]

  return STATUS_ERROR unless require_gem('stackprof')

  with_memory = @options[:memory]
  if with_memory
    return STATUS_ERROR unless require_gem('memory_profiler')

    MemoryProfiler.start
  end

  tmp_dir = File.join(ConfigFinder.project_root, 'tmp')
  FileUtils.mkdir_p(tmp_dir)
  cpu_profile_file = File.join(tmp_dir, 'rubocop-stackprof.dump')
  status = nil

  StackProf.run(out: cpu_profile_file) do
    status = yield
  end
  puts "Profile report generated at #{cpu_profile_file}"

  if with_memory
    puts 'Building memory report...'
    report = MemoryProfiler.stop
    memory_profile_file = File.join(tmp_dir, 'rubocop-memory_profiler.txt')
    report.pretty_print(to_file: memory_profile_file, scale_bytes: true)
    puts "Memory report generated at #{memory_profile_file}"
  end
  status
end

# File 'lib/rubocop/cli.rb', line 109

def require_gem(name)
  require name
  true
rescue LoadError
  warn("You don't have #{name} installed. Add it to your Gemfile and run `bundle install`")
  false
end

# File 'lib/rubocop/cli.rb', line 39

def run(args = ARGV)
  @options, paths = Options.new.parse(args)
  @env = Environment.new(@options, @config_store, paths)

  profile_if_needed do
    if @options[:init]
      run_command(:init)
    else
      act_on_options
      validate_options_vs_config
      parallel_by_default!
      apply_default_formatter
      execute_runners
    end
  end
rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
  warn e.message
  STATUS_ERROR
rescue RuboCop::Error => e
  warn Rainbow("Error: #{e.message}").red
  STATUS_ERROR
rescue Finished
  STATUS_SUCCESS
rescue OptionParser::InvalidOption => e
  warn e.message
  warn 'For usage information, use --help'
  STATUS_ERROR
rescue StandardError, SyntaxError, LoadError => e
  warn e.message
  warn e.backtrace
  STATUS_ERROR
end

# File 'lib/rubocop/cli.rb', line 117

def run_command(name)
  @env.run(name)
end

# File 'lib/rubocop/cli.rb', line 170

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]
  ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
end

# File 'lib/rubocop/cli.rb', line 129

def suggest_extensions
  run_command(:suggest_extensions)
end

# File 'lib/rubocop/cli.rb', line 133

def validate_options_vs_config
  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