Module: Params
- Defined in:
- lib/params.rb,
lib/params/version.rb
Defined Under Namespace
Classes: Param
Constant Summary collapse
- VERSION =
"1.2.0"
Class Method Summary collapse
-
.[](name) ⇒ Object
Read param value by other modules.
-
.[]=(name, value) ⇒ Object
Write param value by other modules.
-
.boolean(name, value, description) ⇒ Object
Define new parameter of type Boolean.
- .complex(name, value, description) ⇒ Object
- .each(&block) ⇒ Object
-
.float(name, value, description) ⇒ Object
Define new parameter of type Float.
- .get_init_info_messages ⇒ Object
- .get_init_warning_messages ⇒ Object
-
.init(args) ⇒ Object
Initializes the project parameters.
-
.integer(name, value, description) ⇒ Object
Define new parameter of type Integer.
-
.path(name, value, description) ⇒ Object
Define new parameter of type path (the only difference with string is that the path expends ‘~’ to full user directory).
-
.string(name, value, description) ⇒ Object
Define new parameter of type String.
-
.to_simple_hash ⇒ Object
end of Parse function.
Class Method Details
.[](name) ⇒ Object
Read param value by other modules. Note that this operator should only be used, after parameter has been defined through one of Param module methods: Params.string, Params.integer, Params.float or Params.boolean.“
170 171 172 173 |
# File 'lib/params.rb', line 170 def Params.[](name) raise_error_if_param_does_not_exist(name) @params_data_base[name].value end |
.[]=(name, value) ⇒ Object
Write param value by other modules. Note that this operator should only be used, after parameter has been defined through one of Param module methods: Params.string, Params.integer, Params.float or Params.boolean.“
183 184 185 186 187 |
# File 'lib/params.rb', line 183 def Params.[]=(name, value) raise_error_if_param_does_not_exist(name) set_value = @params_data_base[name].value_type_check(value) @params_data_base[name].value = set_value end |
.boolean(name, value, description) ⇒ Object
Define new parameter of type Boolean.
247 248 249 250 |
# File 'lib/params.rb', line 247 def Params.boolean(name, value, description) raise_error_if_param_exists(name) @params_data_base[name] = Param.new(name, value, 'Boolean', description) end |
.complex(name, value, description) ⇒ Object
241 242 243 244 |
# File 'lib/params.rb', line 241 def Params.complex(name, value, description) raise_error_if_param_exists(name) @params_data_base[name] = Param.new(name, value, 'Complex', description) end |
.each(&block) ⇒ Object
175 176 177 |
# File 'lib/params.rb', line 175 def Params.each(&block) @params_data_base.each(&block) end |
.float(name, value, description) ⇒ Object
Define new parameter of type Float.
222 223 224 225 |
# File 'lib/params.rb', line 222 def Params.float(name, value, description) raise_error_if_param_exists(name) @params_data_base[name] = Param.new(name, value, 'Float', description) end |
.get_init_info_messages ⇒ Object
145 146 147 |
# File 'lib/params.rb', line 145 def Params. return @init_info_messages end |
.get_init_warning_messages ⇒ Object
149 150 151 |
# File 'lib/params.rb', line 149 def Params. return @init_warning_messages end |
.init(args) ⇒ Object
Initializes the project parameters. Precedence is: Defined params, file and command line is highest.
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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/params.rb', line 254 def Params.init(args) #define default configuration file Params['conf_file'] = "~/.bbfs/etc/config_#{File.basename($PROGRAM_NAME)}.yml" @init_info_messages = [] @init_warning_messages = [] #parse command line argument and set configuration file if provided by user results = parse_command_line_arguments(args) if results['conf_file'] Params['conf_file'] = File.(results['conf_file']) if !File.exist?(Params['conf_file']) or File.directory?(Params['conf_file']) raise("Param:'conf_file' value:'#{Params['conf_file']}' is a file name which does not exist" + " or a directory name") end end Params['conf_file'] = File.(Params['conf_file']) #load yml params if path is provided and exists if File.exist?(Params['conf_file']) @init_info_messages << "Loading parameters from configuration file:'#{Params['conf_file']}'" if not read_yml_params(File.open(Params['conf_file'], 'r')) raise("Bad configuration file #{Params['conf_file']}.") end else @init_warning_messages << "Configuration file path:'#{Params['conf_file']}' does not exist. " + \ "Skipping loading file parameters." end #override command line argument results.keys.each do |result_name| override_param(result_name, results[result_name]) end # Prints help and parameters if needed. if @show_help_and_exit # Print parameters + description and exit. puts "Full list of parameters:" Params.each do |name, param| puts "--#{name}, #{param.type}, default:#{param.value}\n\t#{param.desc}" end exit end # Add parameters to log init messages (used by Log.init if param:print_params_to_stdout is true) @init_info_messages << 'Initialized executable parameters:' @init_info_messages << '---------------------------------' counter=0 @params_data_base.values.each do |param| counter += 1 @init_info_messages << "Param ##{counter}: #{param.name}=#{param.value}" end @init_info_messages << '---------------------------------' end |
.integer(name, value, description) ⇒ Object
Define new parameter of type Integer.
216 217 218 219 |
# File 'lib/params.rb', line 216 def Params.integer(name, value, description) raise_error_if_param_exists(name) @params_data_base[name] = Param.new(name, value, 'Integer', description) end |
.path(name, value, description) ⇒ Object
Define new parameter of type path (the only difference with string is that the path expends ‘~’ to full user directory).
235 236 237 238 239 |
# File 'lib/params.rb', line 235 def Params.path(name, value, description) raise_error_if_param_exists(name) value = File.(value) unless value.nil? @params_data_base[name] = Param.new(name, value, 'Path', description) end |
.string(name, value, description) ⇒ Object
Define new parameter of type String.
228 229 230 231 |
# File 'lib/params.rb', line 228 def Params.string(name, value, description) raise_error_if_param_exists(name) @params_data_base[name] = Param.new(name, value, 'String', description) end |
.to_simple_hash ⇒ Object
end of Parse function
400 401 402 403 404 |
# File 'lib/params.rb', line 400 def Params.to_simple_hash @params_data_base.map { |param| param.value } end |