inifile 2.0.2 → 3.0.0

data/test/data/bad_2.ini

@@ -0,0 +1,11 @@
+[section_one]
+one = 1
+two = 2
+
+[section_two]
+close-quote = "some text without
+a closing quote - should
+be interesting
+
+[section_three]
+wat = where is that closing quote?

data/test/data/comment.ini

@@ -6,5 +6,5 @@ two = 2
 [section_two]  # you can comment here
 one = 42       # and even here!
 multi = 20 \   # and here, too
-+ 22 \= 42
++ 22 = 42
 

data/test/data/continuation.ini

@@ -0,0 +1,6 @@
+[section_one]
+one = 1
+two = 2
+
+[section_two]
+end-of-file = here is the last value \

data/test/data/good.ini

@@ -3,15 +3,15 @@ one = 1
 two = 2
 
 [section_two]
-three =         3
+three =         -3
 multi = multiline \
 support
 
 ; comments should be ignored
 [section three]
-four   =4
-five=5
-six =6
+four   =true
+five=false   # comments can go here
+six =6.0     ; and here, too
 
 [section_four]
    [section_five]

data/test/data/section.ini

@@ -0,0 +1,4 @@
+; section headers can be values
+[section_one]
+one=[value]
+two=2

data/test/test_inifile.rb

@@ -11,13 +11,13 @@ class TestIniFile < Test::Unit::TestCase
   def setup
     @ini_file = IniFile.new(:filename => 'test/data/good.ini')
     @contents = [
-      ['section_one', 'one', '1'],
-      ['section_one', 'two', '2'],
-      ['section_two', 'three', '3'],
+      ['section_one', 'one', 1],
+      ['section_one', 'two', 2],
+      ['section_two', 'three', -3],
       ['section_two', 'multi', "multiline support"],
-      ['section three', 'four', '4'],
-      ['section three', 'five', '5'],
-      ['section three', 'six', '6'],
+      ['section three', 'four', true],
+      ['section three', 'five', false],
+      ['section three', 'six', 6.0],
       ['section_five', 'seven and eight', '7 & 8']
     ].sort
 
@@ -84,7 +84,7 @@ class TestIniFile < Test::Unit::TestCase
   def test_delete_section
     assert_nil @ini_file.delete_section('section_nil')
 
-    h = {'one' => '1', 'two' => '2'}
+    h = {'one' => 1, 'two' => 2}
     assert_equal true, @ini_file.has_section?('section_one')
     assert_equal h, @ini_file.delete_section('section_one')
     assert_equal false, @ini_file.has_section?('section_one')
@@ -148,7 +148,7 @@ class TestIniFile < Test::Unit::TestCase
     assert @ini_file.eql?(@ini_file)
     assert @ini_file.eql?(@ini_file.clone)
     assert !@ini_file.eql?('string')
-    assert !@ini_file.eql?(IniFile.new(''))
+    assert !@ini_file.eql?(IniFile.new(:content => ''))
   end
 
   def test_freeze
@@ -179,18 +179,18 @@ class TestIniFile < Test::Unit::TestCase
 
   def test_index
     expected = {
-      'one' => '1',
-      'two' => '2'
+      'one' => 1,
+      'two' => 2
     }
     assert_equal expected, @ini_file[:section_one]
 
-    expected = {'three' => '3', 'multi' => "multiline support"}
+    expected = {'three' => -3, 'multi' => "multiline support"}
     assert_equal expected, @ini_file['section_two']
 
     expected = {
-      'four' => '4',
-      'five' => '5',
-      'six'  => '6',
+      'four' => true,
+      'five' => false,
+      'six'  => 6.0,
     }
     assert_equal expected, @ini_file['section three']
 
