class Bundler::CLI::Install

Attributes

options[R]

Public Class Methods

new(options) click to toggle source
# File bundler/cli/install.rb, line 6
def initialize(options)
  @options = options
end

Public Instance Methods

run() click to toggle source
# File bundler/cli/install.rb, line 10
def run
  Bundler.ui.level = "warn" if options[:quiet]

  warn_if_root

  Bundler.self_manager.install_locked_bundler_and_restart_with_it_if_needed

  Bundler::SharedHelpers.set_env "RB_USER_INSTALL", "1" if Gem.freebsd_platform?

  # Disable color in deployment mode
  Bundler.ui.shell = Thor::Shell::Basic.new if options[:deployment]

  check_for_options_conflicts

  check_trust_policy

  if options[:deployment] || options[:frozen] || Bundler.frozen_bundle?
    unless Bundler.default_lockfile.exist?
      flag   = "--deployment flag" if options[:deployment]
      flag ||= "--frozen flag"     if options[:frozen]
      flag ||= "deployment setting"
      raise ProductionError, "The #{flag} requires a lockfile. Please make " \
                             "sure you have checked your #{SharedHelpers.relative_lockfile_path} into version control " \
                             "before deploying."
    end

    options[:local] = true if Bundler.app_cache.exist?

    Bundler.settings.set_command_option :deployment, true if options[:deployment]
    Bundler.settings.set_command_option :frozen, true if options[:frozen]
  end

  # When install is called with --no-deployment, disable deployment mode
  if options[:deployment] == false
    Bundler.settings.set_command_option :frozen, nil
    options[:system] = true
  end

  normalize_settings

  Bundler::Fetcher.disable_endpoint = options["full-index"]

  if options["binstubs"]
    Bundler::SharedHelpers.major_deprecation 2,
      "The --binstubs option will be removed in favor of `bundle binstubs --all`",
      removed_message: "The --binstubs option have been removed in favor of `bundle binstubs --all`"
  end

  Plugin.gemfile_install(Bundler.default_gemfile) if Bundler.feature_flag.plugins?

  definition = Bundler.definition
  definition.validate_runtime!

  installer = Installer.install(Bundler.root, definition, options)

  Bundler.settings.temporary(cache_all_platforms: options[:local] ? false : Bundler.settings[:cache_all_platforms]) do
    Bundler.load.cache(nil, options[:local]) if Bundler.app_cache.exist? && !options["no-cache"] && !Bundler.frozen_bundle?
  end

  Bundler.ui.confirm "Bundle complete! #{dependencies_count_for(definition)}, #{gems_installed_for(definition)}."
  Bundler::CLI::Common.output_without_groups_message(:install)

  if Bundler.use_system_gems?
    Bundler.ui.confirm "Use `bundle info [gemname]` to see where a bundled gem is installed."
  else
    relative_path = Bundler.configured_bundle_path.base_path_relative_to_pwd
    Bundler.ui.confirm "Bundled gems are installed into `#{relative_path}`"
  end

  Bundler::CLI::Common.output_post_install_messages installer.post_install_messages

  warn_ambiguous_gems

  if CLI::Common.clean_after_install?
    require_relative "clean"
    Bundler::CLI::Clean.new(options).run
  end

  Bundler::CLI::Common.output_fund_metadata_summary
rescue Gem::InvalidSpecificationException
  Bundler.ui.warn "You have one or more invalid gemspecs that need to be fixed."
  raise
end

Private Instance Methods

check_for_group_conflicts_in_cli_options() click to toggle source
# File bundler/cli/install.rb, line 112
def check_for_group_conflicts_in_cli_options
  conflicting_groups = Array(options[:without]) & Array(options[:with])
  return if conflicting_groups.empty?
  raise InvalidOption, "You can't list a group in both with and without." \
    " The offending groups are: #{conflicting_groups.join(", ")}."
end
check_for_options_conflicts() click to toggle source
# File bundler/cli/install.rb, line 119
def check_for_options_conflicts
  if (options[:path] || options[:deployment]) && options[:system]
    error_message = String.new
    error_message << "You have specified both --path as well as --system. Please choose only one option.\n" if options[:path]
    error_message << "You have specified both --deployment as well as --system. Please choose only one option.\n" if options[:deployment]
    raise InvalidOption.new(error_message)
  end
