Class: Fig::Environment
- Inherits:
-
Object
- Object
- Fig::Environment
- Defined in:
- lib/fig/environment.rb
Overview
Manages the program’s metadata, including packages and environment variables, and sets things up for running commands (from “command” statements in definition files or from the command-line).
Instance Method Summary collapse
-
#[](name) ⇒ Object
Returns the value of an envirionment variable.
-
#add_retrieve(retrieve_statement) ⇒ Object
Indicates that the values from a particular environment variable path should be copied to a local directory.
- #apply_config(package, config_name, backtrace) ⇒ Object
-
#apply_config_statement(base_package, statement, backtrace) ⇒ Object
In order for this to work correctly, any Overrides need to be processed before any other kind of Statement.
- #check_unused_retrieves ⇒ Object
- #execute_config(base_package, descriptor, args, &block) ⇒ Object
- #execute_shell(command) ⇒ Object
- #get_package(name) ⇒ Object
- #include_config(base_package, descriptor, backtrace) ⇒ Object
-
#initialize(repository, variables_override, working_directory_maintainer) ⇒ Environment
constructor
Note: when reading this code, understand that the word “retrieve” is a noun and not a verb, e.g.
- #register_package(package) ⇒ Object
- #variables ⇒ Object
Constructor Details
#initialize(repository, variables_override, working_directory_maintainer) ⇒ Environment
Note: when reading this code, understand that the word “retrieve” is a noun and not a verb, e.g. “retrieve path” means the value of a retrieve statement and not the action of retrieving a path.
23 24 25 26 27 28 29 30 |
# File 'lib/fig/environment.rb', line 23 def initialize(repository, variables_override, working_directory_maintainer) @repository = repository @variables = variables_override || Fig::OperatingSystem.get_environment_variables() @retrieves = {} @packages = {} @working_directory_maintainer = working_directory_maintainer end |
Instance Method Details
#[](name) ⇒ Object
Returns the value of an envirionment variable
33 34 35 |
# File 'lib/fig/environment.rb', line 33 def [](name) return @variables[name] end |
#add_retrieve(retrieve_statement) ⇒ Object
Indicates that the values from a particular environment variable path should be copied to a local directory.
43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/fig/environment.rb', line 43 def add_retrieve(retrieve_statement) name = retrieve_statement.var if @retrieves.has_key?(name) Fig::Logging.warn \ %q<About to overwrite "#{name}" retrieve path of "#{@retrieves[name].path}" with "#{retrieve_statement.path}".> end @retrieves[name] = retrieve_statement retrieve_statement.added_to_environment(true) return end |
#apply_config(package, config_name, backtrace) ⇒ Object
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/fig/environment.rb', line 78 def apply_config(package, config_name, backtrace) if package.applied_config_names.member?(config_name) return end new_backtrace = backtrace || Fig::Backtrace.new( nil, Fig::PackageDescriptor.new(package.name, package.version, config_name) ) config = package[config_name] config.statements.each do |statement| apply_config_statement(package, statement, new_backtrace) end package.add_applied_config_name(config_name) return end |
#apply_config_statement(base_package, statement, backtrace) ⇒ Object
In order for this to work correctly, any Overrides need to be processed before any other kind of Statement. The Configuration class guarantees that those come first in its set of Statements.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/fig/environment.rb', line 135 def apply_config_statement(base_package, statement, backtrace) case statement when Fig::Statement::Path prepend_variable(base_package, statement.name, statement.value, backtrace) when Fig::Statement::Set set_variable(base_package, statement.name, statement.value, backtrace) when Fig::Statement::Include include_config(base_package, statement.descriptor, backtrace) when Fig::Statement::Override backtrace.add_override(statement) when Fig::Statement::Command # Skip - has no effect on environment. else raise "Unexpected statement in a config block: #{statement.unparse('')}" end return end |
#check_unused_retrieves ⇒ Object
186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/fig/environment.rb', line 186 def check_unused_retrieves() @retrieves.keys().sort().each do |name| statement = @retrieves[name] if statement.loaded_but_not_referenced? Fig::Logging.warn \ %Q<The #{name} variable was never referenced or didn't need expansion, so "#{statement.unparse('')}"#{statement.position_string} was ignored.> end end end |
#execute_config(base_package, descriptor, args, &block) ⇒ Object
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/fig/environment.rb', line 106 def execute_config(base_package, descriptor, args, &block) config_name = descriptor.config || find_config_name_in_package(descriptor.name) name = descriptor.name || base_package.name package = lookup_package( name, descriptor.version, Fig::Backtrace.new( nil, Fig::PackageDescriptor.new(name, descriptor.version, config_name) ) ) command_statement = package[config_name].command_statement if command_statement execute_command(command_statement, args, package, nil, &block) else raise Fig::UserInputError.new( %Q<The "#{package.to_s}" package with the "#{config_name}" configuration does not contain a command.> ) end return end |
#execute_shell(command) ⇒ Object
98 99 100 101 102 103 104 |
# File 'lib/fig/environment.rb', line 98 def execute_shell(command) @variables.with_environment do yield command.map{|arg| (arg, nil, nil)} end return end |
#get_package(name) ⇒ Object
74 75 76 |
# File 'lib/fig/environment.rb', line 74 def get_package(name) return @packages[name] end |
#include_config(base_package, descriptor, backtrace) ⇒ Object
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/fig/environment.rb', line 154 def include_config(base_package, descriptor, backtrace) resolved_descriptor = nil # Check to see if this include has been overridden. if backtrace override = backtrace.get_override( descriptor.name || base_package.name ) if override resolved_descriptor = Fig::PackageDescriptor.new( descriptor.name, override, descriptor.config ) end end resolved_descriptor ||= descriptor new_backtrace = Fig::Backtrace.new(backtrace, resolved_descriptor) package = lookup_package( resolved_descriptor.name || base_package.name, resolved_descriptor.version, new_backtrace ) apply_config( package, resolved_descriptor.config || Fig::Package::DEFAULT_CONFIG, new_backtrace ) return end |
#register_package(package) ⇒ Object
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/fig/environment.rb', line 56 def register_package(package) name = package.name if get_package(name) raise_repository_error( name.nil? \ ? %Q<There is already a package with the name "#{name}".> \ : %q<There is already an unnamed package.>, nil, package ) end @packages[name] = package return end |
#variables ⇒ Object
37 38 39 |
# File 'lib/fig/environment.rb', line 37 def variables return @variables.clone end |