Class: RHC::Vendor::ParseConfig
Constant Summary collapse
- Version =
'1.0.2'
Instance Attribute Summary collapse
-
#config_file ⇒ Object
Returns the value of attribute config_file.
-
#groups ⇒ Object
Returns the value of attribute groups.
-
#params ⇒ Object
Returns the value of attribute params.
Instance Method Summary collapse
-
#[](param) ⇒ Object
This method is a shortcut to accessing the @params variable.
-
#add(param_name, value) ⇒ Object
This method adds an element to the config object (not the config file) By adding a Hash, you create a new group.
-
#add_to_group(group, param_name, value) ⇒ Object
Add parameters to a group.
-
#get_groups ⇒ Object
List available sub-groups of the config.
-
#get_params ⇒ Object
This method returns all parameters/groups defined in a config file.
-
#get_value(param) ⇒ Object
This method will provide the value held by the object “@param” where “@param” is actually the name of the param in the config file.
-
#import_config ⇒ Object
Import data from the config to our config object.
-
#initialize(config_file = nil) ⇒ ParseConfig
constructor
Initialize the class with the path to the ‘config_file’ The class objects are dynamically generated by the name of the ‘param’ in the config file.
-
#validate_config ⇒ Object
Validate the config file, and contents.
-
#write(output_stream = STDOUT) ⇒ Object
Writes out the config file to output_stream.
Constructor Details
#initialize(config_file = nil) ⇒ ParseConfig
Initialize the class with the path to the ‘config_file’ The class objects are dynamically generated by the name of the ‘param’ in the config file. Therefore, if the config file is ‘param = value’ then the itializer will eval “@param = value”
34 35 36 37 38 39 40 41 42 43 |
# File 'lib/rhc/vendor/parseconfig.rb', line 34 def initialize(config_file=nil) @config_file = config_file @params = {} @groups = [] if(self.config_file) self.validate_config() self.import_config() end end |
Instance Attribute Details
#config_file ⇒ Object
Returns the value of attribute config_file.
26 27 28 |
# File 'lib/rhc/vendor/parseconfig.rb', line 26 def config_file @config_file end |
#groups ⇒ Object
Returns the value of attribute groups.
26 27 28 |
# File 'lib/rhc/vendor/parseconfig.rb', line 26 def groups @groups end |
#params ⇒ Object
Returns the value of attribute params.
26 27 28 |
# File 'lib/rhc/vendor/parseconfig.rb', line 26 def params @params end |
Instance Method Details
#[](param) ⇒ Object
This method is a shortcut to accessing the @params variable
105 106 107 |
# File 'lib/rhc/vendor/parseconfig.rb', line 105 def [](param) return self.params[param] end |
#add(param_name, value) ⇒ Object
This method adds an element to the config object (not the config file) By adding a Hash, you create a new group
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/rhc/vendor/parseconfig.rb', line 121 def add(param_name, value) if value.class == Hash if self.params.has_key?(param_name) if self.params[param_name].class == Hash self.params[param_name].merge!(value) elsif self.params.has_key?(param_name) if self.params[param_name].class != value.class raise ArgumentError, "#{param_name} already exists, and is of different type!" end end else self.params[param_name] = value end if ! self.groups.include?(param_name) self.groups.push(param_name) end else self.params[param_name] = value end end |
#add_to_group(group, param_name, value) ⇒ Object
Add parameters to a group. Note that parameters with the same name could be placed in different groups
144 145 146 147 148 149 |
# File 'lib/rhc/vendor/parseconfig.rb', line 144 def add_to_group(group, param_name, value) if ! self.groups.include?(group) self.add(group, {}) end self.params[group][param_name] = value end |
#get_groups ⇒ Object
List available sub-groups of the config.
115 116 117 |
# File 'lib/rhc/vendor/parseconfig.rb', line 115 def get_groups() return self.groups end |
#get_params ⇒ Object
This method returns all parameters/groups defined in a config file.
110 111 112 |
# File 'lib/rhc/vendor/parseconfig.rb', line 110 def get_params() return self.params.keys end |
#get_value(param) ⇒ Object
This method will provide the value held by the object “@param” where “@param” is actually the name of the param in the config file.
DEPRECATED - will be removed in future versions
98 99 100 101 102 |
# File 'lib/rhc/vendor/parseconfig.rb', line 98 def get_value(param) puts "ParseConfig Deprecation Warning: get_value() is deprecated. Use " + \ "config['param'] or config['group']['param'] instead." return self.params[param] end |
#import_config ⇒ Object
Import data from the config to our config object.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/rhc/vendor/parseconfig.rb', line 55 def import_config() # The config is top down.. anything after a [group] gets added as part # of that group until a new [group] is found. group = nil File.open(self.config_file) { |f| f.each do |line| line.strip! unless (/^\#/.match(line)) if(/\s*=\s*/.match(line)) param, value = line.split(/\s*=\s*/, 2) var_name = "#{param}".chomp.strip value = value.chomp.strip new_value = '' if (value) if value =~ /^['"](.*)['"]$/ new_value = $1 else new_value = value end else new_value = '' end if group self.add_to_group(group, var_name, new_value) else self.add(var_name, new_value) end elsif(/^\[(.+)\]$/.match(line).to_a != []) group = /^\[(.+)\]$/.match(line).to_a[1] self.add(group, {}) end end end } end |
#validate_config ⇒ Object
Validate the config file, and contents
46 47 48 49 50 51 52 |
# File 'lib/rhc/vendor/parseconfig.rb', line 46 def validate_config() if !File.readable?(self.config_file) raise Errno::EACCES, "#{self.config_file} is not readable" end # FIX ME: need to validate contents/structure? end |
#write(output_stream = STDOUT) ⇒ Object
Writes out the config file to output_stream
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/rhc/vendor/parseconfig.rb', line 152 def write(output_stream=STDOUT) self.params.each do |name,value| if value.class.to_s != 'Hash' if value.scan(/\w+/).length > 1 output_stream.puts "#{name} = \"#{value}\"" else output_stream.puts "#{name} = #{value}" end end end output_stream.puts "\n" self.groups.each do |group| output_stream.puts "[#{group}]" self.params[group].each do |param, value| if value.scan(/\w+/).length > 1 output_stream.puts "#{param} = \"#{value}\"" else output_stream.puts "#{param} = #{value}" end end output_stream.puts "\n" end end |