parseconfig 1.0.2 → 1.0.4

data/Changelog

@@ -1,7 +1,11 @@
+Thu Dec 19, 2013 - v1.0.4
+- Add fix for config files with Byte Order Marker (BOM)
+- Add support for .eql? function.
+
 Tue Jun 12, 2012 - v1.0.2
-- Re-enable get_value() as it seems some projects are still using it.  
+- Re-enable get_value() as it seems some projects are still using it.
   That said, get_value() *will* be removed in the future at some point.
-  
+
 Tue Jun 12, 2012 - v1.0.0
 - Resolved Issue #3, Config files not closed properly.
 - Resolved Issue #7, Added basic rspec testing
@@ -11,26 +15,26 @@ Tue Jun 12, 2012 - v1.0.0
 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
-  of the import_config() method, the group would not be properly added to 
+  of the import_config() method, the group would not be properly added to
   self.groups[].
-- Added feature that if you attempt to add a group that already exists, the 
+- Added feature that if you attempt to add a group that already exists, the
   groups will be merged together.  Any existing params in the original
   group will be overwritten by the new ones.
 - Fully deprecated override_value() and nil_value().  Anything using
   'instance_variable*' has been removed as well as it wasn't working properly
   anyway.
-- If you attempt to add_to_group() to a group that doesn't exist, the group 
+- If you attempt to add_to_group() to a group that doesn't exist, the group
   is added automatically.
-  
+
 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 
+- 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_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.
@@ -39,44 +43,44 @@ Mon Aug 31, 2009 - v0.5
 
 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. 
+- Added the 'get_params' to return an array of all config parameters.
 
 Thu Feb 28, 2008 - v0.4.2
-- Fixed bug where if the value contains a '=' then the parameter 
+- Fixed bug where if the value contains a '=' then the parameter
   is not properly set. [bjd]
-- Fixed bug #13680	Unable to parse config options that contain 
-  single quotes. [bjd] 
+- Fixed bug #13680	Unable to parse config options that contain
+  single quotes. [bjd]
 
 Sun Sep 03, 2007 - v0.4.1
 - Now using 'instance_variable_set' and 'instance_variable_get'
-  instead of 'eval' (yeah.. that was dirty). [bjd] 
+  instead of 'eval' (yeah.. that was dirty). [bjd]
 
 
 Sat Aug 11, 2007 - v0.3.2
-- reorganizing files a bit. [bjd] 
-- renamed methods ....  no more uglyStyle...  now new_style. [bjd] 
+- reorganizing files a bit. [bjd]
+- renamed methods ....  no more uglyStyle...  now new_style. [bjd]
 
 
 Fri Feb 23, 2007 - v0.3.1
 - Added a bit of code to remove 'single' quotes... so, until I figure
-  a better option, values can't contain single quotes. [bjd] 
+  a better option, values can't contain single quotes. [bjd]
 
 
 Wed Feb 07, 2007 - v0.2.1
-- Renamed ParseConfig.class.rb to ParseConfig.rb. [bjd] 
-- Add 'strip' to remove trailing white spaces from config file. [bjd] 
+- Renamed ParseConfig.class.rb to ParseConfig.rb. [bjd]
+- Add 'strip' to remove trailing white spaces from config file. [bjd]
 
 
 Wed Dec 13, 2006 - v0.1.3
-- Added error check to ensure configFile is readable. [bjd] 
+- Added error check to ensure configFile is readable. [bjd]
 
 
 Sat Nov 25, 2006 - v0.1.2
 - Added regex to only read lines matching /\s*=\s*/ as
-  The class would bork if you had say, and empty line. [bjd] 
+  The class would bork if you had say, and empty line. [bjd]
 
 
 Fri Nov 24 2006 - v0.1.1
-- Built class, which is functional and fully usable. [bjd] 
+- Built class, which is functional and fully usable. [bjd]
 
 

data/LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License:
 
-Copyright (c) 2006-2012 BJ Dierkes
+Copyright (c) 2006-2013 Data Folk Labs, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,10 @@
 Ruby ParseConfig Library
 ========================
 
