lorj 1.0.3 → 1.0.4

data/lib/logging.rb

@@ -152,14 +152,8 @@ module PrcLib
     end
 
     # Log to STDOUT and Log file and FATAL class message
-    # fatal retrieve the caller list of functions and save it to the log file if
-    # the exception class is given.
-    # The exception class should provide message and backtrace.
-    def fatal(message, e = nil)
+    def fatal(message)
       @out_logger.fatal(message + ANSI.clear_eol)
-      return @file_logger.fatal(format("%s\n%s\n%s",
-                                       message, e.message,
-                                       e.backtrace.join("\n"))) if e
       @file_logger.fatal(message)
     end
 
@@ -184,18 +178,11 @@ module PrcLib
     private
 
     def file_logger_initialize
-      log_file = PrcLib.log_file
-      if log_file.nil?
-        default_log_file = format('%s.log', PrcLib.app_name)
-        log_file = File.join(PrcLib.data_path, default_log_file)
-      end
-
-      @file_logger = Logger.new(log_file, 'weekly')
+      @file_logger = Logger.new(PrcLib.log_file, 'weekly')
       @file_logger.level = Logger::DEBUG
       @file_logger.formatter = proc do |severity, datetime, progname, msg|
         "#{progname} : #{datetime}: #{severity}: #{msg} \n"
       end
-      PrcLib.log_file = log_file
     end
   end
 
@@ -260,12 +247,12 @@ module PrcLib
   # the exception class is given.
   # The exception class should provide message and backtrace.
   def fatal(rc, message, *p)
-    e = nil
     if p.length > 0 && p[-1].is_a?(Exception)
       e = p[-1]
       p.pop
+      message = format("%s\n%s\n%s", message, e.message, e.backtrace.join("\n"))
     end
-    log_object.fatal(format(message, *p), e)
+    log_object.fatal(format(message, *p))
     puts format('Issues found. Please fix it and retry. Process aborted. '\
          "See details in log file '%s'.", PrcLib.log_file)
     exit rc

data/lib/lorj/version.rb

@@ -16,5 +16,5 @@
 
 # Lorj version
 module Lorj
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/lorj.rb

@@ -29,6 +29,7 @@ require 'logging.rb'               # class PrcLib::Logging
 require 'prc_base_config.rb'       # PRC::BaseConfig class
 require 'prc_section_config.rb'    # PRC::SectionConfig class
 require 'prc_core_config.rb'       # PRC::CoreConfig class
+require 'lorj_meta.rb'             # PRC::Meta class - Application defaults
 require 'lorj_defaults.rb'         # PRC::Defaults class - Application defaults
 require 'lorj_config.rb'           # Lorj::Config class -
 require 'lorj_account.rb'          # Lorj::Account class  - account config
@@ -72,7 +73,7 @@ module Lorj
     if iLevel <= PrcLib.core_level
       message = format('-%s- %s', iLevel, sMsg)
 
-      PrcLib.debug(format(message, *p))
+      PrcLib.debug(message, *p)
     end
   end
 

data/lib/lorj_account.rb

@@ -17,6 +17,7 @@
 
 require 'rubygems'
 
+# Lorj implements Lorj::Accounts
 module Lorj
   # Simple List of accounts class.
   class Accounts
@@ -35,6 +36,7 @@ module Lorj
   end
 end
 
+# Lorj implements Lorj::AccountConfig
 module Lorj
   # AccountConfig class layer
   class AccountConfig < PRC::SectionConfig
@@ -48,11 +50,12 @@ module Lorj
     end
 
     def data_options(options = { :section => :default })
-      _data_options(options)
+      p_data_options(options)
     end
   end
 end
 
+# Lorj implements Lorj::Account
 module Lorj
   # Lorj::Account manage a list of key/value grouped by section.
   # The intent of Lorj::Account is to attach some keys/values to
@@ -109,16 +112,25 @@ module Lorj
 
     # This object manage data located in oConfig[:hpc_accounts/AccountName]
 
