Class: Bundler::CLI

Inherits:
Thor
  • Object
show all
Includes:
Thor::Actions
Defined in:
lib/bundler/cli.rb,
lib/bundler/cli/gem.rb

Defined Under Namespace

Modules: Common Classes: Add, Binstubs, Cache, Check, Clean, Config, Console, Doctor, Exec, Gem, Info, Init, Inject, Install, Issue, Lock, Open, Outdated, Package, Platform, Plugin, Pristine, Show, Update, Viz

Constant Summary

AUTO_INSTALL_CMDS =
%w(show binstubs outdated exec open console licenses clean).freeze

Constants inherited from Thor

Thor::AmbiguousTaskError, Thor::DynamicTask, Thor::HELP_MAPPINGS, Thor::HiddenTask, Thor::TEMPLATE_EXTNAME, Thor::THOR_RESERVED_WORDS, Thor::Task, Thor::UndefinedTaskError, Thor::VERSION

Instance Attribute Summary

Attributes included from Thor::Actions

#behavior

Attributes included from Thor::Base

#args, #options, #parent_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Thor::Actions

#action, #append_to_file, #apply, #chmod, #comment_lines, #copy_file, #create_file, #create_link, #destination_root, #destination_root=, #directory, #empty_directory, #find_in_source_paths, #get, #gsub_file, #in_root, included, #inject_into_class, #insert_into_file, #inside, #link_file, #prepend_to_file, #relative_to_original_destination_root, #remove_file, #run, #run_ruby_script, #source_paths, #template, #thor, #uncomment_lines

Methods inherited from Thor

check_unknown_options!, check_unknown_options?, command_help, default_command, desc, disable_class_options, help, long_desc, map, method_option, method_options, package_name, printable_commands, register, stop_on_unknown_option!, stop_on_unknown_option?, subcommand, subcommand_classes, subcommands

Methods included from Thor::Base

included, register_klass_file, subclass_files, subclasses

Constructor Details

#initialize(*args) ⇒ CLI

Returns a new instance of CLI



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/bundler/cli.rb', line 23

def initialize(*args)
  super

  custom_gemfile = options[:gemfile] || Bundler.settings[:gemfile]
  if custom_gemfile && !custom_gemfile.empty?
    ENV["BUNDLE_GEMFILE"] = File.expand_path(custom_gemfile)
    Bundler.reset_paths!
  end

  Bundler.settings[:retry] = options[:retry] if 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 ||= {}
  Bundler.settings.cli_flags_given = !options.empty?
  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

Class Method Details

.dispatchObject



19
20
21
# File 'lib/bundler/cli.rb', line 19

def self.dispatch(*)
  super {|i| i.send(:print_command) }
end

.handle_no_command_error(command, has_namespace = $thor_runner) ⇒ Object



92
93
94
95
96
97
98
99
100
# File 'lib/bundler/cli.rb', line 92

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

.reformatted_help_args(args) ⇒ Object

Reformat the arguments passed to bundle that include a –help flag into the corresponding `bundle help #command` call



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'lib/bundler/cli.rb', line 570

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_rootObject



467
468
469
# File 'lib/bundler/cli.rb', line 467

def self.source_root
  File.expand_path(File.join(File.dirname(__FILE__), "templates"))
end

.startObject



9
10
11
12
13
14
15
16
17
# File 'lib/bundler/cli.rb', line 9

def self.start(*)
  super
rescue Exception => e
  Bundler.ui = UI::Shell.new
  raise e
ensure
  warn_on_outdated_bundler
  Bundler::SharedHelpers.print_major_deprecations!
end

Instance Method Details

#add(gem_name) ⇒ Object



278
279
280
281
# File 'lib/bundler/cli.rb', line 278

def add(gem_name)
  require "bundler/cli/add"
  Add.new(options.dup, gem_name).run
end

#binstubs(*gems) ⇒ Object



265
266
267
268
# File 'lib/bundler/cli.rb', line 265

def binstubs(*gems)
  require "bundler/cli/binstubs"
  Binstubs.new(options, gems).run
end

#cacheObject



320
321
322
323
# File 'lib/bundler/cli.rb', line 320

def cache
  require "bundler/cli/cache"
  Cache.new(options).run
end

#checkObject



127
128
129
130
# File 'lib/bundler/cli.rb', line 127

def check
  require "bundler/cli/check"
  Check.new(options).run
