class Bundler::CLI
Constants
- AUTO_INSTALL_CMDS
- PARSEABLE_COMMANDS
Public Class Methods
deprecated_option(*args, &blk)
click to toggle source
# File lib/bundler/cli.rb, line 63 def self.deprecated_option(*args, &blk) return if Bundler.feature_flag.forget_cli_options? method_option(*args, &blk) end
dispatch(*)
click to toggle source
Calls superclass method
# File lib/bundler/cli.rb, line 25 def self.dispatch(*) super do |i| i.send(:print_command) i.send(:warn_on_outdated_bundler) end end
handle_no_command_error(command, has_namespace = $thor_runner)
click to toggle source
Calls superclass method
# File lib/bundler/cli.rb, line 128 def self.handle_no_command_error(command, has_namespace = $thor_runner) if Bundler.feature_flag.plugins? && Bundler::Plugin.command?(command) return Bundler::Plugin.exec_command(command, ARGV[1..-1]) end return super unless command_path = Bundler.which("bundler-#{command}") Kernel.exec(command_path, *ARGV[1..-1]) end
new(*args)
click to toggle source
Calls superclass method
Bundler::Thor::Actions.new
# File lib/bundler/cli.rb, line 32 def initialize(*args) super custom_gemfile = options[:gemfile] || Bundler.settings[:gemfile] if custom_gemfile && !custom_gemfile.empty? Bundler::SharedHelpers.set_env "BUNDLE_GEMFILE", File.expand_path(custom_gemfile) Bundler.reset_paths! end Bundler.settings.set_command_option_if_given :retry, options[:retry] current_cmd = args.last[:current_command].name auto_install if AUTO_INSTALL_CMDS.include?(current_cmd) rescue UnknownArgumentError => e raise InvalidOption, e.message ensure self.options ||= {} unprinted_warnings = Bundler.ui.unprinted_warnings Bundler.ui = UI::Shell.new(options) Bundler.ui.level = "debug" if options["verbose"] unprinted_warnings.each {|w| Bundler.ui.warn(w) } if ENV["RUBYGEMS_GEMDEPS"] && !ENV["RUBYGEMS_GEMDEPS"].empty? Bundler.ui.warn( "The RUBYGEMS_GEMDEPS environment variable is set. This enables RubyGems' " \ "experimental Gemfile mode, which may conflict with Bundler and cause unexpected errors. " \ "To remove this warning, unset RUBYGEMS_GEMDEPS.", :wrap => true ) end end
reformatted_help_args(args)
click to toggle source
Reformat the arguments passed to bundle that include a –help flag into the corresponding `bundle help #{command}` call
# File lib/bundler/cli.rb, line 648 def self.reformatted_help_args(args) bundler_commands = all_commands.keys help_flags = %w[--help -h] exec_commands = %w[e ex exe exec] help_used = args.index {|a| help_flags.include? a } exec_used = args.index {|a| exec_commands.include? a } command = args.find {|a| bundler_commands.include? a } if exec_used && help_used if exec_used + help_used == 1 %w[help exec] else args end elsif help_used args = args.dup args.delete_at(help_used) ["help", command || args].flatten.compact else args end end
source_root()
click to toggle source
# File lib/bundler/cli.rb, line 540 def self.source_root File.expand_path(File.join(File.dirname(__FILE__), "templates")) end
start(*)
click to toggle source
Calls superclass method
# File lib/bundler/cli.rb, line 16 def self.start(*) super rescue Exception => e Bundler.ui = UI::Shell.new raise e ensure Bundler::SharedHelpers.print_major_deprecations! end
Public Instance Methods
add(gem_name)
click to toggle source
# File lib/bundler/cli.rb, line 331 def add(gem_name) require "bundler/cli/add" Add.new(options.dup, gem_name).run end
binstubs(*gems)
click to toggle source
# File lib/bundler/cli.rb, line 318 def binstubs(*gems) require "bundler/cli/binstubs" Binstubs.new(options, gems).run end
cache()
click to toggle source
# File lib/bundler/cli.rb, line 379 def cache require "bundler/cli/cache" Cache.new(options).run end
check()
click to toggle source
# File lib/bundler/cli.rb, line 163 def check require "bundler/cli/check" Check.new(options).run end
clean()
click to toggle source
# File lib/bundler/cli.rb, line 549 def clean require "bundler/cli/clean" Clean.new(options.dup).run end
cli_help()
click to toggle source
# File lib/bundler/cli.rb, line 72 def cli_help version Bundler.ui.info "\n" primary_commands = ["install", "update", Bundler.feature_flag.cache_command_is_package? ? "cache" : "package", "exec", "config", "help"] list = self.class.printable_commands(true) by_name = list.group_by {|name, _message| name.match(/^bundle (\w+)/)[1] } utilities = by_name.keys.sort - primary_commands primary_commands.map! {|name| (by_name[name] || raise("no primary command #{name}")).first } utilities.map! {|name| by_name[name].first } shell.say "Bundler commands:\n\n" shell.say " Primary commands:\n" shell.print_table(primary_commands, :indent => 4, :truncate => true) shell.say shell.say " Utilities:\n" shell.print_table(utilities, :indent => 4, :truncate => true) shell.say self.class.send(:class_options_help, shell) end
config(*args)
click to toggle source
# File lib/bundler/cli.rb, line 439 def config(*args) require "bundler/cli/config" Config.new(options, args, self).run end
console(group = nil)
click to toggle source
# File lib/bundler/cli.rb, line 452 def console(group = nil) require "bundler/cli/console" Console.new(options, group).run end
doctor()
click to toggle source
# File lib/bundler/cli.rb, line 618 def doctor require "bundler/cli/doctor" Doctor.new(options).run end
env()
click to toggle source
# File lib/bundler/cli.rb, line 604 def env Env.write($stdout) end
exec(*args)
click to toggle source
# File lib/bundler/cli.rb, line 421 def exec(*args) require "bundler/cli/exec" Exec.new(options, args).run end
help(cli = nil)
click to toggle source
Calls superclass method
# File lib/bundler/cli.rb, line 103 def help(cli = nil) case cli when "gemfile" then command = "gemfile" when nil then command = "bundle" else command = "bundle-#{cli}" end man_path = File.expand_path("../../../man", __FILE__) man_pages = Hash[Dir.glob(File.join(man_path, "*")).grep(/.*\.\d*\Z/).collect do |f| [File.basename(f, ".*"), f] end] if man_pages.include?(command) if Bundler.which("man") && man_path !~ %r{^file:/.+!/META-INF/jruby.home/.+} Kernel.exec "man #{man_pages[command]}" else puts File.read("#{man_path}/#{File.basename(man_pages[command])}.txt") end elsif command_path = Bundler.which("bundler-#{cli}") Kernel.exec(command_path, "--help") else super end end
info(gem_name)
click to toggle source
# File lib/bundler/cli.rb, line 299 def info(gem_name) require "bundler/cli/info" Info.new(options, gem_name).run end
init()
click to toggle source
# File lib/bundler/cli.rb, line 145 def init require "bundler/cli/init" Init.new(options.dup).run end
inject(name, version)
click to toggle source
# File lib/bundler/cli.rb, line 567 def inject(name, version) SharedHelpers.major_deprecation 2, "The `inject` command has been replaced by the `add` command" require "bundler/cli/inject" Inject.new(options.dup, name, version).run end
install()
click to toggle source
# File lib/bundler/cli.rb, line 220 def install require "bundler/cli/install" Bundler.settings.temporary(:no_install => false) do Install.new(options.dup).run end end
issue()
click to toggle source
# File lib/bundler/cli.rb, line 624 def issue require "bundler/cli/issue" Issue.new.run end
licenses()
click to toggle source
# File lib/bundler/cli.rb, line 474 def licenses Bundler.load.specs.sort_by {|s| s.license.to_s }.reverse_each do |s| gem_name = s.name license = s.license || s.licenses if license.empty? Bundler.ui.warn "#{gem_name}: Unknown" else Bundler.ui.info "#{gem_name}: #{license}" end end end
list()
click to toggle source
# File lib/bundler/cli.rb, line 287 def list require "bundler/cli/list" List.new(options).run end
lock()
click to toggle source
# File lib/bundler/cli.rb, line 598 def lock require "bundler/cli/lock" Lock.new(options).run end
open(name)
click to toggle source
# File lib/bundler/cli.rb, line 445 def open(name) require "bundler/cli/open" Open.new(options, name).run end
outdated(*gems)
click to toggle source
# File lib/bundler/cli.rb, line 364 def outdated(*gems) require "bundler/cli/outdated" Outdated.new(options, gems).run end
package()
click to toggle source
# File lib/bundler/cli.rb, line 407 def package require "bundler/cli/package" Package.new(options).run end
platform()
click to toggle source
# File lib/bundler/cli.rb, line 557 def platform require "bundler/cli/platform" Platform.new(options).run end
pristine(*gems)
click to toggle source
# File lib/bundler/cli.rb, line 635 def pristine(*gems) require "bundler/cli/pristine" Pristine.new(gems).run end
show(gem_name = nil)
click to toggle source
# File lib/bundler/cli.rb, line 277 def show(gem_name = nil) Bundler::SharedHelpers.major_deprecation(2, "use `bundle list` instead of `bundle show`") if ARGV[0] == "show" require "bundler/cli/show" Show.new(options, gem_name).run end
update(*gems)
click to toggle source
# File lib/bundler/cli.rb, line 263 def update(*gems) require "bundler/cli/update" Update.new(options, gems).run end
version()
click to toggle source
# File lib/bundler/cli.rb, line 459 def version cli_help = current_command.name == "cli_help" if cli_help || ARGV.include?("version") build_info = " (#{BuildMetadata.built_at} commit #{BuildMetadata.git_commit_sha})" end if !cli_help && Bundler.feature_flag.print_only_version_number? Bundler.ui.info "#{Bundler::VERSION}#{build_info}" else Bundler.ui.info "Bundler version #{Bundler::VERSION}#{build_info}" end end
viz()
click to toggle source
# File lib/bundler/cli.rb, line 498 def viz require "bundler/cli/viz" Viz.new(options.dup).run end
Private Instance Methods
auto_install()
click to toggle source
Automatically invoke `bundle install` and resume if Bundler.settings exists. This is set through config cmd `bundle config #auto_install 1`.
Note that this method `nil`s out the global Definition object, so it should be called first, before you instantiate anything like an `Installer` that'll keep a reference to the old one instead.
# File lib/bundler/cli.rb, line 679 def auto_install return unless Bundler.settings[:auto_install] begin Bundler.definition.specs rescue GemNotFound Bundler.ui.info "Automatically installing missing gems." Bundler.reset! invoke :install, [] Bundler.reset! end end
current_command()
click to toggle source
# File lib/bundler/cli.rb, line 692 def current_command _, _, config = @_initializer config[:current_command] end
gem(name)
click to toggle source
# File lib/bundler/cli.rb, line 515 def gem(name) end
print_command()
click to toggle source
# File lib/bundler/cli.rb, line 697 def print_command return unless Bundler.ui.debug? cmd = current_command command_name = cmd.name return if PARSEABLE_COMMANDS.include?(command_name) command = ["bundle", command_name] + args options_to_print = options.dup options_to_print.delete_if do |k, v| next unless o = cmd.options[k] o.default == v end command << Thor::Options.to_switches(options_to_print.sort_by(&:first)).strip command.reject!(&:empty?) Bundler.ui.info "Running `#{command * " "}` with bundler #{Bundler::VERSION}" end
warn_on_outdated_bundler()
click to toggle source
# File lib/bundler/cli.rb, line 713 def warn_on_outdated_bundler return if Bundler.settings[:disable_version_check] command_name = current_command.name return if PARSEABLE_COMMANDS.include?(command_name) latest = Fetcher::CompactIndex. new(nil, Source::Rubygems::Remote.new(URI("https://rubygems.org")), nil). send(:compact_index_client). instance_variable_get(:@cache). dependencies("bundler"). map {|d| Gem::Version.new(d.first) }. max return unless latest current = Gem::Version.new(VERSION) return if current >= latest latest_installed = Bundler.rubygems.find_name("bundler").map(&:version).max installation = "To install the latest version, run `gem install bundler#{" --pre" if latest.prerelease?}`" if latest_installed && latest_installed > current suggestion = "To update to the most recent installed version (#{latest_installed}), run `bundle update --bundler`" suggestion = "#{installation}\n#{suggestion}" if latest_installed < latest else suggestion = installation end Bundler.ui.warn "The latest bundler is #{latest}, but you are currently running #{current}.\n#{suggestion}" rescue nil end