inifile 0.4.1 → 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   PROJ.ignore_file = '.gitignore'
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+*~
+*.sw[op]
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -1,3 +1,12 @@
+== 1.0.0 / 2012-02-27
+
+Major Enhancements
+  - Changed how multi-line values are handled [issue #7]
+  - Added backslash escaping support for values
+Enhancements
+  - Inifile merge functionality [Jens Hilligsøe]
+  - Use regular expressions to find sections [issue 8]
+
 == 0.4.1 / 2011-02-22
 
 Bug Fixes

data/README.md

@@ -0,0 +1,164 @@
+inifile
+=======
+
+This is a native Ruby package for reading and writing INI files.
+
+
+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
+
+All properties must exist within a section. If the file contains a property
+before the first section is declared, an error will be raised.
+
+### 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
+
+
+Implementation
+--------------
+
+The format of INI files is not well defined. Several assumptions are made by
+the **inifile** gem when parsing INI files. Most of these assumptions can be
+modified at, but the defaults are listed below.
+
+### Duplicate Properties
+
+Duplicate properties are allowed in a single section. The last property value
+set is the one that will be stored in the `IniFile` instance.
+
+    [section1]
+    var1 = foo
+    var2 = bar
+    var1 = poodle
+
+The resulting value of `var1` will be `poodle`.
+
+### Duplicate Sections
+
+If you have more than one section with the same name then the sections will be
+merged. Duplicate properties between the two sections will follow the rules
+discussed above. Properties in the latter section will override properties in
+the earlier section.
+
+### Comments
+
+The comment character can be either a semicolon *;* or a number sign *#*. The
+comment character must be the first non-whitespace character on the line. This
+means it is perfectly valid to include a comment character inside a **value**
+or event a property **name** (although this is not recommended). For this
+reason, comments cannot be placed on the end of a line after a name/value
+pair.
+
+### Escape Characters
+
+Several escape characters are supported within the **value** for a property.
+Most notably, a backslash *\* at the end of a line will continue the value
+onto the next line. When parsed, a literal newline will appear in the value.
+
+* \0 -- null character
+* \n -- newline character
+* \r -- carriage return character
+* \t -- tab character
+* \\\\ -- backslash character
+
+The backslash escape sequence is only needed if you want one of the escape
+sequences to appear literally in your value. For example:
+
+    property=this is not a tab \\t character
+
+
+Install
+-------
+
+    gem install inifile
+
+
+Testing
+-------
+
+To run the tests:
+
+    $ rake
+
+
+Contributing
+------------
+
+Contributions are gladly welcome! For small modifications (fixing typos,
+improving documentation) you can use GitHub's in-browser editing capabilities
+to create a pull request. For larger modifications I would recommend forking
+the project, creating your patch, and then submitting a pull request.
+
+Mr Bones is used to manage rake tasks and to install dependent files. To setup
+your environment ...
+
+    $ gem install bones
+    $ rake gem:install_dependencies
+
+And always remember that `rake -T` will show you the list of available tasks.
+
+
+License
+-------
+
+MIT License
+Copyright (c) 2006 - 2012
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -16,9 +16,8 @@ Bones {
   summary      'INI file reader and writer'
   authors      'Tim Pease'
   email        'tim.pease@gmail.com'
-  url          'http://gemcutter.org/gems/inifile'
+  url          'http://rubygems.org/gems/inifile'
   version      IniFile::VERSION
-  ignore_file  '.gitignore'
 
   use_gmail
   depend_on    'bones-git', :development => true

data/lib/inifile.rb

@@ -12,7 +12,7 @@ class IniFile
 
   # :stopdoc:
   class Error < StandardError; end
-  VERSION = '0.4.1'
+  VERSION = '1.0.0'
   # :startdoc:
 
   #
@@ -20,11 +20,13 @@ class IniFile
   #    IniFile.load( filename )
   #    IniFile.load( filename, options )
   #
-  # Open the given _filename_ and load the contetns of the INI file.
+  # Open the given _filename_ and load the contents of the INI file.
   # The following _options_ can be passed to this method:
   #
   #    :comment => ';'      The line comment character(s)
   #    :parameter => '='    The parameter / value separator
+  #    :encoding => nil     The encoding used for read/write (RUBY 1.9)
+  #    :escape => true      Whether or not to escape values when reading/writing
   #
   def self.load( filename, opts = {} )
     new(filename, opts)
@@ -42,21 +44,19 @@ class IniFile
   #    :comment => ';'      The line comment character(s)
   #    :parameter => '='    The parameter / value separator
   #    :encoding => nil     The encoding used for read/write (RUBY 1.9)
+  #    :escape => true      Whether or not to escape values when reading/writing
   #
   def initialize( filename, opts = {} )
     @fn = filename
-    @comment = opts[:comment] || ';#'
-    @param = opts[:parameter] || '='
-    @encoding = opts[:encoding]
+    @comment = opts.fetch(:comment, ';#')
+    @param = opts.fetch(:parameter, '=')
+    @encoding = opts.fetch(:encoding, nil)
+    @escape = opts.fetch(:escape, true)
     @ini = Hash.new {|h,k| h[k] = Hash.new}
 
     @rgxp_comment = %r/\A\s*\z|\A\s*[#{@comment}]/
-    @rgxp_section = %r/\A\s*\[([^\]]+)\]/o
-    @rgxp_param   = %r/\A([^#{@param}]+)#{@param}\s*"?([^"]*)"?\z/
-
-    @rgxp_multiline_start = %r/\A([^#{@param}]+)#{@param}\s*"([^"]*)?\z/
-    @rgxp_multiline_value = %r/\A([^"]*)\z/
-    @rgxp_multiline_end   = %r/\A([^"]*)"\z/
+    @rgxp_section = %r/\A\s*\[([^\]]+)\]/
+    @rgxp_param   = %r/[^\\]#{@param}/
 
     parse
   end
@@ -66,7 +66,7 @@ class IniFile
   #    write
   #    write( filename )
   #
-  # Write the INI file contents to the filesystem. The given _filename_
+  # Write the INI file contents to the file system. The given _filename_
   # will be used to write the file. If _filename_ is not given, then the
   # named used when constructing this object will be used.
   # The following _options_ can be passed to this method:
@@ -84,7 +84,7 @@ class IniFile
     File.open(@fn, mode) do |f|
       @ini.each do |section,hash|
         f.puts "[#{section}]"
-        hash.each {|param,val| f.puts "#{param} #{@param} #{val}"}
+        hash.each {|param,val| f.puts "#{param} #{@param} #{escape val}"}
         f.puts
       end
     end
@@ -102,7 +102,7 @@ class IniFile
     s = []
     @ini.each do |section,hash|
       s << "[#{section}]"
-      hash.each {|param,val| s << "#{param} #{@param} #{val}"}
+      hash.each {|param,val| s << "#{param} #{@param} #{escape val}"}
       s << ""
     end
     s.join("\n")
@@ -118,6 +118,43 @@ class IniFile
     @ini.dup
   end
 
+  #
+  # call-seq:
+  #   merge( other_inifile )
+  #
+  # Returns a copy of this inifile with the entries from the other_inifile
+  # merged into the copy.
+  #
+  def merge( other )
+    self.dup.merge!(other)
+  end
+
+  #
+  # call-seq:
+  #   merge!( other_inifile )
+  #
+  # Merges other_inifile into this inifile, overwriting existing entries.
+  # Useful for having a system inifile with user overridable settings elsewhere.
+  #
+  def merge!( other )
+    my_keys = @ini.keys
+    other_keys =
+        case other
+        when IniFile; other.instance_variable_get(:@ini).keys
+        when Hash; other.keys
+        else raise "cannot merge contents from '#{other.class.name}'" end
+
+    (my_keys & other_keys).each do |key|
+      @ini[key].merge!(other[key])
+    end
+
+    (other_keys - my_keys).each do |key|
+      @ini[key] = other[key]
+    end
+
+    self
+  end
+
   #
   # call-seq:
   #    each {|section, parameter, value| block}
@@ -182,6 +219,17 @@ class IniFile
     @ini[section.to_s] = value
   end
 
+  #
+  # call-seq:
+  #    ini_file.match( /section/ )    #=> hash
+  #
+  # Return a hash containing only those sections that match the given regular
+  # expression.
+  #
+  def match( regex )
+    @ini.dup.delete_if { |section, _| section !~ regex }
+  end
+
   #
   # call-seq:
   #    has_section?( section )
@@ -236,7 +284,7 @@ class IniFile
   #
   # Produces a duplicate of this INI file. The duplicate is independent of the
   # original -- i.e. the duplicate can be modified without changing the
-  # orgiinal. The tainted state of the original is copied to the duplicate.
+  # original. The tainted state of the original is copied to the duplicate.
   #
   def dup
     other = super
@@ -252,7 +300,7 @@ class IniFile
   #
   # Produces a duplicate of this INI file. The duplicate is independent of the
   # original -- i.e. the duplicate can be modified without changing the
-  # orgiinal. The tainted state and the frozen state of the original is copied
+  # original. The tainted state and the frozen state of the original is copied
   # to the duplicate.
   #
   def clone
@@ -287,19 +335,16 @@ class IniFile
     parse
   end
 
-  private
-  #
-  # call-seq
-  #    parse
-  #
+private
+
   # Parse the ini file contents.
   #
   def parse
     return unless File.file?(@fn)
 
-    section = nil
-    tmp_value = ""
-    tmp_param = ""
+    @_current_section = nil
+    @_current_param = nil
+    @_current_value = nil
 
     fd = (RUBY_VERSION >= '1.9' && @encoding) ?
          File.open(@fn, 'r', :encoding => @encoding) :
@@ -308,53 +353,103 @@ class IniFile
     while line = fd.gets
       line = line.chomp
 
-      # mutline start
-      # create tmp variables to indicate that a multine has started
-      # and the next lines of the ini file will be checked
-      # against the other mutline rgxps.
-      if line =~ @rgxp_multiline_start then
+      # we ignore comment lines and blank lines
+      if line =~ @rgxp_comment
+        finish_property
+        next
+      end
 
-        tmp_param = $1.strip
-        tmp_value = $2 + "\n"
+      # place values in the current section
+      if line =~ @rgxp_section
+        finish_property
+        @_current_section = @ini[$1.strip]
+        next
+      end
 
-      # the mutline end-delimiter is found
-      # clear the tmp vars and add the param / value pair to the section
-      elsif line =~ @rgxp_multiline_end && tmp_param != "" then
+      parse_property line
+
+    end  # while
+
+    finish_property
+  ensure
+    fd.close if defined? fd and fd
+    @_current_section = nil
+    @_current_param = nil
+    @_current_value = nil
+  end
 
-        section[tmp_param] = tmp_value + $1
-        tmp_value, tmp_param = "", ""
+  # Attempt to parse a property name and value from the given _line_. This
+  # method takes into account multi-line values.
+  #
+  def parse_property( line )
+    p = v = nil
+    split = line =~ @rgxp_param
 
-      # anything else between multiline start and end
-      elsif line =~ @rgxp_multiline_value && tmp_param != ""  then
+    if split
+      p = line.slice(0, split+1).strip
+      v = line.slice(split+2, line.length).strip
+    else
+      v = line
+    end
 
-        tmp_value += $1 + "\n"
+    if p.nil? and @_current_param.nil?
+      raise Error, "could not parse line '#{line}'"
+    end
 
-      # ignore blank lines and comment lines
-      elsif line =~ @rgxp_comment then
+    @_current_param = p unless p.nil?
 
-        next
+    if @_current_value then @_current_value << v
+    else @_current_value = v end
 
-      # this is a section declaration
-      elsif line =~ @rgxp_section then
+    finish_property unless @_current_value.sub!(%r/\\\z/, "\n")
+  end
 
-        section = @ini[$1.strip]
+  # If there is a current property being parsed, finish this parse step by
+  # storing the name and value in the current section and resetting for the
+  # next parse step.
+  #
+  def finish_property
+    return unless @_current_param
 
-      # otherwise we have a parameter
-      elsif line =~ @rgxp_param then
+    raise Error, "parameter encountered before first section" if @_current_section.nil?
+    @_current_section[@_current_param] = unescape @_current_value
 
-        begin
-          section[$1.strip] = $2.strip
-        rescue NoMethodError
-          raise Error, "parameter encountered before first section"
-        end
+    @_current_param = nil
+    @_current_value = nil
+  end
 
-      else
-        raise Error, "could not parse line '#{line}"
+  # Unescape special characters found in the value string. This will convert
+  # escaped null, tab, carriage return, newline, and backslash into their
+  # literal equivalents.
+  #
+  def unescape( value )
+    return value unless @escape
+
+    value = value.to_s
+    value.gsub!(%r/\\[0nrt\\]/) { |char|
+      case char
+      when '\0';   "\0"
+      when '\n';   "\n"
+      when '\r';   "\r"
+      when '\t';   "\t"
+      when '\\\\'; "\\"
       end
-    end  # while
+    }
+    value
+  end
 
-  ensure
-    fd.close if defined? fd and fd
+  # Escape special characters
+  #
+  def escape( value )
+    return value unless @escape
+
+    value = value.to_s.dup
+    value.gsub!(%r/\\([0nrt])/, '\\\\\1')
+    value.gsub!(%r/\n/, '\n')
+    value.gsub!(%r/\r/, '\r')
+    value.gsub!(%r/\t/, '\t')
+    value.gsub!(%r/\0/, '\0')
+    value
   end
 
 end  # IniFile

data/test/data/escape.ini

@@ -0,0 +1,12 @@
+; this test file demonstrates escape sequences supported by IniFile
+[normal]
+foo = http://en.wikipedia.org/wiki/Foobar
+
+[escaped]
+tabs = There is a tab\tcharacter in here somewhere
+carriage return = Who uses these anyways?\r
+newline = Trust newline!\nAlways there when you need him.\nSplittin' those lines.
+null = Who'd be silly enough to put\0 a null character in the middle of a string?\
+Stroustrup would not approve!
+backslash = This string \\t contains \\n no \\r special \\0 characters!
+

data/test/data/good.ini

@@ -4,8 +4,8 @@ two = 2
 
 [section_two]
 three =         3
-multi = "multiline
-support"
+multi = multiline\
+support
 
 ; comments should be ignored
 [section three]

data/test/data/merge.ini

@@ -0,0 +1,5 @@
+[section_one]
+one = 3
+
+[section_five]
+five=5

data/test/data/mixed_comment.ini

@@ -1,5 +1,5 @@
 # comments should be ignored
-; multiple comments characeters are supported
+; multiple comments characters are supported
 ; (I'm lookin' at you, samba)
 [section_one]
 one = 1

data/test/data/multiline.ini

@@ -7,15 +7,15 @@ three =         3
 
 ; comments should be ignored
 [section_three]
-three   = "hello
-multiline"
+three   = hello\
+multiline
 other = "stuff"
 
 [section_four]
-four   = "hello
-multiple
-multilines"
+four   = hello\
+multiple\
+multilines
 
 [empty_lines]
-empty = ""
+empty =
 not_empty=full

data/test/test_inifile.rb

@@ -4,17 +4,11 @@
 
 # encoding: UTF-8
 
-begin
-  require 'inifile'
-rescue LoadError
-  require 'rubygems'
-  require 'inifile'
-end
-
+libpath = File.expand_path '../../lib', __FILE__
+require File.join(libpath, 'inifile')
 require 'fileutils'
+require 'test/unit'
 
-begin; require 'turn'; rescue LoadError; end
-require 'test/unit' unless defined? $ZENTEST and $ZENTEST
 
 class TestIniFile < Test::Unit::TestCase
 
@@ -223,6 +217,26 @@ class TestIniFile < Test::Unit::TestCase
     assert_nil ini_file[nil]
   end
 
+  def test_match
+    expected = {
+     "section_two" =>
+      {
+        "three"=>"3", "multi"=>"multiline\nsupport"
+      },
+     "section three" =>
+      {
+        "four"=>"4", "five"=>"5", "six"=>"6"
+      }
+    }
+    assert_equal expected, @ini_file.match(/(two|three)/)
+
+    # the match function should not delete entries from the inifile hash
+    assert_equal({'seven and eight' => '7 & 8'}, @ini_file['section_five'])
+
+    expected = {}
+    assert_equal expected, @ini_file.match(/houndreds/)
+  end
+
   def test_initialize
     # see if we can parse different style comments
     #assert_raise(IniFile::Error) {IniFile.new 'test/data/comment.ini'}
@@ -338,7 +352,7 @@ class TestIniFile < Test::Unit::TestCase
     ini_file = IniFile.load('test/data/multiline.ini')
 
     multiline = ini_file['section_three']
-    expected = {"three" => "hello\nmultiline", "other" => "stuff"}
+    expected = {"three" => "hello\nmultiline", "other" => '"stuff"'}
     assert_equal expected, multiline
 
     multiple = ini_file['section_four']
@@ -347,7 +361,40 @@ class TestIniFile < Test::Unit::TestCase
 
     multiple = ini_file['empty_lines']
     expected = {'empty' => '', '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']
+
+    # make sure that the rest haven't changed
+    assert_equal '3', ini_file['section_two']['three']
 
+    # and that we got any additional sections too
+    assert_equal '5', ini_file['section_five']['five']
+
+    # original object is unchanged
+    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' }
+    })
+    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']
+
+    # and that we got any additional sections too
+    assert_equal '5', ini_file['section_five']['five']
+
+    # original object is unchanged
+    assert_equal '1', @ini_file['section_one']['one']
   end
 
   if RUBY_VERSION >= '1.9'
@@ -370,5 +417,27 @@ class TestIniFile < Test::Unit::TestCase
     end
   end
 
+  def test_value_escaping
+    ini_file = IniFile.load('test/data/escape.ini')
+    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?\nStroustrup would not approve!}, escaped['null']
+    assert_equal %q{This string \t contains \n no \r special \0 characters!}, escaped['backslash']
+  end
+
+  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?\nStroustrup would not approve!}, escaped['null']
+    assert_equal %q{This string \\\\t contains \\\\n no \\\\r special \\\\0 characters!}, escaped['backslash']
+  end
+
 end
 

metadata

@@ -1,129 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: inifile
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Tim Pease
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-22 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bones-git
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157141580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 2
-        - 4
-        version: 1.2.4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.5
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bones
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157141580
+- !ruby/object:Gem::Dependency
+  name: bones
+  requirement: &2157140760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 3
-        - 6
-        - 5
-        version: 3.6.5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
   type: :development
-  version_requirements: *id002
-description: |-
-  This is a native Ruby package for reading and writing INI files.
-  
-  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.
-    
-  == SYNOPSIS:
-  
-  An initialization file, or INI file, is a configuration file that contains
-  configuration data for Microsoft Windows based applications. Starting with
-  Windows 95, the INI file format was superseded but not entirely replaced by
-  a registry database in Microsoft operating systems.
-  
-  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.
+  prerelease: false
+  version_requirements: *2157140760
+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\nAll properties must exist within
+  a section. If the file contains a property\nbefore the first section is declared,
+  an error will be raised.\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"
 email: tim.pease@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
-- README.txt
-files: 
+files:
+- .gitignore
 - History.txt
-- README.txt
+- README.md
 - Rakefile
 - lib/inifile.rb
 - test/data/bad_1.ini
 - test/data/bad_2.ini
 - test/data/browscap.ini
 - test/data/comment.ini
+- test/data/escape.ini
 - test/data/good.ini
+- test/data/merge.ini
 - test/data/mixed_comment.ini
 - test/data/multiline.ini
 - test/data/param.ini
 - test/test_inifile.rb
-has_rdoc: true
-homepage: http://gemcutter.org/gems/inifile
+homepage: http://rubygems.org/gems/inifile
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
-- README.txt
-require_paths: 
+- README.md
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: inifile
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: INI file reader and writer
-test_files: 
+test_files:
 - test/test_inifile.rb

data/README.txt

@@ -1,101 +0,0 @@
-= inifile
-    by Tim Pease
-    http://codeforpeople.rubyforge.org/inifile
-
-== DESCRIPTION:
-
-This is a native Ruby package for reading and writing INI files.
-
-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.
-  
-== SYNOPSIS:
-
-An initialization file, or INI file, is a configuration file that contains
-configuration data for Microsoft Windows based applications. Starting with
-Windows 95, the INI file format was superseded but not entirely replaced by
-a registry database in Microsoft operating systems.
-
-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.
-
-=== File Format
-
-A typical INI file might look like this:
-
-  [section1]
-
-  ; some comment on section1
-  var1 = foo
-  var2 = doodle
-  var3 = "multiline
-  also possible"
- 
-  [section2]
-
-  ; another comment
-  var1 = baz
-  var2 = shoodle
-
-
-==== Format
-
-This describes the elements of the INI file format:
-
-* *Sections*: Section declarations start with '[' and end with ']' as in [section1] and [section2] above. And sections start with section declarations.
-* *Parameters*: The "var1 = foo" above is an example of a parameter (also known as an item). Parameters are made up of a key ('var1'), equals sign ('='), and a value ('foo'). Multiline is support if value of parameter is enclosed by ".
-* *Comments*: All the lines starting with a ';' are assumed to be comments, and are ignored.
-
-==== Differences
-
-The format of INI files is not well defined. Many programs interpret their
-structure differently than the basic structure that was defined in the above
-example. The following is a basic list of some of the differences:
-
-* *Comments*: Programs like Samba accept either ';' or '#' as comments. Comments can be added after parameters with several formats.
-* *Backslashes*: Adding a backslash '\' allows you to continue the value from one line to another. Some formats also allow various escapes with a '\', such as '\n' for newline.
-* <b>Duplicate parameters</b>: Most of the time, you can't have two parameters with the same name in one section. Therefore one can say that parameters are local to the section. Although this behavior can vary between implementations, it is advisable to stick with this rule.
-* <b>Duplicate sections</b>: If you have more than one section with the same name then the last section overrides the previous one. (Some implementations will merge them if they have different keys.)
-* Some implementations allow ':' in place of '='.
-
-=== This Package
-
-This package supports the standard INI file format described in the *Format*
-section above. The following differences are also supported:
-
-* *Comments*: The comment character can be specified when an +IniFile+ is created. The comment character must be the first non-whitespace character on a line.
-* *Backslashes*: Backslashes are not supported by this package. But multilines are. Enclose the param's value by ".
-* <b>Duplicate parameters</b>: Duplicate parameters are allowed in a single section. The last parameter value is the one that will be stored in the +IniFile+.
-* <b>Duplicate sections</b>: Duplicate sections will be merged. Parameters duplicated between to the two sections follow the duplicate parameters rule above.
-* *Parameters*: The parameter separator character can be specified when an +IniFile+ is created.
-
-== INSTALL:
-
-  sudo gem install inifile
-
-== LICENSE:
-
-MIT License
-Copyright (c) 2006 - 2008
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.