diff options
Diffstat (limited to 'lib/bundler/plugin/index.rb')
| -rw-r--r-- | lib/bundler/plugin/index.rb | 158 |
1 files changed, 80 insertions, 78 deletions
diff --git a/lib/bundler/plugin/index.rb b/lib/bundler/plugin/index.rb index c4a25be22e..b276bfdf4f 100644 --- a/lib/bundler/plugin/index.rb +++ b/lib/bundler/plugin/index.rb @@ -4,104 +4,106 @@ module Bundler # 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). - class Plugin::Index - def initialize - @plugin_paths = {} - @commands = {} + module Plugin + class Index + def initialize + @plugin_paths = {} + @commands = {} - load_index - end + load_index + end - # 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. - # - # @param [String] name of the plugin to be registered - # @param [String] path where the plugin is installed - # @param [Array<String>] commands that are handled by the plugin - def register_plugin(name, path, commands) - @plugin_paths[name] = path + # 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. + # + # @param [String] name of the plugin to be registered + # @param [String] path where the plugin is installed + # @param [Array<String>] commands that are handled by the plugin + def register_plugin(name, path, commands) + @plugin_paths[name] = path - common = commands & @commands.keys - raise "Command(s) #{common.join(", ")} are already registered" if common.any? - commands.each {|c| @commands[c] = name } + common = commands & @commands.keys + raise "Command(s) #{common.join(", ")} are already registered" if common.any? + commands.each {|c| @commands[c] = name } - save_index - end + save_index + end - # Path where the index file is stored - def index_file - Plugin.root.join("index") - end + # Path where the index file is stored + def index_file + Plugin.root.join("index") + end - def plugin_path(name) - Pathname.new @plugin_paths[name] - end + def plugin_path(name) + Pathname.new @plugin_paths[name] + end - # Fetch the name of plugin handling the command - def command_plugin(command) - @commands[command] - end + # Fetch the name of plugin handling the command + def command_plugin(command) + @commands[command] + end - private + private - # Reads the index file from the directory and initializes the instance variables. - def load_index - SharedHelpers.filesystem_access(index_file, :read) do |index_f| - valid_file = index_f && index_f.exist? && !index_f.size.zero? - break unless valid_file - data = index_f.read - index = load_yaml(data) - @plugin_paths = index["plugin_paths"] || {} - @commands = index["commands"] || {} + # Reads the index file from the directory and initializes the instance variables. + def load_index + SharedHelpers.filesystem_access(index_file, :read) do |index_f| + valid_file = index_f && index_f.exist? && !index_f.size.zero? + break unless valid_file + data = index_f.read + index = load_yaml(data) + @plugin_paths = index["plugin_paths"] || {} + @commands = index["commands"] || {} + end end - end - # Should be called when any of the instance variables change. Stores the instance - # variables in YAML format. (The instance variables are supposed to be only String key value pairs) - def save_index - index = { - "plugin_paths" => @plugin_paths, - "commands" => @commands, - } + # Should be called when any of the instance variables change. Stores the instance + # variables in YAML format. (The instance variables are supposed to be only String key value pairs) + def save_index + index = { + "plugin_paths" => @plugin_paths, + "commands" => @commands, + } - SharedHelpers.filesystem_access(index_file) do |index_f| - FileUtils.mkdir_p(index_f.dirname) - File.open(index_f, "w") {|f| f.puts dump_hash(index) } + SharedHelpers.filesystem_access(index_file) do |index_f| + FileUtils.mkdir_p(index_f.dirname) + File.open(index_f, "w") {|f| f.puts dump_hash(index) } + end end - end - def dump_yaml(hash) - yaml = "---\n" - yaml << dump_hash(hash) - end + def dump_yaml(hash) + yaml = "---\n" + yaml << dump_hash(hash) + end - def dump_hash(hash) - yaml = String.new("") - hash.each do |k, v| - yaml << k << ": " - if v.is_a?(Hash) - yaml << "\n" << dump_hash(v).gsub(/^/, " ") << "\n" - else - yaml << v.to_s.gsub(/\s+/, " ").inspect << "\n" + def dump_hash(hash) + yaml = String.new("") + hash.each do |k, v| + yaml << k << ": " + if v.is_a?(Hash) + yaml << "\n" << dump_hash(v).gsub(/^/, " ") << "\n" + else + yaml << v.to_s.gsub(/\s+/, " ").inspect << "\n" + end end + yaml end - yaml - end - def load_yaml(str) - res = {} - stack = [res] - str.scan(/^( *)(.*):\s?(["']?)([^"'\n]*)\3\n/).each do |(indent, key, _, val)| - depth = indent.scan(/ /).length - if val.empty? - new_hash = {} - stack[depth][key] = new_hash - stack[depth + 1] = new_hash - else - stack[depth][key] = val + def load_yaml(str) + res = {} + stack = [res] + str.scan(/^( *)(.*):\s?(["']?)([^"'\n]*)\3\n/).each do |(indent, key, _, val)| + depth = indent.scan(/ /).length + if val.empty? + new_hash = {} + stack[depth][key] = new_hash + stack[depth + 1] = new_hash + else + stack[depth][key] = val + end end + res end - res end end end |