parseconfig 0.4.3 → 0.5

data/Changelog

@@ -1,3 +1,18 @@
+Mon Aug 31, 2009 - v0.5
+- Added sub-groups feature per RubyForge tracker [#27019].  Config files
+  can now have [subgroups] whose values are added to a nested Hash object.
+- Added the write() function per RubyForge tracker [#27019].  Will print 
+  to STDOUT by default, or to a file object if passed.
+- Added the add(), and add_to_group() functions to support new features
+  per RubyForge tracker [#27019].
+- Thank you to Titouan Christophe for the submissions listed above!
+- ParseConfig.get_params() returns all params including groups.  
+  ParseConfig.get_groups() returns available sub-groups.
+- See the demo.rb and demo.conf files which have been updated to reflect
+  this update.
+- The methods override_value() and nil_value() are now deprecated and will
+  be removed in future versions.
+
 Sat Mar 28, 2009 - v0.4.3
 - Added the self.params member that is a Hash holding all parameter/values.
 - Added the 'get_params' to return an array of all config parameters. 

data/README

@@ -14,9 +14,6 @@ applications.
 Parsing of simple configuration files (not Ruby specific).
 Allows ruby applications as well as Bash Init scripts to use the same config.
 
-Problem: Currently single quotes are stripped... therefore, values with a 
-single quote are not possible.
-
 == SYNOPSIS:
 
   require('rubygems')
@@ -37,7 +34,7 @@ single quote are not possible.
 
 == LICENSE:
 
-Copyright (C) 2006,2007  BJ Dierkes <wdierkes@5dollarwhitebox.org>
+Copyright (C) 2006,2009  BJ Dierkes <wdierkes@5dollarwhitebox.org>
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License

data/demo.conf

@@ -1,6 +1,11 @@
-# Sample configuration file to demo ParseConfig
-name = johnny
-age = 21
-    # checking bug 23244
-address = '5555 North South 77th street'
-slogan = "I ain't no fool"
+admin_email = root@localhost
+listen_ip = 127.0.0.1
+listen_port = 87345
+
+[group1]
+user_name = johnny
+group_name = daemons
+
+[group2]
+user_name = rita
+group_name = daemons

data/demo.rb

@@ -14,19 +14,53 @@ rescue Errno::EACCES
 	exit
 end
 
-puts "Hello, my name is #{c.get_value('name')}."
-puts "I am #{c.get_value('age')} years old, but will be #{c.override_value('age', '22')} soon."
-puts "I currently live at #{c.params['address']}, and my slogan is \"#{c.get_value('slogan')}\"."
+puts
+puts 'Reading main config section and groups...'
+puts '-' * 77
+puts 
+c.write()
+puts
+puts 'Available params are...'
+puts '-' * 77
+puts 
+puts c.get_params()
+puts
+puts
 
+puts 'Available sub-groups are...'
+puts '-' * 77
+puts 
+puts c.get_groups()
+puts
+puts
+
+puts 'Accessing sub-group params...'
+puts '-' * 77
+puts 
+puts "group1 user name value is: #{c.params['group1']['user_name']}"
+puts
+puts
+
+puts "Using params hash..."
+puts '-' * 77
+puts
+puts "The admin email address is #{c.params['admin_email']}"
+puts 
+puts
+
+puts "Using get_value (kind of deprecated)..."
+puts '-' * 77
+puts
+puts "The listen address is #{c.get_value('listen_ip')} and the user name " + 
+     "is #{c.get_value('group1')['user_name']}"
 puts 
 puts
-puts "All the paramaters are..."
-res = c.get_params()
-res.each do |param|
-  puts param
-end
 
+puts "Writing the config out to a file"
+puts '-' * 77
 puts
+f = open('/tmp/parseconfig_sample_config', 'w')
+c.write(f)
+f.close()
+puts "Config written to /tmp/parseconfig_sample_config"
 puts
-puts "using params hash"
-puts c.params['age']

data/lib/parseconfig.rb

@@ -2,7 +2,7 @@
 # $Id: parseconfig.rb 37 2008-02-29 07:27:33Z wdierkes $
 # 
 # Author::      BJ Dierkes <wdierkes@5dollarwhitebox.org> 
-# Copyright::   Copyright (c) 2006,2007 5dollarwhitebox.org 
+# Copyright::   Copyright (c) 2006,2009 5dollarwhitebox.org 
 # License::     GPL
 # URL::         http://www.5dollarwhitebox.org
 # 
@@ -15,11 +15,14 @@
 # as well as the ChangeLog and README files included.
 #
 
+# Note: A group is a set of parameters defined for a subpart of a 
+# config file
+
 class ParseConfig
   
-  Version = '0.4.3'
+  Version = '0.5'
 
-  attr_accessor :config_file, :params
+  attr_accessor :config_file, :params, :groups
 
   # Initialize the class with the path to the 'config_file'
   # The class objects are dynamically generated by the
@@ -27,14 +30,32 @@ class ParseConfig
   # the config file is 'param = value' then the itializer
   # will eval "@param = value"
   #
-  def initialize(config_file)
+  def initialize(config_file=nil)
     @config_file = config_file
     @params = {}
+    @groups = []
+  
+    if(self.config_file)
+      self.validate_config()
+      self.import_config()
+    end
+  end
+  
+  # Validate the config file, and contents
+  def validate_config()  
     if !File.readable?(self.config_file)
       raise Errno::EACCES, "#{self.config_file} is not readable" 
     end
-
-    open(self.config_file).each { |line| 
+    
+    # FIX ME: need to validate contents/structure?
+  end  
+  
+  # Import data from the config to our config object.
+  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
+    open(self.config_file).each do |line| 
       line.strip!
       unless (/^\#/.match(line))
         if(/\s*=\s*/.match(line))
@@ -51,11 +72,21 @@ class ParseConfig
           else
             new_value = ''
           end 
-          self.instance_variable_set("@#{var_name}", new_value)
-          self.params["#{var_name}"] = new_value
+
+          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, {})
+          self.groups.push(group)
+          
         end
       end
-    }   
+    end   
   end
 
   # This method will provide the value held by the object "@param"
@@ -65,22 +96,73 @@ class ParseConfig
     self.instance_variable_get("@#{param}") 
   end
 
+  # This method returns all parameters/groups defined in a config file.
+  def get_params()
+    return self.params.keys
+  end
+  
+  # List available sub-groups of the config.
+  def get_groups()
+    return self.groups
+  end
+  
   # This method is simple.  Should you need to override a value 
   # dynamically, use override_value(param, value) where 'param' is
   # the name of the paramater in the config file.
   #
+  # DEPRECATED - will be removed in future versions.
+  #
   def override_value(param, value)
     self.instance_variable_set("@#{param}", value)
   end
 
   # This method will set the value of '@param' to nil (not in the config
   # file, only in the app).  
+  #
+  # DEPRECATED - will be removed in future versions.
+  #
   def nil_value(param)
     self.instance_variable_set("@#{param}", nil)
   end
 
-  def get_params()
-    return self.params.keys
+  # This method adds an element to the config object (not the config file)
+  # By adding a Hash, you create a new group
+  def add(param_name, value)
+    self.instance_variable_set("@#{param_name}", value)
+    self.params["#{param_name}"] = value
+  end
+
+  # Add parameters to a group. Note that parameters with the same name
+  # could be placed in different groups
+  def add_to_group(group, param_name, value)
+    self.instance_eval("@#{group}[\"#{param_name}\"] = \"#{value}\"")
+    self.params["#{group}"]["#{param_name}"] = value
   end
 
+  # Writes out the config file to output_stream
+  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
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: parseconfig
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: "0.5"
 platform: ruby
 authors: 
 - BJ Dierkes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-28 00:00:00 -05:00
+date: 2009-09-21 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: ParseConfig provides simple parsing of standard *nix style config files.