parseconfig 1.0.6 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d1e9b35305ee60ce0732906eee17091e8c3564e
-  data.tar.gz: 20c5c7343345170d04a5f9009f55f9a31bf61cc2
+SHA256:
+  metadata.gz: 6d3c3c0e6a2c362a4d7afb9c6ecef637497b94137e570b96c3eade26f07f8825
+  data.tar.gz: ae849249bce23a5988a51159e388237af2540883dc60de7d164e14501c3d484d
 SHA512:
-  metadata.gz: 7db0455728e0e7a4cbb058db4766e28bf5029258b10f808c11bf5eca06a5d53dafb9499dac1339bbcf847306ac3f39c6f55cd9ed77dfbdb57134170dcd3ff413
-  data.tar.gz: 31d19e90674de0732c023e644b90e9860c5845b8d0cabed89022786b45d8c43a4d16c81cd8b2f9f196da6548ada8a95741ee941fbe43bf1b250a5e822373a9c3
+  metadata.gz: 3f49ecd6162b3a6f6bb6140f7a44666f312e6682862e8e6957ce28792b4e5e1629b815e981b409ee0588a9309d2c4dbdcce595b3f42e2bee390f6439731b6c54
+  data.tar.gz: bfc2d1519921b14744d873bf71ad76b3da18068cc0929ce59baac5757e0dcb5948b59a86940e2141ee99530ef436787157f4a04726c8562762979f48c8708996

data/Changelog

@@ -1,3 +1,22 @@
+
+Wed Sep 29, 2021 - v1.1.1 (DEVELOPMENT - will be released as 1.1.2)
+- Dev and test against recent versions of Ruby (2.6+, 3.0+)
+- Docker development support
+- Remove tests for deprecated 'get_value()' method
+- Use Rspec 'expect' in place of 'should'
+
+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)

data/LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License:
 
-Copyright (c) 2006-2014 Data Folk Labs, LLC
+Copyright (c) 2006 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,42 +1,43 @@
-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.
+form of `param = value`.  It also supports nested `[group]` sections.
 