@@ -214,13 +214,11 @@ class TestIniFile < Test::Unit::TestCase
 
   def test_match
     expected = {
-     "section_two" =>
-      {
-        "three"=>"3", "multi"=>"multiline support"
+     "section_two" => {
+        "three" => -3, "multi" => "multiline support"
       },
-     "section three" =>
-      {
-        "four"=>"4", "five"=>"5", "six"=>"6"
+      "section three" => {
+        "four" => true, "five"=> false, "six" => 6.0
       }
     }
     assert_equal expected, @ini_file.match(/(two|three)/)
@@ -245,8 +243,8 @@ class TestIniFile < Test::Unit::TestCase
 
     ini_file = IniFile.new(:filename => 'test/data/param.ini', :parameter => ':')
     assert ini_file.has_section?('section_one')
-    assert_equal '1', ini_file['section_one']['one']
-    assert_equal '2', ini_file['section_one']['two']
+    assert_equal 1, ini_file['section_one']['one']
+    assert_equal 2, ini_file['section_one']['two']
 
     # make sure we error out on files with bad lines
     assert_raise(IniFile::Error) {IniFile.new :filename => 'test/data/bad_1.ini'}
@@ -254,7 +252,7 @@ class TestIniFile < Test::Unit::TestCase
 
   def test_initialize_from_string_without_ending_newline
     content = "[section_one]\n  foo=bar"
-    ini_file = IniFile.new(content)
+    ini_file = IniFile.new(:content => content)
     assert ini_file.has_section?('section_one')
     assert_equal 'bar', ini_file['section_one']['foo']
   end
@@ -262,7 +260,7 @@ class TestIniFile < Test::Unit::TestCase
   def test_initialize_from_string
     content = File.read('test/data/good.ini')
 
-    ini_file = IniFile.new(content, :comment => ';')
+    ini_file = IniFile.new(:content => content, :comment => ';')
     assert ini_file.has_section?('section_one')
     assert ini_file.has_section?('section_two')
     assert ini_file.has_section?('section three')
@@ -272,6 +270,35 @@ class TestIniFile < Test::Unit::TestCase
     assert_equal '7 & 8', ini_file['section_five']['seven and eight']
   end
 
+  def test_initialize_from_hash
+    hash = {
+      'section one' => {
+        'foo' => 'bar',
+        'baz' => 'buz'
+      },
+      'colors' => {
+        'perrywinkle' => '7e6ff3',
+        'steelblue' => '4682b4'
+      },
+      'empty' => nil
+    }
+
+    ini_file = IniFile.new(:content => hash)
+    assert ini_file.has_section?('section one')
+    assert ini_file.has_section?('colors')
+    assert ini_file.has_section?('empty')
+
+    assert_equal %w[baz foo], ini_file['section one'].keys.sort
+    assert_equal 'bar', ini_file['section one']['foo']
+    assert_equal 'buz', ini_file['section one']['baz']
+
+    assert_equal %w[perrywinkle steelblue], ini_file['colors'].keys.sort
+    assert_equal '7e6ff3', ini_file['colors']['perrywinkle']
+    assert_equal '4682b4', ini_file['colors']['steelblue']
+
+    assert_empty ini_file['empty']
+  end
+
   def test_sections
     expected = [
       'section_one', 'section_two', 'section three',
@@ -323,8 +350,8 @@ class TestIniFile < Test::Unit::TestCase
     assert_equal 42, @ini_file['section_one']['two']
 
     @ini_file.read
-    assert_equal '1', @ini_file['section_one']['one']
-    assert_equal '2', @ini_file['section_one']['two']
+    assert_equal 1, @ini_file['section_one']['one']
+    assert_equal 2, @ini_file['section_one']['two']
 
     @ini_file.read(:filename => 'test/data/mixed_comment.ini')
     assert_equal false, @ini_file.has_section?('section_two')
@@ -392,61 +419,73 @@ class TestIniFile < Test::Unit::TestCase
     assert_equal expected, multiple
 
     multiple = ini_file['empty_lines']
-    expected = {'empty' => '', 'not_empty' => 'full'}
+    expected = {'empty' => nil, 'not_empty' => 'full'}
     assert_equal expected, multiple
   end
 
   def test_merge
     ini_file = @ini_file.merge(IniFile.load("test/data/merge.ini"))
-    assert_equal '3', ini_file['section_one']['one']
-    assert_equal '2', ini_file['section_one']['two']
+    assert_equal 3, ini_file['section_one']['one']
+    assert_equal 2, ini_file['section_one']['two']
 
     # make sure that the rest haven't changed
-    assert_equal '3', ini_file['section_two']['three']
+    assert_equal(-3, ini_file['section_two']['three'])
 
     # and that we got any additional sections too
-    assert_equal '5', ini_file['section_five']['five']
+    assert_equal 5, ini_file['section_five']['five']
 
     # original object is unchanged
-    assert_equal '1', @ini_file['section_one']['one']
+    assert_equal 1, @ini_file['section_one']['one']
   end
 
   def test_merge_hash
     ini_file = @ini_file.merge({
-      'section_one'  => { 'one'  => '3' },
-      'section_five' => { 'five' => '5' }
+      'section_one'  => { 'one'  => 3 },
+      'section_five' => { 'five' => 5 }
     })
-    assert_equal '3', ini_file['section_one']['one']
-    assert_equal '2', ini_file['section_one']['two']
+    assert_equal 3, ini_file['section_one']['one']
+    assert_equal 2, ini_file['section_one']['two']
 
     # make sure that the rest haven't changed
-    assert_equal '3', ini_file['section_two']['three']
+    assert_equal(-3, ini_file['section_two']['three'])
 
     # and that we got any additional sections too
-    assert_equal '5', ini_file['section_five']['five']
+    assert_equal 5, ini_file['section_five']['five']
 
     # original object is unchanged
-    assert_equal '1', @ini_file['section_one']['one']
+    assert_equal 1, @ini_file['section_one']['one']
   end
 
-  if RUBY_VERSION >= '1.9'
-    def test_parse_encoding
-      ini_file = IniFile.new(:filename => "test/data/browscap.ini", :encoding => 'ISO-8859-1')
-      assert_equal ini_file['www.substancia.com AutoHTTPAgent (ver *)']['Browser'], "Subst\xE2ncia".force_encoding('ISO-8859-1')
-    end
+  def test_merge_invalid_hash
+    bad_hash = { 'section_one' => [1, 2, 3, 4] }
+    assert_raise(IniFile::Error) { @ini_file.merge(bad_hash) }
 
-    def test_write_encoding
-      tmp = 'test/data/tmp.ini'
-      File.delete tmp if Kernel.test(?f, tmp)
+    bad_hash = { 'foo' => 'bar' }
+    assert_raise(IniFile::Error) { @ini_file.merge(bad_hash) }
 
-      @ini_file = IniFile.new(:filename => tmp, :encoding => 'UTF-8')
-      @ini_file['testutf-8'] = {"utf-8" => "appr\u20accier"}
+    not_a_hash = [['section_one', ['foo','bar'], ['baz', 'buz']]]
+    assert_raise(IniFile::Error) { @ini_file.merge(not_a_hash) }
 
-      @ini_file.save(:filename => tmp)
+    ini_file = @ini_file.merge nil
+    assert ini_file.eql?(@ini_file)
+  end
 
-      test = File.open(tmp)
-      assert_equal test.external_encoding.to_s, 'UTF-8'
-    end
+  def test_parse_encoding
+    ini_file = IniFile.new(:filename => "test/data/browscap.ini", :encoding => 'ISO-8859-1')
+    assert_equal ini_file['www.substancia.com AutoHTTPAgent (ver *)']['Browser'], "Subst\xE2ncia".force_encoding('ISO-8859-1')
+  end
+
+  def test_write_encoding
+    tmp = 'test/data/tmp.ini'
+    File.delete tmp if Kernel.test(?f, tmp)
+
+    @ini_file = IniFile.new(:filename => tmp, :encoding => 'UTF-8')
+    @ini_file['testutf-8'] = {"utf-8" => "appr\u20accier"}
+
+    @ini_file.save(:filename => tmp)
+
+    test = File.open(tmp)
+    assert_equal test.external_encoding.to_s, 'UTF-8'
   end
 
   def test_value_escaping
@@ -461,32 +500,62 @@ class TestIniFile < Test::Unit::TestCase
     assert_equal %Q{Escaping works\tinside quoted strings!}, escaped['quoted']
   end
 
+  # disabling escaping is no longer supported
   def test_value_escaping_disabled
     ini_file = IniFile.load('test/data/escape.ini', :escape => false)
     escaped = ini_file['escaped']
 
-    assert_equal %q{There is a tab\tcharacter in here somewhere}, escaped['tabs']
-    assert_equal %q{Who uses these anyways?\r}, escaped['carriage return']
-    assert_equal %q{Trust newline!\nAlways there when you need him.\nSplittin' those lines.}, escaped['newline']
-    assert_equal %Q{Who'd be silly enough to put\\0 a null character in the middle of a string? Stroustrup would not approve!}, escaped['null']
-    assert_equal %q{This string \\\\t contains \\\\n no \\\\r special \\\\0 characters!}, escaped['backslash']
-    assert_equal %q{Escaping works\tinside quoted strings!}, escaped['quoted']
+    assert_equal %Q{There is a tab\tcharacter in here somewhere}, escaped['tabs']
+    assert_equal %Q{Who uses these anyways?\r}, escaped['carriage return']
+    assert_equal %Q{Trust newline!\nAlways there when you need him.\nSplittin' those lines.}, escaped['newline']
+    assert_equal %Q{Who'd be silly enough to put\0 a null character in the middle of a string? Stroustrup would not approve!}, escaped['null']
+    assert_equal %q{This string \t contains \n no \r special \0 characters!}, escaped['backslash']
+    assert_equal %Q{Escaping works\tinside quoted strings!}, escaped['quoted']
   end
 
   def test_global_section
     ini_file = IniFile.load('test/data/global.ini')
 
     assert_equal %w[global], ini_file.sections
-    assert_equal '1', ini_file['global']['one']
-    assert_equal '2', ini_file['global']['two']
+    assert_equal 1, ini_file['global']['one']
+    assert_equal 2, ini_file['global']['two']
   end
 
   def test_default_global_section
     ini_file = IniFile.load('test/data/global.ini', :default => 'nonce')
 
     assert_equal %w[nonce], ini_file.sections
-    assert_equal '1', ini_file['nonce']['one']
-    assert_equal '2', ini_file['nonce']['two']
+    assert_equal 1, ini_file['nonce']['one']
+    assert_equal 2, ini_file['nonce']['two']
+  end
+
+  def test_unescaped_section_header_as_value
+    ini_file = IniFile.load('test/data/section.ini')
+
+    assert_equal %w[section_one], ini_file.sections
+    assert_equal '[value]', ini_file['section_one']['one']
+    assert_equal 2, ini_file['section_one']['two']
+  end
+
+  def test_unmatched_quotes
+    # missing a closing quote should raise an error
+    assert_raise(IniFile::Error) { IniFile.load 'test/data/bad_2.ini' }
+  end
+
+  def test_continuation_at_end_of_file
+    ini_file = IniFile.load('test/data/continuation.ini')
+
+    assert_equal 1, ini_file['section_one']['one']
+    assert_equal 2, ini_file['section_one']['two']
+
+    assert_equal 'here is the last value', ini_file['section_two']['end-of-file']
+  end
+
+  def test_empty_comment_string
+    ini_file = IniFile.load('test/data/merge.ini', :comment => nil)
+
+    assert_equal 3, ini_file['section_one']['one']
+    assert_equal 5, ini_file['section_five']['five']
   end
 end
 

metadata

@@ -1,80 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: inifile
 version: !ruby/object:Gem::Version
-  version: 2.0.2
-  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors:
 - Tim Pease
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-15 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bones-git
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bones
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
-description: ! "Although made popular by Windows, INI files can be used on any system
-  thanks\nto their flexibility. They allow a program to store configuration data,
-  which\ncan then be easily parsed and changed. Two notable systems that use the INI\nformat
-  are Samba and Trac.\n\nMore information about INI files can be found on the [Wikipedia
-  Page](http://en.wikipedia.org/wiki/INI_file).\n\n### Properties\n\nThe basic element
-  contained in an INI file is the property. Every property has\na name and a value,
-  delimited by an equals sign *=*. The name appears to the\nleft of the equals sign
-  and the value to the right.\n\n    name=value\n\n### Sections\n\nSection declarations
-  start with *[* and end with *]* as in `[section1]` and\n`[section2]` shown in the
-  example below. The section declaration marks the\nbeginning of a section. All properties
-  after the section declaration will be\nassociated with that section.\n\n### Comments\n\nAll
-  lines beginning with a semicolon *;* or a number sign *#* are considered\nto be
-  comments. Comment lines are ignored when parsing INI files.\n\n### Example File
-  Format\n\nA typical INI file might look like this:\n\n    [section1]\n    ; some
-  comment on section1\n    var1 = foo\n    var2 = doodle\n    var3 = multiline values
-  \\\n    are also possible\n\n    [section2]\n    # another comment\n    var1 = baz\n
-  \   var2 = shoodle"
+        version: 3.8.1
+description: |-
+  Although made popular by Windows, INI files can be used on any system thanks
+  to their flexibility. They allow a program to store configuration data, which
+  can then be easily parsed and changed. Two notable systems that use the INI
+  format are Samba and Trac.
+
+  More information about INI files can be found on the [Wikipedia Page](http://en.wikipedia.org/wiki/INI_file).
+
+  ### Properties
+
+  The basic element contained in an INI file is the property. Every property has
+  a name and a value, delimited by an equals sign *=*. The name appears to the
+  left of the equals sign and the value to the right.
+
+      name=value
+
+  ### Sections
+
+  Section declarations start with *[* and end with *]* as in `[section1]` and
+  `[section2]` shown in the example below. The section declaration marks the
+  beginning of a section. All properties after the section declaration will be
+  associated with that section.
+
+  ### Comments
+
+  All lines beginning with a semicolon *;* or a number sign *#* are considered
+  to be comments. Comment lines are ignored when parsing INI files.
+
+  ### Example File Format
+
+  A typical INI file might look like this:
+
+      [section1]
+      ; some comment on section1
+      var1 = foo
+      var2 = doodle
+      var3 = multiline values \
+      are also possible
+
+      [section2]
+      # another comment
+      var1 = baz
+      var2 = shoodle
 email: tim.pease@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - History.txt
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - History.txt
 - README.md
 - Rakefile
+- inifile.gemspec
 - lib/inifile.rb
 - test/data/bad_1.ini
+- test/data/bad_2.ini
 - test/data/browscap.ini
 - test/data/comment.ini
+- test/data/continuation.ini
 - test/data/escape.ini
 - test/data/global.ini
 - test/data/good.ini
@@ -82,32 +106,32 @@ files:
 - test/data/mixed_comment.ini
 - test/data/multiline.ini
 - test/data/param.ini
+- test/data/section.ini
 - test/test_inifile.rb
 homepage: http://rubygems.org/gems/inifile
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: inifile
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: INI file reader and writer
 test_files:
 - test/test_inifile.rb