end
check_trust_policy() click to toggle source
# File bundler/cli/install.rb, line 128
def check_trust_policy
  trust_policy = options["trust-policy"]
  unless Bundler.rubygems.security_policies.keys.unshift(nil).include?(trust_policy)
    raise InvalidOption, "RubyGems doesn't know about trust policy '#{trust_policy}'. " \
      "The known policies are: #{Bundler.rubygems.security_policies.keys.join(", ")}."
  end
  Bundler.settings.set_command_option_if_given :"trust-policy", trust_policy
end
dependencies_count_for(definition) click to toggle source
# File bundler/cli/install.rb, line 102
def dependencies_count_for(definition)
  count = definition.dependencies.count
  "#{count} Gemfile #{count == 1 ? "dependency" : "dependencies"}"
end
gems_installed_for(definition) click to toggle source
# File bundler/cli/install.rb, line 107
def gems_installed_for(definition)
  count = definition.specs.count
  "#{count} #{count == 1 ? "gem" : "gems"} now installed"
end
normalize_groups() click to toggle source
# File bundler/cli/install.rb, line 137
def normalize_groups
  check_for_group_conflicts_in_cli_options

  # need to nil them out first to get around validation for backwards compatibility
  Bundler.settings.set_command_option :without, nil
  Bundler.settings.set_command_option :with,    nil
  Bundler.settings.set_command_option :without, options[:without]
  Bundler.settings.set_command_option :with,    options[:with]
end
normalize_settings() click to toggle source
# File bundler/cli/install.rb, line 147
def normalize_settings
  Bundler.settings.set_command_option :path, nil if options[:system]
  Bundler.settings.set_command_option_if_given :path, options[:path]

  if options["standalone"] && Bundler.settings[:path].nil? && !options["local"]
    Bundler.settings.temporary(path_relative_to_cwd: false) do
      Bundler.settings.set_command_option :path, "bundle"
    end
  end

  bin_option = options["binstubs"]
  bin_option = nil if bin_option&.empty?
  Bundler.settings.set_command_option :bin, bin_option if options["binstubs"]

  Bundler.settings.set_command_option_if_given :shebang, options["shebang"]

  Bundler.settings.set_command_option_if_given :jobs, options["jobs"]

  Bundler.settings.set_command_option_if_given :no_prune, options["no-prune"]

  Bundler.settings.set_command_option_if_given :no_install, options["no-install"]

  Bundler.settings.set_command_option_if_given :clean, options["clean"]

  normalize_groups if options[:without] || options[:with]

  options[:force] = options[:redownload]
end
warn_ambiguous_gems() click to toggle source
# File bundler/cli/install.rb, line 176
def warn_ambiguous_gems
  # TODO: remove this when we drop Bundler 1.x support
  Installer.ambiguous_gems.to_a.each do |name, installed_from_uri, *also_found_in_uris|
    Bundler.ui.warn "Warning: the gem '#{name}' was found in multiple sources."
    Bundler.ui.warn "Installed from: #{installed_from_uri}"
    Bundler.ui.warn "Also found in:"
    also_found_in_uris.each {|uri| Bundler.ui.warn "  * #{uri}" }
    Bundler.ui.warn "You should add a source requirement to restrict this gem to your preferred source."
    Bundler.ui.warn "For example:"
    Bundler.ui.warn "    gem '#{name}', :source => '#{installed_from_uri}'"
    Bundler.ui.warn "Then uninstall the gem '#{name}' (or delete all bundled gems) and then install again."
  end
end
warn_if_root() click to toggle source
# File bundler/cli/install.rb, line 96
def warn_if_root
  return if Bundler.settings[:silence_root_warning] || Gem.win_platform? || !Process.uid.zero?
  Bundler.ui.warn "Don't run Bundler as root. Installing your bundle as root " \
                  "will break this application for all non-root users on this machine.", wrap: true
end