Class: Bundler::Plugin::Index
- Inherits:
-
Object
- Object
- Bundler::Plugin::Index
- Defined in:
- lib/bundler/plugin/index.rb
Defined Under Namespace
Classes: CommandConflict, SourceConflict
Instance Attribute Summary collapse
-
#commands ⇒ Object
readonly
Returns the value of attribute commands.
Instance Method Summary collapse
-
#command_plugin(command) ⇒ Object
Fetch the name of plugin handling the command.
-
#global_index_file ⇒ Object
Path where the global index file is stored.
-
#hook_plugins(event) ⇒ Object
Returns the list of plugin names handling the passed event.
-
#index_file ⇒ Object
Path of default index file.
-
#initialize ⇒ Index
constructor
A new instance of Index.
- #installed?(name) ⇒ Boolean
- #load_paths(name) ⇒ Object
-
#local_index_file ⇒ Object
Path where the local index file is stored.
- #plugin_path(name) ⇒ Object
-
#register_plugin(name, path, load_paths, commands, sources, hooks) ⇒ Object
This function is to be called when a new plugin is installed.
- #source?(source) ⇒ Boolean
- #source_plugin(name) ⇒ Object
Constructor Details
#initialize ⇒ Index
Returns a new instance of Index.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/bundler/plugin/index.rb', line 25 def initialize @plugin_paths = {} @commands = {} @sources = {} @hooks = {} @load_paths = {} begin load_index(global_index_file, true) rescue GenericSystemCallError # no need to fail when on a read-only FS, for example nil end load_index(local_index_file) if SharedHelpers.in_bundle? end |
Instance Attribute Details
#commands ⇒ Object (readonly)
Returns the value of attribute commands.
23 24 25 |
# File 'lib/bundler/plugin/index.rb', line 23 def commands @commands end |
Instance Method Details
#command_plugin(command) ⇒ Object
Fetch the name of plugin handling the command
95 96 97 |
# File 'lib/bundler/plugin/index.rb', line 95 def command_plugin(command) @commands[command] end |
#global_index_file ⇒ Object
Path where the global index file is stored
77 78 79 |
# File 'lib/bundler/plugin/index.rb', line 77 def global_index_file Plugin.global_root.join("index") end |
#hook_plugins(event) ⇒ Object
Returns the list of plugin names handling the passed event
112 113 114 |
# File 'lib/bundler/plugin/index.rb', line 112 def hook_plugins(event) @hooks[event] || [] end |
#index_file ⇒ Object
Path of default index file
72 73 74 |
# File 'lib/bundler/plugin/index.rb', line 72 def index_file Plugin.root.join("index") end |
#installed?(name) ⇒ Boolean
99 100 101 |
# File 'lib/bundler/plugin/index.rb', line 99 def installed?(name) @plugin_paths[name] end |
#load_paths(name) ⇒ Object
90 91 92 |
# File 'lib/bundler/plugin/index.rb', line 90 def load_paths(name) @load_paths[name] end |
#local_index_file ⇒ Object
Path where the local index file is stored
82 83 84 |
# File 'lib/bundler/plugin/index.rb', line 82 def local_index_file Plugin.local_root.join("index") end |
#plugin_path(name) ⇒ Object
86 87 88 |
# File 'lib/bundler/plugin/index.rb', line 86 def plugin_path(name) Pathname.new @plugin_paths[name] end |
#register_plugin(name, path, load_paths, commands, sources, hooks) ⇒ Object
This function is to be called when a new plugin is installed. This function shall add the functions of the plugin to existing maps and also the name to source location.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/bundler/plugin/index.rb', line 50 def register_plugin(name, path, load_paths, commands, sources, hooks) old_commands = @commands.dup common = commands & @commands.keys raise CommandConflict.new(name, common) unless common.empty? commands.each {|c| @commands[c] = name } common = sources & @sources.keys raise SourceConflict.new(name, common) unless common.empty? sources.each {|k| @sources[k] = name } hooks.each {|e| (@hooks[e] ||= []) << name } @plugin_paths[name] = path @load_paths[name] = load_paths save_index rescue StandardError @commands = old_commands raise end |
#source?(source) ⇒ Boolean
103 104 105 |
# File 'lib/bundler/plugin/index.rb', line 103 def source?(source) @sources.key? source end |
#source_plugin(name) ⇒ Object
107 108 109 |
# File 'lib/bundler/plugin/index.rb', line 107 def source_plugin(name) @sources[name] end |