module Bundler::CLI::Common

Public Class Methods

ask_for_spec_from(specs) click to toggle source
# File lib/bundler/cli/common.rb, line 51
def self.ask_for_spec_from(specs)
  if !$stdout.tty? && ENV["BUNDLE_SPEC_RUN"].nil?
    raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
  end

  specs.each_with_index do |spec, index|
    Bundler.ui.info "#{index.succ} : #{spec.name}", true
  end
  Bundler.ui.info "0 : - exit -", true

  num = Bundler.ui.ask("> ").to_i
  num > 0 ? specs[num - 1] : nil
end
clean_after_install?() click to toggle source
# File lib/bundler/cli/common.rb, line 94
def self.clean_after_install?
  clean = Bundler.settings[:clean]
  return clean unless clean.nil?
  clean ||= Bundler.feature_flag.auto_clean_without_path? && Bundler.settings[:path].nil?
  clean &&= !Bundler.use_system_gems?
  clean
end
configure_gem_version_promoter(definition, options) click to toggle source
# File lib/bundler/cli/common.rb, line 81
def self.configure_gem_version_promoter(definition, options)
  patch_level = patch_level_options(options)
  raise InvalidOption, "Provide only one of the following options: #{patch_level.join(", ")}" unless patch_level.length <= 1
  definition.gem_version_promoter.tap do |gvp|
    gvp.level = patch_level.first || :major
    gvp.strict = options[:strict] || options["update-strict"]
  end
end
ensure_all_gems_in_lockfile!(names, locked_gems = Bundler.locked_gems) click to toggle source
# File lib/bundler/cli/common.rb, line 74
def self.ensure_all_gems_in_lockfile!(names, locked_gems = Bundler.locked_gems)
  locked_names = locked_gems.specs.map(&:name)
  names.-(locked_names).each do |g|
    raise GemNotFound, gem_not_found_message(g, locked_names)
  end
end
gem_not_found_message(missing_gem_name, alternatives) click to toggle source
# File lib/bundler/cli/common.rb, line 65
def self.gem_not_found_message(missing_gem_name, alternatives)
  require "bundler/similarity_detector"
  message = "Could not find gem '#{missing_gem_name}'."
  alternate_names = alternatives.map {|a| a.respond_to?(:name) ? a.name : a }
  suggestions = SimilarityDetector.new(alternate_names).similar_word_list(missing_gem_name)
  message += "\nDid you mean #{suggestions}?" if suggestions
  message
end
output_post_install_messages(messages) click to toggle source
# File lib/bundler/cli/common.rb, line 5
    def self.output_post_install_messages(messages)
      return if Bundler.settings["ignore_messages"]
      messages.to_a.each do |name, msg|
        print_post_install_message(name, msg) unless Bundler.settings["ignore_messages.#{name}"]
      end
    end

    def self.print_post_install_message(name, msg)
      Bundler.ui.confirm "Post-install message from #{name}:"
      Bundler.ui.info msg
    end

    def self.output_without_groups_message
      return if Bundler.settings[:without].empty?
      Bundler.ui.confirm without_groups_message
    end

    def self.without_groups_message
      groups = Bundler.settings[:without]
      group_list = [groups[0...-1].join(", "), groups[-1..-1]].
        reject {|s| s.to_s.empty? }.join(" and ")
      group_str = (groups.size == 1) ? "group" : "groups"
      "Gems in the #{group_str} #{group_list} were not installed."
    end

    def self.select_spec(name, regex_match = nil)
      specs = []
      regexp = Regexp.new(name) if regex_match

      Bundler.definition.specs.each do |spec|
        return spec if spec.name == name
        specs << spec if regexp && spec.name =~ regexp
      end

      case specs.count
      when 0
        raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
      when 1
        specs.first
      else
        ask_for_spec_from(specs)
      end
    rescue RegexpError
      raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
    end

    def self.ask_for_spec_from(specs)
      if !$stdout.tty? && ENV["BUNDLE_SPEC_RUN"].nil?
        raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
      end

      specs.each_with_index do |spec, index|
        Bundler.ui.info "#{index.succ} : #{spec.name}", true
      end
      Bundler.ui.info "0 : - exit -", true

      num = Bundler.ui.ask("> ").to_i
      num > 0 ? specs[num - 1] : nil
    end

    def self.gem_not_found_message(missing_gem_name, alternatives)
      require "bundler/similarity_detector"
      message = "Could not find gem '#{missing_gem_name}'."
      alternate_names = alternatives.map {|a| a.respond_to?(:name) ? a.name : a }
      suggestions = SimilarityDetector.new(alternate_names).similar_word_list(missing_gem_name)
      message += "\nDid you mean #{suggestions}?" if suggestions
      message
    end

    def self.ensure_all_gems_in_lockfile!(names, locked_gems = Bundler.locked_gems)
      locked_names = locked_gems.specs.map(&:name)
      names.-(locked_names).each do |g|
        raise GemNotFound, gem_not_found_message(g, locked_names)
      end
    end

    def self.configure_gem_version_promoter(definition, options)
      patch_level = patch_level_options(options)
      raise InvalidOption, "Provide only one of the following options: #{patch_level.join(", ")}" unless patch_level.length <= 1
      definition.gem_version_promoter.tap do |gvp|
        gvp.level = patch_level.first || :major
        gvp.strict = options[:strict] || options["update-strict"]
      end
    end

    def self.patch_level_options(options)
      [:major, :minor, :patch].select {|v| options.keys.include?(v.to_s) }
    end

    def self.clean_after_install?
      clean = Bundler.settings[:clean]
      return clean unless clean.nil?
      clean ||= Bundler.feature_flag.auto_clean_without_path? && Bundler.settings[:path].nil?
      clean &&= !Bundler.use_system_gems?
      clean
    end
  end
