iniparser 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 361522b3234615dbc73ae63ecd9abbb9ed1df79a
-  data.tar.gz: 9c7d1909eb8a8c7d5616d9be5d8d2f9021ee2d1b
+  metadata.gz: 6681fa0238b38ea834fdc8452d8da9bc1233996f
+  data.tar.gz: 70f3ef1fd66d4692bd2087fed4004f8788839047
 SHA512:
-  metadata.gz: bd91875fcc709176b7a1da91264497c82aa954660debcc5b3a51083f5c521618cf728e382c66b1b09ddbc32b2bea11c304f1e815ea0995fc6ea4fc79577811c5
-  data.tar.gz: 34a3188526a16e62006c34d4a9406c2f5c256ea020ceea8def88c68d105fb14670782cf54a6d7bd8a47ac5c1db48342464b8f7de3e269e04f8d42b2e0e755983
+  metadata.gz: b4e304e2f6d4fac81144565b4c3d265767ec5a672a040f8fa7eac0262cf89b6242fe66e69e86522c2854bff531974d4319333fe10346093c95cfdc9653453c3c
+  data.tar.gz: 4559486a9a9dc64f0f4312ee9664ca54b70bb7358cc1c09b3b8f250825e132e329e3ec5b3ae17afa4b21dfecc657038e8a0daf3af0cd9c02f02933c3f05c2a91

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/Manifest.txt

@@ -1,4 +1,5 @@
-HISTORY.md
+CHANGELOG.md
+LICENSE.md
 Manifest.txt
 README.md
 Rakefile
@@ -7,4 +8,3 @@ lib/iniparser/parser.rb
 lib/iniparser/version.rb
 test/helper.rb
 test/test_parser.rb
-test/test_version.rb

data/README.md

