module Bundler::Plugin

This is the interfacing class represents the API that we intend to provide the plugins to use.

For plugins to be independent of the Bundler internals they shall limit their interactions to methods of this class only. This will save them from breaking when some internal change.

Currently we are delegating the methods defined in Bundler class to itself. So, this class acts as a buffer.

If there is some change in the Bundler class that is incompatible to its previous behavior or if otherwise desired, we can reimplement(or implement) the method to preserve compatibility.

To use this, either the class can inherit this class or use it directly. For example of both types of use, refer the file ‘spec/plugins/command.rb`

To use it without inheriting, you will have to create an object of this to use the functions (except for declaration functions like command, source, and hooks).

Manages which plugins are installed and their sources. This also is supposed to map which plugin does what (currently the features are not implemented so this class is now a stub class).

Handles the installation of plugin in appropriate directories.

This class is supposed to be wrapper over the existing gem installation infra but currently it itself handles everything as the Source’s subclasses (e.g. Source::RubyGems) are heavily dependent on the Gemfile.

SourceList object to be used while parsing the Gemfile, setting the approptiate options to be used with Source classes for plugin installation



Public Instance Methods

add_command(command, cls) click to toggle source

To be called via the API to register to handle a command

# File bundler/plugin.rb, line 160
def add_command(command, cls)
  @commands[command] = cls
add_hook(event, &block) click to toggle source

To be called via the API to register a hooks and corresponding block that will be called to handle the hook

# File bundler/plugin.rb, line 209
def add_hook(event, &block)
  unless Events.defined_event?(event)
    raise ArgumentError, "Event '#{event}' not defined in Bundler::Plugin::Events"
  @hooks_by_event[event.to_s] << block
add_source(source, cls) click to toggle source

To be called via the API to register to handle a source plugin

# File bundler/plugin.rb, line 180
def add_source(source, cls)
  @sources[source] = cls
cache() click to toggle source

The cache directory for plugin stuffs

# File bundler/plugin.rb, line 155
def cache
  @cache ||= root.join("cache")
command?(command) click to toggle source

Checks if any plugin handles the command

# File bundler/plugin.rb, line 165
def command?(command)
exec_command(command, args) click to toggle source

To be called from Cli class to pass the command and argument to appropriate plugin class

# File bundler/plugin.rb, line 171
def exec_command(command, args)
  raise UndefinedCommandError, "Command `#{command}` not found" unless command? command

  load_plugin index.command_plugin(command) unless @commands.key? command

  @commands[command].new.exec(command, args)
from_lock(locked_opts) click to toggle source

@param [Hash] The options that are present in the lock file @return [API::Source] the instance of the class that handles the source

type passed in locked_opts
# File bundler/plugin.rb, line 201
def from_lock(locked_opts)
  src = source(locked_opts["type"])"uri" => locked_opts["remote"]))
gemfile_install(gemfile = nil, &inline) click to toggle source

Evaluates the Gemfile with a limited DSL and installs the plugins specified by plugin method

@param [Pathname] gemfile path @param [Proc] block that can be evaluated for (inline) Gemfile

# File bundler/plugin.rb, line 103
def gemfile_install(gemfile = nil, &inline)
  Bundler.settings.temporary(frozen: false, deployment: false) do
    builder =
    if block_given?
    definition = builder.to_definition(nil, true)

    return if definition.dependencies.empty?

    plugins = {|p| index.installed? p }
    installed_specs =

    save_plugins plugins, installed_specs, builder.inferred_plugins
rescue RuntimeError => e
  unless e.is_a?(GemfileError)
    Bundler.ui.error "Failed to install plugin: #{e.message}\n  #{e.backtrace[0]}"
global_root() click to toggle source

The global directory root for all plugin related data

# File bundler/plugin.rb, line 150
def global_root
hook(event, *args, &arg_blk) click to toggle source

Runs all the hooks that are registered for the passed event

It passes the passed arguments and block to the block registered with the api.

@param [String] event

# File bundler/plugin.rb, line 222
def hook(event, *args, &arg_blk)
  return unless Bundler.feature_flag.plugins?
  unless Events.defined_event?(event)
    raise ArgumentError, "Event '#{event}' not defined in Bundler::Plugin::Events"

  plugins = index.hook_plugins(event)
  return unless plugins.any?

  plugins.each {|name| load_plugin(name) }

  @hooks_by_event[event].each {|blk|*args, &arg_blk) }
index() click to toggle source

The index object used to store the details about the plugin

# File bundler/plugin.rb, line 129
def index
  @index ||=
install(names, options) click to toggle source

Installs a new plugin by the given name

@param [Array<String>] names the name of plugin to be installed @param [Hash] options various parameters as described in description.

Refer to cli/plugin for available options
# File bundler/plugin.rb, line 38
def install(names, options)
  raise InvalidOption, "You cannot specify `--branch` and `--ref` at the same time." if options["branch"] && options["ref"]

  specs =, options)

  save_plugins names, specs
rescue PluginError
  specs_to_delete = {|k, _v| names.include?(k) && !index.commands.values.include?(k) }
  specs_to_delete.each_value {|spec| Bundler.rm_rf(spec.full_gem_path) }

installed?(plugin) click to toggle source

currently only intended for specs

@return [String, nil] installed path

# File bundler/plugin.rb, line 239
def installed?(plugin)
list() click to toggle source

List installed plugins and commands

# File bundler/plugin.rb, line 80
def list
  installed_plugins = index.installed_plugins
  if installed_plugins.any?
    output =
    installed_plugins.each do |plugin|
      output << "#{plugin}\n"
      output << "-----\n"
      index.plugin_commands(plugin).each do |command|
        output << "  #{command}\n"
      output << "\n"
    output = "No plugins installed"
  end output
