iniparse 0.2.1

data/spec/parser/document_parsing_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# Tests parsing of multiple lines, in context, using #parse.
+
+describe 'Parsing a document' do
+  describe 'when a comment preceeds a single section and option' do
+    before(:all) do
+      @doc = IniParse::Parser.new(fixture(:comment_before_section)).parse
+    end
+
+    it 'should have a comment as the first line' do
+      @doc.lines.to_a.first.should be_kind_of(IniParse::Lines::Comment)
+    end
+
+    it 'should have one section' do
+      @doc.lines.keys.should == ['first_section']
+    end
+
+    it 'should have one option belonging to `first_section`' do
+      @doc['first_section']['key'].should == 'value'
+    end
+  end
+
+  it 'should allow blank lines to preceed the first section' do
+    lambda {
+      @doc = IniParse::Parser.new(fixture(:blank_before_section)).parse
+    }.should_not raise_error
+
+    @doc.lines.to_a.first.should be_kind_of(IniParse::Lines::Blank)
+  end
+
+  it 'should allow a blank line to belong to a section' do
+    lambda {
+      @doc = IniParse::Parser.new(fixture(:blank_in_section)).parse
+    }.should_not raise_error
+
+    @doc['first_section'].lines.to_a.first.should be_kind_of(IniParse::Lines::Blank)
+  end
+
+  it 'should raise an error if an option preceeds the first section' do
+    lambda {
+      IniParse::Parser.new(fixture(:option_before_section)).parse
+    }.should raise_error(IniParse::NoSectionError)
+  end
+
+  it 'should raise ParseError if a line could not be parsed' do
+    lambda { IniParse::Parser.new(fixture(:invalid_line)).parse }.should \
+      raise_error(IniParse::ParseError)
+  end
+end

data/spec/parser/line_parsing_spec.rb