-ParseConfig provides simple parsing of standard configuration files in the 
+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)
+[![Continuous Integration Status](https://secure.travis-ci.org/datafolklabs/ruby-parseconfig.png)](http://travis-ci.org/datafolklabs/ruby-parseconfig)
 
 Installation
 ------------
@@ -19,54 +19,61 @@ An example configuration file might look like:
     # Example Config
     param1 = value1
     param2 = value2
-    
-    [group1] 
+
+    [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"], 
+    => #<ParseConfig:0x102410908
+            @config_file="example.conf",
+            @groups=["group1", "group2"],
             @params={
                 "param1"=>"value1"
                 "param2"=>"value2",
                 "group1"=>{
                     "param1"=>"value1"
-                    "param2"=>"value2", 
-                    }, 
+                    "param2"=>"value2",
+                    },
                 "group2"=>{
                     "param1"=>"value1"
-                    "param2"=>"value2", 
-                    }, 
+                    "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"
 
+    >> file = File.open('/path/to/config/file', 'w')
+    => #<File:file>
+    >> config.write(file)
+    => []
+    >> file.close
+    => nil
+
 
 License
 -------

data/lib/parseconfig.rb

@@ -1,24 +1,24 @@
-# 
-# Author::      BJ Dierkes <derks@bjdierkes.com> 
-# Copyright::   Copyright (c) 2006,2012 BJ Dierkes
-# License::     MIT 
-# URL::         https://github.com/derks/ruby-parseconfig
-# 
+#
+# Author::      BJ Dierkes <derks@datafolklabs.com>
+# Copyright::   Copyright (c) 2006,2013 BJ Dierkes
+# License::     MIT
+# URL::         https://github.com/datafolklabs/ruby-parseconfig
+#
 
 # This class was written to simplify the parsing of configuration
-# files in the format of "param = value".  Please review the 
+# files in the format of "param = value".  Please review the
 # demo files included with this package.
 #
 # For further information please refer to the './doc' directory
 # as well as the ChangeLog and README files included.
 #
 
-# Note: A group is a set of parameters defined for a subpart of a 
+# Note: A group is a set of parameters defined for a subpart of a
 # config file
 
 class ParseConfig
-  
-  Version = '1.0.2'
+
+  Version = '1.0.4'
 
   attr_accessor :config_file, :params, :groups
 
@@ -32,32 +32,41 @@ class ParseConfig
     @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" 
+  def validate_config()
+    unless File.readable?(self.config_file)
+      raise Errno::EACCES, "#{self.config_file} is not readable"
     end
-    
+
     # FIX ME: need to validate contents/structure?
-  end  
-  
+  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.  
+    # of that group until a new [group] is found.
     group = nil
-    open(self.config_file) { |f| f.each do |line|
+    open(self.config_file) { |f| f.each_with_index do |line, i|
       line.strip!
+
+      # force_encoding not available in all versions of ruby
+      begin
+        if i.eql? 0 and line.include?("\xef\xbb\xbf".force_encoding("UTF-8"))
+          line.delete!("\xef\xbb\xbf".force_encoding("UTF-8"))
+        end
+      rescue NoMethodError
+      end
+
       unless (/^\#/.match(line))
         if(/\s*=\s*/.match(line))
-          param, value = line.split(/\s*=\s*/, 2)  
+          param, value = line.split(/\s*=\s*/, 2)
           var_name = "#{param}".chomp.strip
           value = value.chomp.strip
           new_value = ''
@@ -69,26 +78,26 @@ class ParseConfig
             end
           else
             new_value = ''
-          end 
+          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
 
   # This method will provide the value held by the object "@param"
-  # where "@param" is actually the name of the param in the config 
-  # file.  
+  # where "@param" is actually the name of the param in the config
+  # file.
   #
   # DEPRECATED - will be removed in future versions
   #
@@ -107,7 +116,7 @@ class ParseConfig
   def get_params()
     return self.params.keys
   end
-  
+
   # List available sub-groups of the config.
   def get_groups()
     return self.groups
@@ -147,7 +156,7 @@ class ParseConfig
 
   # Writes out the config file to output_stream
   def write(output_stream=STDOUT)
-    self.params.each do |name,value| 
+    self.params.each do |name,value|
       if value.class.to_s != 'Hash'
         if value.scan(/\w+/).length > 1
           output_stream.puts "#{name} = \"#{value}\""
@@ -157,10 +166,10 @@ class ParseConfig
       end
     end
     output_stream.puts "\n"
-    
+
     self.groups.each do |group|
       output_stream.puts "[#{group}]"
-      self.params[group].each do |param, value| 
+      self.params[group].each do |param, value|
         if value.scan(/\w+/).length > 1
           output_stream.puts "#{param} = \"#{value}\""
         else
@@ -170,4 +179,16 @@ class ParseConfig
       output_stream.puts "\n"
     end
   end
+
+  # Public: Compare this ParseConfig to some other ParseConfig. For two config to
+  # be equivalent, they must have the same sections with the same parameters
+  #
+  # other - The other ParseConfig.
+  #
+  # Returns true if ParseConfig are equivalent and false if they differ.
+
+  def eql?(other)
+    self.params == other.params && self.groups == other.groups
+  end
+  alias == eql?
 end

metadata

@@ -1,65 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: parseconfig
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - BJ Dierkes
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-12 00:00:00 -05:00
-default_executable: 
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies: []
-
-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
+description: ParseConfig provides simple parsing of standard configuration files in
+  the form of 'param = value'.  It also supports nested [group] sections.
+email: derks@datafolklabs.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - Changelog
 - LICENSE
 - lib/parseconfig.rb
-has_rdoc: true
-homepage: http://github.com/derks/ruby-parseconfig/
+homepage: http://github.com/datafolklabs/ruby-parseconfig/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Config File Parser for Standard Unix/Linux Type Config Files
 test_files: []
-