lorj 1.0.10 → 1.0.11

data/lib/core/core_setup_list.rb

@@ -40,7 +40,8 @@ module Lorj
     # * *Raises* :
     #
     def _setup_list_from_controller_call(obj_to_load, list_options, default)
-      PrcLib.message("Loading #{obj_to_load}.")
+      PrcLib.message("Loading :object #{obj_to_load}.")
+      Lorj.debug(3, ':query_type = :controller_call')
 
       object = @object_data[obj_to_load, :ObjectData]
       object = process_create(obj_to_load) if object.nil?
@@ -78,7 +79,8 @@ module Lorj
     # * *Raises* :
     #
     def _setup_list_from_query_call(obj_to_load, list_options, default)
-      PrcLib.message("Querying #{obj_to_load}.")
+      PrcLib.message("Querying :object #{obj_to_load}.")
+      Lorj.debug(3, ':query_type = :query_call - ')
 
       query_hash = list_options[:query_params]
       query_hash = {} if query_hash.nil?
@@ -126,7 +128,8 @@ module Lorj
                           data if list_options[:query_call].nil?
       proc = list_options[:query_call]
       obj_to_load = list_options[:object]
-      Lorj.debug(2, "Running process '#{proc}' on '#{obj_to_load}'.")
+      PrcLib.message("Running process '#{proc}' on :object '#{obj_to_load}'.")
+      Lorj.debug(3, ':query_type = :process_call')
 
       # Building Process function attr_params parameter
       params = ObjectData.new

data/lib/core/definition.rb

@@ -289,9 +289,9 @@ module Lorj
 
       PrcLib.model.data_context data
 
-      section = Lorj.data.first_section(data.key)
+      section, key = Lorj.data.first_section(data.key)
 
-      Lorj.data.define_controller_data(section, data.key, options)
+      Lorj.data.define_controller_data(section, key, options)
     end
 
     # Controller to declare a model Data value mapping

data/lib/core/definition_internal.rb

@@ -37,7 +37,7 @@ module Lorj
 
     def _get_account_section(key)
       return nil if key.nil?
-      Lorj.data.first_section(key)
+      Lorj.data.first_section(key)[0]
     end
 
     # internal runtime function for process call

data/lib/core/lorj_basedefinition.rb

@@ -35,6 +35,12 @@ module Lorj
       }
 
       @config = oForjConfig
+
+      @data = Lorj.data # Get data definition object
+      # data object is currently built by
+      # - global application defaults.yaml loaded in @config.
+      # - process data.yaml files
+
       @erb_config = ERBConfig.new(oForjConfig)
       if !oForjConfig.is_a?(Lorj::Account) && !oForjConfig.is_a?(Lorj::Config)
         PrcLib.runtime_fail "'%s' is not a valid ForjAccount or ForjConfig"\

data/lib/core/process.rb

@@ -24,9 +24,40 @@ module Lorj
   class ProcessResource
     attr_reader :defaults_file, :data_file, :process, :name, :controllers
 
+    # ProcessResource initialization
+    #
+    # Create a ProcessResource Instance with resource data.
+    #
+    # * *Args*:
+    #   - +name+ : Name of the process
+    #   - +path+ : Process path
+    #     By default the process path will search for:
+    #     - <name>_process.rb : Main process file
+    #     - <name>/controllers/<controller>/<controller>.rb : controllers list
+    #       attached to the process `name`.
+    #     - <name>/defaults.yaml : defaults process values
+    #       (under section :defaults)
+    #     - <name>/data.yaml : Process data definition
+    #
+    #   You can redefine some defaults, with `props` Hash argument.
+    #
+    #   - :controllers_dir : Change the name of the controllers directory.
+    #     Default is `controllers`
+    #   - :controllers_path: Change the complete path to search for controllers
+    #     By default is `<name>/controllers`
+    #   - :defaults_file   : Use a different file as process defaults.
+    #     By default is `<name>/defaults.yaml`
+    #   - :data_file    : Use a different file as process data definition.
+    #     By default is `<name>/data.yaml`
+    #
+    # * *return*:
+    #   - self with at least a process name and a path to it.
+    #
+    #     If any data are invalid, the process name will be set to nil.
     def initialize(name, path, props = {})