-    # The class new accept to provide a local config file different than
-    # standard one configured by PrcLib.app_path/.config.yaml
+    # Lorj::Account implements Config layers.
+    # - default    : Represents the application defaults.yaml config.
+    # - controller : Represents the controller config redefinition.
+    #   See BaseDefinition::define_data
+    # - local      : Represents the config.yaml located in ~/.forj
+    # - account    : Represents an Account data located in ~/.forj/accounts
+    # - runtime    : Represents the runtime in memory data settings.
     def initialize(config_name = nil)
       config_layers = []
 
       # Application layer
       config_layers << define_default_layer
 
+      # runtime Config layer
+      config_layers << define_controller_data_layer
+
       # Local Config layer
-      config_layers << define_local_layer
+      local = define_local_layer
+      config_layers << local
 
       # Account config layer
       config_layers << define_account_layer
@@ -130,7 +142,7 @@ module Lorj
         PrcLib.fatal(1, 'Internal PrcLib.data_path was not set.')
       end
 
-      initialize_local(config_layers[1][:config], config_name)
+      initialize_local(local[:config], config_name)
 
       initialize_account
 
@@ -143,15 +155,15 @@ module Lorj
     # otherwise, search in all layers.
     #
     # * *Args*    :
-    # - +key+     : key name. It do not support it to be a key tree (Arrays of
-    #               keys).
-    # - +default+ : default value, if not found.
-    # - +options+ : Options for get:
-    #   - +:section+ : Get will use this section name instead of searching it.
-    #   - +:name+    : layer to exclusively get data.
-    #   - +:indexes+ : layer index to exclusively get data.
-    #                  If neither :name or :index is set, get will search
-    #                  data on all predefined layers, first found.
+    #   - +key+     : key name. It do not support it to be a key tree (Arrays of
+    #     keys).
+    #   - +default+ : default value, if not found.
+    #   - +options+ : Options for get:
+    #     - +:section+ : Get will use this section name instead of searching it.
+    #     - +:names+   : array of layers name to exclusively get data.
+    #     - +:indexes+ : array of layers index to exclusively get data.
+    #       If neither :name or :index is set, get will search
+    #       data on all predefined layers, first found.
     # * *Returns* :
     #   - key value.
     # * *Raises* :
@@ -161,21 +173,23 @@ module Lorj
       options = {} unless options.is_a?(Hash)
 
       section = options[:section]
-      section = Lorj.defaults.get_meta_section(key) if section.nil?
+      section = Lorj.data.first_section(key) if section.nil?
 
       options = { :keys => [key], :section => section }
 
-      indexes = _identify_indexes(options, exclusive?(key, section))
+      indexes = _identify_array_indexes(options, exclusive?(key, section))
       names = []
       indexes.each { |index| names << @config_layers[index][:name] }
 
       options[:data_options] = _set_data_options_per_names(names)
 
-      return _get(options) if _exist?(options)
+      return p_get(options) if p_exist?(options)
 
       default
     end
 
+    # Simple get call with default options
+    # Alternative is to use Account::get
     def [](key, default = nil)
       get(key, default)
     end
@@ -186,14 +200,14 @@ module Lorj
     # otherwise, search in all layers.
     #
     # * *Args*    :
-    # - +key+     : key name. It do not support it to be a key tree (Arrays of
-    #               keys).
-    # - +options+ : possible options:
-    #   - +:section+ : Force to use a specific section name.
-    #   - +:name+    : layer to exclusively get data.
-    #   - +:indexes+ : layer index to exclusively get data.
-    #                  If neither :name or :index is set, get will search
-    #                  data on all predefined layers, first found, first listed.
+    #   - +key+     : key name. It do not support it to be a key tree (Arrays of
+    #     keys).
+    #   - +options+ : possible options:
+    #     - +:section+ : Force to use a specific section name.
+    #     - +:names+   : array of layers name to exclusively get data.
+    #     - +:indexes+ : array of layers index to exclusively get data.
+    #       If neither :name or :index is set, get will search data on all
+    #       predefined layers, first found, first listed.
     # * *Returns* :
     #   - key value.
     # * *Raises* :
@@ -217,20 +231,20 @@ module Lorj
         :data_options => _set_data_options_per_names(names)
       }
 
-      _where?(where_options)
+      p_where?(where_options)
     end
 
     # check key/value existence in config layers
     #
     # * *Args*    :
