class IniParse::Document

Represents an INI document.

Attributes

lines[R]

path[RW]

Public Instance Methods

[](key) click to toggle source

Returns the section identified by key.

Returns nil if there is no Section with the given key.

# File lib/iniparse/document.rb, line 31
def [](key)
  @lines[key.to_s]
end

delete(*args) click to toggle source

Deletes the section whose name matches the given key.

Returns the document.

# File lib/iniparse/document.rb, line 47
def delete(*args)
  @lines.delete(*args)
  self
end

each(*args, &blk) click to toggle source

Enumerates through each Section in this document.

Does not yield blank and comment lines by default; if you want all lines to be yielded, pass true.

Parameters

include_blank<Boolean>: Include blank/comment lines?

# File lib/iniparse/document.rb, line 23
def each(*args, &blk)
  @lines.each(*args, &blk)
end

has_section?(key) click to toggle source

Returns true if a section with the given key exists in this document.

# File lib/iniparse/document.rb, line 87
def has_section?(key)
  @lines.has_key?(key.to_s)
end

inspect() click to toggle source

A human-readable version of the document, for debugging.

# File lib/iniparse/document.rb, line 81
def inspect
  sections = @lines.select { |l| l.is_a?(IniParse::Lines::Section) }
  "#<IniParse::Document {#{ sections.map(&:key).join(', ') }}>"
end

save(path = nil) click to toggle source

Saves a copy of this Document to disk.

If a path was supplied when the Document was initialized then nothing needs to be given to #save. If Document was not given a file path, or you wish to save the document elsewhere, supply a path when calling #save.

Parameters

path<String>: A path to which this document will be saved.

Raises

IniParseError: If your document couldn’t be saved.

# File lib/iniparse/document.rb, line 104
def save(path = nil)
  @path = path if path
  raise IniParseError, 'No path given to Document#save' if @path !~ /\S/
  File.open(@path, 'w') { |f| f.write(self.to_ini) }
end

section(key) click to toggle source

Returns the section identified by key.

If there is no Section with the given key it will be created.

# File lib/iniparse/document.rb, line 39
def section(key)
  @lines[key.to_s] ||= Lines::Section.new(key.to_s)
end

to_h() click to toggle source

Alias for: to_hash

to_hash() click to toggle source

Returns a has representation of the INI with multi-line options as an array

# File lib/iniparse/document.rb, line 64
def to_hash
  result = {}
  @lines.entries.each do |section|
    result[section.key] ||= {}
    section.entries.each do |option|
      opts = Array(option)
      val = opts.map { |o| o.respond_to?(:value) ? o.value : o }
      val = val.size > 1 ? val : val.first
      result[section.key][opts.first.key] = val
    end
  end
  result
end

Also aliased as: to_h

to_ini() click to toggle source

Returns this document as a string suitable for saving to a file.

# File lib/iniparse/document.rb, line 53
def to_ini
  string = @lines.to_a.map { |line| line.to_ini }.join($/)
  string = "#{ string }\n" unless string[-1] == "\n"

  string
end

Also aliased as: to_s

to_s() click to toggle source

Alias for: to_ini

Public Class Methods

new(path = nil) click to toggle source

Creates a new Document instance.

# File lib/iniparse/document.rb, line 10
def initialize(path = nil)
  @path  = path
  @lines = IniParse::SectionCollection.new
end