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
PARSEABLE_COMMANDS =
%w(
  check config help exec platform show version
).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, #inject_into_module, #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_required_check!, disable_required_check?, 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



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
54
55
56
57
58
# File 'lib/bundler/cli.rb', line 28

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



21
22
23
24
25
26
# File 'lib/bundler/cli.rb', line 21

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



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

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



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

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



469
470
471
# File 'lib/bundler/cli.rb', line 469

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

.startObject



12
13
14
15
16
17
18
19
# File 'lib/bundler/cli.rb', line 12

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

Instance Method Details

#add(gem_name) ⇒ Object



280
281
282
283
# File 'lib/bundler/cli.rb', line 280

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

#binstubs(*gems) ⇒ Object



267
268
269
270
# File 'lib/bundler/cli.rb', line 267

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

#cacheObject



322
323
324
325
# File 'lib/bundler/cli.rb', line 322

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

#checkObject



129
130
131
132
# File 'lib/bundler/cli.rb', line 129

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

#cleanObject



478
479
480
481
# File 'lib/bundler/cli.rb', line 478

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

#config(*args) ⇒ Object



378
379
380
381
# File 'lib/bundler/cli.rb', line 378

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

#console(group = nil) ⇒ Object



390
391
392
393
394
# File 'lib/bundler/cli.rb', line 390

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

#doctorObject



547
548
549
550
# File 'lib/bundler/cli.rb', line 547

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

#envObject



533
534
535
# File 'lib/bundler/cli.rb', line 533

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

#exec(*args) ⇒ Object



360
361
362
363
# File 'lib/bundler/cli.rb', line 360

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

#help(cli = nil) ⇒ Object



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/bundler/cli.rb', line 69

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



250
251
252
253
# File 'lib/bundler/cli.rb', line 250

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

#initObject



111
112
113
114
# File 'lib/bundler/cli.rb', line 111

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

#inject(name, version) ⇒ Object



496
497
498
499
500
# File 'lib/bundler/cli.rb', line 496

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



185
186
187
188
189
190
# File 'lib/bundler/cli.rb', line 185

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

#issueObject



553
554
555
556
# File 'lib/bundler/cli.rb', line 553

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

#licensesObject



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

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



527
528
529
530
# File 'lib/bundler/cli.rb', line 527

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

#open(name) ⇒ Object



384
385
386
387
# File 'lib/bundler/cli.rb', line 384

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

#outdated(*gems) ⇒ Object



313
314
315
316
# File 'lib/bundler/cli.rb', line 313

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

#packageObject



346
347
348
349
# File 'lib/bundler/cli.rb', line 346

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

#platformObject



486
487
488
489
# File 'lib/bundler/cli.rb', line 486

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

#pristineObject



559
560
561
562
# File 'lib/bundler/cli.rb', line 559

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

#show(gem_name = nil) ⇒ Object



240
241
242
243
244
# File 'lib/bundler/cli.rb', line 240

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



226
227
228
229
# File 'lib/bundler/cli.rb', line 226

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

#versionObject



397
398
399
# File 'lib/bundler/cli.rb', line 397

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

#vizObject



427
428
429
430
# File 'lib/bundler/cli.rb', line 427

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