inifile 1.0.0 → 1.1.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+before_install: "gem install bones"
+install:        "rake gem:install_dependencies"
+
+script: "rake"
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - jruby
+

data/History.txt

@@ -1,3 +1,8 @@
+== 1.1.0 / 2012-02-28
+
+Enhancements
+  - Added support for a default "global" section
+
 == 1.0.0 / 2012-02-27
 
 Major Enhancements

data/README.md

@@ -1,4 +1,4 @@
-inifile
+inifile [![Build Status](https://secure.travis-ci.org/TwP/inifile.png)](http://travis-ci.org/TwP/inifile)
 =======
 
 This is a native Ruby package for reading and writing INI files.
@@ -22,9 +22,6 @@ 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
@@ -61,6 +58,13 @@ 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.
 
+### Global Properties
+
+If the INI file lacks any section declarations, or if there are properties
+decalared before the first section, then these properties will be placed into
+a default "global" section. The name of this section can be configured when
+creating an `IniFile` instance.
+
 ### Duplicate Properties
 
 Duplicate properties are allowed in a single section. The last property value

data/lib/inifile.rb

@@ -12,7 +12,7 @@ class IniFile
 
   # :stopdoc:
   class Error < StandardError; end
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
   # :startdoc:
 
   #
@@ -23,10 +23,11 @@ class IniFile
   # 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
+  #    :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
+  #    :default => 'global'  Default global section name
   #
   def self.load( filename, opts = {} )
     new(filename, opts)
@@ -41,10 +42,11 @@ class IniFile
   # exists and is a regular file, then its contents will be parsed.
   # 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
+  #    :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
+  #    :default => 'global'  Default global section name
   #
   def initialize( filename, opts = {} )
     @fn = filename
@@ -52,6 +54,7 @@ class IniFile
     @param = opts.fetch(:parameter, '=')
     @encoding = opts.fetch(:encoding, nil)
     @escape = opts.fetch(:escape, true)
+    @default = opts.fetch(:default, 'global')
     @ini = Hash.new {|h,k| h[k] = Hash.new}
 
     @rgxp_comment = %r/\A\s*\z|\A\s*[#{@comment}]/
@@ -411,7 +414,7 @@ private
   def finish_property
     return unless @_current_param
 
-    raise Error, "parameter encountered before first section" if @_current_section.nil?
+    @_current_section = @ini[@default] if @_current_section.nil?
     @_current_section[@_current_param] = unescape @_current_value
 
     @_current_param = nil

data/test/data/bad_1.ini

@@ -1,6 +1,6 @@
-; having a paramater / value pair outside a section is an error
-one = 1
-
 [section_one]
 one = 1
 two = 2
+
+; the following is not a valid line
+invalid line

data/test/data/global.ini

@@ -0,0 +1,3 @@
+; without any section, a default 'global' section will be created
+one = 1
+two = 2

data/test/test_inifile.rb

@@ -57,7 +57,6 @@ class TestIniFile < Test::Unit::TestCase
 
     # make sure we error out on files with bad lines
     assert_raise(IniFile::Error) {IniFile.load 'test/data/bad_1.ini'}
-    assert_raise(IniFile::Error) {IniFile.load 'test/data/bad_2.ini'}
   end
 
   def test_clone
@@ -254,7 +253,6 @@ class TestIniFile < Test::Unit::TestCase
 
     # make sure we error out on files with bad lines
     assert_raise(IniFile::Error) {IniFile.new 'test/data/bad_1.ini'}
-    assert_raise(IniFile::Error) {IniFile.new 'test/data/bad_2.ini'}
   end
 
   def test_sections
@@ -439,5 +437,20 @@ class TestIniFile < Test::Unit::TestCase
     assert_equal %q{This string \\\\t contains \\\\n no \\\\r special \\\\0 characters!}, escaped['backslash']
   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']
+  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']
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inifile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bones-git
-  requirement: &2157141580 !ruby/object:Gem::Requirement
+  requirement: &2167250880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.5
   type: :development
   prerelease: false
-  version_requirements: *2157141580
+  version_requirements: *2167250880
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2157140760 !ruby/object:Gem::Requirement
+  requirement: &2167250400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 3.7.2
   type: :development
   prerelease: false
-  version_requirements: *2157140760
+  version_requirements: *2167250400
 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
@@ -40,12 +40,10 @@ description: ! "Although made popular by Windows, INI files can be used on any s
   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
+  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
@@ -59,15 +57,16 @@ extra_rdoc_files:
 - History.txt
 files:
 - .gitignore
+- .travis.yml
 - History.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/global.ini
 - test/data/good.ini
 - test/data/merge.ini
 - test/data/mixed_comment.ini

data/test/data/bad_2.ini

@@ -1,6 +0,0 @@
-[section_one]
-one = 1
-two = 2
-
-; the following is not a valid line
-invalid line