load_plugin(name) click to toggle source

Executes the plugins.rb file

@param [String] name of the plugin

# File bundler/plugin.rb, line 336
def load_plugin(name)
  return unless name && !name.empty?
  return if loaded?(name)

  # Need to ensure before this that plugin root where the rest of gems
  # are installed to be on load path to support plugin deps. Currently not
  # done to avoid conflicts
  path = index.plugin_path(name)


  load path.join(PLUGIN_FILE_NAME)

  @loaded_plugin_names << name
rescue RuntimeError => e
  Bundler.ui.error "Failed loading plugin #{name}: #{e.message}"
loaded?(plugin) click to toggle source

@return [true, false] whether the plugin is loaded

# File bundler/plugin.rb, line 244
def loaded?(plugin)
local_root() click to toggle source
# File bundler/plugin.rb, line 145
def local_root
register_plugin(name, spec, optional_plugin = false) click to toggle source

Runs the plugins.rb file in an isolated namespace, records the plugin actions it registers for and then passes the data to index to be stored.

@param [String] name the name of the plugin @param [Specification] spec of installed plugin @param [Boolean] optional_plugin, removed if there is conflict with any

other plugin (used for default source plugins)

@raise [MalformattedPlugin] if plugins.rb raises any error

# File bundler/plugin.rb, line 300
def register_plugin(name, spec, optional_plugin = false)
  commands = @commands
  sources = @sources
  hooks = @hooks_by_event

  @commands = {}
  @sources = {}
  @hooks_by_event = {|h, k| h[k] = [] }

  load_paths = spec.load_paths
  path = spec.full_gem_path

    load path.join(PLUGIN_FILE_NAME), true
  rescue StandardError => e
    raise MalformattedPlugin, "#{e.class}: #{e.message}"

  if optional_plugin && @sources.keys.any? {|s| source? s }
    index.register_plugin(name, path.to_s, load_paths, @commands.keys,
      @sources.keys, @hooks_by_event.keys)
  @commands = commands
  @sources = sources
  @hooks_by_event = hooks
reset!() click to toggle source
# File bundler/plugin.rb, line 22
def reset!
  instance_variables.each {|i| remove_instance_variable(i) }

  @sources = {}
  @commands = {}
  @hooks_by_event = {|h, k| h[k] = [] }
  @loaded_plugin_names = []
root() click to toggle source

The directory root for all plugin related data

If run in an app, points to local root, in app_config_path Otherwise, points to global root, in Bundler.user_bundle_path(“plugin”)

# File bundler/plugin.rb, line 137
def root
  @root ||= if SharedHelpers.in_bundle?
save_plugin(name, spec, optional_plugin = false) click to toggle source

Validates and registers a plugin.

@param [String] name the name of the plugin @param [Specification] spec of installed plugin @param [Boolean] optional_plugin, removed if there is conflict with any

other plugin (used for default source plugins)

@raise [PluginInstallError] if validation or registration raises any error

# File bundler/plugin.rb, line 283
def save_plugin(name, spec, optional_plugin = false)
  installed = register_plugin(name, spec, optional_plugin) "Installed plugin #{name}" if installed
rescue PluginError => e
  raise PluginInstallError, "Failed to install plugin `#{}`, due to #{e.class} (#{e.message})"
save_plugins(plugins, specs, optional_plugins = []) click to toggle source

Post installation processing and registering with index

@param [Array<String>] plugins list to be installed @param [Hash] specs of plugins mapped to installation path (currently they

contain all the installed specs, including plugins)

@param [Array<String>] names of inferred source plugins that can be ignored

# File bundler/plugin.rb, line 254
def save_plugins(plugins, specs, optional_plugins = [])
  plugins.each do |name|
    next if index.installed?(name)

    spec = specs[name]

    save_plugin(name, spec, optional_plugins.include?(name))
source(name) click to toggle source

@return [Class] that handles the source. The class includes API::Source

# File bundler/plugin.rb, line 190
def source(name)
  raise UnknownSourceError, "Source #{name} not found" unless source? name

  load_plugin(index.source_plugin(name)) unless @sources.key? name

source?(name) click to toggle source

Checks if any plugin declares the source

# File bundler/plugin.rb, line 185
def source?(name)
uninstall(names, options) click to toggle source

Uninstalls plugins by the given names

@param [Array<String>] names the names of plugins to be uninstalled

# File bundler/plugin.rb, line 54
def uninstall(names, options)
  if names.empty? && !options[:all]
    Bundler.ui.error "No plugins to uninstall. Specify at least 1 plugin to uninstall.\n"\
      "Use --all option to uninstall all the installed plugins."

  names = index.installed_plugins if options[:all]
  if names.any?
    names.each do |name|
      if index.installed?(name)
        path = index.plugin_path(name).to_s
        Bundler.rm_rf(path) if index.installed_in_plugin_root?(name)
        index.unregister_plugin(name) "Uninstalled plugin #{name}"
        Bundler.ui.error "Plugin #{name} is not installed \n"
  else "No plugins installed"
validate_plugin!(plugin_path) click to toggle source

Checks if the gem is good to be a plugin

At present it only checks whether it contains plugins.rb file

@param [Pathname] plugin_path the path plugin is installed at @raise [MalformattedPlugin] if plugins.rb file is not found

# File bundler/plugin.rb, line 270
def validate_plugin!(plugin_path)
  plugin_file = plugin_path.join(PLUGIN_FILE_NAME)
  raise MalformattedPlugin, "#{PLUGIN_FILE_NAME} was not found in the plugin." unless plugin_file.file?