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, Fund, Gem, Info, Init, Inject, Install, Issue, List, Lock, Open, Outdated, Platform, Plugin, Pristine, Remove, Show, Update, Viz

Constant Summary collapse

AUTO_INSTALL_CMDS = 
%w[show binstubs outdated exec open console licenses clean].freeze
PARSEABLE_COMMANDS = 
%w[check config help exec platform show version].freeze
EXTENSIONS = 
["c", "rust"].freeze
COMMAND_ALIASES = 
{
  "check" => "c",
  "install" => "i",
  "plugin" => "",
  "list" => "ls",
  "exec" => ["e", "ex", "exe"],
  "cache" => ["package", "pack"],
  "version" => ["-v", "--version"],
}.freeze

Constants included from Thor::Actions

Thor::Actions::WARNINGS

Constants inherited from Thor

Thor::AmbiguousTaskError, Thor::Correctable, 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, deprecation_warning, desc, disable_required_check!, disable_required_check?, help, long_desc, map, method_at_least_one, method_exclusive, 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.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/bundler/cli.rb', line 59

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_settings_and_root!
  end

  Bundler.auto_switch

  Bundler.settings.set_command_option_if_given :retry, options[:retry]

  current_cmd = args.last[:current_command].name
  Bundler.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) }
end

Class Method Details

.aliases_for(command_name) ⇒ Object 



55
56
57
 
# File 'lib/bundler/cli.rb', line 55

def self.aliases_for(command_name)
  COMMAND_ALIASES.select {|k, _| k == command_name }.invert
end

.all_aliases ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/bundler/cli.rb', line 41

def self.all_aliases
  @all_aliases ||= begin
                     command_aliases = {}

                     COMMAND_ALIASES.each do |name, aliases|
                       Array(aliases).each do |one_alias|
                         command_aliases[one_alias] = name
                       end
                     end

                     command_aliases
                   end
end

.check_deprecated_ext_option(arguments) ⇒ Object 



708
709
710
711
712
713
714
715
716
717
 
# File 'lib/bundler/cli.rb', line 708

def self.check_deprecated_ext_option(arguments)
  # when deprecated version of `--ext` is called
  # print out deprecation warning and pretend `--ext=c` was provided
  if deprecated_ext_value?(arguments)
    message = "Extensions can now be generated using C or Rust, so `--ext` with no arguments has been deprecated. Please select a language, e.g. `--ext=rust` to generate a Rust extension. This gem will now be generated as if `--ext=c` was used."
    removed_message = "Extensions can now be generated using C or Rust, so `--ext` with no arguments has been removed. Please select a language, e.g. `--ext=rust` to generate a Rust extension."
    SharedHelpers.major_deprecation 2, message, removed_message: removed_message
    arguments[arguments.index("--ext")] = "--ext=c"
  end
end

.deprecated_ext_value?(arguments) ⇒ Boolean

Returns:

  • (Boolean) 


719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/bundler/cli.rb', line 719

def self.deprecated_ext_value?(arguments)
  index = arguments.index("--ext")
  next_argument = arguments[index + 1]

  # it is ok when --ext is followed with valid extension value
  # for example `bundle gem hello --ext c`
  return false if EXTENSIONS.include?(next_argument)

  # deprecated call when --ext is called with no value in last position
  # for example `bundle gem hello_gem --ext`
  return true if next_argument.nil?

  # deprecated call when --ext is followed by other parameter
  # for example `bundle gem --ext --no-ci hello_gem`
  return true if next_argument.start_with?("-")

  # deprecated call when --ext is followed by gem name
  # for example `bundle gem --ext hello_gem`
  return true if next_argument

  false
end

.dispatch ⇒ Object 



34
35
36
37
38
39
 
# File 'lib/bundler/cli.rb', line 34

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 



145
146
147
148
149
150
151
152
153
 
# File 'lib/bundler/cli.rb', line 145

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



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/bundler/cli.rb', line 682