@@ -0,0 +1,367 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# Tests parsing of individual, out of context, line types using #parse_line.
+
+describe 'Parsing a line' do
+  it 'should strip leading whitespace and set the :indent option' do
+    IniParse::Parser.parse_line('  [section]').should \
+      be_section_tuple(:any, {:indent => '  '})
+  end
+
+  it 'should raise an error if the line could not be matched' do
+    lambda { IniParse::Parser.parse_line('invalid line') }.should \
+      raise_error(IniParse::ParseError)
+  end
+
+  it 'should parse using the types set in IniParse::Parser.parse_types' do
+    begin
+      # Remove last type.
+      type = IniParse::Parser.parse_types.pop
+      type.should_not_receive(:parse)
+      IniParse::Parser.parse_line('[section]')
+    ensure
+      IniParse::Parser.parse_types << type
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   Option lines.
+  # ==========================================================================
+  # ++
+
+  describe 'with "k = v"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('k = v')
+    end
+
+    it 'should return an option tuple' do
+      @tuple.should be_option_tuple('k', 'v')
+    end
+
+    it 'should set no indent, comment, offset or separator' do
+      @tuple.last[:indent].should be_nil
+      @tuple.last[:comment].should be_nil
+      @tuple.last[:comment_offset].should be_nil
+      @tuple.last[:comment_sep].should be_nil
+    end
+  end
+
+  describe 'with "k = a value with spaces"' do
+    it 'should return an option tuple' do
+      IniParse::Parser.parse_line('k = a value with spaces').should \
+        be_option_tuple('k', 'a value with spaces')
+    end
+  end
+
+  describe 'with "k = v ; a comment "' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('k = v ; a comment')
+    end
+
+    it 'should return an option tuple' do
+      @tuple.should be_option_tuple('k', 'v')
+    end
+
+    it 'should set the comment to "a comment"' do
+      @tuple.should be_option_tuple(:any, :any, :comment => 'a comment')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_option_tuple(:any, :any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 6' do
+      @tuple.should be_option_tuple(:any, :any, :comment_offset => 6)
+    end
+  end
+
+  describe 'with "k = v;w;x y;z"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('k = v;w;x y;z')
+    end
+
+    it 'should return an option tuple with the correct value' do
+      @tuple.should be_option_tuple(:any, 'v;w;x y;z')
+    end
+
+    it 'should not set a comment' do
+      @tuple.last[:comment].should be_nil
+      @tuple.last[:comment_offset].should be_nil
+      @tuple.last[:comment_sep].should be_nil
+    end
+  end
+
+  describe 'with "k = v;w ; a comment"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('k = v;w ; a comment')
+    end
+
+    it 'should return an option tuple with the correct value' do
+      @tuple.should be_option_tuple(:any, 'v;w')
+    end
+
+    it 'should set the comment to "a comment"' do
+      @tuple.should be_option_tuple(:any, :any, :comment => 'a comment')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_option_tuple(:any, :any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 8' do
+      @tuple.should be_option_tuple(:any, :any, :comment_offset => 8)
+    end
+  end
+
+  describe 'with "key=value"' do
+    it 'should return an option tuple with the correct key and value' do
+      IniParse::Parser.parse_line('key=value').should \
+        be_option_tuple('key', 'value')
+    end
+  end
+
+  describe 'with "key= value"' do
+    it 'should return an option tuple with the correct key and value' do
+      IniParse::Parser.parse_line('key= value').should \
+        be_option_tuple('key', 'value')
+    end
+  end
+
+  describe 'with "key =value"' do
+    it 'should return an option tuple with the correct key and value' do
+      IniParse::Parser.parse_line('key =value').should \
+        be_option_tuple('key', 'value')
+    end
+  end
+
+  describe 'with "key   =   value"' do
+    it 'should return an option tuple with the correct key and value' do
+      IniParse::Parser.parse_line('key   =   value').should \
+        be_option_tuple('key', 'value')
+    end
+  end
+
+  describe 'with "key ="' do
+    it 'should return an option tuple with the correct key' do
+      IniParse::Parser.parse_line('key =').should \
+        be_option_tuple('key')
+    end
+
+    it 'should set the option value to nil' do
+      IniParse::Parser.parse_line('key =').should \
+        be_option_tuple(:any, nil)
+    end
+  end
+
+  describe 'with "key.two = value"' do
+    it 'should return an option tuple with the correct key' do
+      IniParse::Parser.parse_line('key.two = value').should \
+        be_option_tuple('key.two')
+    end
+  end
+
+  describe 'with "key/with/slashes = value"' do
+    it 'should return an option tuple with the correct key' do
+      IniParse::Parser.parse_line('key/with/slashes = value').should \
+        be_option_tuple('key/with/slashes', 'value')
+    end
+  end
+
+  describe 'with "key_with_underscores = value"' do
+    it 'should return an option tuple with the correct key' do
+      IniParse::Parser.parse_line('key_with_underscores = value').should \
+        be_option_tuple('key_with_underscores', 'value')
+    end
+  end
+
+  describe 'with "key-with-dashes = value"' do
+    it 'should return an option tuple with the correct key' do
+      IniParse::Parser.parse_line('key-with-dashes = value').should \
+        be_option_tuple('key-with-dashes', 'value')
+    end
+  end
+
+  describe 'with "key with spaces = value"' do
+    it 'should return an option tuple with the correct key' do
+      IniParse::Parser.parse_line('key with spaces = value').should \
+        be_option_tuple('key with spaces', 'value')
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   Section lines.
+  # ==========================================================================
+  # ++
+
+  describe 'with "[section]"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('[section]')
+    end
+
+    it 'should return a section tuple' do
+      @tuple.should be_section_tuple('section')
+    end
+
+    it 'should set no indent, comment, offset or separator' do
+      @tuple.last[:indent].should be_nil
+      @tuple.last[:comment].should be_nil
+      @tuple.last[:comment_offset].should be_nil
+      @tuple.last[:comment_sep].should be_nil
+    end
+  end
+
+  describe 'with "[section with whitespace]"' do
+    it 'should return a section tuple with the correct key' do
+      IniParse::Parser.parse_line('[section with whitespace]').should \
+        be_section_tuple('section with whitespace')
+    end
+  end
+
+  describe 'with "[  section with surounding whitespace  ]"' do
+    it 'should return a section tuple with the correct key' do
+      IniParse::Parser.parse_line('[  section with surounding whitespace  ]').should \
+        be_section_tuple('  section with surounding whitespace  ')
+    end
+  end
+
+  describe 'with "[section] ; a comment"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('[section] ; a comment')
+    end
+
+    it 'should return a section tuple' do
+      @tuple.should be_section_tuple('section')
+    end
+
+    it 'should set the comment to "a comment"' do
+      @tuple.should be_section_tuple(:any, :comment => 'a comment')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_section_tuple(:any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 10' do
+      @tuple.should be_section_tuple(:any, :comment_offset => 10)
+    end
+  end
+
+  describe 'with "[section;with#comment;chars]"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('[section;with#comment;chars]')
+    end
+
+    it 'should return a section tuple with the correct key' do
+      @tuple.should be_section_tuple('section;with#comment;chars')
+    end
+
+    it 'should not set a comment' do
+      @tuple.last[:indent].should be_nil
+      @tuple.last[:comment].should be_nil
+      @tuple.last[:comment_offset].should be_nil
+      @tuple.last[:comment_sep].should be_nil
+    end
+  end
+
+  describe 'with "[section;with#comment;chars] ; a comment"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('[section;with#comment;chars] ; a comment')
+    end
+
+    it 'should return a section tuple with the correct key' do
+      @tuple.should be_section_tuple('section;with#comment;chars')
+    end
+
+    it 'should set the comment to "a comment"' do
+      @tuple.should be_section_tuple(:any, :comment => 'a comment')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_section_tuple(:any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 29' do
+      @tuple.should be_section_tuple(:any, :comment_offset => 29)
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   Comment lines.
+  # ==========================================================================
+  # ++
+
+  describe 'with "; a comment"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line('; a comment')
+    end
+
+    it 'should return a comment tuple with the correct comment' do
+      @tuple.should be_comment_tuple('a comment')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_comment_tuple(:any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 0' do
+      @tuple.should be_comment_tuple(:any, :comment_offset => 0)
+    end
+  end
+
+  describe 'with " ; a comment"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line(' ; a comment')
+    end
+
+    it 'should return a comment tuple with the correct comment' do
+      @tuple.should be_comment_tuple('a comment')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_comment_tuple(:any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 1' do
+      @tuple.should be_comment_tuple(:any, :comment_offset => 1)
+    end
+  end
+
+  describe 'with ";"' do
+    before(:all) do
+      @tuple = IniParse::Parser.parse_line(';')
+    end
+
+    it 'should return a comment tuple with an empty value' do
+      @tuple.should be_comment_tuple('')
+    end
+
+    it 'should set the comment separator to ";"' do
+      @tuple.should be_comment_tuple(:any, :comment_sep => ';')
+    end
+
+    it 'should set the comment offset to 0' do
+      @tuple.should be_comment_tuple(:any, :comment_offset => 0)
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   Blank lines.
+  # ==========================================================================
+  # ++
+
+  describe 'with ""' do
+    it 'should return a blank tuple' do
+      IniParse::Parser.parse_line('').should be_blank_tuple
+    end
+  end
+
+  describe 'with " "' do
+    it 'should return a blank tuple' do
+      IniParse::Parser.parse_line(' ').should be_blank_tuple
+    end
+  end
+end

data/spec/spec_fixtures.rb

@@ -0,0 +1,46 @@
+module IniParse
+  module Test
+    class Fixtures
+      @@fixtures = {}
+
+      def self.[](fix)
+        if @@fixtures.has_key?(fix)
+          @@fixtures[fix]
+        else
+          @@fixtures[fix] = File.read(Pathname(__FILE__).dirname.expand_path / 'fixtures' / fix)
+        end
+      end
+
+      def self.[]=(fix, val)
+        @@fixtures[fix] = val.margin
+      end
+    end
+  end
+end
+
+IniParse::Test::Fixtures[:comment_before_section] = <<-FIX
+  ; This is a comment
+  [first_section]
+  key = value
+FIX
+
+IniParse::Test::Fixtures[:blank_before_section] = <<-FIX
+
+  [first_section]
+  key = value
+FIX
+
+IniParse::Test::Fixtures[:blank_in_section] = <<-FIX
+  [first_section]
+
+  key = value
+FIX
+
+IniParse::Test::Fixtures[:option_before_section] = <<-FIX
+  key = value
+  [first_section]
+FIX
+
+IniParse::Test::Fixtures[:invalid_line] = <<-FIX
+  this line is not valid
+FIX