-      # Determine resources
-      name = name.to_s if name.is_a?(Symbol)
+      name, path, props = _validate_parameters(name, path, props)
+
+      return if name.nil?
 
       process_path = File.expand_path(File.join(path, 'process',
                                                 name + '_process.rb'))
@@ -37,22 +68,50 @@ module Lorj
 
       controller_dir = 'controllers'
       controller_dir = props[:controllers_dir] if props.key?(:controllers_dir)
-      controller_path = File.expand_path(File.join(path, controller_dir))
+      ctrls_path = File.expand_path(File.join(path, 'process', name,
+                                              controller_dir))
 
-      _identify_controllers(controller_path)
+      _identify_controllers(_get_value(props, :controllers_path, ctrls_path))
 
-      defaults_file = File.expand_path(File.join(path, 'defaults.yaml'))
-      @defaults_file = defaults_file if File.exist?(defaults_file)
+      defaults_file = _get_file(props, :defaults_file,
+                                File.join(path, 'process',
+                                          name, 'defaults.yaml'))
+      @defaults_file = defaults_file if defaults_file
 
-      data_file = File.expand_path(File.join(path, 'data.yaml'))
-      @data_file = data_file if File.exist?(data_file)
+      data_file = _get_file(props, :data_file, File.join(path, 'process',
+                                                         name, 'data.yaml'))
+      @data_file = data_file if data_file
 
       self
     end
 
     private
 
+    def _get_value(props, key, default)
+      return props[key] if props.key?(key)
+      default
+    end
+
+    def _get_file(props, key, filename)
+      file = File.expand_path(filename)
+      file = _get_value(props, key, file)
+      return file if File.exist?(file)
+    end
+
+    # Ensure parameters are correct
+    def _validate_parameters(name, path, props)
+      return unless [String, Symbol].include?(name.class) && path.is_a?(String)
+
+      props = {} unless props.is_a?(Hash)
+
+      # Determine resources
+      name = name.to_s if name.is_a?(Symbol)
+      [name, path, props]
+    end
+
     def _identify_controllers(controller_path)
+      return unless File.directory?(controller_path)
+
       @controllers = {}
 
       Dir.foreach(controller_path) do |dir|

data/lib/logging.rb

@@ -191,11 +191,15 @@ module PrcLib
   # Create a Logging object if missing and return it.
   # Used internally by other functions
   def log_object
-    if PrcLib.log.nil?
-      PrcLib.log = PrcLib::Logging.new
-    else
-      PrcLib.log
-    end
+    PrcLib.log = PrcLib::Logging.new if PrcLib.log.nil?
+    PrcLib.log
+  end
+
+  def log_object=(logger)
+    return PrcLib.log unless logger.is_a?(Logger)
+
+    PrcLib.log = logger if PrcLib.log.nil?
+    PrcLib.log
   end
 
   # Print out a message, not logged in the log file. This message is printed out

data/lib/lorj/version.rb

@@ -16,6 +16,6 @@
 
 # Lorj version
 module Lorj
-  VERSION = '1.0.10'
-  DATE = '2015-04-17'
+  VERSION = '1.0.11'
+  DATE = '2015-05-20'
 end

data/lib/lorj_account.rb

@@ -197,11 +197,13 @@ module Lorj
       options = {} unless options.is_a?(Hash)
 
       section = options[:section]
-      section = Lorj.data.first_section(key) if section.nil?
+      section, key = Lorj.data.first_section(key) if section.nil?
 
-      options = options.merge(:keys => [key], :section => section)
+      options = options.merge(:keys => [key])
+      options.delete(:section)
 
       indexes = _identify_indexes(options, exclusive?(key, section))
+
       names = []
       indexes.each { |index| names << @config_layers[index][:name] }
 
@@ -246,7 +248,7 @@ module Lorj
       options = {} unless options.is_a?(Hash)
 
       section = options[:section]
-      section = Lorj.data.first_section(key) if section.nil?
+      section, key = Lorj.data.first_section(key) if section.nil?
 
       indexes = _identify_indexes(options, exclusive?(key, section))
 
@@ -255,7 +257,6 @@ module Lorj
 
       where_options = {
         :keys => [key],
-        :section => section,
         :indexes => indexes,
         :data_options => _set_data_options_per_names(names, section)
       }