-    # - +key+     : key name. It do not support it to be a key tree (Arrays of
-    #               keys).
-    # - +options+ : possible options:
-    #   - +:section+ : Force to use a specific section name.
-    #   - +:name+    : layer to exclusively get data.
-    #   - +:indexes+ : layer index to exclusively get data.
-    #                  If neither :name or :index is set, get will search
-    #                  data on all predefined layers, first found.
+    #   - +key+     : key name. It do not support it to be a key tree (Arrays of
+    #   keys).
+    #   - +options+ : possible options:
+    #     - +:section+ : Force to use a specific section name.
+    #     - +:names+   : array of layers name to exclusively get data.
+    #     - +:indexes+ : array of layers index to exclusively get data.
+    #       If neither :name or :index is set, get will search data on all
+    #       predefined layers, first found.
     #
     # * *Returns* :
     #   - 'runtime'       : if found in runtime.
@@ -246,27 +260,27 @@ module Lorj
       options = {} unless options.is_a?(Hash)
 
       section = options[:section]
-      section = Lorj.defaults.get_meta_section(key) if section.nil?
+      section = Lorj.data.first_section(key) if section.nil?
       options = { :keys => [key], :section => section }
 
-      indexes = _identify_indexes(options, exclusive?(key, section))
+      indexes = _identify_array_indexes(options, exclusive?(key, section))
 
       names = []
       indexes.each { |index| names << @config_layers[index][:name] }
 
       options[:data_options] = _set_data_options_per_names(names)
 
-      _exist?(options)
+      p_exist?(options)
     end
 
     # Return true if readonly. set won't be able to update this value.
-    # Only _set (private function) is able.
+    # Only p_set (private function) is able.
     #
     # * *Args*    :
     #   - +key+     : key name. It can support it to be a key tree (Arrays of
-    #                 keys).
+    #     keys).
     #   - +section+ : optionnal. If missing the section name is determined by
-    #                 the data name associated
+    #     the data name associated
     # * *Returns* :
     #   - true/false : readonly value
     #   OR
@@ -280,20 +294,20 @@ module Lorj
 
       return nil if section.nil?
 
-      result = Lorj.defaults.get_meta(section, key, :readonly)
+      result = Lorj.data.section_data(section, key, :readonly)
       return result if result.boolean?
       false
     end
 
     # Return true if exclusive
     # set won't be able to update this value.
-    # Only _set (private function) is able.
+    # Only p_set (private function) is able.
     #
     # * *Args*    :
     #   - +key+     : key name. It can support it to be a key tree (Arrays of
-    #                 keys).
+    #     keys).
     #   - +section+ : optionnal. If missing the section name is determined by
-    #                 the data name associated
+    #     the data name associated
     # * *Returns* :
     #   - true/false : readonly value
     #   OR
@@ -303,37 +317,35 @@ module Lorj
       return nil unless key
 
       key = key.to_sym if key.class == String
-      section = Lorj.defaults.get_meta_section(key) if section.nil?
+      section = Lorj.data.first_section(key) if section.nil?
 
       return nil if section.nil?
-      result = Lorj.defaults.get_meta(section, key,
-                                      :account_exclusive)
+      result = Lorj.data[:sections, section, key, :account_exclusive]
       return result if result.boolean?
       result
     end
 
     # This function update a section/key=value if the account structure is
-    # defined.
-    # If no section is defined, set it in runtime config.
+    # defined. (see Lorj::Defaults)
+    # If no section is defined, it will assume to be :default.
     #
     # * *Args*    :
-    # - +key+     : key name. It do not support it to be a key tree (Arrays of
-    #               keys).
-    # - +value+   : value to set
-    # - +options+ : possible options:
-    #   - +:section+ : Force to use a specific section name.
-    #   - +:name+    : layer to exclusively get data.
-    #   - +:indexes+ : layer index to exclusively get data.
-    #                  If neither :name or :index is set, set will use the
-    #                  'runtime' layer.
+    #   - +key+     : key name. It do not support it to be a key tree (Arrays of
+    #     keys).
+    #   - +value+   : value to set
+    #   - +options+ : possible options:
+    #     - +:section+ : Force to use a specific section name.
+    #     - +:name+    : layer to exclusively set data.
+    #     - +:index+   : layer index to exclusively set data.
+    #       If neither :name or :index is set, set will use the 'runtime' layer.
     #
     # * *Returns* :