@@ -1,19 +1,39 @@
-# iniparser
-
-iniparser gem -  read / parse INI configuration, setttings and data files into a hash
+# iniparser - read / parse INI configuration, settings and data files into a hash
 
 
 * home  :: [github.com/datatxt/iniparser](https://github.com/datatxt/iniparser)
 * bugs  :: [github.com/datatxt/iniparser/issues](https://github.com/datatxt/iniparser/issues)
 * gem   :: [rubygems.org/gems/iniparser](https://rubygems.org/gems/iniparser)
 * rdoc  :: [rubydoc.info/gems/iniparser](http://rubydoc.info/gems/iniparser)
+* forum :: [groups.google.com/group/wwwmake](http://groups.google.com/group/wwwmake)
+
+
+
+## Usage
 
+`INI.load` • `INI.load_file`
 
 
-## Usage - `INI.load`, `INI.load_file`
+Option 1) `INI.load` - load from string. Example:
+
+``` ruby
+hash = INI.load( <<TXT )
+  title = Planet Open Data News
+
+  [Open Street Map (OSM) News]
+    feed = https://blog.openstreetmap.org/feed
+TXT
+```
+
+
+Option 2) `INI.load_file` - load from file (shortcut). Example:
+
+``` ruby
+hash = INI.load_file( './planet.ini' )
+```
 
-Use `INI.load` or `INI.load_file`. Example:
 
+All together now. Example:
 
 ``` ruby
 require 'iniparser'
@@ -23,21 +43,21 @@ text = <<TXT
 ; another comment
 
 key1 = hello
-key2 : hi!
+key2 = hi!
 
 [section1]
-key3 = salut   # end of line comment here
+key3 = salut    # end of line comment here
 
 [section2]
-key4: hola
+key4  = hola    ; another end of line comment here
 blank =
-blank2:
+blank2
 
-[ http://example.com ]
-title =  A rose is a rose is a rose, eh?
-title2:  A rose is a rose is a rose, eh?   # comment here
-; another one here
-title3 = A rose is a rose is a rose, eh?
+[section3 "http://example.com"]
+# comment here
+title  = A rose is a rose is a rose, eh?
+; another comment here
+title2 = A rose is a rose is a rose, eh?
 TXT
 
 hash = INI.load( text )
@@ -51,35 +71,239 @@ resulting in:
  "key2"=>"hi!",
  "section1"=>{"key3"=>"salut"},
  "section2"=>{"key4"=>"hola", "blank"=>"", "blank2"=>""},
- "http://example.com"=>
-  {"title"=>"A rose is a rose is a rose, eh?",
-   "title2"=>"A rose is a rose is a rose, eh?",
-   "title3"=>"A rose is a rose is a rose, eh?"}}
+ "section3"=>{"http://example.com"=>{"title"=>"A rose is a rose is a rose, eh?",
+                                     "title2"=>"A rose is a rose is a rose, eh?"}}}
 ```
 
 to access use:
 
 ``` ruby
 puts hash['key1']
-# => 'hello'
+#=> 'hello'
 puts hash['key2']
-# => 'hi!'
+#=> 'hi!'
 puts hash['section1']['key3']
-# => 'salut'
+#=> 'salut'
 puts hash['section2']['key4']
-# => 'hola'
+#=> 'hola'
 puts hash['section2']['blank']
-# => ''
+#=> ''
 puts hash['section2']['blank2']
-# => ''      
-puts hash['http://example.com']['title']
-# => 'A rose is a rose is a rose, eh?'
-puts hash['http://example.com']['title2']
-# => 'A rose is a rose is a rose, eh?'
-puts hash['http://example.com']['title3']
-# => 'A rose is a rose is a rose, eh?'
+#=> ''      
+puts hash['section3']['http://example.com']['title']
+#=> 'A rose is a rose is a rose, eh?'
+puts hash['section3']['http://example.com']['title2']
+#=> 'A rose is a rose is a rose, eh?'
+```
+
+
+
+## Real World Example
+
+
+**Git Config**
+
+```
+#
+# This is the config file, and
+# a '#' or ';' character indicates
+# a comment
+#
+
+; core variables
+[core]
+  ; Don't trust file modes
+  filemode = false
+
+; Our diff algorithm
+[diff]
+  external = /usr/local/bin/diff-wrapper
+  renames = true
+
+; Proxy settings
+[core]
+  gitproxy=proxy-command for kernel.org
+  gitproxy=default-proxy ; for all the rest
+
+; HTTP
+[http]
+  sslVerify
+[http "https://weak.example.com"]
+  sslVerify = false
+  cookieFile = /tmp/cookie.txt
 ```
 
+resulting in
+a format warning:
+
+```
+WARN: line 20 - duplicate key >gitproxy< in section; will overwrite existing value
+```
+
+and:
+
+``` ruby
+{"core"=>{"filemode"=>"false", "gitproxy"=>"default-proxy"},
+ "diff"=>{"external"=>"/usr/local/bin/diff-wrapper", "renames"=>"true"},
+ "http"=>
+  {"sslVerify"=>"",
+   "https://weak.example.com"=>
+    {"sslVerify"=>"false", "cookieFile"=>"/tmp/cookie.txt"}}}
+```
+
+**"Classic" Windows INI Config**
+
+```
+; last modified 1 April 2001 by John Doe
+[owner]
+name=John Doe
+organization=Acme Widgets Inc.
+
+[database]
+; use IP address in case network name resolution is not working
+server=192.0.2.62
+port=143
+file=payroll.dat
+```
+
+resulting in:
+
+```
+{"owner"=>{"name"=>"John Doe", "organization"=>"Acme Widgets Inc."},
+ "database"=>{"server"=>"192.0.2.62", "port"=>"143", "file"=>"payroll.dat"}}
+```
+
+**Planet Pluto Config**
+
+```
+title = Planet Ruby
+
+[Ruby Lang News]
+  feed = http://www.ruby-lang.org/en/feeds/news.rss
+
+[Rails Girls Summer of Code News]
+  feed = https://railsgirlssummerofcode.org/blog.xml
+
+
+[Benoit Daloze]
+  feed     = https://eregon.me/blog/feed.xml
+  location = Zürich › Switzerland
+
+[Thomas Leitner]
+  feed     = https://gettalong.org/posts.atom
+  location = Vienna • Wien › Austria
+
+[Paweł Świątkowski]
+  feed     = https://rubytuesday.katafrakt.me/feed.xml
+  location = Kraków › Poland
+```
+
+resulting in:
+
+``` ruby
+{"title"=>"Planet Ruby",
+ "Ruby Lang News"=>
+  {"feed"=>"http://www.ruby-lang.org/en/feeds/news.rss"},
+ "Rails Girls Summer of Code News"=>
+  {"feed"=>"https://railsgirlssummerofcode.org/blog.xml"},
+ "Benoit Daloze"=>
+  {"feed"=>"https://eregon.me/blog/feed.xml",
+   "location"=>"Z\u00FCrich \u203A Switzerland"},
+ "Thomas Leitner"=>
+  {"feed"=>"https://gettalong.org/posts.atom",
+   "location"=>"Vienna \u2022 Wien \u203A Austria"},
+ "Pawe\u0142 \u015Awi\u0105tkowski"=>
+  {"feed"=>"https://rubytuesday.katafrakt.me/feed.xml",
+   "location"=>"Krak\u00F3w \u203A Poland"}}
+```
+
+
+## Frequently Asked Questions (FAQ) and Answers
+
+### Q: Why not use TOML (Tom's Obvious, Minimal Language)?
+
+The IniParser returns a simple (nested) hash table and
+all values are always strings, period 
+(no auto-magic type inference or casting) and you MUST always 
+use strings "unquoted" e.g.
+
+    title = Planet Open Data News
+
+instead of requiring "typed" quoted string values:
+
+    title = "Planet Open Data News"
+
+Yes, TOML is great for more "advanced" INI configurations / settings 
+that require (strong) data types, 
+nested lists, inline arrays, and much more. 
+
+
+### Q: Why not use `IniFile` - the most popular library (10+ million downloads and counting)?
+
+Again the IniParser returns a simple (nested) "standard" hash table and
+all values are always strings, period 
+(no auto-magic type inference or casting 
+e.g. no conversion to bool (for true/false) 
+or numbers (for 1,2, etc.). 
+No wrapper around Hash or anything. Here be dragons ;-). 
+
+The popular IniFile CANNOT handle properties without values. Example: 
+
+```
+[http]
+  sslVerify
+```
+
+resulting in:
+
+```
+ERROR: Could not parse line: "  sslVerify" (IniFile::Error)
+```
+
+And parses "modern" named subsections into "flat" sections. Example:
+
+```
+[http]
+  ; sslVerify
+[http "https://weak.example.com"]
+  sslVerify = false
+  cookieFile = /tmp/cookie.txt
+
+```
+
+resulting in:
+
+``` ruby
+{"http"=>{},
+ "http \"https://weak.example.com\""=>
+  {"sslVerify"=>false, "cookieFile"=>"/tmp/cookie.txt"}}}
+```
+
+and NOT resulting in:
+
+``` ruby
+{"http"=>
+  {"https://weak.example.com"=>
+    {"sslVerify"=>"false", "cookieFile"=>"/tmp/cookie.txt"}}}
+```
+
+
+
+### Q: What are some known IniParser format quirks?
+
+No quoted values (e.g. `"Hello"`)
+or escapes (e.g. `\#` `\n`) or quoted values with escapes (e.g. `"\n"`).
+
+No multi-line support for values.
+
+Inline end-of-line comments MUST start with at least one leading
+space (e.g. `test.html#test` is NOT an inline end-of-line comment but `test.html #test` is).
+
+Property key names must match the text pattern / regular expression `[a-zA-Z0-9_]([a-zA-Z0-9_-]*[a-zA-Z0-9_])?`,
+that is, use `a-z` / `A-Z`, `0-9` or underscore (`_`) and dash (`-`) only inside
+BUT no dot (`.`) for now.
+
+
 
 ## License
 

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'iniparser' do
 
   self.version = IniParser::VERSION
 
-  self.summary = 'iniparser - read / parse INI configuration, setttings and data files into a hash'
+  self.summary = 'iniparser - read / parse INI configuration, settings and data files into a hash'
   self.description = summary
 
   self.urls    = ['https://github.com/datatxt/iniparser']
@@ -15,12 +15,12 @@ Hoe.spec 'iniparser' do
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'HISTORY.md'
+  self.history_file = 'CHANGELOG.md'
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   required_ruby_version: '>= 1.9.2'
+   required_ruby_version: '>= 2.2.2'
   }
 
 end

data/lib/iniparser.rb

@@ -9,17 +9,5 @@ require 'iniparser/parser'
 
 
 
-module INI
-
-  # returns a nested hash
-  #  (compatible structure - works like YAML.load_file)
-
-  def self.load_file( path  )   IniParser::IniParser.load_file( path );  end
-  def self.load( text )         IniParser::IniParser.load( text );       end
-
-end  # module INI
-
-
-
 # say hello
 puts IniParser.banner    if defined?( $RUBYLIBS_DEBUG )

data/lib/iniparser/parser.rb

@@ -1,86 +1,164 @@
 # encoding: utf-8
 
 
-module IniParser
-
 
-class IniParser
+module IniParser
 
   # returns a nested hash
   #  (compatible structure - works like YAML.load_file)
+  def self.load_file( path  )   Parser.load_file( path );  end
+  def self.load( text )         Parser.load( text );       end
+
 
-  def self.load_file( path )
-    text = File.open( path, 'r:bom|utf-8' ).read
-    self.load( text )
+  class Error < StandardError
   end
 
-  def self.load( text )
-    self.new( text ).parse
+  ## todo/check - what is JSON and YAML returning Parser/ParseError something else?
+  ##  YAML uses ParseError  and JSON uses ParserError
+  class ParseError < Error
   end
 
 
-  def initialize( text )
-    @text = text
-  end
+  class Parser
+
+    # returns a nested hash
+    #  (compatible structure - works like YAML.load_file)
+
+    def self.load_file( path )
+      text = File.open( path, 'r:bom|utf-8' ) {|f| f.read }
+      load( text )
+    end
+
+    def self.load( text )
+      new( text ).parse
+    end
+
+
+    def initialize( text )
+      @text = text
+    end
+
+
+    COMMENT_CLASS = '[#;]'      # note: for now support # and ; - why? why not?
+
+    SEP_CLASS     = '[=]'       # note: name/value separator - for now only support = (no longer support :) - why? why not?
+
+
+    # note: for now do NOT support dot (.) - keep reserved for hierarchy latter
+    # note: for now allow dash (-) only inside identifier (NOT beginning or end)
+    # note: yes, allow just numbers as identifiers
+    IDENT = '[a-zA-Z0-9_](?:[a-zA-Z0-9_-]*[a-zA-Z0-9_])?'
+    STRICT_SECTION_RE = %r{^
+                            \s*
+                             \[
+                                \s*
+                                  (?<key>#{IDENT})
+                                \s*
+                                (?:"    ## allow optional subsection
+                                   (?<sub>[^"]+)
+                                   "
+                                   \s*
+                                )?
+                             \]
+                            \s*
+                            $}x
+
+    # note: yes, allow spaces inside (but only inside) section name
+    # note: for now NO quotes ("") allowed
+    SECTION_RE = %r{^
+                     \s*
+                      \[
+                         \s*
+                           (?<key>[^ "\]]
+                                   (?:[^"\]]*[^ "\]])?
+                           )
+                          \s*
+                      \]
+                    \s*
+                    $}x     # liberal section; allow everything in key
+
+
+    PROP_RE = %r{^
+                  \s*
+                     (?<key>#{IDENT})
+                   \s*
+                    (?:#{SEP_CLASS}
+                        \s*
+                         (?<value>.*?)    ## note: use non-greedy (.*?) match
+                        \s*
+                    )?
+                  $}x
+
+
+    def parse
+      hash = top_hash = {}
+
+      text = @text
+      text = text.gsub( "\t", ' ' )   # replace all tabs w/ spaces for now
+
+      lineno = 0
+      text.each_line do |line|
+        lineno += 1    ## track line numbers for (parse) error reporting
+
+        ### skip comments
+        #  e.g.   # this is a comment line
+
+        if line =~ /^\s*#{COMMENT_CLASS}/
+          ## logger.debug 'skipping comment line'
+          next
+        end
+
+        ### skip blank lines
+        if line =~ /^\s*$/
+          ## logger.debug 'skipping blank line'
+          next
+        end
+
+        # pass 1) remove possible trailing eol comment
+        ##  e.g    -> New York   # Sample EOL Comment Here (with or without commas,,,,)
+        ##  e.g    -> New York   ; Sample EOL Comment Here (with or without commas,,,,)
+        ## becomes -> New York
+        ## NOTE: MUST have leading white space for now - keep - why? why not!!!!!
+        ##   do any urls use # for fragments?
+
+        line = line.sub( /\s+#{COMMENT_CLASS}.*$/, '' )
+
+        # pass 2) remove leading and trailing whitespace
+
+        line = line.strip
+
+        if m=STRICT_SECTION_RE.match( line )  # strict section
+          key  = m[ :key ]
+          hash = top_hash[ key ] ||= {}
+
+          sub_key = m[ :sub ]
+          if sub_key   ## check for subsection
+            hash = hash[ sub_key ] ||= {}
+          end
+        elsif m=SECTION_RE.match( line )     # liberal section; allow everything in key
+          key =  m[ :key ]
+          hash = top_hash[ key ] ||= {}
+        elsif m=PROP_RE.match( line )
+          key   = m[ :key ]
+          value = m[ :value].to_s   # note: use to_s - might return nil
+          ### todo:  strip quotes from value??? why? why not?
+          ## todo/check - raise error on duplicate - why? why not?
+          ##  for now just warn
+          puts "WARN: line #{lineno} - duplicate key >#{key}< in section; will overwrite existing value"   if hash.key?( key )
+          hash[ key ] = value
+        else
+          raise ParseError.new( "line #{lineno} - unknown line type; cannot parse >#{line}<" )
+        end
+      end # each lines
+
+      top_hash
+    end
+
+  end # class Parser
+end # module IniParser
 
-  def parse
-    hash = top_hash = Hash.new
-
-    text = @text
-    text = text.gsub( "\t", ' ' )   # replace all tabs w/ spaces
-
-    text.each_line do |line|
-
-      ### skip comments
-      #  e.g.   # this is a comment line
-      #  or     ; this too
-      #  or     --  haskell style
-      #  or     %   text style
-
-      if line =~ /^\s*#/ || line =~ /^\s*;/ || line =~ /^\s*--/ || line =~ /^\s*%/
-        ## logger.debug 'skipping comment line'
-        next
-      end
-
-      ### skip blank lines
-      if line =~ /^\s*$/
-        ## logger.debug 'skipping blank line'
-        next
-      end
-
-      # pass 1) remove possible trailing eol comment
-      ##  e.g    -> New York   # Sample EOL Comment Here (with or without commas,,,,)
-      ## becomes -> New York
-
-      line = line.sub( /\s+#.*$/, '' )
-
-      # pass 2) remove leading and trailing whitespace
-
-      line = line.strip
-
-      ## check for new section e.g.  [planet012-xxx_bc]
-
-      ### todo: allow _ or - in strict section key? why? why not??
-      ###   allow _ or - in value key? why why not??
-      if line =~ /^\s*\[\s*([a-z0-9_\-]+)\s*\]\s*$/   # strict section
-        key = $1.to_s.dup
-        hash = top_hash[ key ] = Hash.new
-      elsif line =~ /^\s*\[\s*([^ \]]+)\s*\]\s*$/     # liberal section; allow everything in key
-        key = $1.to_s.dup
-        hash = top_hash[ key ] = Hash.new
-      elsif line =~ /^\s*([a-z0-9_\-]+)\s*[:=](.*)$/
-        key   = $1.to_s.dup
-        value = $2.to_s.strip.dup   # check if it can be nil? if yes use blank string e.g. ''
-        ### todo:  strip quotes from value??? why? why not?
-        hash[ key ] = value
-      else
-        puts "*** warn: skipping unknown line type in ini >#{line}<"
-      end
-    end # each lines
-
-    top_hash
-  end
 
-end # class IniParser
+####
+# add a convenience shortcut
+INI = IniParser
 
-end # module IniParser

data/lib/iniparser/version.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
 module IniParser
-  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
+  MAJOR = 1    ## todo: namespace inside version or something - why? why not??
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/test_parser.rb

@@ -17,21 +17,21 @@ class TestParser < MiniTest::Test
   ; another comment
 
    key1 = hello
-   key2 : hi!
+   key2 = hi!
 
    [section1]
    key3 = salut   # end of line comment here
 
    [section2]
-   key4: hola
+   key4  = hola   ; end of line comment here
    blank =
-   blank2:
+   blank2
 
-   [ http://example.com ]
-   title =  A rose is a rose is a rose, eh?
-   title2:  A rose is a rose is a rose, eh?   # comment here
-   ; another one here
-   title3 = A rose is a rose is a rose, eh?
+   [section3 "http://example.com"]
+   # comment here
+   title  =  A rose is a rose is a rose, eh?
+   ; another comment here
+   title2 =  A rose is a rose is a rose, eh?   
 TXT
 
     hash = INI.load( text )
@@ -43,9 +43,145 @@ TXT
     assert_equal 'hola',  hash['section2']['key4']
     assert_equal '',      hash['section2']['blank']
     assert_equal '',      hash['section2']['blank2']
-    assert_equal 'A rose is a rose is a rose, eh?', hash['http://example.com']['title']
-    assert_equal 'A rose is a rose is a rose, eh?', hash['http://example.com']['title2']
-    assert_equal 'A rose is a rose is a rose, eh?', hash['http://example.com']['title3']
+    assert_equal 'A rose is a rose is a rose, eh?', hash['section3']['http://example.com']['title']
+    assert_equal 'A rose is a rose is a rose, eh?', hash['section3']['http://example.com']['title2']
   end
 
-end
+  def test_git
+    text = <<TXT
+    #
+    # This is the config file, and
+    # a '#' or ';' character indicates
+    # a comment
+    #
+    
+    ; core variables
+    [core]
+      ; Don't trust file modes
+      filemode = false
+    
+    ; Our diff algorithm
+    [diff]
+      external = /usr/local/bin/diff-wrapper
+      renames = true
+    
+    ; Proxy settings
+    [core]
+      gitproxy=proxy-command for kernel.org
+      gitproxy=default-proxy ; for all the rest
+    
+    ; HTTP
+    [http]
+      sslVerify
+    [http "https://weak.example.com"]
+      sslVerify = false
+      cookieFile = /tmp/cookie.txt
+TXT
+
+    hash = INI.load( text )
+    pp hash
+
+
+    assert_equal 'default-proxy', hash['core']['gitproxy']
+
+    assert_equal '',      hash['http']['sslVerify']
+    assert_equal 'false', hash['http']['https://weak.example.com']['sslVerify']    
+  end
+
+  def test_planet
+    text =<<TXT
+    title = Planet Ruby
+    
+    [Ruby Lang News]
+      feed = http://www.ruby-lang.org/en/feeds/news.rss
+    
+    [Rails Girls Summer of Code News]
+      feed = https://railsgirlssummerofcode.org/blog.xml
+    
+    
+    [Benoit Daloze]
+      feed     = https://eregon.me/blog/feed.xml
+      location = Zürich › Switzerland
+    
+    [Thomas Leitner]
+      feed     = https://gettalong.org/posts.atom
+      location = Vienna • Wien › Austria
+    
+    [Paweł Świątkowski]
+      feed     = https://rubytuesday.katafrakt.me/feed.xml
+      location = Kraków › Poland
+TXT
+
+    hash = INI.load( text )
+    pp hash
+
+    assert_equal 'Kraków › Poland', hash['Paweł Świątkowski']['location']
+  end
+
+  def test_database
+    text =<<TXT
+    [database "development"]
+    adapter  = sqlite3
+    database = db/development.sqlite3
+  
+  [database "test"]
+    adapter  = sqlite3
+    database = db/test.sqlite3
+  
+  [database "production"]
+    adapter  = sqlite3
+    database = db/production.sqlite3
+TXT
+
+    hash = INI.load( text )
+    pp hash
+
+    assert_equal 'db/development.sqlite3', hash['database']['development']['database']
+    assert_equal 'db/test.sqlite3',        hash['database']['test']['database']
+  end  
+
+  def test_windows
+    text =<<TXT
+    ; last modified 1 April 2001 by John Doe
+    [owner]
+    name=John Doe
+    organization=Acme Widgets Inc.
+    
+    [database]
+    ; use IP address in case network name resolution is not working
+    server=192.0.2.62
+    port=143
+    file=payroll.dat
+TXT
+
+    hash = INI.load( text )
+    pp hash
+
+    assert_equal '192.0.2.62', hash['database']['server']
+  end      
+
+  def test_quick
+    ## from python's configparser
+    text =<<TXT
+  [DEFAULT]
+  ServerAliveInterval = 45
+  Compression = yes
+  CompressionLevel = 9
+  ForwardX11 = yes
+  
+  [bitbucket.org]
+  User = hg
+  
+  [topsecret.server.com]
+  Port = 50022
+  ForwardX11 = no
+TXT
+
+    hash = INI.load( text )
+    pp hash
+
+    assert_equal 'yes', hash['DEFAULT']['ForwardX11']
+    assert_equal 'hg',  hash['bitbucket.org']['User']
+    assert_equal 'no',  hash['topsecret.server.com']['ForwardX11']
+  end
+end  # class TestParser

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iniparser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2020-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -30,25 +30,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
-description: iniparser - read / parse INI configuration, setttings and data files
-  into a hash
+        version: '3.16'
+description: iniparser - read / parse INI configuration, settings and data files into
+  a hash
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.md
+- CHANGELOG.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile
@@ -57,7 +59,6 @@ files:
 - lib/iniparser/version.rb
 - test/helper.rb
 - test/test_parser.rb
-- test/test_version.rb
 homepage: https://github.com/datatxt/iniparser
 licenses:
 - Public Domain
@@ -72,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -80,9 +81,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: iniparser - read / parse INI configuration, setttings and data files into
+summary: iniparser - read / parse INI configuration, settings and data files into
   a hash
 test_files: []

data/test/test_version.rb

@@ -1,21 +0,0 @@
-# encoding: utf-8
-
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_version.rb
-
-
-require 'helper'
-
-
-class TestVersion < MiniTest::Test
-
-
-  def test_version
-
-    puts IniParser::VERSION
-    assert true
-    ## assume everything ok if get here
-  end
-
-end # class TestVersion