end
output_without_groups_message() click to toggle source
# File lib/bundler/cli/common.rb, line 17
  def self.output_without_groups_message
    return if Bundler.settings[:without].empty?
    Bundler.ui.confirm without_groups_message
  end

  def self.without_groups_message
    groups = Bundler.settings[:without]
    group_list = [groups[0...-1].join(", "), groups[-1..-1]].
      reject {|s| s.to_s.empty? }.join(" and ")
    group_str = (groups.size == 1) ? "group" : "groups"
    "Gems in the #{group_str} #{group_list} were not installed."
  end

  def self.select_spec(name, regex_match = nil)
    specs = []
    regexp = Regexp.new(name) if regex_match

    Bundler.definition.specs.each do |spec|
      return spec if spec.name == name
      specs << spec if regexp && spec.name =~ regexp
    end

    case specs.count
    when 0
      raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
    when 1
      specs.first
    else
      ask_for_spec_from(specs)
    end
  rescue RegexpError
    raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
  end

  def self.ask_for_spec_from(specs)
    if !$stdout.tty? && ENV["BUNDLE_SPEC_RUN"].nil?
      raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
    end

    specs.each_with_index do |spec, index|
      Bundler.ui.info "#{index.succ} : #{spec.name}", true
    end
    Bundler.ui.info "0 : - exit -", true

    num = Bundler.ui.ask("> ").to_i
    num > 0 ? specs[num - 1] : nil
  end

  def self.gem_not_found_message(missing_gem_name, alternatives)
    require "bundler/similarity_detector"
    message = "Could not find gem '#{missing_gem_name}'."
    alternate_names = alternatives.map {|a| a.respond_to?(:name) ? a.name : a }
    suggestions = SimilarityDetector.new(alternate_names).similar_word_list(missing_gem_name)
    message += "\nDid you mean #{suggestions}?" if suggestions
    message
  end

  def self.ensure_all_gems_in_lockfile!(names, locked_gems = Bundler.locked_gems)
    locked_names = locked_gems.specs.map(&:name)
    names.-(locked_names).each do |g|
      raise GemNotFound, gem_not_found_message(g, locked_names)
    end
  end

  def self.configure_gem_version_promoter(definition, options)
    patch_level = patch_level_options(options)
    raise InvalidOption, "Provide only one of the following options: #{patch_level.join(", ")}" unless patch_level.length <= 1
    definition.gem_version_promoter.tap do |gvp|
      gvp.level = patch_level.first || :major
      gvp.strict = options[:strict] || options["update-strict"]
    end
  end

  def self.patch_level_options(options)
    [:major, :minor, :patch].select {|v| options.keys.include?(v.to_s) }
  end

  def self.clean_after_install?
    clean = Bundler.settings[:clean]
    return clean unless clean.nil?
    clean ||= Bundler.feature_flag.auto_clean_without_path? && Bundler.settings[:path].nil?
    clean &&= !Bundler.use_system_gems?
    clean
  end
end
patch_level_options(options) click to toggle source
# File lib/bundler/cli/common.rb, line 90
def self.patch_level_options(options)
  [:major, :minor, :patch].select {|v| options.keys.include?(v.to_s) }
end
print_post_install_message(name, msg) click to toggle source
# File lib/bundler/cli/common.rb, line 12
def self.print_post_install_message(name, msg)
  Bundler.ui.confirm "Post-install message from #{name}:"
  Bundler.ui.info msg
end
select_spec(name, regex_match = nil) click to toggle source
# File lib/bundler/cli/common.rb, line 30
def self.select_spec(name, regex_match = nil)
  specs = []
  regexp = Regexp.new(name) if regex_match

  Bundler.definition.specs.each do |spec|
    return spec if spec.name == name
    specs << spec if regexp && spec.name =~ regexp
  end

  case specs.count
  when 0
    raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
  when 1
    specs.first
  else
    ask_for_spec_from(specs)
  end
rescue RegexpError
  raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
end
without_groups_message() click to toggle source
# File lib/bundler/cli/common.rb, line 22
def self.without_groups_message
  groups = Bundler.settings[:without]
  group_list = [groups[0...-1].join(", "), groups[-1..-1]].
    reject {|s| s.to_s.empty? }.join(" and ")
  group_str = (groups.size == 1) ? "group" : "groups"
  "Gems in the #{group_str} #{group_list} were not installed."
end