-    # - the value set
-    # OR
-    # - nil if:
-    #   - lorj data model set this key as readonly.
-    #   - value is nil. The value is set to nil, then.
-    #   - key is nil. No update is done.
+    #   - the value set
+    #   OR
+    #   - nil if:
+    #     - lorj data model set this key as readonly.
+    #     - value is nil. The value is set to nil, then.
+    #     - key is nil. No update is done.
     #
     # * *Raises* :
     #   Nothing
@@ -344,22 +356,48 @@ module Lorj
       key = parameters[0][0]
       layer_name, section = parameters[1]
 
-      section = Lorj.defaults.get_meta_section(key) if section.nil?
+      section = Lorj.data.first_section(key) if section.nil?
       section = :default if section.nil?
 
       return nil if readonly?(key, section)
 
       options = { :keys => [key], :section => section, :value => value }
 
-      options[:indexes] = index_to_update(layer_name, key, section)
+      options[:index] = index_to_update(layer_name, key, section)
 
-      _set(options)
+      p_set(options)
     end
 
+    # Set a key to te runtime config layer.
+    # Alternative is to use Account::set
     def []=(key, value)
       set(key, value)
     end
 
+    # This function delete a section/key.
+    # If no section is defined, it will assume to be :default.
+    # Without any options, the runtime layer is used to delete the key.
+    #
+    # * *Args*    :
+    #   - +key+     : key name. It do not support it to be a key tree (Arrays of
+    #     keys).
+    #   - +value+   : value to set
+    #   - +options+ : possible options:
+    #     - +:section+ : Force to use a specific section name.
+    #     - +:name+    : layer to exclusively get data.
+    #     - +:index+   : layer index to exclusively get data.
+    #       If neither :name or :index is set, set will use the 'runtime' layer.
+    #
+    # * *Returns* :
+    #   - the value set
+    #   OR
+    #   - nil if:
+    #     - lorj data model set this key as readonly.
+    #     - value is nil. The value is set to nil, then.
+    #     - key is nil. No update is done.
+    #
+    # * *Raises* :
+    #   Nothing
     def del(key, options = {})
       parameters = validate_key_and_options(key, options)
       return nil if parameters.nil?
@@ -374,19 +412,20 @@ module Lorj
 
       options = { :keys => [key], :section => section }
 
-      options[:indexes] = index_to_update(layer_name, key, section)
+      options[:index] = index_to_update(layer_name, key, section)
 
-      _del(options)
+      p_del(options)
     end
   end
 
   # Defines Account exclusive functions
   class Account
-    def ac_new(sAccountName, provider_name = nil)
+    def ac_new(sAccountName, provider_name)
       return nil if sAccountName.nil?
       @account_name = sAccountName
+      index = layer_index('account')
 
-      account = @config_layers[1][:config]
+      account = @config_layers[index][:config]
       account.erase
       account.ac_new sAccountName, provider_name
     end
@@ -399,8 +438,9 @@ module Lorj
 
       account_file = File.join(@account_path, @account_name)
       return false unless File.exist?(account_file)
+      index = layer_index('account')
 
-      _do_load(@config_layers[1][:config], account_file)
+      _do_load(@config_layers[index][:config], account_file)
     end
 
     # Account save function.
@@ -425,25 +465,30 @@ module Lorj
 
       account_file = File.join(@account_path, @account_name)
 
-      account = @config_layers[1][:config]
-      local = @config_layers[2][:config]
+      local_index = layer_index('local')
+      account_index = layer_index('account')
+
+      account = @config_layers[account_index][:config]
+      local = @config_layers[local_index][:config]
 
       account.data_options(:section => :account)
-      if account[:provider].nil?
-        PrcLib.error "Provider name is not set. Unable to save the account '"\
-                     "%s' to '%s'", @account_name, account_file
+
+      [:provider].each do |key|
+        next if account.exist?(key) && !account[key].nil?
+
+        PrcLib.error "':%s' is not set. Unable to save the account '"\
+                     "%s' to '%s'", key.to_s, @account_name, account_file
         return false
       end
 
-      account.filename = account_file
-      result = account.save
+      result = local.save
 
       return result unless result
 
