inifile 0.3.0 → 0.4.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.4.0 / 2011-02-
+
+Enhancements
+  - Added multiline support [André Gawron]
+  - Added file encoding support [Gilles Devaux]
+
 == 0.3.0 / 2009-12-10
 
 * 1 minor enhancement

data/README.txt

@@ -31,6 +31,8 @@ A typical INI file might look like this:
   ; some comment on section1
   var1 = foo
   var2 = doodle
+  var3 = "multiline
+  also possible"
  
   [section2]
 
@@ -38,12 +40,13 @@ A typical INI file might look like this:
   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').
+* *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
@@ -64,7 +67,7 @@ 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.
+* *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.

data/lib/inifile.rb

@@ -2,6 +2,9 @@
 # This class represents the INI file and can be used to parse, modify,
 # and write INI files.
 #
+
+#encoding: UTF-8
+
 class IniFile
 
   # Inifile is enumerable.
@@ -9,7 +12,7 @@ class IniFile
 
   # :stopdoc:
   class Error < StandardError; end
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
   # :startdoc:
 
   #
@@ -38,16 +41,22 @@ class IniFile
   #
   #    :comment => ';'      The line comment character(s)
   #    :parameter => '='    The parameter / value separator
+  #    :encoding => nil     The encoding used for read/write (RUBY 1.9)
   #
   def initialize( filename, opts = {} )
     @fn = filename
     @comment = opts[:comment] || ';#'
     @param = opts[:parameter] || '='
+    @encoding = opts[:encoding]
     @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}(.*)\z/
+    @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/
 
     parse
   end
@@ -60,11 +69,19 @@ class IniFile
   # Write the INI file contents to the filesystem. 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:
+  #
+  #    :encoding => nil     The encoding used for writing (RUBY 1.9)
   #
-  def write( filename = nil )
+  def write( filename = nil, opts={} )
     @fn = filename unless filename.nil?
 
-    File.open(@fn, 'w') do |f|
+    encoding = opts[:encoding] || @encoding
+    mode = (RUBY_VERSION >= '1.9' && @encoding) ?
+         "w:#{encoding.to_s}" :
+         'w'
+
+    File.open(@fn, mode) do |f|
       @ini.each do |section,hash|
         f.puts "[#{section}]"
         hash.each {|param,val| f.puts "#{param} #{@param} #{val}"}
@@ -279,34 +296,66 @@ class IniFile
   #
   def parse
     return unless File.file?(@fn)
+
     section = nil
+    tmp_value = ""
+    tmp_param = ""
+
+    fd = (RUBY_VERSION >= '1.9' && @encoding) ?
+         File.open(@fn, 'r', :encoding => @encoding) :
+         File.open(@fn, 'r')
+
+    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
 
-    File.open(@fn, 'r') do |f|
-      while line = f.gets
-        line = line.chomp
+        tmp_param = $1.strip
+        tmp_value = $2 + "\n"
 
-        case line
-        # ignore blank lines and comment lines
-        when @rgxp_comment; next
+      # 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
 
-        # this is a section declaration
-        when @rgxp_section; section = @ini[$1.strip]
+        section[tmp_param] = tmp_value + $1
+        tmp_value, tmp_param = "", ""
 
-        # otherwise we have a parameter
-        when @rgxp_param
-          begin
-            section[$1.strip] = $2.strip
-          rescue NoMethodError
-            raise Error, "parameter encountered before first section"
-          end
+      # anything else between multiline start and end
+      elsif line =~ @rgxp_multiline_value && tmp_param != ""  then
 
-        else
-          raise Error, "could not parse line '#{line}"
+        tmp_value += $1 + "\n"
+
+      # ignore blank lines and comment lines
+      elsif line =~ @rgxp_comment then
+
+        next
+
+      # this is a section declaration
+      elsif line =~ @rgxp_section then
+
+        section = @ini[$1.strip]
+
+      # otherwise we have a parameter
+      elsif line =~ @rgxp_param then
+
+        begin
+          section[$1.strip] = $2.strip
+        rescue NoMethodError
+          raise Error, "parameter encountered before first section"
         end
