iniparser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6681fa0238b38ea834fdc8452d8da9bc1233996f
-  data.tar.gz: 70f3ef1fd66d4692bd2087fed4004f8788839047
+  metadata.gz: 864d2c269a38ca9efb21af2a1e8710c963edf9dc
+  data.tar.gz: 94e3fcd5157e7e8ab9a86e4be678e1eb5250d3d7
 SHA512:
-  metadata.gz: b4e304e2f6d4fac81144565b4c3d265767ec5a672a040f8fa7eac0262cf89b6242fe66e69e86522c2854bff531974d4319333fe10346093c95cfdc9653453c3c
-  data.tar.gz: 4559486a9a9dc64f0f4312ee9664ca54b70bb7358cc1c09b3b8f250825e132e329e3ec5b3ae17afa4b21dfecc657038e8a0daf3af0cd9c02f02933c3f05c2a91
+  metadata.gz: 6b481907b4e2aac189c6a9fb12460ae8c5a7c0e286b822d68350a70465e53dc64e37e8743537d4a5e45b5a6aa330114ba8fe0ff2d8cabbaf51992b38782bb9a1
+  data.tar.gz: f6a5abb22e3baa710f7f3b4ffdab56957dbd1163bd8187bb24e61e0c0f1522345ea1f46b9f3f1d29f454d60895e9ee33bfea332489dfd71a4a906635620ef79f

data/README.md

@@ -1,4 +1,4 @@
-# iniparser - read / parse INI configuration, settings and data files into a hash
+# iniparser - read / parse INI configuration, settings and data files into a hash (incl. named subsections)
 
 
 * home  :: [github.com/datatxt/iniparser](https://github.com/datatxt/iniparser)
@@ -168,7 +168,7 @@ file=payroll.dat
 
 resulting in:
 
-```
+``` ruby
 {"owner"=>{"name"=>"John Doe", "organization"=>"Acme Widgets Inc."},
  "database"=>{"server"=>"192.0.2.62", "port"=>"143", "file"=>"payroll.dat"}}
 ```
@@ -217,6 +217,49 @@ resulting in:
    "location"=>"Krak\u00F3w \u203A Poland"}}
 ```
 
+**Rosetta Stone - Read A Configuration File**
+
+```
+# This is a configuration file in standard configuration file format
+#
+# Lines beginning with a hash or a semicolon are ignored by the application
+# program. Blank lines are also ignored by the application program.
+
+# This is the fullname parameter
+FULLNAME Foo Barber
+
+# This is a favourite fruit
+FAVOURITEFRUIT banana
+
+# This is a boolean that should be set
+NEEDSPEELING
+
+# This boolean is commented out
+; SEEDSREMOVED
+
+# Configuration option names are not case sensitive, but configuration parameter
+# data is case sensitive and may be preserved by the application program.
+
+# An optional equals sign can be used to separate configuration parameter data
+# from the option name. This is dropped by the parser. 
+
+# A configuration option may take multiple parameters separated by commas.
+# Leading and trailing whitespace around parameter names and parameter data fields
+# are ignored by the application program.
+
+OTHERFAMILY Rhu Barber, Harry Barber
+```
+
+resulting in:
+
+``` ruby
+{"FULLNAME"=>"Foo Barber",
+ "FAVOURITEFRUIT"=>"banana",
+ "NEEDSPEELING"=>"",
+ "OTHERFAMILY"=>"Rhu Barber, Harry Barber"}
+```
+
+
 
 ## Frequently Asked Questions (FAQ) and Answers
 
@@ -284,7 +327,7 @@ and NOT resulting in:
 ``` ruby
 {"http"=>
   {"https://weak.example.com"=>
-    {"sslVerify"=>"false", "cookieFile"=>"/tmp/cookie.txt"}}}
+    {"sslVerify"=>false, "cookieFile"=>"/tmp/cookie.txt"}}}
 ```
 
 

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'iniparser' do
 
   self.version = IniParser::VERSION
 
-  self.summary = 'iniparser - read / parse INI configuration, settings and data files into a hash'
+  self.summary = 'iniparser - read / parse INI configuration, settings and data files into a hash (incl. named subsections)'
   self.description = summary
 
   self.urls    = ['https://github.com/datatxt/iniparser']

data/lib/iniparser/parser.rb

@@ -41,7 +41,9 @@ module IniParser
 
     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?
+    SEP_CLASS     = '[= ]'       # note: name/value separator
+                                 # - for now support = AND yes, space!!
+                                 # (note: no longer support :) - why? why not?
 
 
     # note: for now do NOT support dot (.) - keep reserved for hierarchy latter

data/lib/iniparser/version.rb

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

data/test/test_parser.rb

@@ -31,11 +31,21 @@ class TestParser < MiniTest::Test
    # 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?   
+   title2 =  A rose is a rose is a rose, eh?
 TXT
 
     hash = INI.load( text )
-    pp hash
+
+    exp = {"key1"=>"hello",
+           "key2"=>"hi!",
+           "section1"=>{"key3"=>"salut"},
+           "section2"=>{"key4"=>"hola", "blank"=>"", "blank2"=>""},
+           "section3"=>
+           {"http://example.com"=>
+            {"title"=>"A rose is a rose is a rose, eh?",
+             "title2"=>"A rose is a rose is a rose, eh?"}}}
+
+    assert_equal exp, hash
 
     assert_equal 'hello', hash['key1']
     assert_equal 'hi!',   hash['key2']
@@ -54,22 +64,22 @@ TXT
     # 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
@@ -79,41 +89,64 @@ TXT
 TXT
 
     hash = INI.load( text )
-    pp hash
 
+    exp = {"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"}}}
+
+    assert_equal exp, hash
 
     assert_equal 'default-proxy', hash['core']['gitproxy']
 
     assert_equal '',      hash['http']['sslVerify']
