iniparse 0.2.1

data/spec/fixtures/race07.ini

@@ -0,0 +1,133 @@
+; All names and Steam IDs changed to fake values.
+
+[Header]
+Game=RACE 07
+Version=1.1.1.14
+TimeString=2008/09/13 23:26:32
+Aids=0,0,0,0,0,1,1,0,0
+
+[Race]
+RaceMode=5
+Scene=GameData\Locations\Anderstorp_2007\2007_ANDERSTORP.TRK
+AIDB=GameData\Locations\Anderstorp_2007\2007_ANDERSTORP.AIW
+Race Length=0.100
+Track Length=4018.8376
+
+[Slot010]
+Driver=Mark Voss
+SteamUser=mvoss
+SteamId=1865369
+Vehicle=Chevrolet Lacetti 2007
+Team=TEMPLATE_TEAM
+QualTime=1:37.839
+Laps=13
+Lap=(0, -1.000, 1:48.697)
+Lap=(1, 89.397, 1:39.455)
+Lap=(2, 198.095, 1:38.060)
+Lap=(3, 297.550, 1:38.632)
+Lap=(4, 395.610, 1:38.031)
+Lap=(5, 494.242, 1:39.562)
+Lap=(6, 592.273, 1:39.950)
+Lap=(7, 691.835, 1:38.366)
+Lap=(8, 791.785, 1:39.889)
+Lap=(9, 890.151, 1:39.420)
+Lap=(10, 990.040, 1:39.401)
+Lap=(11, 1089.460, 1:39.506)
+Lap=(12, 1188.862, 1:40.017)
+LapDistanceTravelled=3857.750244
+BestLap=1:38.031
+RaceTime=0:21:38.988
+
+[Slot016]
+Driver=Corey Ball
+SteamUser=cball
+SteamId=889853
+Vehicle=SEAT Leon 2007
+Team=TEMPLATE_TEAM
+QualTime=1:37.904
+Laps=9
+Lap=(0, -1.000, 1:51.434)
+Lap=(1, 89.397, 1:39.427)
+Lap=(2, 200.831, 1:38.394)
+Lap=(3, 300.258, 1:40.239)
+Lap=(4, 398.653, 1:38.172)
+Lap=(5, 498.891, 1:38.427)
+Lap=(6, 597.063, 1:39.271)
+Lap=(7, 695.490, 1:39.922)
+Lap=(8, 794.761, 1:40.305)
+LapDistanceTravelled=532.898193
+BestLap=1:38.172
+RaceTime=DNF
+Reason=0
+
+[Slot013]
+Driver=Gabriel Lloyd
+SteamUser=glloyd
+SteamId=635
+Vehicle=Chevrolet Lacetti 2007
+Team=TEMPLATE_TEAM
+QualTime=1:36.607
+Laps=13
+Lap=(0, -1.000, 1:50.816)
+Lap=(1, 89.397, 1:38.835)
+Lap=(2, 200.213, 1:38.082)
+Lap=(3, 299.048, 1:38.367)
+Lap=(4, 397.131, 1:37.825)
+Lap=(5, 495.497, 1:38.757)
+Lap=(6, 593.322, 1:38.718)
+Lap=(7, 692.080, 1:38.478)
+Lap=(8, 790.797, 1:39.347)
+Lap=(9, 889.275, 1:38.713)
+Lap=(10, 988.622, 1:38.952)
+Lap=(11, 1087.336, 1:39.285)
+Lap=(12, 1186.288, 1:40.555)
+LapDistanceTravelled=3898.517578
+BestLap=1:37.825
+RaceTime=0:21:36.730
+
+[Slot018]
+Driver=Reino Lintula
+SteamUser=rlintula
+SteamId=1816
+Vehicle=SEAT Leon 2007
+Team=TEMPLATE_TEAM
+QualTime=1:39.602
+Laps=7
+Lap=(0, -1.000, 1:52.788)
+Lap=(1, 112.593, 1:39.346)
+Lap=(2, 225.381, 1:40.680)
+Lap=(3, 324.727, 1:38.775)
+Lap=(4, 425.407, 1:40.149)
+Lap=(5, 524.182, 1:41.551)
+Lap=(6, 624.331, 1:46.908)
+LapDistanceTravelled=1333.551270
+BestLap=1:38.775
+RaceTime=DNF
+Reason=0
+
+[Slot002]
+Driver=Jerry Lalich
+SteamUser=jlalich
+SteamId=236892
+Vehicle=Chevrolet Lacetti 2007
+Team=TEMPLATE_TEAM
+QualTime=1:38.081
+Laps=13
+Lap=(0, -1.000, 1:48.530)
+Lap=(1, 89.397, 1:39.213)
+Lap=(2, 197.927, 1:37.933)
+Lap=(3, 297.140, 1:37.717)
+Lap=(4, 395.073, 1:38.500)
+Lap=(5, 492.790, 1:38.641)
+Lap=(6, 591.290, 1:39.810)
+Lap=(7, 689.931, 1:39.177)
+Lap=(8, 789.742, 1:40.122)
+Lap=(9, 888.918, 1:38.928)
+Lap=(10, 989.040, 1:39.238)
+Lap=(11, 1087.968, 1:39.223)
+Lap=(12, 1187.206, 1:39.888)
+LapDistanceTravelled=3892.720215
+BestLap=1:37.717
+RaceTime=0:21:36.920
+
+[END]