def self.reformatted_help_args(args)
  bundler_commands = (COMMAND_ALIASES.keys + COMMAND_ALIASES.values).flatten

  help_flags = %w[--help -h]
  exec_commands = ["exec"] + COMMAND_ALIASES["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 ⇒ Object 



588
589
590
 
# File 'lib/bundler/cli.rb', line 588

def self.source_root
  File.expand_path("templates", __dir__)
end

.start ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/bundler/cli.rb', line 26

def self.start(*)
  check_deprecated_ext_option(ARGV) if ARGV.include?("--ext")

  super
ensure
  Bundler::SharedHelpers.print_major_deprecations!
end

Instance Method Details

#add(*gems) ⇒ Object 



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

def add(*gems)
  require_relative "cli/add"
  Add.new(options.dup, gems).run
end

#binstubs(*gems) ⇒ Object 



335
336
337
338
 
# File 'lib/bundler/cli.rb', line 335

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

#cache ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/bundler/cli.rb', line 417

def cache
  print_remembered_flag_deprecation("--all", "cache_all", "true") if ARGV.include?("--all")

  if ARGV.include?("--path")
    message =
      "The `--path` flag is deprecated because its semantics are unclear. " \
      "Use `bundle config cache_path` to configure the path of your cache of gems, " \
      "and `bundle config path` to configure the path where your gems are installed, " \
      "and stop using this flag"
    removed_message =
      "The `--path` flag has been removed because its semantics were unclear. " \
      "Use `bundle config cache_path` to configure the path of your cache of gems, " \
      "and `bundle config path` to configure the path where your gems are installed."
    SharedHelpers.major_deprecation 2, message, removed_message: removed_message
  end

  require_relative "cli/cache"
  Cache.new(options).run
end

#check ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/bundler/cli.rb', line 177

def check
  remembered_flag_deprecation("path")

  require_relative "cli/check"
  Check.new(options).run
end

#clean ⇒ Object 



595
596
597
598
 
# File 'lib/bundler/cli.rb', line 595

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

#cli_help ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/bundler/cli.rb', line 88

def cli_help
  version
  Bundler.ui.info "\n"

  primary_commands = ["install", "update", "cache", "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

#console(group = nil) ⇒ Object 



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

def console(group = nil)
  require_relative "cli/console"
  Console.new(options, group).run
end

#doctor ⇒ Object 



650
651
652
653
 
# File 'lib/bundler/cli.rb', line 650

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

#env ⇒ Object 



638
639
640
 
# File 'lib/bundler/cli.rb', line 638

def env
  Env.write($stdout)
end

#exec(*args) ⇒ Object 



447
448
449
450
451
452
453
454
455
456
 
# File 'lib/bundler/cli.rb', line 447

def exec(*args)
  if ARGV.include?("--no-keep-file-descriptors")
    message = "The `--no-keep-file-descriptors` has been deprecated. `bundle exec` no longer mess with your file descriptors. Close them in the exec'd script if you need to"
    removed_message = "The `--no-keep-file-descriptors` has been removed. `bundle exec` no longer mess with your file descriptors. Close them in the exec'd script if you need to"
    SharedHelpers.major_deprecation(2, message, removed_message: removed_message)
  end

  require_relative "cli/exec"
  Exec.new(options, args).run
end

#fund ⇒ Object 



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

def fund
  require_relative "cli/fund"
  Fund.new(options).run
end

#help(cli = nil) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/bundler/cli.rb', line 117

def help(cli = nil)
  cli = self.class.all_aliases[cli] if self.class.all_aliases[cli]

  case cli
  when "gemfile" then command = "gemfile"
  when nil       then command = "bundle"
  else command = "bundle-#{cli}"
  end

  man_path = File.expand_path("man", __dir__)
  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)
    man_page = man_pages[command]
    if Bundler.which("man") && !man_path.match?(%r{^file:/.+!/META-INF/jruby.home/.+})
      Kernel.exec("man", man_page)
    else
      puts File.read("#{man_path}/#{File.basename(man_page)}.ronn")
    end
  elsif command_path = Bundler.which("bundler-#{cli}")
    Kernel.exec(command_path, "--help")
  else
    super
  end
end

#info(gem_name) ⇒ Object 



318
319
320
321
 
# File 'lib/bundler/cli.rb', line 318

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

#init ⇒ Object 



163
164
165
166
 
# File 'lib/bundler/cli.rb', line 163

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

#inject(name, version) ⇒ Object 



610
611
612
613
614
 
# File 'lib/bundler/cli.rb', line 610

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

#install ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/bundler/cli.rb', line 234

def install
  SharedHelpers.major_deprecation(2, "The `--force` option has been renamed to `--redownload`") if ARGV.include?("--force")

  %w[clean deployment frozen no-prune path shebang without with].each do |option|
    remembered_flag_deprecation(option)
  end

  print_remembered_flag_deprecation("--system", "path.system", "true") if ARGV.include?("--system")

  remembered_negative_flag_deprecation("no-deployment")

  require_relative "cli/install"
  Bundler.settings.temporary(no_install: false) do
    Install.new(options.dup).run
  end
end

#issue ⇒ Object 



656
657
658
659
 
# File 'lib/bundler/cli.rb', line 656

def issue
  require_relative "cli/issue"
  Issue.new.run
end

#licenses ⇒ Object 



507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/bundler/cli.rb', line 507

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



308
309
310
311
 
# File 'lib/bundler/cli.rb', line 308

def list
  require_relative "cli/list"
  List.new(options).run
end

#lock ⇒ Object 



632
633
634
635
 
# File 'lib/bundler/cli.rb', line 632

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

#open(name) ⇒ Object 



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

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

#outdated(*gems) ⇒ Object 



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

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

#platform ⇒ Object 



602
603
604
605
 
# File 'lib/bundler/cli.rb', line 602

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

#pristine(*gems) ⇒ Object 



667
668
669
670
671
672
 
# File 'lib/bundler/cli.rb', line 667

def pristine(*gems)
  require_relative "cli/pristine"
  Bundler.settings.temporary(no_install: false) do
    Pristine.new(gems).run
  end
end

#remove(*gems) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/bundler/cli.rb', line 191

def remove(*gems)
  if ARGV.include?("--install")
    message = "The `--install` flag has been deprecated. `bundle install` is triggered by default."
    removed_message = "The `--install` flag has been removed. `bundle install` is triggered by default."
    SharedHelpers.major_deprecation(2, message, removed_message: removed_message)
  end

  require_relative "cli/remove"
  Remove.new(gems, options).run
end

#show(gem_name = nil) ⇒ Object 



293
294
295
296
297
298
299
300
301
 
# File 'lib/bundler/cli.rb', line 293

def show(gem_name = nil)
  if ARGV.include?("--outdated")
    message = "the `--outdated` flag to `bundle show` was undocumented and will be removed without replacement"
    removed_message = "the `--outdated` flag to `bundle show` was undocumented and has been removed without replacement"
    SharedHelpers.major_deprecation(2, message, removed_message: removed_message)
  end
  require_relative "cli/show"
  Show.new(options, gem_name).run
end

#update(*gems) ⇒ Object 



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

def update(*gems)
  SharedHelpers.major_deprecation(2, "The `--force` option has been renamed to `--redownload`") if ARGV.include?("--force")
  require_relative "cli/update"
  Bundler.settings.temporary(no_install: false) do
    Update.new(options, gems).run
  end
end

#version ⇒ Object 



491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/bundler/cli.rb', line 491

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



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

def viz
  SharedHelpers.major_deprecation 2, "The `viz` command has been renamed to `graph` and moved to a plugin. See https://github.com/rubygems/bundler-graph"
  require_relative "cli/viz"
  Viz.new(options.dup).run
end