Class: BeakerPuppet::IniFile

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/beaker-puppet/inifile.rb

Overview

This class represents the INI file and can be used to parse, modify, and write INI files.

Defined Under Namespace

Classes: Error, Parser

Constant Summary collapse

VERSION = 
'3.0.0'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ IniFile

Public: Create a new INI file from the given set of options. If :content is provided then it will be used to populate the INI file. If a :filename is provided then the contents of the file will be parsed and stored in the INI file. If neither the :content or :filename is provided then an empty INI file is created.

opts - The Hash of options (default: {})

:content   - The String/Hash containing the INI contents
:comment   - String containing the comment character(s)
:parameter - String used to separate parameter and value
:encoding  - Encoding String for reading / writing
:default   - The String name of the default global section
:filename  - The filename as a String

Examples

IniFile.new
#=> an empty IniFile instance

IniFile.new( :content => "[global]\nfoo=bar" )
#=> an IniFile instance

IniFile.new( :filename => 'file.ini', :encoding => 'UTF-8' )
#=> an IniFile instance

IniFile.new( :content => "[global]\nfoo=bar", :comment => '#' )
#=> an IniFile instance



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/beaker-puppet/inifile.rb', line 88

def initialize( opts = {} )
  @comment  = opts.fetch(:comment, ';#')
  @param    = opts.fetch(:parameter, '=')
  @encoding = opts.fetch(:encoding, nil)
  @default  = opts.fetch(:default, 'global')
  @filename = opts.fetch(:filename, nil)
  content   = opts.fetch(:content, nil)

  @ini = Hash.new {|h,k| h[k] = Hash.new}

  if    content.is_a?(Hash) then merge!(content)
  elsif content             then parse(content)
  elsif @filename           then read
  end
end

Instance Attribute Details

#encoding ⇒ Object

Get and set the encoding



58
59
60
 
# File 'lib/beaker-puppet/inifile.rb', line 58

def encoding
  @encoding
end

#filename ⇒ Object

Get and set the filename



55
56
57
 
# File 'lib/beaker-puppet/inifile.rb', line 55

def filename
  @filename
end

Class Method Details

.load(filename, opts = {}) ⇒ Object

Public: Open an INI file and load the contents.

filename - The name of the file as a String opts - The Hash of options (default: {})

:comment   - String containing the comment character(s)
:parameter - String used to separate parameter and value
:encoding  - Encoding String for reading / writing
:default   - The String name of the default global section

Examples

IniFile.load('file.ini')
#=> IniFile instance

IniFile.load('does/not/exist.ini')
#=> nil

Returns an IniFile instance or nil if the file could not be opened.



49
50
51
52
 
# File 'lib/beaker-puppet/inifile.rb', line 49

def self.load( filename, opts = {} )
  return unless File.file? filename
  new(opts.merge(:filename => filename))
end

Instance Method Details

#[](section) ⇒ Object

Public: Get the section Hash by name. If the section does not exist, then it will be created.

section - The section name as a String.

Examples

inifile['global']
#=> global section Hash

Returns the Hash of parameter/value pairs for this section.



285
286
287
288
 
# File 'lib/beaker-puppet/inifile.rb', line 285

def []( section )
  return nil if section.nil?
  @ini[section.to_s]
end

#[]=(section, value) ⇒ Object

Public: Set the section to a hash of parameter/value pairs.

section - The section name as a String. value - The Hash of parameter/value pairs.

Examples

inifile['tenderloin'] = { 'gritty' => 'yes' }
#=> { 'gritty' => 'yes' }

Returns the value Hash.



301
302
303
 
# File 'lib/beaker-puppet/inifile.rb', line 301

def []=( section, value )
  @ini[section.to_s] = value
end

#clone ⇒ Object

Public: Produces a duplicate of this IniFile. The duplicate is independent of the original – i.e. the duplicate can be modified without changing the original.

Returns a new IniFile.



363
364
365
366
367
 
# File 'lib/beaker-puppet/inifile.rb', line 363

def clone
  other = dup
  other.freeze if self.frozen?
  other
end

#delete_section(section) ⇒ Object

Public: Remove a section identified by name from the IniFile.

