class UnixConfigStyle

Author: Erwan SEITE Aim: Read or Write config files written in Unix Style Licence : GPL v2 Source : github.com/wanix/ruby-UnixConfigStyle The section name “[-UnixConfigStyle-]” is reserved for the global one

Constants

Version

Public Class Methods

new(config_file=nil) click to toggle source

(private) Initialise the class and read the file Parameters:

config_file: String (path to a readable unix config file) (optionnal)

# File lib/unixconfigstyle.rb, line 30
def initialize(config_file=nil)
  @sections = {}

  if(config_file)
    push_unix_config_file(config_file)
  end
end

Public Instance Methods

addValues(values, key, section=@@rootsection) click to toggle source

Add values for a key Parameters:

values: Array or String
key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 222
def addValues (values, key, section=@@rootsection)
  @sections[section]={} unless @sections.key?(section)
  @sections[section][key]=[] unless @sections[section].key?(key)
  if values.is_a? Array
    return true if @sections[section][key].concat(values)
  else
    #String
    return true if @sections[section][key].push(values)
  end
  return false
end

getAllKeys(section=nil) click to toggle source

Get all differents keys in the object

if section is defined, return a merged array for keys in the section and keys in root section
if section is not defined, return a a merged array for all keys in the object

return an array (or nil if no keys found)

# File lib/unixconfigstyle.rb, line 197
def getAllKeys (section=nil)
  allKeys=[]
  #Get keys from root section
  allKeys.concat(@sections[@@rootsection].keys) if @sections.key?(@@rootsection)
  if ( section == nil )
    #Get keys from the others sections if exists and are not empty
    if self.haveSections?()
      self.getSections().each do |subsection|
        allKeys.concat(@sections[subsection].keys) if @sections.key?(subsection)
      end
    end
  else
    #get keys for this specific section
    allKeys.concat(@sections[section].keys) if self.sectionExists?(section)
  end
  return nil if allKeys.empty?()
  allKeys.uniq!
  return allKeys
end

getFirstValue(key, section=@@rootsection) click to toggle source

Get the first value for a key (config first win) Parameters:

key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 269
def getFirstValue (key, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      return @sections[section][key].first
    end
  end
  return nil
end

getKeys(section=@@rootsection) click to toggle source

Get all avalaibles keys for this section return an array (or nil if no keys found) Parameters:

section: String (optionnal)

# File lib/unixconfigstyle.rb, line 186
def getKeys (section=@@rootsection)
  if @sections.key?(section)
    return @sections[section].keys
  end
  return nil
end

getLastValue(key, section=@@rootsection) click to toggle source

Get the last value for a key (config last win) Parameters:

key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 282
def getLastValue (key, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      return @sections[section][key].last
    end
  end
  return nil
end

getRootSectionName() click to toggle source

Return the root section name (for loops with sections?)

# File lib/unixconfigstyle.rb, line 415
def getRootSectionName
  return @@rootsection
end

getSections() click to toggle source

Get all avalaibles sections (all but root one) return an array

# File lib/unixconfigstyle.rb, line 174
def getSections ()
  allsections = @sections.keys
  if allsections
    allsections.delete(@@rootsection)
  end
  return allsections
end

getValue(key, index=0, section=@@rootsection) click to toggle source

Get the value with the given index for a key Parameters:

key: String
index :Integer (default 0)
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 296
def getValue (key, index=0, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      return @sections[section][key][index]
    end
  end
  return nil
end

getValues(key, section=@@rootsection, globalSearch=false) click to toggle source

Get all values for a key (in a section if given, else in root one) Parameters:

key: String
section: String (optionnal)
globalSearch: boolean, if true, insert the results from the root section (default false)

# File lib/unixconfigstyle.rb, line 254
def getValues (key, section=@@rootsection, globalSearch=false)
  resultArray=[]
  if (globalSearch == true and section != @@rootsection)
    #We put first the result form the root section
    resultArray.concat(@sections[@@rootsection][key]) if ( @sections.key?(@@rootsection) and @sections[@@rootsection].key?(key) )
  end
  resultArray.concat(@sections[section][key]) if ( @sections.key?(section) and @sections[section].key?(key) )
  return nil if resultArray.empty?()
  return resultArray
end

haveKeys?(section=@@rootsection) click to toggle source

Return true if at list one key is present

# File lib/unixconfigstyle.rb, line 391
def haveKeys? (section=@@rootsection)
  return false if @sections.empty?
  return true unless @sections[section].empty?
  return false
end

haveSections?() click to toggle source

Return true if at list one section is present

# File lib/unixconfigstyle.rb, line 398
def haveSections? ()
  return true unless self.getSections().empty?
  return false
end

insertValues(values, key, section=@@rootsection) click to toggle source

Insert values for a key Parameters:

values: Array or String
key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 239
def insertValues (values, key, section=@@rootsection)
  @sections[section]={} unless @sections.key?(section)
  @sections[section][key]=[] unless @sections[section].key?(key)
  if @sections[section][key].insert(0,values)
    return true
  else
    return false
  end
end

insert_unix_config_file(config_file) click to toggle source

Read a config file and add its properties to the start of the object ones Parameters:

config_file: String (path to a readable unix config file)

# File lib/unixconfigstyle.rb, line 59
def insert_unix_config_file(config_file)
  add_unix_config_file(config_file,"insert")
end

isEmpty?() click to toggle source

Return false if at list one key is found, whatever its section, global or not

# File lib/unixconfigstyle.rb, line 404
def isEmpty?()
  return false if self.haveKeys?
  if self.haveSections?
    self.getSections().each do |section|
      return false if self.haveKeys?(section)
    end
  end
  return true
end

keyExists?(key, section, globalSearch=false) click to toggle source

Return true if the key exists for the section “section” if global search is set to true, return true if the key exists in the root section and not in the section itself Parameters:

key : string, the key to search
section: string, the section where to search the key (default the root one)
globalSearch: boolean, if the section is not the root one, return true if the key is found in the root section even if it not exists in the given section

# File lib/unixconfigstyle.rb, line 368
def keyExists?(key, section, globalSearch=false)
  return false if @sections.empty?
  if ( section == nil)
    return false unless @sections.has_key?(@@rootsection)
    return @sections[@@rootsection].has_key?(key)
  else
    return false unless @sections.has_key?(section)
    if (globalSearch == true and @sections.has_key?(@@rootsection))
      return ( @sections[section].has_key?(key) || @sections[@@rootsection].has_key?(key) )
    else
      return @sections[section].has_key?(key)
    end
  end
end

print(comment=nil, io_obj=$stdout) click to toggle source

Print the object in a unix config style into an IO obj Parameters:

comment: String
io_obj : IO (default stdout)

# File lib/unixconfigstyle.rb, line 146
def print (comment=nil, io_obj=$stdout)
  raise ArgumentError, 'the argument "comment" must be a String' unless (comment.is_a? String or comment == nil)
  raise ArgumentError, 'the argument "io_obj" must be an IO class or an IO inherited class' unless io_obj.is_a? IO
  if comment
    io_obj.puts "##{comment}"
  end
  if @sections.key?(@@rootsection)
    @sections[@@rootsection].keys.each do |param_key|
      @sections[@@rootsection][param_key].each do |param_value|
        io_obj.puts "#{param_key}=#{param_value}"
      end
    end
  end
  @sections.keys.each do |section_key|
    if section_key == @@rootsection
      next
    end
    io_obj.puts "[#{section_key}]"
    @sections[section_key].keys.each do |param_key|
      @sections[section_key][param_key].each do |param_value|
        io_obj.puts "#{param_key}=#{param_value}"
      end
    end
  end
end

push_unix_config_file(config_file) click to toggle source

Read a config file and add its properties to the end of the object ones Parameters:

config_file: String (path to a readable unix config file)

# File lib/unixconfigstyle.rb, line 52
def push_unix_config_file(config_file)
  add_unix_config_file(config_file,"push")
end

replaceFirstValue(newvalue, key, section=@@rootsection) click to toggle source

Replace the first value by the given one Parameters:

newvalue : string
key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 310
def replaceFirstValue (newvalue, key, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      @sections[section][key].first.replace(newvalue)
    end
  end
  return nil
end

replaceLastValue(newvalue, key, section=@@rootsection) click to toggle source

Replace the last value by the given one Parameters:

newvalue : string
key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 324
def replaceLastValue (newvalue, key, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      @sections[section][key].last.replace(newvalue)
    end
  end
  return nil
end

replaceValue(newvalue, key, index=0, section=@@rootsection) click to toggle source

Replace the value by the given one Parameters:

newvalue : string
key: String
index :Integer (default 0)
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 339
def replaceValue (newvalue, key, index=0, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      @sections[section][key][index].replace(newvalue)
    end
  end
  return nil
end

replaceValues(newvalues, key, section=@@rootsection) click to toggle source

Replace all the value array by the given one Parameters:

newvalues : Array
key: String
section: String (optionnal)

# File lib/unixconfigstyle.rb, line 353
def replaceValues (newvalues, key, section=@@rootsection)
  if @sections.key?(section)
    if @sections[section].key?(key)
      @sections[section][key].replace(newvalues)
    end
  end
  return nil
end

sectionExists?(section) click to toggle source

Return true if the specific section is found

# File lib/unixconfigstyle.rb, line 384
def sectionExists? (section)
  return false if section == nil
  return false if @sections.empty?
  return @sections.has_key?(section)
end

write(fileToWrite, comment=nil) click to toggle source

Write the object in a file Parameters:

fileToWrite : String, path to a file
comment: String (optionnal)

# File lib/unixconfigstyle.rb, line 136
def write (fileToWrite, comment=nil)
  File.open(fileToWrite,'w') do |file|
    self.print(comment, file)
  end
end

Private Instance Methods

add_unix_config_file(config_file, operation="push") click to toggle source

(private) read a config file and add its properties to the current object Parameters:

config_file: String (path to a readable unix config file)
operation: String [push|insert]

# File lib/unixconfigstyle.rb, line 67
def add_unix_config_file(config_file, operation="push")
  if operation != "push" and operation != "insert"
    raise ArgumentError, "operation #{operation} not allowed", caller
  end
  validate(config_file)

  file = File.open(config_file, 'r')

  @sections[@@rootsection]={} unless @sections.key?(@@rootsection)
  currentSection=@@rootsection

  while !file.eof?
    line = file.readline
    #We ignore the empty lines
    next if @@regexpStruct[:emptyline].match(line)
    #We ignore the comment lines
    next if @@regexpStruct[:commentline].match(line)
    #Change the current section if a new line section is matched
    sectionmatch = @@regexpStruct[:sectionline].match(line)
    if sectionmatch
      currentSection=sectionmatch[1]
      #If this section is seen for the first time, initialise the hash
      @sections[currentSection]={} unless @sections.key?(currentSection)
      next
    end
    #Now we have to recognize the line or there is an error in the file ... or a bug here :)
    paramlinematch = @@regexpStruct[:paramline].match(line)
    if paramlinematch
      #First time this param is seen ?
      @sections[currentSection][paramlinematch[1]]=[] unless @sections[currentSection].key?(paramlinematch[1])
      parammatch = @@regexpStruct[:paramlinequote].match(line)
      if parammatch
        if operation == "push"
          @sections[currentSection][paramlinematch[1]].push(parammatch[2])
        elsif operation == "insert"
          @sections[currentSection][paramlinematch[1]].insert(0,parammatch[2])
        end
        next
      end
      parammatch = @@regexpStruct[:paramline2quote].match(line)
      if parammatch
        if operation == "push"
          @sections[currentSection][paramlinematch[1]].push(parammatch[2])
        elsif operation == "insert"
          @sections[currentSection][paramlinematch[1]].insert(0,parammatch[2])
        end
        next
      end
      parammatch = @@regexpStruct[:paramlinenormal].match(line)
      if parammatch
        if operation == "push"
          @sections[currentSection][paramlinematch[1]].push(parammatch[2])
        elsif operation == "insert"
          @sections[currentSection][paramlinematch[1]].insert(0,parammatch[2])
        end
        next
      end
    else
      warn("[warning] unrecognized line "+file.lineno.to_s+" in "+@unix_config_file+" : "+line)
    end
  end
  file.close()
end

validate(fileToRead) click to toggle source

(private) Validate a file is readable Parameters:

fileToRead: String (path to a readable file)

# File lib/unixconfigstyle.rb, line 42
def validate(fileToRead)
  unless File.readable?(fileToRead)
    raise Errno::EACCES, "Can't read #{fileToRead}"
  end
end