-      end  # while
-    end  # File.open
+
+      else
+        raise Error, "could not parse line '#{line}"
+      end
+    end  # while
+
+  ensure
+    fd.close if defined? fd and fd
   end
 
-end  # class IniFile
+end  # IniFile
 
-# EOF

data/test/data/browscap.ini

@@ -0,0 +1,5 @@
+
+;just the offending entry
+[www.substancia.com AutoHTTPAgent (ver *)]
+Parent=Version Checkers
+Browser=Subst�ncia

data/test/data/good.ini

@@ -3,7 +3,9 @@ one = 1
 two = 2
 
 [section_two]
-three =         3    
+three =         3
+multi = "multiline
+support"
 
 ; comments should be ignored
 [section three]

data/test/data/multiline.ini

@@ -0,0 +1,17 @@
+[section_one]
+one = 1
+two = 2
+
+[section_two]
+three =         3
+
+; comments should be ignored
+[section_three]
+three   = "hello
+multiline"
+other = "stuff"
+
+[section_four]
+four   = "hello
+multiple
+multilines"

data/test/test_inifile.rb

@@ -2,6 +2,8 @@
 #                 classname: asrt / meth =  ratio%
 #             Rini::IniFile:    0 /    9 =   0.00%
 
+# encoding: UTF-8
+
 begin
   require 'inifile'
 rescue LoadError
@@ -22,6 +24,7 @@ class TestIniFile < Test::Unit::TestCase
       ['section_one', 'one', '1'],
       ['section_one', 'two', '2'],
       ['section_two', 'three', '3'],
+      ['section_two', 'multi', "multiline\nsupport"],
       ['section three', 'four', '4'],
       ['section three', 'five', '5'],
       ['section three', 'six', '6'],
@@ -192,7 +195,7 @@ class TestIniFile < Test::Unit::TestCase
     }
     assert_equal expected, @ini_file[:section_one]
 
-    expected = {'three' => '3'}
+    expected = {'three' => '3', 'multi' => "multiline\nsupport"}
     assert_equal expected, @ini_file['section_two']
 
     expected = {
@@ -330,6 +333,39 @@ class TestIniFile < Test::Unit::TestCase
     ini_file[:foo] = {}
     assert_equal ini_file["foo"], {}
   end
+
+  def test_multiline_parsing
+    ini_file = IniFile.load('test/data/multiline.ini')
+
+    multiline = ini_file['section_three']
+    expected = {"three" => "hello\nmultiline", "other" => "stuff"}
+    assert_equal expected, multiline
+
+    multiple = ini_file['section_four']
+    expected = {"four" => "hello\nmultiple\nmultilines"}
+    assert_equal expected, multiple
+
+  end
+
+  if RUBY_VERSION >= '1.9'
+    def test_parse_encoding
+      ini_file = IniFile.new("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(tmp, :encoding => 'UTF-8')
+      @ini_file['testutf-8'] = {"utf-8" => "appr\u20accier"}
+
+      @ini_file.save tmp
+
+      test = File.open(tmp)
+      assert_equal test.external_encoding.to_s, 'UTF-8'
+    end
+  end
+
 end
 
-# EOF

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: inifile
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,30 +15,59 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-10 00:00:00 -07:00
+date: 2011-02-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bones-git
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.1
-    version: 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bones
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.2.0
-    version: 
-description: This is a native Ruby package for reading and writing INI files.
+        hash: 21
+        segments: 
+        - 3
+        - 6
+        - 5
+        version: 3.6.5
+  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.
 email: tim.pease@gmail.com
 executables: []
 
@@ -42,16 +77,17 @@ extra_rdoc_files:
 - History.txt
 - README.txt
 files: 
-- .gitignore
 - History.txt
 - README.txt
 - Rakefile
 - lib/inifile.rb
 - test/data/bad_1.ini
 - test/data/bad_2.ini
+- test/data/browscap.ini
 - test/data/comment.ini
 - test/data/good.ini
 - test/data/mixed_comment.ini
+- test/data/multiline.ini
 - test/data/param.ini
 - test/test_inifile.rb
 has_rdoc: true
@@ -65,21 +101,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: inifile
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: INI file reader and writer

data/.gitignore

@@ -1,17 +0,0 @@
-# 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