Module: Bundler::Plugin

Defined in:
lib/bundler/plugin/api.rb,
lib/bundler/plugin.rb,
lib/bundler/plugin/dsl.rb,
lib/bundler/plugin/index.rb,
lib/bundler/plugin/events.rb,
lib/bundler/plugin/installer.rb,
lib/bundler/plugin/api/source.rb,
lib/bundler/plugin/source_list.rb,
lib/bundler/plugin/installer/git.rb,
lib/bundler/plugin/installer/rubygems.rb

Overview

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

Defined Under Namespace

Modules: Events Classes: API, DSL, Index, Installer, MalformattedPlugin, SourceList, UndefinedCommandError, UnknownSourceError

Constant Summary collapse

PLUGIN_FILE_NAME =
"plugins.rb".freeze

Class Method Summary collapse

Class Method Details

.add_command(command, cls) ⇒ Object

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


131
132
133
# File 'lib/bundler/plugin.rb', line 131

def add_command(command, cls)
  @commands[command] = cls
end

.add_hook(event, &block) ⇒ Object

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


180
181
182
183
184
185
# File 'lib/bundler/plugin.rb', line 180

def add_hook(event, &block)
  unless Events.defined_event?(event)
    raise ArgumentError, "Event '#{event}' not defined in Bundler::Plugin::Events"
  end
  @hooks_by_event[event.to_s] << block
end

.add_source(source, cls) ⇒ Object

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


151
152
153
# File 'lib/bundler/plugin.rb', line 151

def add_source(source, cls)
  @sources[source] = cls
end

.cacheObject

The cache directory for plugin stuffs


126
127
128
# File 'lib/bundler/plugin.rb', line 126

def cache
  @cache ||= root.join("cache")
end

.command?(command) ⇒ Boolean

Checks if any plugin handles the command

Returns:

  • (Boolean)

136
137
138
# File 'lib/bundler/plugin.rb', line 136

def command?(command)
  !index.command_plugin(command).nil?
end

.exec_command(command, args) ⇒ Object

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


142
143
144
145
146
147
148
# File 'lib/bundler/plugin.rb', line 142

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)
end

.gemfile_install(gemfile = nil, &inline) ⇒ Object

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

Parameters:

  • gemfile (Pathname) (defaults to: nil)

    path

  • block (Proc)

    that can be evaluated for (inline) Gemfile


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/bundler/plugin.rb', line 75

def gemfile_install(gemfile = nil, &inline)
  Bundler.settings.temporary(:frozen => false, :deployment => false) do
    builder = DSL.new
    if block_given?
      builder.instance_eval(&inline)
    else
      builder.eval_gemfile(gemfile)
    end
    definition = builder.to_definition(nil, true)

    return if definition.dependencies.empty?

    plugins = definition.dependencies.map(&:name).reject {|p| index.installed? p }
    installed_specs = Installer.new.install_definition(definition)

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

.global_rootObject

The global directory root for all plugin related data


121
122
123
# File 'lib/bundler/plugin.rb', line 121

def global_root
  Bundler.user_bundle_path("plugin")
end

.hook(event, *args, &arg_blk) ⇒ Object

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.

Parameters:

  • event (String)

193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/bundler/plugin.rb', line 193

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"
  end

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

  (plugins - @loaded_plugin_names).each {|name| load_plugin(name) }

  @hooks_by_event[event].each {|blk| blk.call(*args, &arg_blk) }
end

.indexObject

The index object used to store the details about the plugin


100
101
102
# File 'lib/bundler/plugin.rb', line 100

def index
  @index ||= Index.new
end

.install(names, options) ⇒ Object

Installs a new plugin by the given name

Parameters:

  • names (Array<String>)

    the name of plugin to be installed

  • options (Hash)

    various parameters as described in description. Refer to cli/plugin for available options


37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/bundler/plugin.rb', line 37

def install(names, options)
  specs = Installer.new.install(names, options)

  save_plugins names, specs
rescue PluginError => e
  if specs
    specs_to_delete = Hash[specs.select {|k, _v| names.include?(k) && !index.commands.values.include?(k) }]
    specs_to_delete.values.each {|spec| Bundler.rm_rf(spec.full_gem_path) }
  end

  Bundler.ui.error "Failed to install plugin #{name}: #{e.message}\n  #{e.backtrace.join("\n ")}"
end

.installed?(plugin) ⇒ String?

currently only intended for specs

Returns:

  • (String, nil)

    installed path


210
211
212
# File 'lib/bundler/plugin.rb', line 210

def installed?(plugin)
  Index.new.installed?(plugin)
end

.listObject

List installed plugins and commands


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/bundler/plugin.rb', line 52