section - The section name as a String.

Returns the deleted section Hash.



270
271
272
 
# File 'lib/beaker-puppet/inifile.rb', line 270

def delete_section( section )
  @ini.delete section.to_s
end

#dup ⇒ Object

Public: Produces a duplicate of this IniFile. The duplicate is independent of the original – i.e. the duplicate can be modified without changing the original. The tainted state of the original is copied to the duplicate.

Returns a new IniFile.



351
352
353
354
355
356
 
# File 'lib/beaker-puppet/inifile.rb', line 351

def dup
  other = super
  other.instance_variable_set(:@ini, Hash.new {|h,k| h[k] = Hash.new})
  @ini.each_pair {|s,h| other[s].merge! h}
  other
end

#each ⇒ Object

Public: Yield each INI file section, parameter, and value in turn to the given block.

block - The block that will be iterated by the each method. The block will

be passed the current section and the parameter/value pair.

Examples

inifile.each do |section, parameter, value|
  puts "#{parameter} = #{value} [in section - #{section}]"
end

Returns this IniFile.



237
238
239
240
241
242
243
244
245
 
# File 'lib/beaker-puppet/inifile.rb', line 237

def each
  return unless block_given?
  @ini.each do |section,hash|
    hash.each do |param,val|
      yield section, param, val
    end
  end
  self
end

#each_section ⇒ Object

Public: Yield each section in turn to the given block.

block - The block that will be iterated by the each method. The block will

be passed the current section as a Hash.

Examples

inifile.each_section do |section|
  puts section.inspect
end

Returns this IniFile.



259
260
261
262
263
 
# File 'lib/beaker-puppet/inifile.rb', line 259

def each_section
  return unless block_given?
  @ini.each_key {|section| yield section}
  self
end

#eql?(other) ⇒ Boolean Also known as: ==

Public: Compare this IniFile to some other IniFile. For two INI files to be equivalent, they must have the same sections with the same parameter / value pairs in each section.

other - The other IniFile.

Returns true if the INI files are equivalent and false if they differ.

Returns:

  • (Boolean) 


376
377
378
379
380
 
# File 'lib/beaker-puppet/inifile.rb', line 376

def eql?( other )
  return true if equal? other
  return false unless other.instance_of? self.class
  @ini == other.instance_variable_get(:@ini)
end

#escape_value(value) ⇒ Object

Escape special characters.

value - The String value to escape.

Returns the escaped value.



388
389
390
391
392
393
394
395
396
 
# File 'lib/beaker-puppet/inifile.rb', line 388

def escape_value( value )
  value = value.to_s.dup
  value.gsub!(%r/\\([0nrt])/, '\\\\\1')
  value.gsub!(%r/\n/, '\n')
  value.gsub!(%r/\r/, '\r')
  value.gsub!(%r/\t/, '\t')
  value.gsub!(%r/\0/, '\0')
  value
end

#freeze ⇒ Object

Public: Freeze the state of this IniFile object. Any attempts to change the object will raise an error.

Returns this IniFile.



339
340
341
342
343
344
 
# File 'lib/beaker-puppet/inifile.rb', line 339

def freeze
  super
  @ini.each_value {|h| h.freeze}
  @ini.freeze
  self
end

#has_section?(section) ⇒ Boolean

Public: Check to see if the IniFile contains the section.

section - The section name as a String.

Returns true if the section exists in the IniFile.

Returns:

  • (Boolean) 


326
327
328
 
# File 'lib/beaker-puppet/inifile.rb', line 326

def has_section?( section )
  @ini.has_key? section.to_s
end

#match(regex) ⇒ Object

Public: Create a Hash containing only those INI file sections whose names match the given regular expression.

regex - The Regexp used to match section names.

Examples

inifile.match(/^tree_/)
#=> Hash of matching sections

Return a Hash containing only those sections that match the given regular expression.



317
318
319
 
# File 'lib/beaker-puppet/inifile.rb', line 317

def match( regex )
  @ini.dup.delete_if { |section, _| section !~ regex }
end

#merge(other) ⇒ Object

Public: Creates a copy of this inifile with the entries from the other_inifile merged into the copy.

other - The other IniFile.