-    assert_equal 'false', hash['http']['https://weak.example.com']['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
+
+    exp = {"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"}}
+
+    assert_equal exp, hash
 
     assert_equal 'Kraków › Poland', hash['Paweł Świątkowski']['location']
   end
@@ -123,22 +156,28 @@ 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
+
+    exp = {"database"=>
+            {"development"=>{"adapter"=>"sqlite3", "database"=>"db/development.sqlite3"},
+             "test"=>{"adapter"=>"sqlite3", "database"=>"db/test.sqlite3"},
+             "production"=>{"adapter"=>"sqlite3", "database"=>"db/production.sqlite3"}}}
+
+    assert_equal exp, hash
 
     assert_equal 'db/development.sqlite3', hash['database']['development']['database']
     assert_equal 'db/test.sqlite3',        hash['database']['test']['database']
-  end  
+  end
 
   def test_windows
     text =<<TXT
@@ -146,7 +185,7 @@ TXT
     [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
@@ -155,10 +194,14 @@ TXT
 TXT
 
     hash = INI.load( text )
-    pp hash
+
+    exp = {"owner"=>{"name"=>"John Doe", "organization"=>"Acme Widgets Inc."},
+           "database"=>{"server"=>"192.0.2.62", "port"=>"143", "file"=>"payroll.dat"}}
+
+    assert_equal exp, hash
 
     assert_equal '192.0.2.62', hash['database']['server']
-  end      
+  end
 
   def test_quick
     ## from python's configparser
@@ -168,20 +211,71 @@ TXT
   Compression = yes
   CompressionLevel = 9
   ForwardX11 = yes
-  
+
   [bitbucket.org]
   User = hg
-  
+
   [topsecret.server.com]
   Port = 50022
   ForwardX11 = no
 TXT
 
     hash = INI.load( text )
-    pp hash
+
+    exp = {"DEFAULT"=>
+            {"ServerAliveInterval"=>"45",
+             "Compression"=>"yes",
+             "CompressionLevel"=>"9",
+             "ForwardX11"=>"yes"},
+           "bitbucket.org"=>{"User"=>"hg"},
+           "topsecret.server.com"=>{"Port"=>"50022", "ForwardX11"=>"no"}}
+
+    assert_equal exp, hash
 
     assert_equal 'yes', hash['DEFAULT']['ForwardX11']
     assert_equal 'hg',  hash['bitbucket.org']['User']
     assert_equal 'no',  hash['topsecret.server.com']['ForwardX11']
   end
+
+  def test_rosetta_stone
+    text =<<TXT
+    # This is a configuration file in standard configuration file format
+    #
+    # Lines beginning with a hash or a semicolon are ignored by the application
+    # program. Blank lines are also ignored by the application program.
+
+    # This is the fullname parameter
+    FULLNAME Foo Barber
+
+    # This is a favourite fruit
+    FAVOURITEFRUIT banana
+
+    # This is a boolean that should be set
+    NEEDSPEELING
+
+    # This boolean is commented out
+    ; SEEDSREMOVED
+
+    # Configuration option names are not case sensitive, but configuration parameter
+    # data is case sensitive and may be preserved by the application program.
+
+    # An optional equals sign can be used to separate configuration parameter data
+    # from the option name. This is dropped by the parser.
+
+    # A configuration option may take multiple parameters separated by commas.
+    # Leading and trailing whitespace around parameter names and parameter data fields
+    # are ignored by the application program.
+
+    OTHERFAMILY Rhu Barber, Harry Barber
+TXT
+
+    hash = INI.load( text )
+
+    exp = {"FULLNAME"=>"Foo Barber",
+           "FAVOURITEFRUIT"=>"banana",
+           "NEEDSPEELING"=>"",
+           "OTHERFAMILY"=>"Rhu Barber, Harry Barber"}
+
+    assert_equal exp, hash
+  end
 end  # class TestParser

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iniparser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-23 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.16'
 description: iniparser - read / parse INI configuration, settings and data files into
-  a hash
+  a hash (incl. named subsections)
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
@@ -85,5 +85,5 @@ rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: iniparser - read / parse INI configuration, settings and data files into
-  a hash
+  a hash (incl. named subsections)
 test_files: []