def list
  installed_plugins = index.installed_plugins
  if installed_plugins.any?
    output = String.new
    installed_plugins.each do |plugin|
      output << "#{plugin}\n"
      output << "-----\n"
      index.plugin_commands(plugin).each do |command|
        output << "  #{command}\n"
      end
      output << "\n"
    end
  else
    output = "No plugins installed"
  end
  Bundler.ui.info output
end

.load_plugin(name) ⇒ Object

Executes the plugins.rb file

Parameters:

  • name (String)

    of the plugin


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'lib/bundler/plugin.rb', line 285

def load_plugin(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)

  Bundler.rubygems.add_to_load_path(index.load_paths(name))

  load path.join(PLUGIN_FILE_NAME)

  @loaded_plugin_names << name
rescue RuntimeError => e
  Bundler.ui.error "Failed loading plugin #{name}: #{e.message}"
  raise
end

.local_rootObject


116
117
118
# File 'lib/bundler/plugin.rb', line 116

def local_root
  Bundler.app_config_path.join("plugin")
end

.register_plugin(name, spec, optional_plugin = false) ⇒ Object

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.

Parameters:

  • name (String)

    the name of the plugin

  • spec (Specification)

    of installed plugin

  • optional_plugin, (Boolean)

    removed if there is conflict with any other plugin (used for default source plugins)

Raises:


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/bundler/plugin.rb', line 249

def register_plugin(name, spec, optional_plugin = false)
  commands = @commands
  sources = @sources
  hooks = @hooks_by_event

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

  load_paths = spec.load_paths
  Bundler.rubygems.add_to_load_path(load_paths)
  path = Pathname.new spec.full_gem_path

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

  if optional_plugin && @sources.keys.any? {|s| source? s }
    Bundler.rm_rf(path)
    false
  else
    index.register_plugin(name, path.to_s, load_paths, @commands.keys,
      @sources.keys, @hooks_by_event.keys)
    true
  end
ensure
  @commands = commands
  @sources = sources
  @hooks_by_event = hooks
end

.reset!Object


21
22
23
24
25
26
27
28
# File 'lib/bundler/plugin.rb', line 21

def reset!
  instance_variables.each {|i| remove_instance_variable(i) }

  @sources = {}
  @commands = {}
  @hooks_by_event = Hash.new {|h, k| h[k] = [] }
  @loaded_plugin_names = []
end

.rootObject

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”)


108
109
110
111
112
113
114
# File 'lib/bundler/plugin.rb', line 108

def root
  @root ||= if SharedHelpers.in_bundle?
    local_root
  else
    global_root
  end
end

.save_plugins(plugins, specs, optional_plugins = []) ⇒ Object

Post installation processing and registering with index

Parameters:

  • plugins (Array<String>)

    list to be installed

  • specs (Hash)

    of plugins mapped to installation path (currently they contain all the installed specs, including plugins)

  • names (Array<String>)

    of inferred source plugins that can be ignored


220
221
222
223
224
225
226
227
# File 'lib/bundler/plugin.rb', line 220

def save_plugins(plugins, specs, optional_plugins = [])
  plugins.each do |name|
    spec = specs[name]
    validate_plugin! Pathname.new(spec.full_gem_path)
    installed = register_plugin(name, spec, optional_plugins.include?(name))
    Bundler.ui.info "Installed plugin #{name}" if installed
  end
end

.source(name) ⇒ Class

Returns that handles the source. The calss includes API::Source.

Returns:

  • (Class)

    that handles the source. The calss includes API::Source

Raises:


161
162
163
164
165
166
167
# File 'lib/bundler/plugin.rb', line 161

def source(name)
  raise UnknownSourceError, "Source #{name} not found" unless source? name

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

  @sources[name]
end

.source?(name) ⇒ Boolean

Checks if any plugin declares the source

Returns:

  • (Boolean)

156
157
158
# File 'lib/bundler/plugin.rb', line 156

def source?(name)
  !index.source_plugin(name.to_s).nil?
end

.source_from_lock(locked_opts) ⇒ API::Source

Returns the instance of the class that handles the source type passed in locked_opts.

Parameters:

  • The (Hash)

    options that are present in the lock file

Returns:

  • (API::Source)

    the instance of the class that handles the source type passed in locked_opts


172
173
174
175
176
# File 'lib/bundler/plugin.rb', line 172

def source_from_lock(locked_opts)
  src = source(locked_opts["type"])

  src.new(locked_opts.merge("uri" => locked_opts["remote"]))
end

.validate_plugin!(plugin_path) ⇒ Object

Checks if the gem is good to be a plugin

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

Parameters:

  • plugin_path (Pathname)

    the path plugin is installed at

Raises:


235
236
237
238
# File 'lib/bundler/plugin.rb', line 235

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?
end