Returns a new IniFile.



175
176
177
 
# File 'lib/beaker-puppet/inifile.rb', line 175

def merge( other )
  self.dup.merge!(other)
end

#merge!(other) ⇒ Object

Public: Merges other_inifile into this inifile, overwriting existing entries. Useful for having a system inifile with user overridable settings elsewhere.

other - The other IniFile.

Returns this IniFile.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/beaker-puppet/inifile.rb', line 186

def merge!( other )
  return self if other.nil?

  my_keys = @ini.keys
  other_keys = case other
    when self.class
      other.instance_variable_get(:@ini).keys
    when Hash
      other.keys
    else
      raise Error, "cannot merge contents from '#{other.class.name}'"
    end

  (my_keys & other_keys).each do |key|
    case other[key]
    when Hash
      @ini[key].merge!(other[key])
    when nil
      nil
    else
      raise Error, "cannot merge section #{key.inspect} - unsupported type: #{other[key].class.name}"
    end
  end

  (other_keys - my_keys).each do |key|
    @ini[key] = case other[key]
      when Hash
        other[key].dup
      when nil
        {}
      else
        raise Error, "cannot merge section #{key.inspect} - unsupported type: #{other[key].class.name}"
      end
  end

  self
end

#parse(content) ⇒ Object

Parse the given content and store the information in this IniFile instance. All data will be cleared out and replaced with the information read from the content.

content - A String or a file descriptor (must respond to ‘each_line`)

Returns this IniFile.



405
406
407
408
409
 
# File 'lib/beaker-puppet/inifile.rb', line 405

def parse( content )
  parser = Parser.new(@ini, @param, @comment, @default)
  parser.parse(content)
  self
end

#read(opts = {}) ⇒ Object Also known as: restore

Public: Read the contents of the INI file from the file system and replace and set the state of this IniFile instance. If left unspecified the currently configured filename and encoding will be used when reading from the file system. Otherwise the filename and encoding can be specified in the options hash.

opts - The default options Hash

:filename - The filename as a String
:encoding - The encoding as a String

Returns this IniFile instance if the read was successful; nil is returned if the file could not be read.



142
143
144
145
146
147
148
149
150
 
# File 'lib/beaker-puppet/inifile.rb', line 142

def read( opts = {} )
  filename = opts.fetch(:filename, @filename)
  encoding = opts.fetch(:encoding, @encoding)
  return unless File.file? filename

  mode = encoding ? "r:#{encoding}" : "r"
  File.open(filename, mode) { |fd| parse fd }
  self
end

#sections ⇒ Object

Returns an Array of section names contained in this IniFile.



331
332
333
 
# File 'lib/beaker-puppet/inifile.rb', line 331

def sections
  @ini.keys
end

#to_h ⇒ Object

Returns this IniFile converted to a Hash.



165
166
167
 
# File 'lib/beaker-puppet/inifile.rb', line 165

def to_h
  @ini.dup
end

#to_s ⇒ Object

Returns this IniFile converted to a String.



154
155
156
157
158
159
160
161
162
 
# File 'lib/beaker-puppet/inifile.rb', line 154

def to_s
  s = []
  @ini.each do |section,hash|
    s << "[#{section}]"
    hash.each {|param,val| s << "#{param} #{@param} #{escape_value val}"}
    s << ""
  end
  s.join("\n")
end

#write(opts = {}) ⇒ Object Also known as: save

Public: Write the contents of this IniFile to the file system. If left unspecified, the currently configured filename and encoding will be used. Otherwise the filename and encoding can be specified in the options hash.

opts - The default options Hash

:filename - The filename as a String
:encoding - The encoding as a String

Returns this IniFile instance.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/beaker-puppet/inifile.rb', line 113

def write( opts = {} )
  filename = opts.fetch(:filename, @filename)
  encoding = opts.fetch(:encoding, @encoding)
  mode = encoding ? "w:#{encoding}" : "w"

  File.open(filename, mode) do |f|
    @ini.each do |section,hash|
      f.puts "[#{section}]"
      hash.each {|param,val| f.puts "#{param} #{@param} #{escape_value val}"}
      f.puts
    end
  end

  self
end