Class: Bundler::CLI

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

Defined Under Namespace

Modules: Common Classes: Binstubs, Cache, Check, Clean, Config, Console, Doctor, Exec, Gem, Init, Inject, Install, Lock, Open, Outdated, Package, Platform, Plugin, 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, 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
# File 'lib/bundler/cli.rb', line 23

def initialize(*args)
  super
  Bundler.reset!

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

  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?
  Bundler.ui = UI::Shell.new(options)
  Bundler.ui.level = "debug" if options["verbose"]

  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



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.settings[: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



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'lib/bundler/cli.rb', line 493

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



416
417
418
# File 'lib/bundler/cli.rb', line 416

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

.startObject



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

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

Instance Method Details

#binstubs(*gems) ⇒ Object



260
261
262
263
# File 'lib/bundler/cli.rb', line 260

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

#cacheObject



292
293
294
295
# File 'lib/bundler/cli.rb', line 292

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



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

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

#config(*args) ⇒ Object



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

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

#console(group = nil) ⇒ Object



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

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

#doctorObject



480
481
482
483
# File 'lib/bundler/cli.rb', line 480

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

#envObject



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

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

#exec(*args) ⇒ Object



330
331
332
333
# File 'lib/bundler/cli.rb', line 330

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

#gem(name) ⇒ Object



411
412
413
414
# File 'lib/bundler/cli.rb', line 411

def gem(name)
  require "bundler/cli/gem"
  Gem.new(options, name, self).run
end

#help(cli = nil) ⇒ Object



60
61
62
63
64
65
66
67
68
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 60

def help(cli = nil)
  case cli
  when "gemfile" then command = "gemfile.5"
  when nil       then command = "bundle"
  else command = "bundle-#{cli}"
  end

  manpages = %w(
    bundle
    bundle-config
    bundle-exec
    bundle-gem
    bundle-install
    bundle-package
    bundle-update
    bundle-platform
    gemfile.5
  )

  if manpages.include?(command)
    root = File.expand_path("../man", __FILE__)

    if Bundler.which("man") && root !~ %r{^file:/.+!/META-INF/jruby.home/.+}
      Kernel.exec "man #{root}/#{command}"
    else
      puts File.read("#{root}/#{command}.txt")
    end
  elsif command_path = Bundler.which("bundler-#{cli}")
    Kernel.exec(command_path, "--help")
  else
    super
  end
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, *gems) ⇒ Object



439
440
441
442
443
# File 'lib/bundler/cli.rb', line 439

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

#installObject



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

def install
  require "bundler/cli/install"
  no_install = Bundler.settings[:no_install]
  Bundler.settings[:no_install] = false if no_install == true
  Install.new(options.dup).run
ensure
  Bundler.settings[:no_install] = no_install unless no_install.nil?
end

#licensesObject



372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/bundler/cli.rb', line 372

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



460
461
462
463
# File 'lib/bundler/cli.rb', line 460

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

#open(name) ⇒ Object



353
354
355
356
# File 'lib/bundler/cli.rb', line 353

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

#outdated(*gems) ⇒ Object



283
284
285
286
# File 'lib/bundler/cli.rb', line 283

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

#packageObject



316
317
318
319
# File 'lib/bundler/cli.rb', line 316

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

#platformObject



433
434
435
436
# File 'lib/bundler/cli.rb', line 433

def platform
  require "bundler/cli/platform"
  Platform.new(options).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



366
367
368
# File 'lib/bundler/cli.rb', line 366

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

#vizObject



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

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