parseconfig 0.5.2 → 1.0.0

data/Changelog

@@ -1,3 +1,9 @@
+Tue Jun 12, 2012 - v1.0.0
+- Resolved Issue #3, Config files not closed properly.
+- Resolved Issue #7, Added basic rspec testing
+- Resolved Issue #5, Readded support for array like access
+- Removed deprecated function get_value()
+
 Sat Feb 27, 2010 - v0.5.2
 - Re-releasing under MIT License.
 - Fixed issue with the add() method where if you added a group outside

data/LICENSE

@@ -1,6 +1,7 @@
+
 The MIT License:
 
-Copyright (c) 2006 BJ Dierkes
+Copyright (c) 2006-2012 BJ Dierkes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +20,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,75 @@
+Ruby ParseConfig Library
+========================
+
+ParseConfig provides simple parsing of standard configuration files in the 
+form of 'param = value'.  It also supports nested [group] sections.
+
+[![Continuous Integration Status](https://secure.travis-ci.org/derks/ruby-parseconfig.png)](http://travis-ci.org/derks/ruby-parseconfig)
+
+Installation
+------------
+
+    $ sudo gem install parseconfig
+
+Usage
+-----
+
+An example configuration file might look like:
+
+    # Example Config
+    param1 = value1
+    param2 = value2
+    
+    [group1] 
+    group1_param1 = group1_value1
+    group1_param2 = group1_value2
+    
+    [group2]
+    group2_param1 = group2_value1
+    group2_param2 = group2_value2
+    
+
+Access it with ParseConfig:
+
+    >> require('parseconfig.rb')
+    => true
+    
+    >> config = ParseConfig.new('/path/to/config/file')
+    => #<ParseConfig:0x102410908 
+            @config_file="example.conf", 
+            @groups=["group1", "group2"], 
+            @params={
+                "param1"=>"value1"
+                "param2"=>"value2",
+                "group1"=>{
+                    "param1"=>"value1"
+                    "param2"=>"value2", 
+                    }, 
+                "group2"=>{
+                    "param1"=>"value1"
+                    "param2"=>"value2", 
+                    }, 
+                }
+            >
+    
+    >> config.get_params()
+    => ["param1", "param2", "group1", "group2"]
+
+    >> config['param1']
+    => "value1"
+    
+    >> config.get_groups()
+    => ["group1", "group2"]
+    
+    >> config['group1']
+    => {"group1_param1"=>"group1_value1", "group1_param2"=>"group1_value2"}
+
+    >> config['group1']['group1_param1']
+    => "group1_value1"
+
+
+License
+-------
+
+The ParseConfig library is Open Source and distributed under the MIT license.
+Please see the LICENSE file included with this software.

data/lib/parseconfig.rb

@@ -1,9 +1,8 @@
-# $Id: parseconfig.rb 37 2008-02-29 07:27:33Z wdierkes $
 # 
-# Author::      BJ Dierkes <wdierkes@5dollarwhitebox.org> 
-# Copyright::   Copyright (c) 2006,2009 5dollarwhitebox.org 
+# Author::      BJ Dierkes <derks@bjdierkes.com> 
+# Copyright::   Copyright (c) 2006,2012 BJ Dierkes
 # License::     MIT 
-# URL::         http://www.5dollarwhitebox.org
+# URL::         https://github.com/derks/ruby-parseconfig
 # 
 
 # This class was written to simplify the parsing of configuration
@@ -19,7 +18,7 @@
 
 class ParseConfig
   
-  Version = '0.5.2'
+  Version = '0.5.3'
 
   attr_accessor :config_file, :params, :groups
 
@@ -54,7 +53,7 @@ class ParseConfig
     # 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| 
+    open(self.config_file) { |f| f.each do |line|
       line.strip!
       unless (/^\#/.match(line))
         if(/\s*=\s*/.match(line))
@@ -84,7 +83,7 @@ class ParseConfig
           
         end
       end
-    end   
+    end }
   end
 
   # This method will provide the value held by the object "@param"
@@ -93,7 +92,13 @@ class ParseConfig
   #
   # DEPRECATED - will be removed in future versions
   #
-  def get_value(param)
+  #def get_value(param)
+  #  puts "ParseConfig Deprecation Warning: get_value() is deprecated."
+  #  return self.params[param]
+  #end
+
+  # This method is a shortcut to accessing the @params variable
+  def [](param)
     return self.params[param]
   end
 
@@ -106,27 +111,6 @@ class ParseConfig
   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)
-    raise RuntimeError, "override_value() is deprecated as of 0.5.1"
-  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)
-    raise RuntimeError, "nil_value() is deprecated as of 0.5.1"
-  end
 
   # This method adds an element to the config object (not the config file)
   # By adding a Hash, you create a new group

metadata

@@ -3,10 +3,10 @@ name: parseconfig
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 5
-  - 2
-  version: 0.5.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - BJ Dierkes
@@ -14,12 +14,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-27 00:00:00 -06:00
+date: 2012-06-12 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: ParseConfig provides simple parsing of standard *nix style config files.
-email: wdierkes@5dollarwhitebox.org
+description: ParseConfig provides simple parsing of standard configuration files in the form of 'param = value'.  It also supports nested [group] sections.
+email: derks@bjdierkes.com
 executables: []
 
 extensions: []
@@ -27,14 +27,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.md
 - Changelog
 - LICENSE
-- demo.rb
-- demo.conf
 - lib/parseconfig.rb
 has_rdoc: true
-homepage: http://www.5dollarwhitebox.org/
+homepage: http://github.com/derks/ruby-parseconfig/
 licenses: []
 
 post_install_message: 
@@ -62,6 +60,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: ParseConfig provides simple parsing of standard *nix style config files.
+summary: Config File Parser for Standard Unix/Linux Type Config Files
 test_files: []
 

data/README

@@ -1,57 +0,0 @@
-rb-parseconfig
-    by BJ Dierkes
-    http://www.5dollarwhitebox.org 
-
-== DESCRIPTION:
-  
-rb-parseconfig is a Ruby class written to parse simple configuration 
-files in the format of 'param = value'. The key benefit is that your ruby 
-scripts can use the same configuration files of most unix/linux 
-applications.
-
-== FEATURES/PROBLEMS:
-  
-Parsing of simple configuration files (not Ruby specific).
-Allows ruby applications as well as Bash Init scripts to use the same config.
-
-== SYNOPSIS:
-
-  require('rubygems')
-  require('parseconfig')
-  config = ParseConfig.new('/path/to/config/file')
-  puts config['log_file']
-  puts config['pid_file']
-  ...
-
-== REQUIREMENTS:
-
-  * Ruby (Developed on 1.8.6)
-  * RubyGems 
-
-== INSTALL:
-
-  sudo gem install parseconfig
-
-== LICENSE:
-
-The MIT License:
-
-Copyright (c) 2006 BJ Dierkes
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/demo.conf

@@ -1,11 +0,0 @@
-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

@@ -1,66 +0,0 @@
-#!/usr/bin/env ruby
-
-require('rubygems')
-require('parseconfig')
-#require('./lib/parseconfig.rb')
-
-begin
-	c = ParseConfig.new('demo.conf')
-rescue Errno::ENOENT 
-	puts "The config file you specified was not found"
-	exit
-rescue Errno::EACCES 
-	puts "The config file you specified is not readable"
-	exit
-end
-
-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 "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