-      return true if local.exist?(:account_name)
-
-      local[:account_name] = @account_name
-      local.save
+      account.data_options(:section => :account)
+      account[:name] = @account_name
+      account.filename = account_file
+      account.save
 
       true
     end
@@ -451,8 +496,9 @@ module Lorj
 
   # Defines internal functions
   class Account
-    # TODO: Strange function!!! To revisit
+    # TODO: Strange function!!! To revisit. Used by forj cli in forj-settings.rb
 
+    #
     def meta_type?(key)
       return nil unless key
 
@@ -494,7 +540,7 @@ module Lorj
 
     def exclusive_indexes(account_exclusive)
       return [0, 1] if account_exclusive
-      [0, 1, 2, 3]
+      [0, 1, 2, 3, 4]
     end
 
     def _identify_indexes(options, account_exclusive)
@@ -516,8 +562,9 @@ module Lorj
       data_options
     end
 
-    # This internal function defines default section name per config index.
     # TODO: Change local and default way to get default values, not in /:default
+
+    # This internal function defines default section name per config index.
     def _data_options_per_layer(layer_name)
       # runtime and local and default uses :default section
       case layer_name
@@ -552,14 +599,14 @@ module Lorj
     end
 
     def index_to_update(layer_name, key, section)
-      indexes = [0] # choose runtime by default.
-      indexes = layer_indexes([layer_name]) unless layer_name.nil?
+      index = 0 # choose runtime by default.
+      index = layer_index(layer_name) unless layer_name.nil?
 
       if layer_name.nil?
         # Return runtime layer, if layer requested is not updatable.
-        return [0] if indexes[0] <= (exclusive?(key, section) ? 1 : 3)
+        return 0 if index <= (exclusive?(key, section) ? 1 : 3)
       end
-      indexes
+      index
     end
 
     def define_account_layer

data/lib/lorj_config.rb

@@ -17,6 +17,7 @@
 require 'rubygems'
 require 'yaml'
 
+# Definition of Lorj::Config
 module Lorj
   # Lorj::Config is a generic class for configuration management.
   # It is used by lorj to get/set data
@@ -101,7 +102,7 @@ module Lorj
     #
     # * *Args*    :
     #   - +config_name+ : Config file name to use. By default, file path is
-    #                     built as PrcLib.data_path+'config.yaml'
+    #                     built as #{PrcLib.data_path}/config.yaml
     # * *Returns* :
     #   -
     # * *Raises* :
@@ -112,8 +113,12 @@ module Lorj
       # Application layer
       config_layers << define_default_layer
 
+      # runtime Config layer
+      config_layers << define_controller_data_layer
+
       # Local Config layer
-      config_layers << define_local_layer
+      local = define_local_layer
+      config_layers << local
 
       # runtime Config layer
       config_layers << define_runtime_layer
@@ -122,7 +127,7 @@ module Lorj
         PrcLib.fatal(1, 'Internal PrcLib.data_path was not set.')
       end
 
-      initialize_local(config_layers[1][:config], config_name)
+      initialize_local(local[:config], config_name)
 
       initialize_layers(config_layers)
     end
@@ -139,6 +144,10 @@ module Lorj
                                    :load => true, :save => true)
     end
 
+    def define_controller_data_layer
+      PRC::CoreConfig.define_layer :name => 'controller'
+    end
+
     def define_runtime_layer
       PRC::CoreConfig.define_layer
     end
@@ -230,7 +239,7 @@ module Lorj
     # * *Raises* :
     #   nothing
     def [](key, default = nil) # Re-define PRC::CoreConfig []= function
-      return _get(:keys => [key]) if exist?(key)
+      return p_get(:keys => [key]) if exist?(key)
       default
     end
 
@@ -290,21 +299,6 @@ module Lorj
       @config_layers[index][:config][key]
     end
 
-    # Get Application data
-    # Used to get any kind of section available in the Application default.yaml.
-    #
-    # * *Args*    :
-    #   - +section+   : section name to get the key.
-    #   - +keys_tree+ : list of key name tree
-    # * *Returns* :
-    #   value found
-    # * *Raises* :
-    #   nothing
-    def app_default(*keys)
-      return Lorj.defaults.data.rh_get(*keys) if keys.length > 0
-      nil
-    end
-
     # Save the config.yaml file.
     #
     # * *Args*    :