parseconfig 1.0.2 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79e32d975451b2b4cbf6ee3123e87b26a1fbf540066b3d44322c02d573a451af
+  data.tar.gz: 3a53181d9344b6b2ea790f968d7f33305709944bafd1c430a27601c411672fff
+SHA512:
+  metadata.gz: d7b538e6e901837e6d6e479e072841ba6dd404ecc060cf417d98a40e714daabaf92fa54c3eeec137ff11d5df98e055f374c8f8f43917ce4d3d3ef4668a3d2efa
+  data.tar.gz: 634668d51266a54123d170652bb8bd03fcac5936c4a0deb0f388860ecad6cd84cd88c256b85be6d78a7155b766cbccbc2de0334d3b601e1b9304aaa8403118c9

data/Changelog

@@ -1,7 +1,27 @@
+Mon Sep 28, 2020 - v1.1.0
+- Add non-value option support.
+  Resolves Issue #11
+
+Mon Jan 25, 2016 - v1.0.8
+- Use backward compatible positional arguments (not named keyword arguments)
+  Resolves Issue #31
+
+Mon Jan 25, 2016 - v1.0.7
+- Support alternative comment types (default: ['#', ';']) (@voobscout)
+  Resolves Issue #30
+
+Mon Oct 06, 2014 - v1.0.6
+- Fix where extraneous double quotes were getting wrapped around parameters
+  that have non-word characters (issue #19)
+
+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 +31,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 +59,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-2016 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,75 +1,91 @@
-Ruby ParseConfig Library
-========================
+# Ruby ParseConfig Library
 
-ParseConfig provides simple parsing of standard configuration files in the 
-form of 'param = value'.  It also supports nested [group] sections.
+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
-------------
+## Installation
 
-    $ sudo gem install parseconfig
+```
+$ gem install parseconfig
+```
 
-Usage
------
+Gemfile
+
+```
+gem '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
-    
+```
+# 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={
+```ruby
+>> require 'parseconfig'
+=> true
+
+>> config = ParseConfig.new('/path/to/config/example.conf')
+=> #<ParseConfig:0x102410908
+      @config_file="example.conf",
+      @groups=["group1", "group2"],
+      @params={
+            "param1"=>"value1"
+            "param2"=>"value2",
+            "group1"=>{
                 "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
--------
+            },
+            "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"
+
+>> file = File.open('/path/to/config/file', 'w')
+=> #<File:file>
+
+>> config.write(file)
+=> []
+
+>> file.close
+=> nil
+
+```
+
+## 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,25 +1,22 @@
-# 
-# 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,2016 Data Folk Labs, LLC
+# 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'
-
   attr_accessor :config_file, :params, :groups
 
   # Initialize the class with the path to the 'config_file'
@@ -28,128 +25,151 @@ class ParseConfig
   # the config file is 'param = value' then the itializer
   # will eval "@param = value"
   #
-  def initialize(config_file=nil)
+  def initialize(config_file = nil, separator = '=', comments = ['#', ';'])
     @config_file = config_file
     @params = {}
     @groups = []
-  
-    if(self.config_file)
-      self.validate_config()
-      self.import_config()
-    end
+    @split_regex = '\s*' + separator + '\s*'
+    @comments = comments
+
+    return unless config_file
+
+    validate_config
+    import_config
   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
-    
+  def validate_config
+    return if File.readable?(config_file)
+
+    raise Errno::EACCES, "#{config_file} is not readable"
+
     # FIX ME: need to validate contents/structure?
-  end  
-  
+  end
+
   # Import data from the config to our config object.
-  def import_config()
+  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|
-      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
+    open(config_file) do |f|
+      f.each_with_index do |line, i|
+        line.strip!
+
+        # force_encoding not available in all versions of ruby
+        begin
+          if i.eql? 0 && line.include?("\xef\xbb\xbf".force_encoding('UTF-8'))
+            line.delete!("\xef\xbb\xbf".force_encoding('UTF-8'))
+          end
+        rescue NoMethodError
+        end
+
+        is_comment = false
+        @comments.each do |comment|
+          if /^#{comment}/.match(line)
+            is_comment = true
+            break
+          end
+        end
+
+        unless is_comment
+          if /#{@split_regex}/.match(line)
+            param, value = line.split(/#{@split_regex}/, 2)
+            var_name = param.to_s.chomp.strip
+            value = value.chomp.strip
+            new_value = ''
+            if value
+              if value =~ /^['"](.*)['"]$/
+                new_value = Regexp.last_match(1)
+              else
+                new_value = value
+              end
             else
-              new_value = value
+              new_value = ''
             end
-          else
-            new_value = ''
-          end 
 
-          if group
-            self.add_to_group(group, var_name, new_value)
-          else
-            self.add(var_name, new_value)
+            if group
+              add_to_group(group, var_name, new_value)
+            else
+              add(var_name, new_value)
+            end
+          elsif /^\[(.+)\]$/.match(line).to_a != []
+            group = /^\[(.+)\]$/.match(line).to_a[1]
+            add(group, {})
+          elsif /\w+/.match(line)
+            add(line.to_s.chomp.strip, true)
           end
-          
-        elsif(/^\[(.+)\]$/.match(line).to_a != [])
-          group = /^\[(.+)\]$/.match(line).to_a[1]
-          self.add(group, {})
-          
         end
       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
   #
   def get_value(param)
-    puts "ParseConfig Deprecation Warning: get_value() is deprecated. Use " + \
+    puts 'ParseConfig Deprecation Warning: get_value() is deprecated. Use ' \
          "config['param'] or config['group']['param'] instead."
-    return self.params[param]
+    params[param]
   end
 
   # This method is a shortcut to accessing the @params variable
   def [](param)
-    return self.params[param]
+    params[param]
   end
 
   # This method returns all parameters/groups defined in a config file.
-  def get_params()
-    return self.params.keys
+  def get_params
+    params.keys
   end
-  
+
   # List available sub-groups of the config.
-  def get_groups()
-    return self.groups
+  def get_groups
+    groups
   end
 
   # 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)
+  def add(param_name, value, override = false)
     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
+      if params.key? param_name
+        if params[param_name].class == Hash
+          if override
+            params[param_name] = value
+          else
+            params[param_name].merge!(value)
+          end
+        elsif params.key? param_name
+          if 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
+        params[param_name] = value
       end
-      if ! self.groups.include?(param_name)
-        self.groups.push(param_name)
+      unless groups.include?(param_name)
+        groups.push(param_name)
       end
     else
-      self.params[param_name] = value
+      params[param_name] = value
     end
   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)
-    if ! self.groups.include?(group)
-      self.add(group, {})
-    end
-    self.params[group][param_name] = value
+    add(group, {}) unless groups.include?(group)
+    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| 
+  def write(output_stream = STDOUT, quoted = true)
+    params.each do |name, value|
       if value.class.to_s != 'Hash'
-        if value.scan(/\w+/).length > 1
+        if quoted == true
           output_stream.puts "#{name} = \"#{value}\""
         else
           output_stream.puts "#{name} = #{value}"
@@ -157,11 +177,11 @@ class ParseConfig
       end
     end
     output_stream.puts "\n"
-    
-    self.groups.each do |group|
+
+    groups.each do |group|
       output_stream.puts "[#{group}]"
-      self.params[group].each do |param, value| 
-        if value.scan(/\w+/).length > 1
+      params[group].each do |param, value|
+        if quoted == true
           output_stream.puts "#{param} = \"#{value}\""
         else
           output_stream.puts "#{param} = #{value}"
@@ -170,4 +190,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)
+    params == other.params && groups == other.groups
+  end
+  alias == eql?
 end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module ParseConfig
+  VERSION = '1.1.0'.freeze
+end

metadata

@@ -1,65 +1,47 @@
---- !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.1.0
 platform: ruby
-authors: 
+authors:
 - BJ Dierkes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2012-06-12 00:00:00 -05:00
-default_executable: 
+date: 2020-09-28 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 standardconfiguration files in
+  the form of 'param = value'. It also supports nested [group] sections.
+email: derks@datafolklabs.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README.md
+files:
 - Changelog
 - LICENSE
+- README.md
 - lib/parseconfig.rb
-has_rdoc: true
-homepage: http://github.com/derks/ruby-parseconfig/
+- lib/version.rb
+homepage: http://github.com/datafolklabs/ruby-parseconfig/
 licenses: []
-
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.6
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
 summary: Config File Parser for Standard Unix/Linux Type Config Files
 test_files: []
-