-[![Continuous Integration Status](https://secure.travis-ci.org/datafolklabs/ruby-parseconfig.png)](http://travis-ci.org/datafolklabs/ruby-parseconfig)
+[![Continuous Integration Status](https://app.travis-ci.com/datafolklabs/ruby-parseconfig.svg?branch=master)](https://app.travis-ci.com/github/datafolklabs/ruby-parseconfig)
 
-Installation
-------------
+## Installation
 
-    $ sudo gem install parseconfig
+```
+$ gem install parseconfig
+```
 
 Gemfile
 
-     gem 'parseconfig'
+```
+gem 'parseconfig'
+```
 
-Usage
------
+## Usage
 
 An example configuration file might look like:
 
-    # Example Config
-    param1 = value1
-    param2 = value2
-
-    [group1]
-    group1_param1 = group1_value1
-    group1_param2 = group1_value2
+```
+# Example Config
+param1 = value1
+param2 = value2
 
-    [group2]
-    group2_param1 = group2_value1
-    group2_param2 = group2_value2
+[group1]
+group1_param1 = group1_value1
+group1_param2 = group1_value2
 
+[group2]
+group2_param1 = group2_value1
+group2_param2 = group2_value2
+```
 
 Access it with ParseConfig:
 
 ```ruby
-
 >> require 'parseconfig'
 => true
 
@@ -74,15 +75,65 @@ Access it with ParseConfig:
 
 >> file = File.open('/path/to/config/file', 'w')
 => #<File:file>
+
 >> config.write(file)
 => []
+
 >> file.close
 => nil
 
 ```
 
-License
--------
+## Development
+
+### Docker
+
+This project includes a `docker-compose` configuration that sets up all required services, and dependencies for development and testing.  This is the recommended path for local development, and is the only fully supported option.
+
+The following creates all required docker containers, and launches a BASH shell within the `parseconfig` dev container for development.
+```
+$ make dev
+
+|> parseconfig <| src #
+```
+
+The above is the equivalent of running:
+
+```
+$ docker-compose up -d
+
+$ docker-compose exec parseconfig /bin/bash
+```
+
+**Testing Alternative Versions of Ruby**
+
+The latest stable version of Ruby is the default, and target version accessible as the `parseconfig` container within Docker Compose.  For testing against alternative versions of Ruby, additional containers are created (ex: `parseconfig-rb26`, `parseconfig-rb27`, etc). You can access these containers via:
+
+```
+$ docker-compose ps
+               Name                    Command    State   Ports
+---------------------------------------------------------------
+ruby-parseconfig_parseconfig-rb26_1   /bin/bash   Up
+ruby-parseconfig_parseconfig-rb27_1   /bin/bash   Up
+ruby-parseconfig_parseconfig-rb30_1   /bin/bash   Up
+ruby-parseconfig_parseconfig_1        /bin/bash   Up
+
+
+$ docker-compose exec parseconfig-rb26 /bin/bash
+
+|> parseconfig-rb26 <| src #
+```
+
+### Running Unit Tests
+
+```
+$ make test
+```
+
+
+## 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,6 +1,6 @@
 #
 # Author::      BJ Dierkes <derks@datafolklabs.com>
-# Copyright::   Copyright (c) 2006,2013 BJ Dierkes
+# Copyright::   Copyright (c) 2006,2016 Data Folk Labs, LLC
 # License::     MIT
 # URL::         https://github.com/datafolklabs/ruby-parseconfig
 #
@@ -17,9 +17,6 @@
 # config file
 
 class ParseConfig
-
-  Version = '1.0.6'
-
   attr_accessor :config_file, :params, :groups
 
   # Initialize the class with the path to the 'config_file'
@@ -28,71 +25,87 @@ 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 = []
+    @split_regex = '\s*' + separator + '\s*'
+    @comments = comments
 
-    if(self.config_file)
-      self.validate_config()
-      self.import_config()
-    end
+    return unless config_file
+
+    validate_config
+    import_config
   end
 
   # Validate the config file, and contents
-  def validate_config()
-    unless 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
 
   # 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.
     group = nil
-    open(self.config_file) { |f| f.each_with_index do |line, i|
-      line.strip!
+    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
 
-      # 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"))
+        is_comment = false
+        @comments.each do |comment|
+          if /^#{comment}/.match(line)
+            is_comment = true
+            break
+          end
         end
-      rescue NoMethodError
-      end
 
-      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
+        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 /^\[(.+)\](\s*#{escaped_comment_regex}+.*)?$/.match(line).to_a != []
+            group = /^\[(.+)\](\s*#{escaped_comment_regex}+.*)?$/.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
+
+  def escaped_comment_regex
+    /[#{Regexp.escape(@comments.join(''))}]/
   end
 
   # This method will provide the value held by the object "@param"
@@ -102,61 +115,63 @@ class ParseConfig
   # 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, quoted=true)
-    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 quoted == true
           output_stream.puts "#{name} = \"#{value}\""
@@ -167,9 +182,9 @@ class ParseConfig
     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|
+      params[group].each do |param, value|
         if quoted == true
           output_stream.puts "#{param} = \"#{value}\""
         else
@@ -188,7 +203,7 @@ class ParseConfig
   # Returns true if ParseConfig are equivalent and false if they differ.
 
   def eql?(other)
-    self.params == other.params && self.groups == other.groups
+    params == other.params && groups == other.groups
   end
   alias == eql?
 end

data/lib/version.rb

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

metadata

@@ -1,18 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: parseconfig
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.2
 platform: ruby
 authors:
 - BJ Dierkes
+- Dmitry Shagin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2021-09-30 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@datafolklabs.com
+description: ParseConfig provides simple parsing of standardconfiguration files in
+  the form of 'param = value'. It also supports nested [group] sections.
+email: team@datafolklabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -21,8 +22,10 @@ files:
 - LICENSE
 - README.md
 - lib/parseconfig.rb
+- lib/version.rb
 homepage: http://github.com/datafolklabs/ruby-parseconfig/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -39,8 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Config File Parser for Standard Unix/Linux Type Config Files