data/spec/fixtures/smb.ini

@@ -0,0 +1,102 @@
+; Configuration file for the Samba software suite.
+; ============================================================================
+;
+; For the format of this file and comprehensive descriptions of all the
+; configuration option, please refer to the man page for smb.conf(5).
+;
+; The following configuration should suit most systems for basic usage and
+; initial testing. It gives all clients access to their home directories and
+; allows access to all printers specified in /etc/printcap.
+
+; BEGIN required configuration
+
+; Parameters inside the required configuration block should not be altered.
+; They may be changed at any time by upgrades or other automated processes.
+;
+; Site-specific customizations will only be preserved if they are done
+; outside this block. If you choose to make customizations, it is your
+; own responsibility to verify that they work correctly with the supported
+; configuration tools.
+
+[global]
+    debug pid = yes
+    log level = 1
+    server string = Mac OS X
+
+    printcap name = cups
+    printing = cups
+
+    encrypt passwords = yes
+    use spnego = yes
+
+    passdb backend = odsam
+
+    idmap domains = default
+    idmap config default: default = yes
+    idmap config default: backend = odsam
+    idmap alloc backend = odsam
+    idmap negative cache time = 5
+
+    map to guest = Bad User
+    guest account = nobody
+
+    unix charset = UTF-8-MAC
+    display charset = UTF-8-MAC
+    dos charset = 437
+
+    vfs objects = darwinacl,darwin_streams
+
+    ; Don't become a master browser unless absolutely necessary.
+    os level = 2
+    domain master = no
+
+    ; For performance reasons, set the transmit buffer size
+    ; to the maximum and enable sendfile support.
+    max xmit = 131072
+    use sendfile = yes
+
+    ; The darwin_streams module gives us named streams support.
+    stream support = yes
+    ea support = yes
+
+    ; Enable locking coherency with AFP.
+    darwin_streams:brlm = yes
+
+    ; Core files are invariably disabled system-wide, but attempting to
+    ; dump core will trigger a crash report, so we still want to try.
+    enable core files = yes
+
+    ; Configure usershares for use by the synchronize-shares tool.
+    usershare max shares = 1000
+    usershare path = /var/samba/shares
+    usershare owner only = no
+    usershare allow guests = yes
+    usershare allow full config = yes
+
+    ; Filter inaccessible shares from the browse list.
+    com.apple:filter shares by access = yes
+
+    ; Check in with PAM to enforce SACL access policy.
+    obey pam restrictions = yes
+
+    ; Don't be trying to enforce ACLs in userspace.
+    acl check permissions = no
+
+    ; Make sure that we resolve unqualified names as NetBIOS before DNS.
+    name resolve order = lmhosts wins bcast host
+
+    ; Pull in system-wide preference settings. These are managed by
+    ; synchronize-preferences tool.
+    include = /var/db/smb.conf
+
+[printers]
+    comment = All Printers
+    path = /tmp
+    printable = yes
+    guest ok = no
+    create mode = 0700
+    writeable = no
+    browseable = no
+
+; Site-specific parameters can be added below this comment.
+; END required configuration.