@@ -292,8 +293,9 @@ module Lorj
       options = {} unless options.is_a?(Hash)
 
       section = options[:section]
-      section = Lorj.data.first_section(key) if section.nil?
-      options = options.merge(:keys => [key], :section => section)
+      section, key = Lorj.data.first_section(key) if section.nil?
+      options = options.merge(:keys => [key])
+      options.delete(:section)
 
       indexes = _identify_indexes(options, exclusive?(key, section))
 
@@ -323,6 +325,7 @@ module Lorj
 
       key = key.to_sym if key.class == String
       section = Lorj.defaults.get_meta_section(key) if section.nil?
+      section, key = _detect_section(key, section)
 
       return nil if section.nil?
 
@@ -349,7 +352,7 @@ module Lorj
       return nil unless key
 
       key = key.to_sym if key.class == String
-      section = Lorj.data.first_section(key) if section.nil?
+      section, key = Lorj.data.first_section(key) if section.nil?
 
       return nil if section.nil?
       result = Lorj.data[:sections, section, key, :account_exclusive]
@@ -386,9 +389,10 @@ module Lorj
       return nil if parameters.nil?
 
       key = parameters[0][0]
-      layer_name, section = parameters[1]
+      layer_name, section = parameters[1][0]
 
-      section = Lorj.data.first_section(key) if section.nil?
+      found_section, key = Lorj.data.first_section(key)
+      section = found_section if section.nil?
       section = :default if section.nil?
 
       return nil if readonly?(key, section)
@@ -439,6 +443,7 @@ module Lorj
 
       section = Lorj.defaults.get_meta_section(key) if section.nil?
       section = :default if section.nil?
+      section, key = _detect_section(key, section)
 
       return nil if readonly?(key, section)
 
@@ -544,6 +549,12 @@ module Lorj
 
     private
 
+    def _detect_section(key, default_section)
+      m = key.to_s.match(/^(.*)#(.*)$/)
+      return [m[1].to_sym, m[2].to_sym] if m && m[1] != '' && m[2] != ''
+      [default_section, key]
+    end
+
     def _identify_array_indexes(options, account_exclusive)
       def_indexes = options[:indexes] if options.key?(:indexes)
       if options[:names].is_a?(Array)
@@ -571,8 +582,9 @@ module Lorj
     end
 
     def exclusive_indexes(account_exclusive)
-      return [0, 1] if account_exclusive
-      [0, 1, 2, 3, 4]
+      return layer_indexes { true } unless account_exclusive
+
+      layer_indexes { |n, _i| %w(runtime account).include?(n[:name]) }
     end
 
     def _identify_indexes(options, account_exclusive)
@@ -588,6 +600,9 @@ module Lorj
       indexes
     end
 
+    # Internal functions to generate the list of options
+    # for each layer name.
+    # The names order needs to be kept in options.
     def _set_data_options_per_names(names, section)
       data_options = []
 
@@ -608,16 +623,21 @@ module Lorj
         # local & default are SectionConfig and is forced to use :default as
         # section name for each data.
         return { :section => :default }
+      when 'account'
+        # If no section is provided, 'account' layer will use the first section
+        # name
+        # otherwise, it will used the section provided.
+        # account is a SectionConfig and use section value defined by the
+        # lorj data model. So the section name is not forced.
+        return { :section => section } unless section.nil?
+        return nil
       end
-      # nil: layer_index = 0 => runtime. runtime is not a SectionConfig.
-
-      # nil: layer_index = 1 => account
-      # If no section is provided, 'account' layer will use the first section
-      # name
-      # otherwise, it will used the section provided.
-      return { :section => section } unless section.nil?
-      # account is a SectionConfig and use section value defined by the
-      # lorj data model. So the section name is not forced.
+      # For SectionsConfig layer, :default is automatically set.
+      # Except if there is later a need to set a section, nil is enough.
+      # For BaseConfig, no options => nil
+      #
+      # Process/controller layers are SectionsConfig
+      # others (runtime/instant) are BaseConfig.
       nil
     end
 

data/lib/lorj_config.rb

@@ -202,12 +202,17 @@ module Lorj
     # * *Args*    :
     #   - +key+   : key name. Can be an key tree (Array of keys).
     #   - +value+ : Value to set
+    #   - +options+ : possible options:
+    #     - +: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* :
     #   - value set
     # * *Raises* :
     #   Nothing
-    def set(key, value)
-      self[key] = value # Call PRC::CoreConfig [] function
+    def set(key, value, options = {})
+      p_set(options.merge(:keys => [key], :value => value))
     end
 
     # Get function

data/lib/lorj_defaults.rb

@@ -228,9 +228,12 @@ module Lorj
     def get_meta_section(key)
       PrcLib.debug("'Lorj.defaults.%s' is obsolete and will be removed "\
                    'in Lorj 2.0. Please update your code to call '\
-                   "'Lorj.data.%s' instead.\n%s",
-                   __method__, 'first_section', caller[0])
-      Lorj.data.first_section(key)
+                   "'Lorj.data.%s' instead.\n%s. Warning! This function call "\
+                   "return is different than 'Lorj.defaults.%s'. Please read "\
+                   'the documentation',
+                   __method__, 'first_section', caller[0], __method__)
+      section, = Lorj.data.first_section(key)
+      section
     end
 
     #
