Class: Bundler::CLI

Inherits:

Thor

Object
Thor
Bundler::CLI

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

COMMAND_ALIASES =

{
  "check" => "c",
  "install" => "i",
  "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

.aliases_for(command_name) ⇒ Object
.all_aliases ⇒ Object
.dispatch ⇒ Object
.handle_no_command_error(command, has_namespace = $thor_runner) ⇒ Object
.reformatted_help_args(args) ⇒ Object

Reformat the arguments passed to bundle that include a –help flag into the corresponding ‘bundle help #command` call.
.source_root ⇒ Object
.start ⇒ Object

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ `CLI`

Returns a new instance of CLI.

# File 'lib/bundler/cli.rb', line 54

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.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

Class Method Details

.aliases_for(command_name) ⇒ `Object`



50
51
52

# File 'lib/bundler/cli.rb', line 50

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

.all_aliases ⇒ `Object`

# File 'lib/bundler/cli.rb', line 36

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

.dispatch ⇒ `Object`

# File 'lib/bundler/cli.rb', line 29

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`

# File 'lib/bundler/cli.rb', line 144

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

# File 'lib/bundler/cli.rb', line 729

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 }
  command = all_aliases[command] if all_aliases[command]

  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`



619
620
621

# File 'lib/bundler/cli.rb', line 619

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

.start ⇒ `Object`

# File 'lib/bundler/cli.rb', line 23

def self.start(*)
  super
ensure
  Bundler::SharedHelpers.print_major_deprecations!
end

Instance Method Details

#add(*gems) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 401

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

#binstubs(*gems) ⇒ `Object`

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

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

#cache ⇒ `Object`

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

def cache
  SharedHelpers.major_deprecation 2,
    "The `--all` flag is deprecated because it relies on being " \
    "remembered across bundler invocations, which bundler will no longer " \
    "do in future versions. Instead please use `bundle config set cache_all true`, " \
    "and stop using this flag" if ARGV.include?("--all")

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

#check ⇒ `Object`

# File 'lib/bundler/cli.rb', line 178

def check
  remembered_flag_deprecation("path")

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

#clean ⇒ `Object`

# File 'lib/bundler/cli.rb', line 628

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

#cli_help ⇒ `Object`

# File 'lib/bundler/cli.rb', line 89

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`

# File 'lib/bundler/cli.rb', line 522

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

#doctor ⇒ `Object`

# File 'lib/bundler/cli.rb', line 699

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

#env ⇒ `Object`



685
686
687

# File 'lib/bundler/cli.rb', line 685

def env
  Env.write($stdout)
end

#exec(*args) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 492

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

#fund ⇒ `Object`

# File 'lib/bundler/cli.rb', line 445

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

#help(cli = nil) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 118

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", __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 !~ %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`

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

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

#init ⇒ `Object`

# File 'lib/bundler/cli.rb', line 161

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

#inject(name, version) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 646

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`

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

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 system without with].each do |option|
    remembered_flag_deprecation(option)
  end

  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`

# File 'lib/bundler/cli.rb', line 705

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

#licenses ⇒ `Object`

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

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`

# File 'lib/bundler/cli.rb', line 351

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

#lock ⇒ `Object`

# File 'lib/bundler/cli.rb', line 679

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

#open(name) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 515

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

#outdated(*gems) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 437

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

#platform ⇒ `Object`

# File 'lib/bundler/cli.rb', line 636

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

#pristine(*gems) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 716

def pristine(*gems)
  require_relative "cli/pristine"
  Pristine.new(gems).run
end

#remove(*gems) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 193

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

#show(gem_name = nil) ⇒ `Object`

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

def show(gem_name = nil)
  if ARGV[0] == "show"
    rest = ARGV[1..-1]

    if flag = rest.find{|arg| ["--verbose", "--outdated"].include?(arg) }
      Bundler::SharedHelpers.major_deprecation(2, "the `#{flag}` flag to `bundle show` was undocumented and will be removed without replacement")
    else
      new_command = rest.find {|arg| !arg.start_with?("--") } ? "info" : "list"

      new_arguments = rest.map do |arg|
        next arg if arg != "--paths"
        next "--path" if new_command == "info"
      end

      old_argv = ARGV.join(" ")
      new_argv = [new_command, *new_arguments.compact].join(" ")

      Bundler::SharedHelpers.major_deprecation(2, "use `bundle #{new_argv}` instead of `bundle #{old_argv}`")
    end
  end
  require_relative "cli/show"
  Show.new(options, gem_name).run
end

#update(*gems) ⇒ `Object`

# File 'lib/bundler/cli.rb', line 303

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`

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

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`

# File 'lib/bundler/cli.rb', line 570

def viz
  SharedHelpers.major_deprecation 2, "The `viz` command has been moved to the `bundle-viz` gem, see https://github.com/bundler/bundler-viz"
  require_relative "cli/viz"
  Viz.new(options.dup).run
end

Class: Bundler::CLI

Defined Under Namespace

Constant Summary collapse

Constants included from Thor::Actions

Constants inherited from Thor

Instance Attribute Summary

Attributes included from Thor::Actions

Attributes included from Thor::Base

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Thor::Actions

Methods inherited from Thor

Methods included from Thor::Base

Constructor Details

#initialize(*args) ⇒ CLI

Class Method Details

.aliases_for(command_name) ⇒ Object

.all_aliases ⇒ Object

.dispatch ⇒ Object

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

.reformatted_help_args(args) ⇒ Object

.source_root ⇒ Object

.start ⇒ Object

Instance Method Details

#add(*gems) ⇒ Object

#binstubs(*gems) ⇒ Object

#cache ⇒ Object

#check ⇒ Object

#clean ⇒ Object

#cli_help ⇒ Object

#console(group = nil) ⇒ Object

#doctor ⇒ Object

#env ⇒ Object

#exec(*args) ⇒ Object

#fund ⇒ Object

#help(cli = nil) ⇒ Object

#info(gem_name) ⇒ Object

#init ⇒ Object

#inject(name, version) ⇒ Object

#install ⇒ Object

#issue ⇒ Object

#licenses ⇒ Object

#list ⇒ Object

#lock ⇒ Object

#open(name) ⇒ Object

#outdated(*gems) ⇒ Object

#platform ⇒ Object

#pristine(*gems) ⇒ Object

#remove(*gems) ⇒ Object

#show(gem_name = nil) ⇒ Object

#update(*gems) ⇒ Object

#version ⇒ Object

#viz ⇒ Object