iniparser 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57828451b2152df706f149f08a0e163ab260eb83
-  data.tar.gz: 94c5a6efa3dc99fb7f92d8ae1cea835de6190e8b
+  metadata.gz: 361522b3234615dbc73ae63ecd9abbb9ed1df79a
+  data.tar.gz: 9c7d1909eb8a8c7d5616d9be5d8d2f9021ee2d1b
 SHA512:
-  metadata.gz: 1799b8c7c03b8b1470befcaa20239affcec38a840fd012c91b42c40fe14057c212ae355dd9d1b2e78f2ce6ce5c24fe3183185fdb210d3e21ca628491b6dc5f4f
-  data.tar.gz: 82e6c8c1040b1399b5e7549800a9fa40ab219eee21b90f6d9ee819dc5217f9cf59545b2d8c084920cd52ec52b64e22be81ba8917aa036936fc997a61241b1031
+  metadata.gz: bd91875fcc709176b7a1da91264497c82aa954660debcc5b3a51083f5c521618cf728e382c66b1b09ddbc32b2bea11c304f1e815ea0995fc6ea4fc79577811c5
+  data.tar.gz: 34a3188526a16e62006c34d4a9406c2f5c256ea020ceea8def88c68d105fb14670782cf54a6d7bd8a47ac5c1db48342464b8f7de3e269e04f8d42b2e0e755983

data/Manifest.txt

@@ -3,6 +3,8 @@ Manifest.txt
 README.md
 Rakefile
 lib/iniparser.rb
+lib/iniparser/parser.rb
 lib/iniparser/version.rb
 test/helper.rb
+test/test_parser.rb
 test/test_version.rb

data/README.md

@@ -1,6 +1,6 @@
 # iniparser
 
-iniparser gem -  read INI configuration, setttings and data files into a hash
+iniparser gem -  read / parse INI configuration, setttings and data files into a hash
 
 
 * home  :: [github.com/datatxt/iniparser](https://github.com/datatxt/iniparser)
@@ -9,12 +9,85 @@ iniparser gem -  read INI configuration, setttings and data files into a hash
 * rdoc  :: [rubydoc.info/gems/iniparser](http://rubydoc.info/gems/iniparser)
 
 
-## Usage
 
-TBD
+## Usage - `INI.load`, `INI.load_file`
+
+Use `INI.load` or `INI.load_file`. Example:
+
+
+``` ruby
+require 'iniparser'
+
+text = <<TXT
+# comment
+; another comment
+
+key1 = hello
+key2 : hi!
+
+[section1]
+key3 = salut   # end of line comment here
+
+[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?   # comment here
+; another one here
+title3 = A rose is a rose is a rose, eh?
+TXT
+
+hash = INI.load( text )
+pp hash
+```
+
+resulting in:
+
+``` ruby
+{"key1"=>"hello",
+ "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?"}}
+```
+
+to access use:
+
+``` ruby
+puts hash['key1']
+# => 'hello'
+puts hash['key2']
+# => 'hi!'
+puts hash['section1']['key3']
+# => 'salut'
+puts hash['section2']['key4']
+# => '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?'
+```
 
 
 ## License
 
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
 The `iniparser` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Post them to the [wwwmake forum](http://groups.google.com/group/wwwmake). Thanks!

data/Rakefile

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

data/lib/iniparser.rb

@@ -1,9 +1,23 @@
 # encoding: utf-8
 
 
+require 'pp'
 
 # our own code
 require 'iniparser/version'   # note: let version always go first
+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
 
 
 

data/lib/iniparser/parser.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+
+module IniParser
+
+
+class IniParser
+
+  # returns a nested hash
+  #  (compatible structure - works like YAML.load_file)
+
+  def self.load_file( path )
+    text = File.open( path, 'r:bom|utf-8' ).read
+    self.load( text )
+  end
+
+  def self.load( text )
+    self.new( text ).parse
+  end
+
+
+  def initialize( text )
+    @text = text
+  end
+
+  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
+
+end # module IniParser

data/lib/iniparser/version.rb

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

data/test/test_parser.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_parser.rb
+
+
+require 'helper'
+
+
+class TestParser < MiniTest::Test
+
+  def test_load
+
+    text = <<TXT
+  # comment
+  ; another comment
+
+   key1 = hello
+   key2 : hi!
+
+   [section1]
+   key3 = salut   # end of line comment here
+
+   [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?   # comment here
+   ; another one here
+   title3 = A rose is a rose is a rose, eh?
+TXT
+
+    hash = INI.load( text )
+    pp hash
+
+    assert_equal 'hello', hash['key1']
+    assert_equal 'hi!',   hash['key2']
+    assert_equal 'salut', hash['section1']['key3']
+    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']
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iniparser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -38,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.15'
-description: iniparser - read INI configuration, setttings and data files into a hash
+description: iniparser - read / parse INI configuration, setttings and data files
+  into a hash
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
@@ -52,8 +53,10 @@ files:
 - README.md
 - Rakefile
 - lib/iniparser.rb
+- lib/iniparser/parser.rb
 - lib/iniparser/version.rb
 - test/helper.rb
+- test/test_parser.rb
 - test/test_version.rb
 homepage: https://github.com/datatxt/iniparser
 licenses:
@@ -80,5 +83,6 @@ rubyforge_project:
 rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: iniparser - read INI configuration, setttings and data files into a hash
+summary: iniparser - read / parse INI configuration, setttings and data files into
+  a hash
 test_files: []