iniparse 1.1.6 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3fc88cab6fd9b214be0c4baa4b5d3b6729add3e
+  data.tar.gz: 006036392b16391ab8b80394b22607975144cf73
+SHA512:
+  metadata.gz: 83b9c5fb87539797e3cda761063bbbc5d7c26fe5eda392d7d19d60e99e7f5f2833e5744887bef07ed6bc3d2c474337922334b12b1c9e8526dda00a6a8e9eba62
+  data.tar.gz: a4858ba30df58a5bf5c10a9928f6ccaf44bc7f9ade77f8e53effed28b31c4230f4d63391231ff5180c532fe8dfab6a16465774e82c1d4f1809a87158d1151e9c

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/README.rdoc

@@ -64,6 +64,22 @@ be supplied to you.
     document['my_section']['key']
       # => ['value', 'another value', 'third value']
 
+Options which appear before the first section will be added to a section called
+"__anonymous__".
+
+    document = IniParse.parse <<-EOS
+      driver = true
+
+      [driver]
+      key = value
+    EOS
+
+    document['__anonymous__']['driver']
+      # => true
+
+    document['driver']['key']
+      # => 'value'
+
 === Updating an INI file
 
     document['a_section']['an_option']

data/Rakefile

@@ -85,7 +85,7 @@ task :gemspec => :validate do
     split("\n").
     sort.
     reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    reject { |file| file =~ /^(rdoc|pkg|spec)/ }.
     map { |file| "    #{file}" }.
     join("\n")
 

data/iniparse.gemspec

@@ -12,14 +12,19 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'iniparse'
-  s.version           = '1.1.6'
-  s.date              = '2012-11-07'
+  s.version           = '1.2.0'
+  s.date              = '2014-04-08'
   s.rubyforge_project = 'iniparse'
 
   s.summary           = 'A pure Ruby library for parsing INI documents.'
   s.authors           = ['Anthony Williams']
   s.email             = 'hi@antw.me'
   s.homepage          = 'http://github.com/antw/iniparse'
+  s.licenses          = ['MIT']
+
+  s.description       = 'A pure Ruby library for parsing INI documents. ' \
+                        'Preserves the structure of the original document, ' \
+                        'including whitespace and comments'
 
   s.require_paths     = %w(lib)
 
@@ -27,7 +32,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = %w(History LICENSE README.rdoc)
 
   # Dependencies.
-  s.add_development_dependency('rspec', '>= 2.11.0')
+  s.add_development_dependency('rspec', '~> 2.14')
 
   # = MANIFEST =
   s.files = %w[
@@ -44,24 +49,6 @@ Gem::Specification.new do |s|
     lib/iniparse/line_collection.rb
     lib/iniparse/lines.rb
     lib/iniparse/parser.rb
-    spec/document_spec.rb
-    spec/fixture_spec.rb
-    spec/fixtures/openttd.ini
-    spec/fixtures/race07.ini
-    spec/fixtures/smb.ini
-    spec/generator/method_missing_spec.rb
-    spec/generator/with_section_blocks_spec.rb
-    spec/generator/without_section_blocks_spec.rb
-    spec/iniparse_spec.rb
-    spec/line_collection_spec.rb
-    spec/lines_spec.rb
-    spec/parser/document_parsing_spec.rb
-    spec/parser/line_parsing_spec.rb
-    spec/spec_fixtures.rb
-    spec/spec_helper.rb
-    spec/spec_helper_spec.rb
   ]
   # = MANIFEST =
-
-  s.test_files = s.files.select { |path| path =~ /^spec\/.*\.rb/ }
 end

data/lib/iniparse.rb

@@ -7,7 +7,7 @@ require File.join(dir, 'lines')
 require File.join(dir, 'parser')
 
 module IniParse
-  VERSION = '1.1.6'
+  VERSION = '1.2.0'
 
   # A base class for IniParse errors.
   class IniParseError < StandardError; end

data/lib/iniparse/line_collection.rb

@@ -110,8 +110,10 @@ module IniParse
 
     def <<(line)
       if line.kind_of?(IniParse::Lines::Option)
-        raise IniParse::LineNotAllowed,
-          "You can't add an Option to a SectionCollection."
+        option = line
+        line   = IniParse::Lines::AnonymousSection.new
+
+        line.lines << option if option
       end
 
       if line.blank? || (! has_key?(line.key))

data/lib/iniparse/lines.rb

@@ -8,6 +8,7 @@ module IniParse
       def initialize(opts = {})
         @comment        = opts.fetch(:comment, nil)
         @comment_sep    = opts.fetch(:comment_sep, ';')
+        @comment_prefix = opts.fetch(:comment_prefix, ' ')
         @comment_offset = opts.fetch(:comment_offset, 0)
         @indent         = opts.fetch(:indent, '')
       end