data/spec/generator/method_missing_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# Tests use of the Generator when used like so:
+#
+#   IniParse::Generator.gen do |doc|
+#     doc.comment 'My very own comment'
+#     doc.my_section do |section|
+#       section.my_option = 'my value'
+#     end
+#   end
+#
+
+describe 'When generating a document using Generator with section blocks using method_missing,' do
+
+  # --
+  # ==========================================================================
+  #   SECTION LINES
+  # ==========================================================================
+  # ++
+
+  describe 'adding a section' do
+    it 'should yield an object with generator methods' do
+      IniParse::Generator.gen do |doc|
+        doc.a_section do |section|
+          %w( option comment blank ).each do |meth|
+            section.should respond_to(meth)
+          end
+        end
+      end
+    end
+
+    it 'should add a Section to the document' do
+      IniParse::Generator.gen do |doc|
+        doc.a_section { |section| }
+      end.should have_section("a_section")
+    end
+
+    it 'should change the Generator context to the section during the section block' do
+      IniParse::Generator.gen do |doc|
+        doc.a_section do |section|
+          section.context.should be_kind_of(IniParse::Lines::Section)
+          section.context.key.should == "a_section"
+        end
+      end
+    end
+
+    it 'should reset the Generator context to the document after the section block' do
+      IniParse::Generator.gen do |doc|
+        doc.a_section { |section| }
+        doc.context.should be_kind_of(IniParse::Document)
+      end
+    end
+
+    it 'should append a blank line to the document, after the section' do
+      IniParse::Generator.gen do |doc|
+        doc.a_section { |section| }
+      end.lines.to_a.last.should be_kind_of(IniParse::Lines::Blank)
+    end
+
+    it 'should raise a LineNotAllowed if you attempt to nest a section' do
+      lambda do
+        IniParse::Generator.gen do |doc|
+          doc.a_section do |section_one|
+            section_one.another_section { |section_two| }
+          end
+        end
+      end.should raise_error(IniParse::LineNotAllowed)
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   OPTION LINES
+  # ==========================================================================
+  # ++
+
+  describe 'adding a option' do
+    describe 'when the context is a Document' do
+      it "should raise a NoSectionError" do
+        lambda do
+          IniParse::Generator.gen { |doc| doc.my_option = "a value" }
+        end.should raise_error(IniParse::NoSectionError)
+      end
+    end
+
+    describe 'when the context is a Section' do
+      it 'should add the option to the section' do
+        document = IniParse::Generator.gen do |doc|
+          doc.a_section do |section|
+            section.my_option = "a value"
+          end
+        end
+
+        section = document["a_section"]
+        section.should have_option("my_option")
+        section["my_option"].should == "a value"
+      end
+    end
+  end
+
+  # Comments and blanks are added in the same way as in the
+  # 'with_section_block_spec.rb' specification.
+
+end

data/spec/generator/with_section_blocks_spec.rb