@@ -243,7 +246,7 @@ module Lorj
     #   - ++ ->
     def load
       if !PrcLib.app_defaults
-        PrcLib.warning('PrcLib.app_defaults is not set. Application defaults'\
+        PrcLib.debug('PrcLib.app_defaults is not set. Application defaults'\
                        " won't be loaded.")
       else
         @filename = File.join(PrcLib.app_defaults, 'defaults.yaml')

data/lib/lorj_meta.rb

@@ -50,6 +50,15 @@ module Lorj
       p_set(:keys => [:keys], :value => section_map, :name => 'map')
     end
 
+    # Implement a section detection in a symbol/string
+    # Help each auto_* functions to work without update.
+    #
+    def _detect_section(key, default_section)
+      m = key.to_s.match(/^(.*)#(.*)$/)
+      return [m[1].to_sym, m[2].to_sym] if m && m[1] != '' && m[2] != ''
+      [default_section, key]
+    end
+
     # set section data mapping
     #
     def update_map(section, data)
@@ -322,7 +331,11 @@ module Lorj
   #
   #         - :object:
   #
-  #           Used with :query_type=:query_call. object type symbol to query.
+  #           - When used with :query_type == :query_call or :controller_call,
+  #             :object is the object type symbol to query.
+  #
+  #           - When used with :query_type == :process_call, :object is the
+  #             object used in the process.
   #
   #         - :query
   #
@@ -380,6 +393,22 @@ module Lorj
       build_section_mapping
     end
 
+    # Redefine CoreConfig#layer_add to add mapping build
+    #
+    # See CoreConfig#layer_add for details
+    def layer_add(options)
+      p_layer_add(options)
+      build_section_mapping
+    end
+
+    # Redefine CoreConfig#layer_remove to add mapping build
+    #
+    # See CoreConfig#layer_remove for details
+    def layer_remove(options)
+      p_layer_remove(options)
+      build_section_mapping
+    end
+
     # Loop on Config metadata
     #
     # * *Args*    :
@@ -390,6 +419,12 @@ module Lorj
     def meta_each
       data = p_get(:keys => [:sections], :merge => true)
 
+      if data.nil?
+        PrcLib.warning('No model data definition found. Do you have a model'\
+                       ' loaded?')
+        return
+      end
+
       data.each do |section, hValue|
         hValue.each do |key, value|
           yield section, key, value
@@ -414,35 +449,42 @@ module Lorj
     # If a key name is found in several different section,
     #
     # auto_* functions, usually, will get the first section
-    # from a key/sections mapping Array.
+    # from a key/sections mapping Array except if you provide
+    # a '#' in the data name. (Ex: :'section1#key1')
     #
     # The list of sections for one key is build thanks to
     # build_section_mapping.
     #
     # * *Args*    :
-    #   - +data+ : data name to check
+    #   - +data+ : data name to check. Support 'section#data'.
     #
     # * *Returns* :
     #   - true/false
     def auto_meta_exist?(data)
       return nil unless data
 
-      section = first_section(data)
+      section, data = first_section(data)
+
       p_exist?(:keys => [:sections, section, data])
     end
 
-    # return the 1st section name of a data.
+    # return the 1st section name found of a data or the section discovered.
     #
     # * *Args*    :
-    #   - +data+ : data name to search
+    #   - +data+ : data name to search. It supports section#name.
     #
     # * *Returns* :
-    #   - 1st section name found.
+    #   - Array:
+    #     - section name
+    #     - key name
     def first_section(data)
-      return nil unless p_exist?(:keys => [:keys, data])
+      section, data = _detect_section(data, nil)
+      return [section, data] unless section.nil? &&
+                                    p_exist?(:keys => [:keys, data])
+
       arr = p_get(:keys => [:keys, data])
       return nil unless arr.is_a?(Array) && arr[0]
-      arr[0]
+      [arr[0], data]
     end
 
     # return the list of sections name of a data.
@@ -456,6 +498,7 @@ module Lorj
     def sections(data = nil)
       return p_get(:keys => [:sections]).keys if data.nil?
 
+      _, data = _detect_section(data, nil)
       return nil unless p_exist?(:keys => [:keys, data])
       p_get(:keys => [:keys, data])
     end
@@ -492,7 +535,7 @@ module Lorj
       p_get(:keys => keys, :merge => true)
     end
 
-    # Get setup options. It returns the the top layer data for options requested
+    # Get setup options. It returns the top layer data for options requested
     #
     # * *Args*    :
     #   - +options+ : Array of options tree.
@@ -506,7 +549,7 @@ module Lorj
     def setup_data(*options)
       keys = [:setup]
       keys.concat(options)
-      p_get(:keys => keys)
+      p_get(:keys => keys, :merge => true)
     end
 
     # Get model section/data options. It returns the list of options, against
@@ -515,7 +558,7 @@ module Lorj
     # * *Args*    :
     #   - +section+ : section name
     #   - +data+    : data name
-    #   - +options+ : options tree.
+    #   - +options+ : Optionnal. List of sub keys in tree to get data.
     #
     # * *Returns* :
     #   - Merged cloned data options values.
@@ -537,14 +580,16 @@ module Lorj
     # data name
     #
     # auto_* functions, usually, will get the first section
-    # from a key/sections mapping Array.
+    # from a key/sections mapping Array. But it supports also 'Section#Name' to
+    # determine the section to use instead of first one.
+    #
     #
     # The list of sections for one key is build thanks to
     # build_section_mapping.
     #
     # * *Args*    :
-    #   - +data+   : data name
-    #   - options+ : options tree.
+    #   - +data+    : data name. Support 'Section#Name'
+    #   - +options+ : Optionnal. List of sub keys in tree to get data.
     # * *Returns* :
     #   - data options values
     #   OR
@@ -554,7 +599,7 @@ module Lorj
     #
     def auto_section_data(data, *options)
       return nil if data.nil?
-      section = first_section(data)
+      section, data = first_section(data)
       section_data(section, data, *options)
     end
 

data/lorj-spec/process/mock/defaults.yaml

@@ -0,0 +1,42 @@
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Defaults yaml file used for rspec.
+:default:
+  :maestro_url: http://example.org
+  :keypair_name: default_key
+  :data: None
+  :default_case2: 'success'
+:description:
+  :FORJ_HPC: Testing extra application default value.
+:setup:
+  - :desc: 'Step 1'
+    :explanation: |-
+      My complete explanation is in
+      multiline <%= config['text'] %>
+  - :desc: 'Step 2'
+    :add:
+     - :data
+:sections:
+  :credentials:
+    :keypair_name:
+    :data:
+      :account_exclusive: true
+  :maestro:
+    :maestro_url:
+  :lorj_default:
+    :default_case:
+      :default_value: 'success'
+    :default_case2:
+      :default_value: 'incorrect - meta-default value'

data/lorj-spec/process/mock_process.rb

@@ -15,7 +15,7 @@
 #    limitations under the License.
 
 # Students process
-class StudentsProcess
+class MockProcess
   def create_student(sObjectType, hParams)
     PrcLib.state(format("Running creation process for object '%s' = '%s'",
                         sObjectType, hParams[:student_name]))