@@ -40,7 +41,7 @@ module IniParse
       # Returns the inline comment for this line. Includes the comment
       # separator at the beginning of the string.
       def comment
-        '%s %s' % [@comment_sep, @comment]
+        "#{ @comment_sep }#{ @comment_prefix }#{ @comment }"
       end
 
       # Returns whether this is a line which has no data.
@@ -192,6 +193,28 @@ module IniParse
       end
     end
 
+    # Stores options which appear at the beginning of a file, without a
+    # preceding section.
+    class AnonymousSection < Section
+      def initialize
+        super('__anonymous__')
+      end
+
+      def to_ini
+        # Remove the leading space which is added by joining the blank line
+        # content with the options.
+        super.gsub(/\A\n/, '')
+      end
+
+      #######
+      private
+      #######
+
+      def line_contents
+        ''
+      end
+    end
+
     # Represents probably the most common type of line in an INI document:
     # an option. Consists of a key and value, usually separated with an =.
     #

data/lib/iniparse/parser.rb

@@ -77,9 +77,10 @@ module IniParse
       # Strips in inline comment from a line (or value), removes trailing
       # whitespace and sets the comment options as applicable.
       def strip_comment(line, opts)
-        if m = /^(^)(?:(;|\#)\s*(.*))$$/.match(line) ||
-           m = /^(.*?)(?:\s+(;|\#)\s*(.*))$/.match(line) # Comment lines.
-          opts[:comment] = m[3].rstrip
+        if m = /^(^)(?:(;|\#)(\s*)(.*))$$/.match(line) ||
+           m = /^(.*?)(?:\s+(;|\#)(\s*)(.*))$/.match(line) # Comment lines.
+          opts[:comment] = m[4].rstrip
+          opts[:comment_prefix] = m[3]
           opts[:comment_sep] = m[2]
           # Remove the line content (since an option value may contain a
           # semi-colon) _then_ get the index of the comment separator.

metadata

@@ -1,33 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: iniparse
 version: !ruby/object:Gem::Version
-  version: 1.1.6
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Anthony Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
-description: 
+        version: '2.14'
+description: A pure Ruby library for parsing INI documents. Preserves the structure
+  of the original document, including whitespace and comments
 email: hi@antw.me
 executables: []
 extensions: []
@@ -49,59 +47,30 @@ files:
 - lib/iniparse/line_collection.rb
 - lib/iniparse/lines.rb
 - lib/iniparse/parser.rb
-- spec/document_spec.rb
-- spec/fixture_spec.rb
-- spec/fixtures/openttd.ini
-- spec/fixtures/race07.ini
-- spec/fixtures/smb.ini
-- spec/generator/method_missing_spec.rb
-- spec/generator/with_section_blocks_spec.rb
-- spec/generator/without_section_blocks_spec.rb
-- spec/iniparse_spec.rb
-- spec/line_collection_spec.rb
-- spec/lines_spec.rb
-- spec/parser/document_parsing_spec.rb
-- spec/parser/line_parsing_spec.rb
-- spec/spec_fixtures.rb
-- spec/spec_helper.rb
-- spec/spec_helper_spec.rb
 homepage: http://github.com/antw/iniparse
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: iniparse
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 2
 summary: A pure Ruby library for parsing INI documents.
-test_files:
-- spec/document_spec.rb
-- spec/fixture_spec.rb
-- spec/generator/method_missing_spec.rb
-- spec/generator/with_section_blocks_spec.rb
-- spec/generator/without_section_blocks_spec.rb
-- spec/iniparse_spec.rb
-- spec/line_collection_spec.rb
-- spec/lines_spec.rb
-- spec/parser/document_parsing_spec.rb
-- spec/parser/line_parsing_spec.rb
-- spec/spec_fixtures.rb
-- spec/spec_helper.rb
-- spec/spec_helper_spec.rb
+test_files: []
 has_rdoc: 

data/spec/document_spec.rb

@@ -1,88 +0,0 @@
-require 'spec_helper'
-
-describe "IniParse::Document" do
-  it 'should have a +lines+ reader' do
-    methods = IniParse::Document.instance_methods.map { |m| m.to_sym }
-    methods.should include(:lines)
-  end
-
-  it 'should not have a +lines+ writer' do
-    methods = IniParse::Document.instance_methods.map { |m| m.to_sym }
-    methods.should_not include(:lines=)
-  end
-
-  it 'should delegate #[] to +lines+' do
-    doc = IniParse::Document.new
-    doc.lines.should_receive(:[]).with('key')
-    doc['key']
-  end
-
-  it 'should call #each to +lines+' do
-    doc = IniParse::Document.new
-    doc.lines.should_receive(:each)
-    doc.each { |l| }
-  end
-
-  it 'should be enumerable' do
-    IniParse::Document.included_modules.should include(Enumerable)
-
-    sections = [
-      IniParse::Lines::Section.new('first section'),
-      IniParse::Lines::Section.new('second section')
-    ]
-
-    doc = IniParse::Document.new
-    doc.lines << sections[0] << sections[1]
-
-    doc.map { |line| line }.should == sections
-  end
-
-  describe '#has_section?' do
-    before(:all) do
-      @doc = IniParse::Document.new
-      @doc.lines << IniParse::Lines::Section.new('first section')
-    end
-
-    it 'should return true if a section with the given key exists' do
-      @doc.should have_section('first section')
-    end
-
-    it 'should return true if no section with the given key exists' do
-      @doc.should_not have_section('second section')
-    end
-  end
-
-  describe '#save' do
-    describe 'when no path is given to save' do
-      it 'should save the INI document if a path was given when initialized' do
-        doc = IniParse::Document.new('/a/path/to/a/file.ini')
-        File.should_receive(:open).with('/a/path/to/a/file.ini', 'w')
-        doc.save
-      end
-
-      it 'should raise IniParseError if no path was given when initialized' do
-        lambda { IniParse::Document.new.save }.should \
-          raise_error(IniParse::IniParseError)
-      end
-    end
-
-    describe 'when a path is given to save' do
-      it "should update the document's +path+" do
-        File.stub!(:open).and_return(true)
-        doc = IniParse::Document.new('/a/path/to/a/file.ini')
-        doc.save('/a/new/path.ini')
-        doc.path.should == '/a/new/path.ini'
-      end
-
-      it 'should save the INI document to the given path' do
-        File.should_receive(:open).with('/a/new/path.ini', 'w')
-        IniParse::Document.new('/a/path/to/a/file.ini').save('/a/new/path.ini')
-      end
-
-      it 'should raise IniParseError if no path was given when initialized' do
-        lambda { IniParse::Document.new.save }.should \
-          raise_error(IniParse::IniParseError)
-      end
-    end
-  end
-end

data/spec/fixture_spec.rb

@@ -1,166 +0,0 @@
-require 'spec_helper'
-
-describe "IniParse" do
-  describe 'openttd.ini fixture' do
-    before(:all) do
-      @fixture = fixture('openttd.ini')
-    end
-
-    it 'should parse without any errors' do
-      lambda { IniParse.parse(@fixture) }.should_not raise_error
-    end
-
-    it 'should have the correct sections' do
-      IniParse.parse(fixture('openttd.ini')).lines.keys.should == [
-        'misc', 'music', 'difficulty', 'game_creation', 'vehicle',
-        'construction', 'station', 'economy', 'pf', 'order', 'gui', 'ai',
-        'locale', 'network', 'currency', 'servers', 'bans', 'news_display',
-        'version', 'preset-J', 'newgrf', 'newgrf-static'
-      ]
-    end
-
-    it 'should have the correct options' do
-      # Test the keys from one section.
-      doc     = IniParse.parse(@fixture)
-      section = doc['misc']
-
-      section.lines.keys.should == [
-        'display_opt', 'news_ticker_sound', 'fullscreen', 'language',
-        'resolution', 'screenshot_format', 'savegame_format',
-        'rightclick_emulate', 'small_font', 'medium_font', 'large_font',
-        'small_size', 'medium_size', 'large_size', 'small_aa', 'medium_aa',
-        'large_aa', 'sprite_cache_size', 'player_face',
-        'transparency_options', 'transparency_locks', 'invisibility_options',
-        'keyboard', 'keyboard_caps'
-      ]
-
-      # Test some of the options.
-      section['display_opt'].should == 'SHOW_TOWN_NAMES|SHOW_STATION_NAMES|SHOW_SIGNS|FULL_ANIMATION|FULL_DETAIL|WAYPOINTS'
-      section['news_ticker_sound'].should be_false
-      section['language'].should == 'english_US.lng'
-      section['resolution'].should == '1680,936'
-      section['large_size'].should == 16
-
-      # Test some other options.
-      doc['currency']['suffix'].should == '" credits"'
-      doc['news_display']['production_nobody'].should == 'summarized'
-      doc['version']['version_number'].should == '070039B0'
-
-      doc['preset-J']['gcf/1_other/BlackCC/mauvetoblackw.grf'].should be_nil
-      doc['preset-J']['gcf/1_other/OpenGFX/OpenGFX_-_newFaces_v0.1.grf'].should be_nil
-    end
-
-    it 'should be identical to the original when calling #to_ini' do
-      IniParse.parse(@fixture).to_ini.should == @fixture
-    end
-  end
-
-  describe 'race07.ini fixture' do
-    before(:all) do
-      @fixture = fixture('race07.ini')
-    end
-
-    it 'should parse without any errors' do
-      lambda { IniParse.parse(@fixture) }.should_not raise_error
-    end
-
-    it 'should have the correct sections' do
-      IniParse.parse(fixture('race07.ini')).lines.keys.should == [
-        'Header', 'Race', 'Slot010', 'Slot016', 'Slot013', 'Slot018',
-        'Slot002', 'END'
-      ]
-    end
-
-    it 'should have the correct options' do
-      # Test the keys from one section.
-      doc     = IniParse.parse(@fixture)
-      section = doc['Slot010']
-
-      section.lines.keys.should == [
-        'Driver', 'SteamUser', 'SteamId', 'Vehicle', 'Team', 'QualTime',
-        'Laps', 'Lap', 'LapDistanceTravelled', 'BestLap', 'RaceTime'
-      ]
-
-      # Test some of the options.
-      section['Driver'].should == 'Mark Voss'
-      section['SteamUser'].should == 'mvoss'
-      section['SteamId'].should == 1865369
-      section['Vehicle'].should == 'Chevrolet Lacetti 2007'
-      section['Team'].should == 'TEMPLATE_TEAM'
-      section['QualTime'].should == '1:37.839'
-      section['Laps'].should == 13
-      section['LapDistanceTravelled'].should == 3857.750244
-      section['BestLap'].should == '1:38.031'
-      section['RaceTime'].should == '0:21:38.988'
-
-      section['Lap'].should == [
-        '(0, -1.000, 1:48.697)',   '(1, 89.397, 1:39.455)',
-        '(2, 198.095, 1:38.060)',  '(3, 297.550, 1:38.632)',
-        '(4, 395.610, 1:38.031)',  '(5, 494.242, 1:39.562)',
-        '(6, 592.273, 1:39.950)',  '(7, 691.835, 1:38.366)',
-        '(8, 791.785, 1:39.889)',  '(9, 890.151, 1:39.420)',
-        '(10, 990.040, 1:39.401)', '(11, 1089.460, 1:39.506)',
-        '(12, 1188.862, 1:40.017)'
-      ]
-
-      doc['Header']['Version'].should == '1.1.1.14'
-      doc['Header']['TimeString'].should == '2008/09/13 23:26:32'
-      doc['Header']['Aids'].should == '0,0,0,0,0,1,1,0,0'
-
-      doc['Race']['AIDB'].should == 'GameData\Locations\Anderstorp_2007\2007_ANDERSTORP.AIW'
-      doc['Race']['Race Length'].should == 0.1
-    end
-
-    it 'should be identical to the original when calling #to_ini' do
-      pending('awaiting presevation (or lack) of whitespace around =') do
-        IniParse.parse(@fixture).to_ini.should == @fixture
-      end
-    end
-  end
-
-  describe 'smb.ini fixture' do
-    before(:all) do
-      @fixture = fixture('smb.ini')
-    end
-
-    it 'should parse without any errors' do
-      lambda { IniParse.parse(@fixture) }.should_not raise_error
-    end
-
-    it 'should have the correct sections' do
-      IniParse.parse(@fixture).lines.keys.should == [
-        'global', 'printers'
-      ]
-    end
-
-    it 'should have the correct options' do
-      # Test the keys from one section.
-      doc     = IniParse.parse(@fixture)
-      section = doc['global']
-
-      section.lines.keys.should == [
-        'debug pid', 'log level', 'server string', 'printcap name',
-        'printing', 'encrypt passwords', 'use spnego', 'passdb backend',
-        'idmap domains', 'idmap config default: default',
-        'idmap config default: backend', 'idmap alloc backend',
-        'idmap negative cache time', 'map to guest', 'guest account',
-        'unix charset', 'display charset', 'dos charset', 'vfs objects',
-        'os level', 'domain master', 'max xmit', 'use sendfile',
-        'stream support', 'ea support', 'darwin_streams:brlm',
-        'enable core files', 'usershare max shares', 'usershare path',
-        'usershare owner only', 'usershare allow guests',
-        'usershare allow full config', 'com.apple:filter shares by access',
-        'obey pam restrictions', 'acl check permissions',
-        'name resolve order', 'include'
-      ]
-
-      section['display charset'].should == 'UTF-8-MAC'
-      section['vfs objects'].should == 'darwinacl,darwin_streams'
-      section['usershare path'].should == '/var/samba/shares'
-    end
-
-    it 'should be identical to the original when calling #to_ini' do
-      IniParse.parse(@fixture).to_ini.should == @fixture
-    end
-  end
-end