class Vagrant::Plugin::StateFile
This is a helper to deal with the plugin state file that Vagrant
uses to track what plugins are installed and activated and such.
Attributes
@return [Pathname] path to file
Public Class Methods
# File lib/vagrant/plugin/state_file.rb, line 14 def initialize(path) @path = path @data = {} if @path.exist? begin @data = JSON.parse(@path.read) rescue JSON::ParserError => e raise Vagrant::Errors::PluginStateFileParseError, path: path, message: e.message end upgrade_v0! if !@data["version"] end @data["version"] ||= "1" @data["installed"] ||= {} end
Public Instance Methods
Add a plugin that is installed to the state file.
@param [String] name The name of the plugin
# File lib/vagrant/plugin/state_file.rb, line 36 def add_plugin(name, **opts) @data["installed"][name] = { "ruby_version" => RUBY_VERSION, "vagrant_version" => Vagrant::VERSION, "gem_version" => opts[:version] || "", "require" => opts[:require] || "", "sources" => opts[:sources] || [], "installed_gem_version" => opts[:installed_gem_version], "env_local" => !!opts[:env_local] } save! end
Adds a RubyGems index source to look up gems.
@param [String] url URL of the source.
# File lib/vagrant/plugin/state_file.rb, line 53 def add_source(url) @data["sources"] ||= [] @data["sources"] << url if !@data["sources"].include?(url) save! end
Returns true/false if the plugin is present in this state file.
@return [Boolean]
# File lib/vagrant/plugin/state_file.rb, line 71 def has_plugin?(name) @data["installed"].key?(name) end
This returns a hash of installed plugins according to the state file. Note that this may not directly match over to actually installed gems.
@return [Hash]
# File lib/vagrant/plugin/state_file.rb, line 64 def installed_plugins @data["installed"] end
Remove a plugin that is installed from the state file.
@param [String] name The name of the plugin.
# File lib/vagrant/plugin/state_file.rb, line 78 def remove_plugin(name) @data["installed"].delete(name) save! end
Remove a source for RubyGems.
@param [String] url URL of the source
# File lib/vagrant/plugin/state_file.rb, line 86 def remove_source(url) @data["sources"] ||= [] @data["sources"].delete(url) save! end
This saves the state back into the state file.
# File lib/vagrant/plugin/state_file.rb, line 101 def save! Tempfile.open(@path.basename.to_s, @path.dirname.to_s) do |f| f.binmode f.write(JSON.dump(@data)) f.fsync f.chmod(0644) f.close FileUtils.mv(f.path, @path) end end
Returns the list of RubyGems sources that will be searched for plugins.
@return [Array<String>]
# File lib/vagrant/plugin/state_file.rb, line 96 def sources @data["sources"] || [] end
Protected Instance Methods
This upgrades the internal data representation from V0 (the initial version) to V1
.
# File lib/vagrant/plugin/state_file.rb, line 116 def upgrade_v0! @data["version"] = "1" new_installed = {} (@data["installed"] || []).each do |plugin| new_installed[plugin] = { "ruby_version" => "0", "vagrant_version" => "0", } end @data["installed"] = new_installed save! end