end

#cleanObject



476
477
478
479
# File 'lib/bundler/cli.rb', line 476

def clean
  require "bundler/cli/clean"
  Clean.new(options.dup).run
end

#config(*args) ⇒ Object



376
377
378
379
# File 'lib/bundler/cli.rb', line 376

def config(*args)
  require "bundler/cli/config"
  Config.new(options, args, self).run
end

#console(group = nil) ⇒ Object



388
389
390
391
392
# File 'lib/bundler/cli.rb', line 388

def console(group = nil)
  # TODO: Remove for 2.0
  require "bundler/cli/console"
  Console.new(options, group).run
end

#doctorObject



545
546
547
548
# File 'lib/bundler/cli.rb', line 545

def doctor
  require "bundler/cli/doctor"
  Doctor.new(options).run
end

#envObject



531
532
533
# File 'lib/bundler/cli.rb', line 531

def env
  Env.new.write($stdout)
end

#exec(*args) ⇒ Object



358
359
360
361
# File 'lib/bundler/cli.rb', line 358

def exec(*args)
  require "bundler/cli/exec"
  Exec.new(options, args).run
end

#help(cli = nil) ⇒ Object



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/bundler/cli.rb', line 64

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) ⇒ Object



248
249
250
251
# File 'lib/bundler/cli.rb', line 248

def info(gem_name)
  require "bundler/cli/info"
  Info.new(options, gem_name).run
end

#initObject



109
110
111
112
# File 'lib/bundler/cli.rb', line 109

def init
  require "bundler/cli/init"
  Init.new(options.dup).run
end

#inject(name, version) ⇒ Object



494
495
496
497
498
# File 'lib/bundler/cli.rb', line 494

def inject(name, version)
  SharedHelpers.major_deprecation "The `inject` command has been replaced by the `add` command"
  require "bundler/cli/inject"
  Inject.new(options.dup, name, version).run
end

#installObject



183
184
185
186
187
188
# File 'lib/bundler/cli.rb', line 183

def install
  require "bundler/cli/install"
  Bundler.settings.temporary(:no_install => false) do
    Install.new(options.dup).run
  end
end

#issueObject



551
552
553
554
# File 'lib/bundler/cli.rb', line 551

def issue
  require "bundler/cli/issue"
  Issue.new.run
end

#licensesObject



401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/bundler/cli.rb', line 401

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

#lockObject



525
526
527
528
# File 'lib/bundler/cli.rb', line 525

def lock
  require "bundler/cli/lock"
  Lock.new(options).run
end

#open(name) ⇒ Object



382
383
384
385
# File 'lib/bundler/cli.rb', line 382

def open(name)
  require "bundler/cli/open"
  Open.new(options, name).run
end

#outdated(*gems) ⇒ Object



311
312
313
314
# File 'lib/bundler/cli.rb', line 311

def outdated(*gems)
  require "bundler/cli/outdated"
  Outdated.new(options, gems).run
end

#packageObject



344
345
346
347
# File 'lib/bundler/cli.rb', line 344

def package
  require "bundler/cli/package"
  Package.new(options).run
end

#platformObject



484
485
486
487
# File 'lib/bundler/cli.rb', line 484

def platform
  require "bundler/cli/platform"
  Platform.new(options).run
end

#pristineObject



557
558
559
560
# File 'lib/bundler/cli.rb', line 557

def pristine
  require "bundler/cli/pristine"
  Pristine.new.run
end

#show(gem_name = nil) ⇒ Object



238
239
240
241
242
# File 'lib/bundler/cli.rb', line 238

def show(gem_name = nil)
  Bundler::SharedHelpers.major_deprecation("use `bundle show` instead of `bundle list`") if ARGV[0] == "list"
  require "bundler/cli/show"
  Show.new(options, gem_name).run
end

#update(*gems) ⇒ Object



224
225
226
227
# File 'lib/bundler/cli.rb', line 224

def update(*gems)
  require "bundler/cli/update"
  Update.new(options, gems).run
end

#versionObject



395
396
397
# File 'lib/bundler/cli.rb', line 395

def version
  Bundler.ui.info "Bundler version #{Bundler::VERSION}"
end

#vizObject



425
426
427
428
# File 'lib/bundler/cli.rb', line 425

def viz
  require "bundler/cli/viz"
  Viz.new(options.dup).run
end