@@ -0,0 +1,322 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# Tests use of the Generator when used like so:
+#
+#   IniParse::Generator.gen do |doc|
+#     doc.comment('My very own comment')
+#     doc.section('my_section') do |section|
+#       section.option('my_option', 'my value')
+#     end
+#   end
+#
+
+describe 'When generating a document using Generator with section blocks,' do
+
+  it 'should be able to compile an empty document' do
+    lambda { IniParse::Generator.gen { |doc| } }.should_not raise_error
+  end
+
+  it 'should raise LocalJumpError if no block is given' do
+    lambda { IniParse::Generator.gen }.should raise_error(LocalJumpError)
+  end
+
+  it "should yield an object with generator methods" do
+    IniParse::Generator.gen do |doc|
+      %w( section option comment blank ).each do |meth|
+        doc.should respond_to(meth)
+      end
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   SECTION LINES
+  # ==========================================================================
+  # ++
+
+  describe 'adding a section' do
+    it 'should yield an object with generator methods' do
+      IniParse::Generator.gen do |doc|
+        doc.section("a section") do |section|
+          %w( option comment blank ).each do |meth|
+            section.should respond_to(meth)
+          end
+        end
+      end
+    end
+
+    it 'should add a Section to the document' do
+      IniParse::Generator.gen do |doc|
+        doc.section("a section") { |section| }
+      end.should have_section("a section")
+    end
+
+    it 'should change the Generator context to the section during the section block' do
+      IniParse::Generator.gen do |doc|
+        doc.section("a section") do |section|
+          section.context.should be_kind_of(IniParse::Lines::Section)
+          section.context.key.should == "a section"
+        end
+      end
+    end
+
+    it 'should reset the Generator context to the document after the section block' do
+      IniParse::Generator.gen do |doc|
+        doc.section("a section") { |section| }
+        doc.context.should be_kind_of(IniParse::Document)
+      end
+    end
+
+    it "should use the parent document's options as a base" do
+      document = IniParse::Generator.gen(:indent => '    ') do |doc|
+        doc.section("a section") { |section| }
+      end
+
+      document["a section"].to_ini.should match(/\A    /)
+    end
+
+    it 'should pass extra options to the Section instance' do
+      document = IniParse::Generator.gen do |doc|
+        doc.section("a section", :indent => '    ') { |section| }
+      end
+
+      document["a section"].to_ini.should match(/\A    /)
+    end
+
+    it 'should append a blank line to the document, after the section' do
+      IniParse::Generator.gen do |doc|
+        doc.section("a section") { |section| }
+      end.lines.to_a.last.should be_kind_of(IniParse::Lines::Blank)
+    end
+
+    it 'should raise a LineNotAllowed if you attempt to nest a section' do
+      lambda do
+        IniParse::Generator.gen do |doc|
+          doc.section("a section") do |section_one|
+            section_one.section("another_section") { |section_two| }
+          end
+        end
+      end.should raise_error(IniParse::LineNotAllowed)
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   OPTION LINES
+  # ==========================================================================
+  # ++
+
+  describe 'adding a option' do
+
+    describe 'when the context is a Document' do
+      it "should raise a NoSectionError" do
+        lambda do
+          IniParse::Generator.gen do |doc|
+            doc.option("my option", "a value")
+          end
+        end.should raise_error(IniParse::NoSectionError)
+      end
+    end
+
+    describe 'when the context is a Section' do
+      it 'should add the option to the section' do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section") do |section|
+            section.option("my option", "a value")
+          end
+        end
+
+        section = document["a section"]
+        section.should have_option("my option")
+        section["my option"].should == "a value"
+      end
+
+      it 'should pass extra options to the Option instance' do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section") do |section|
+            section.option("my option", "a value", :indent => "    ")
+          end
+        end
+
+        document["a section"].option("my option").to_ini.should match(/^    /)
+      end
+
+      it "should use the parent document's options as a base" do
+        document = IniParse::Generator.gen(:indent => "    ") do |doc|
+          doc.section("a section") do |section|
+            section.option("my option", "a value")
+          end
+        end
+
+        document["a section"].option("my option").to_ini.should match(/^    /)
+      end
+
+      it "should use the parent section's options as a base" do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section", :indent => "    ") do |section|
+            section.option("my option", "a value")
+          end
+        end
+
+        document["a section"].option("my option").to_ini.should match(/^    /)
+      end
+
+      it "should allow customisation of the parent's options" do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section", :indent => "    ") do |section|
+            section.option("my option", "a value", {
+              :comment_sep => "#", :comment => 'a comment'
+            })
+          end
+        end
+
+        option_ini = document["a section"].option("my option").to_ini
+        option_ini.should match(/^    /)
+        option_ini.should match(/ # a comment/)
+      end
+
+      it "should not use the parent section's comment when setting line options" do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section", :comment => "My section") do |section|
+            section.option("my option", "a value")
+          end
+        end
+
+        document["a section"].option("my option").to_ini.should_not match(/My section$/)
+      end
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   COMMENT LINES
+  # ==========================================================================
+  # ++
+
+  describe 'adding a comment' do
+    it 'should pass extra options to the Option instance' do
+      document = IniParse::Generator.gen do |doc|
+        doc.comment("My comment", :indent => '    ')
+      end
+
+      document.lines.to_a.first.to_ini.should match(/\A    /)
+    end
+
+    it 'should ignore any extra :comment option' do
+      document = IniParse::Generator.gen do |doc|
+        doc.comment("My comment", :comment => 'Ignored')
+      end
+
+      document.lines.to_a.first.to_ini.should match(/My comment/)
+      document.lines.to_a.first.to_ini.should_not match(/Ignored/)
+    end
+
+    describe 'when the context is a Document' do
+      it 'should add a comment to the document' do
+        document = IniParse::Generator.gen do |doc|
+          doc.comment("My comment")
+        end
+
+        comment = document.lines.to_a.first
+        comment.should be_kind_of(IniParse::Lines::Comment)
+        comment.to_ini.should match(/My comment/)
+      end
+
+      it 'should use the default line options as a base' do
+        document = IniParse::Generator.gen do |doc|
+          doc.comment("My comment")
+        end
+
+        comment_ini = document.lines.to_a.first.to_ini
+
+        # Match separator (;) and offset (0).
+        comment_ini.should == '; My comment'
+      end
+    end
+
+    describe 'when the context is a Section' do
+      it 'should add a comment to the section' do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section") do |section|
+            section.comment("My comment")
+          end
+        end
+
+        comment = document['a section'].lines.to_a.first
+        comment.should be_kind_of(IniParse::Lines::Comment)
+        comment.to_ini.should match(/My comment/)
+      end
+
+      it "should use the parent document's line options as a base" do
+        document = IniParse::Generator.gen(:comment_offset => 5) do |doc|
+          doc.section("a section") do |section|
+            section.comment("My comment")
+          end
+        end
+
+        document['a section'].lines.to_a.first.to_ini.should match(/^     ;/)
+      end
+
+      it "should use the parent section's line options as a base" do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section", :comment_offset => 5) do |section|
+            section.comment("My comment")
+          end
+        end
+
+        document['a section'].lines.to_a.first.to_ini.should match(/^     ;/)
+      end
+
+      it "should allow customisation of the parent's options" do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section", :comment_offset => 5) do |section|
+            section.comment("My comment", :comment_sep => "#")
+          end
+        end
+
+        # Match separator (#) and offset (5)
+        document['a section'].lines.to_a.first.to_ini.should \
+          == '     # My comment'
+      end
+
+      it "should not use the parent section's comment when setting line options" do
+        document = IniParse::Generator.gen do |doc|
+          doc.section("a section", :comment => "My section") do |section|
+            section.comment("My comment")
+          end
+        end
+
+        comment_ini = document['a section'].lines.to_a.first.to_ini
+        comment_ini.should match(/My comment/)
+        comment_ini.should_not match(/My section/)
+      end
+    end
+  end
+
+  # --
+  # ==========================================================================
+  #   BLANK LINES
+  # ==========================================================================
+  # ++
+
+  describe 'adding a blank line' do
+    it 'should add a blank line to the document when it is the context' do
+      document = IniParse::Generator.gen do |doc|
+        doc.blank
+      end
+
+      document.lines.to_a.first.should be_kind_of(IniParse::Lines::Blank)
+    end
+
+    it 'should add a blank line to the section when it is the context' do
+      document = IniParse::Generator.gen do |doc|
+        doc.section("a section") do |section|
+          section.blank
+        end
+      end
+
+      document['a section'].lines.to_a.first.should be_kind_of(IniParse::Lines::Blank)
+    end
+  end
+
+end