lorj 1.0.1 → 1.0.2

data/lib/core/core_object_data.rb

@@ -133,10 +133,10 @@ module Lorj
     #   nothing
     def add(oDataObject)
       # Requires to be a valid framework object.
-      fail Lorj::PrcError.new,
-           format("Invalid Framework object type '%s'.",
-                  oDataObject.class) unless oDataObject.is_a?(Lorj::Data)
-
+      unless oDataObject.is_a?(Lorj::Data)
+        PrcLib.runtime_fail "Invalid Framework object type '%s'.",
+                            oDataObject.class
+      end
       object_data_add(oDataObject)
       oDataObject.register
     end
@@ -185,10 +185,10 @@ module Lorj
     # * *Raises* :
     #   PrcError
     def exist?(*key) # rubocop: disable Metrics/MethodLength
-      fail Lorj::PrcError.new, 'ObjectData: key is not list of values '\
-      '(string/symbol or array)' unless [Array, String,
-                                         Symbol].include?(key.class)
-
+      unless [Array, String, Symbol].include?(key.class)
+        PrcLib.runtime_fail 'ObjectData: key is not list of values '\
+                            '(string/symbol or array)'
+      end
       key = [key] if key.is_a?(Symbol) || key.is_a?(String)
 
       key = key.flatten
@@ -200,7 +200,7 @@ module Lorj
         object_data_exist?(object, key)
       else
         # By default true if found key hierarchy
-        @params.rh_exist?(key)
+        @params.rh_exist?(*key)
       end
     end
 
@@ -222,11 +222,12 @@ module Lorj
       :DataObject if @params[key].type == :object
     end
 
-    # cObj was an old way to get the internal data :object.
-    # Replaced by get(:object)
-    # def cobj(*key)
-    #   @params.rh_get(key, :object) if @params.rh_exist?(key, :object)
-    # end
+    def to_s
+      str = "-- Lorj::ObjectData --\n"
+      str += "Usage internal\n" if @internal
+      @params.each { |key, data| str += format("%s:\n%s\n", key, data.to_s) }
+      str
+    end
 
     private
 
@@ -304,10 +305,9 @@ module Lorj
     # * *Raises* :
     #   nothing
     def object_data_delete(obj)
-      fail Lorj::PrcError.new,
-           format('ObjectData: delete error. obj is not a'\
-                  " framework data Object. Is a '%s'",
-                  obj.class) unless obj.is_a?(Lorj::Data)
+      PrcLib.runtime_fail 'ObjectData: delete error. obj is not a'\
+                           " framework data Object. Is a '%s'",
+                          obj.class unless obj.is_a?(Lorj::Data)
       if obj.type == :list
         @params.rh_set(nil, :query, obj.object_type?)
       else

data/lib/core/core_object_params.rb

@@ -27,27 +27,33 @@ module Lorj
     #   - +new_params+        : Parameters ObjectData
     #   - +param_object+      : parameter object
     #   - +param_options+     : parameter options
-    #   - +predefined_params+ : predefined parameters.
     #
     # *return*:
-    # - value : return the parameter value.
+    # - value : return the parameter value added.
+    #           The value comes :
+    #   - from an existing param value if the param_options defines
+    #     :extract_from
+    #   - from config layers if exist
+    #   - from param_option[:default_value] if set
+    # OR
+    # - nil   : if not found
     #
     # *raise*:
     #
-    def _build_data(new_params, param_obj, param_options, predefined_value)
+    def _build_data(new_params, param_obj, param_options)
       param_name = param_obj.key
-      value = nil
-
-      default = param_options.rh_get(:default_value)
 
-      if param_options[:extract_from]
+      unless param_options[:extract_from].nil?
         value = new_params[param_options[:extract_from]]
+        new_params[param_obj.tree] = value
+        return value
       end
 
-      return predefined_value if predefined_value && value.nil?
-
-      value = @config.get(param_name, default) if value.nil?
+      return nil unless param_options.key?(:default_value) ||
+                        @config.exist?(param_name)
 
+      default = param_options.rh_get(:default_value)
+      value = @config.get(param_name, default)
       new_params[param_obj.tree] = value
 
       value
@@ -76,10 +82,10 @@ module Lorj
       attr_name = param_obj.key
 
       # Mapping from Object/data definition
-      if value_mapping
-        runtime_fail("'%s.%s': No value mapping for '%s'",
-                     object_type, attr_name,
-                     value) if Lorj.rhExist?(value_mapping, value) != 1
+      if value_mapping.is_a?(Hash)
+        PrcLib.runtime_fail("'%s.%s': No value mapping for '%s'",
+                            object_type, attr_name,
+                            value) unless value_mapping.key?(value)
         value = value_mapping[value]
       end
 
@@ -102,7 +108,6 @@ module Lorj
     #   - +new_params+        : ObjectData. Parameters ObjectData
     #   - +param_path+        : Symbol. parameter name
     #   - +param_options+     : Hash. parameter options
-    #   - +predefined_params+ : Hash. predefined parameters.
     #
     #
     # *return*:
@@ -110,21 +115,18 @@ module Lorj
     #
     # *raise*:
     #
-    def _build_param(new_params,
-                     param_obj, param_options, predefined_value)
-
+    def _build_param(new_params, param_obj, param_options)
       param_name = param_obj.key
 
       case param_options[:type]
       when :data
-        return _build_data(new_params, param_obj, param_options,
-                           predefined_value)
+        return _build_data(new_params, param_obj, param_options)
       when :CloudObject
         if param_options[:required] &&
            @object_data.type?(param_name) != :DataObject
-          fail Lorj::PrcError.new,
-               format("Object '%s/%s' is not defined. '%s' requirement "\
-                      'failed.', self.class, param_name, fname)
+          PrcLib.runtime_fail "Object '%s/%s' is not defined. '%s' "\
+                               'requirement failed.',
+                              self.class, param_name, fname
         end
         if @object_data.exist?(param_name)
           new_params.add(@object_data[param_name, :ObjectData])
@@ -137,6 +139,46 @@ module Lorj
       nil
     end
 
+    # internal runtime function for process call
+    # Build a process parameters object (ObjectData)
+    #
+    # *parameters*:
+    #   - +object_type+       : object type requiring parameters.
+    #   - +sEventType+        : event type used to call the process
+    #   - +fname+             : caller function
+    #
+    # *return*:
+    # - ObjectData : list of data and objects wanted by the process or
+    #                the controller. In case of the controller, hdata
+    #                controller map is also added.
+    #
+    # *raise*:
+    # - runtime error if required data is not set. (empty or nil)
+    #
+    def _get_process_params(object_type, sEventType, fname)
+      _get_object_params(object_type, sEventType, fname, false)
+    end
+
+    # internal runtime function for process call
+    # Build a controller parameters object (ObjectData)
+    #
+    # *parameters*:
+    #   - +object_type+       : object type requiring parameters.
+    #   - +sEventType+        : event type used to call the process
+    #   - +fname+             : caller function
+    #
+    # *return*:
+    # - ObjectData : list of data and objects wanted by the process or
+    #                the controller. In case of the controller, hdata
+    #                controller map is also added.
+    #
+    # *raise*:
+    # - runtime error if required data is not set. (empty or nil)
+    #
+    def _get_controller_params(object_type, sEventType, fname)
+      _get_object_params(object_type, sEventType, fname, true)
+    end
+
     # internal runtime function for process call
     # Build a process/controller parameters object (ObjectData)
     #
@@ -144,8 +186,8 @@ module Lorj
     #   - +object_type+       : object type requiring parameters.
     #   - +sEventType+        : event type used to call the process
     #   - +fname+             : caller function
-    #   - +as_controller+     : attribute options
-    #   - +predefined_params+ : pre-defined parameters values.
+    #   - +as_controller+     : true to store parameters for controller.
+    #                           false to store parameters for process.
     #
     # *return*:
     # - ObjectData : list of data and objects wanted by the process or
@@ -155,26 +197,25 @@ module Lorj
     # *raise*:
     # - runtime error if required data is not set. (empty or nil)
     #
-    def _get_object_params(object_type, sEventType, _fname,
-                           as_controller = false, predefined_params = {})
+    def _get_object_params(object_type, sEventType, fname, as_controller)
       # Building handler parameters
       # hdata is built for controller. ie, ObjectData is NOT internal.
 
       obj_params = PrcLib.model.meta_obj.rh_get(object_type, :params, :keys)
 
-      fail Lorj::PrcError.new, "'%s' Object data needs not set. Forgot "\
-                               'obj_needs?', object_type if obj_params.nil?
+      PrcLib.runtime_fail "%s:'%s' Object data needs not set. Forgot "\
+                           'obj_needs?', fname, object_type if obj_params.nil?
 
       new_params = _obj_param_init(object_type, sEventType, as_controller)
 
-      obj_params.each do | param_path, param_options|
-        next if Lorj.rhExist?(param_options, :for, sEventType) == 2
+      obj_params.each do |param_path, param_options|
+        if param_options.key?(:for)
+          next unless param_options[:for].include?(sEventType)
+        end
 
         param_obj = KeyPath.new(param_path)
-        param_name = param_obj.key
 
-        value = _build_param(new_params, param_path, param_options,
-                             predefined_params[param_name])
+        value = _build_param(new_params, param_obj, param_options)
 
         if as_controller && !value.nil?
           _build_hdata(object_type, new_params, param_obj, param_options, value)

data/lib/core/core_process.rb

@@ -38,7 +38,9 @@ module Lorj
     # creation.
     #
     # * *Returns* :
-    #   - +Object+ : Lorj::Data object of type +ObjectType+ created.
+    # - +Object+ : Lorj::Data object of type +ObjectType+ created.
+    # OR
+    # - Lorj::Data empty.
     #
     # * *Raises* :
     #   - Warning if the create_e process handler did not return any data. (nil)
@@ -49,65 +51,53 @@ module Lorj
     #     data. (nil) - Loop detection.
     #   - Error if the create_e process handler raise an error.
     #
-    def process_create(sObjectType, hConfig = {})
-      #  if hConfig.length > 0
-      #  # cleanup runtime data to avoid conflicts between multiple calls
-      #  valid_keys = _identify_data(sObjectType, :create_e)
-      #  valid_keys.each do | sKey|
-      #  value = hConfig.rh_get(sKey)
-      #  @config[sKey] = value if !@config.exist?(sKey) ||
-      #  @config.exist?(sKey) == 'runtime'
-      #  hConfig.rh_set(nil, sKey)
-      #  end
-      #  if hConfig.length > 0
-      #  PrcLib.warning("'%s' has been passed but not declared to '%s'"\
-      #  ' object. Those are ignored until you add it in the'\
-      #  " model definition of '%s'",
-      #  hConfig.keys, sObjectType, sObjectType)
-      #  end
-      #  end
-
-      return nil unless sObjectType
-
-      unless PrcLib.model.meta_obj.rh_exist?(sObjectType)
-        runtime_fail "%s.Create: '%s' is not a known object type.",
-                     self.class, sObjectType
+    def process_create(object_type, hConfig = nil)
+      return nil unless object_type
+
+      _add_instant_config(hConfig)
+
+      unless PrcLib.model.meta_obj.rh_exist?(object_type)
+        PrcLib.runtime_fail "%s.%s: '%s' is not a known object type.",
+                            self.class, __callee__, object_type
       end
-      proc = PrcLib.model.meta_obj.rh_get(sObjectType, :lambdas, :create_e)
+      proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :create_e)
 
       # Check required parameters
       _process_load_dependencies(object_type, proc, :create_e, __callee__)
 
       # Context: Default object used
-      @runtime_context[:oCurrentObj] = sObjectType
+      @runtime_context[:oCurrentObj] = object_type
 
       if proc.nil?
         # This object is a meta object, without any data.
         # Used to build other kind of objects.
         object = Lorj::Data.new
-        object.set({}, sObjectType) {}
+        object.set({}, object_type) {}
       else
         # build Function params to pass to the event handler.
-        params = _get_object_params(sObjectType, :create_e, proc, hConfig)
-        Lorj.debug(2, "Create Object '%s' - Running '%s'", sObjectType, proc)
+        params = _get_process_params(object_type, :create_e, proc)
+        Lorj.debug(2, "Create Object '%s' - Running '%s'", object_type, proc)
 
         # Call the process function.
         # At some point, the process will call the controller, via the framework
         # This controller call via the framework has the role to
         # create an ObjectData well formatted, with _return_map function
         # See Definition.connect/create/update/query/get functions (lowercase)
-        object = @process.method(proc).call(sObjectType, params)
+        object = @process.method(proc).call(object_type, params)
         # return usually is the main object that the process called should
         # provide.
         # Save Object if the object has been created by the process, without
         # controller
       end
 
+      _remove_instant_config(hConfig)
+
       if object.nil?
         PrcLib.warning("'%s' has returned no data for object Lorj::Data '%s'!",
-                       proc, sObjectType)
+                       proc, object_type)
+        Lorj::Data.new
       else
-        query_cleanup(sObjectType)
+        query_cleanup(object_type)
         @object_data.add(object)
       end
     end
@@ -133,12 +123,14 @@ module Lorj
     #     data. (nil) - Loop detection.
     #   - Error if the query_e process handler raise an error.
     #
-    def process_delete(object_type, hConfig = {})
+    def process_delete(object_type, hConfig = nil)
       return nil unless object_type
 
+      _add_instant_config(hConfig)
+
       unless PrcLib.model.meta_obj.rh_exist?(object_type)
-        runtime_fail "%s.Delete: '%s' is not a known object type.",
-                     self.class, object_type
+        PrcLib.runtime_fail "%s.%s: '%s' is not a known object type.",
+                            self.class, __callee__, object_type
       end
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :delete_e)
@@ -152,11 +144,13 @@ module Lorj
       @runtime_context[:oCurrentObj] = object_type
 
       # build Function params to pass to the event handler.
-      params = _get_object_params(object_type, :delete_e, proc, hConfig)
+      params = _get_process_params(object_type, :delete_e, proc)
 
       state = @process.method(proc).call(object_type, params)
       # return usually is the main object that the process called should provide
 
+      _remove_instant_config(hConfig)
+
       @object_data.delete(object_type) if state
     end
 
@@ -204,15 +198,20 @@ module Lorj
     #
     # * *Returns* :
     #   Lorj::Data of type :list
+    # OR
+    # - Lorj::Data empty.
     #
     # * *Raises* :
     #
     #
-    def process_query(object_type, hQuery, hConfig = {})
+    def process_query(object_type, hQuery, hConfig = nil)
       return nil unless object_type
+
+      _add_instant_config(hConfig)
+
       unless PrcLib.model.meta_obj.rh_exist?(object_type)
-        runtime_fail "%s.Get: '%s' is not a known object type.",
-                     self.class, object_type
+        PrcLib.runtime_fail "%s.%s: '%s' is not a known object type.",
+                            self.class, __callee__, object_type
       end
 
       # Check if we can re-use a previous query
@@ -230,7 +229,7 @@ module Lorj
       @runtime_context[:oCurrentObj] = object_type
 
       # build Function params to pass to the Process Event handler.
-      params = _get_object_params(object_type, :query_e, proc, hConfig)
+      params = _get_process_params(object_type, :query_e, proc)
 
       # Call the process function.
       # At some point, the process will call the controller, via the framework.
@@ -238,10 +237,14 @@ module Lorj
       # create an ObjectData well formatted, with _return_map function
       # See Definition.connect/create/update/query/get functions (lowercase)
       object = @process.method(proc).call(object_type, hQuery, params)
+
+      _remove_instant_config(hConfig)
+
       # return usually is the main object that the process called should provide
       if object.nil?
         PrcLib.warning("'%s' returned no collection of objects Lorj::Data "\
                        "for '%s'", proc, object_type)
+        Lorj::Data.new
       else
         # Save Object if the object has been created by the process, without
         # controller
@@ -274,7 +277,9 @@ module Lorj
     #                    getting.
     #
     # * *Returns* :
-    #   Lorj::Data of type :object
+    # - Lorj::Data of type :object
+    # OR
+    # - Lorj::Data empty.
     #
     # * *Raises* :
     #   - Warning if the Config data passed are not required by the meta object
@@ -284,11 +289,14 @@ module Lorj
     #     data. (nil) - Loop detection.
     #   - Error if the get_e process handler raise an error.
     #
-    def process_get(object_type, sUniqId, hConfig = {})
+    def process_get(object_type, sUniqId, hConfig = nil)
       return nil unless object_type
+
+      _add_instant_config(hConfig)
+
       unless PrcLib.model.meta_obj.rh_exist?(object_type)
-        runtime_fail "$s.Get: '%s' is not a known object type.",
-                     self.class, object_type
+        PrcLib.runtime_fail "$s.: '%s' is not a known object type.",
+                            self.class, __callee__, object_type
       end
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :get_e)
@@ -302,7 +310,7 @@ module Lorj
       @runtime_context[:oCurrentObj] = object_type
 
       # build Function params to pass to the Process Event handler.
-      params = _get_object_params(object_type, :get_e, proc, hConfig)
+      params = _get_process_params(object_type, :get_e, proc)
 
       # Call the process function.
       # At some point, the process will call the controller, via the framework.
@@ -312,9 +320,15 @@ module Lorj
       object = @process.method(proc).call(object_type, sUniqId, params)
       # return usually is the main object that the process called should provide
 
-      # Save Object if the object has been created by the process, without
-      # controller
-      @object_data.add(object) unless object.nil?
+      _remove_instant_config(hConfig)
+
+      if object.nil?
+        PrcLib.warning("'%s' has returned no data for object Lorj::Data '%s'!",
+                       proc, object_type)
+        Lorj::Data.new
+      else
+        @object_data.add(object)
+      end
     end
 
     # Function to execute a update process. This function returns a Lorj::Data
@@ -326,7 +340,9 @@ module Lorj
     # updating.
     #
     # * *Returns* :
-    #   Lorj::Data of type :object
+    # - Lorj::Data of type :object
+    # OR
+    # - Lorj::Data empty.
     #
     # * *Raises* :
     #   - Warning if the Config data passed are not required by the meta object
@@ -336,12 +352,14 @@ module Lorj
     #     data. (nil) - Loop detection.
     #   - Error if the get_e process handler raise an error.
     #
-    def process_update(object_type, hConfig = {})
+    def process_update(object_type, hConfig = nil)
       return nil unless object_type
 
+      _add_instant_config(hConfig)
+
       unless PrcLib.model.meta_obj.rh_exist?(object_type)
-        runtime_fail "$s.Update: '%s' is not a known object type.",
-                     self.class, object_type
+        PrcLib.runtime_fail "$s.%s: '%s' is not a known object type.",
+                            self.class, __callee__, object_type
       end
 
       proc = PrcLib.model.meta_obj.rh_get(object_type, :lambdas, :update_e)
@@ -354,14 +372,41 @@ module Lorj
       @runtime_context[:oCurrentObj] = object_type
 
       # build Function params to pass to the event handler.
-      params = _get_object_params(object_type, :update_e, proc, hConfig)
+      params = _get_process_params(object_type, :update_e, proc)
 
       object = @process.method(proc).call(object_type, params)
       # return usually is the main object that the process called should provide
 
-      # Save Object if the object has been created by the process, without
-      # controller
-      @object_data.add(object) unless object.nil?
+      _remove_instant_config(hConfig)
+
+      if object.nil?
+        PrcLib.warning("'%s' has returned no data for object Lorj::Data '%s'!",
+                       proc, object_type)
+        Lorj::Data.new
+      else
+        @object_data.add(object)
+      end
+    end
+  end
+
+  # Adding private process core functions.
+  class BaseDefinition
+    private
+
+    def _add_instant_config(hConfig)
+      return unless hConfig.is_a?(Hash)
+
+      config = PRC::BaseConfig.new hConfig
+      options = { :name => hConfig.object_id.to_s, :config => config,
+                  :set => false }
+
+      @config.layer_add PRC::CoreConfig.define_layer(options)
+    end
+
+    def _remove_instant_config(hConfig)
+      return unless hConfig.is_a?(Hash)
+
+      @config.layer_remove :name => hConfig.object_id.to_s
     end
 
     def _process_load_dependencies(object_type, proc, handler_name,
@@ -378,13 +423,13 @@ module Lorj
         end
 
         unless process_create(elem)
-          runtime_fail "Unable to create Object '%s'", elem
+          PrcLib.runtime_fail "Unable to create Object '%s'", elem
         end
 
         missing_obj = _check_required(object_type, handler_name, proc).reverse
-        runtime_fail "loop detection: '%s' is required but"\
+        PrcLib.runtime_fail "loop detection: '%s' is required but"\
                      " #{function_name}(%s) did not loaded it.",
-                     elem, elem if missing_obj.include?(elem)
+                            elem, elem if missing_obj.include?(elem)
       end
     end
   end

data/lib/core/core_process_setup.rb

@@ -119,7 +119,7 @@ module Lorj
     #
     def process_setup(sObjectType, sAccountName = nil)
       unless PrcLib.model.meta_obj.rh_exist?(sObjectType)
-        runtime_fail "Setup: '%s' not a valid object type."
+        PrcLib.runtime_fail "Setup: '%s' not a valid object type."
       end
 
       setup_steps = _setup_load
@@ -156,11 +156,11 @@ module Lorj
     def _setup_data_insert(setup_steps, data_to_add, step, order_index)
       level_index = 0
 
-      _setup_data_after(data_to_add).each do |sAfterKey |
+      _setup_data_after(data_to_add).each do |sAfterKey|
         setup_steps.each_index do |iStepToCheck|
           order_array = setup_steps[iStepToCheck][:order]
 
-          order_array.each_index do | iLevelToCheck |
+          order_array.each_index do |iLevelToCheck|
             data_to_ask = order_array[iLevelToCheck]
             order_to_check = data_to_ask.index(sAfterKey)
 
@@ -191,7 +191,7 @@ module Lorj
     # * *Raises* :
     #
     def _setup_data_after(data_to_check)
-      meta = _get_meta_data(data_to_check)
+      meta = _get_meta_data_auto(data_to_check)
       return [] unless meta.rh_exist?(:after)
 
       datas_after = meta[:after]
@@ -206,7 +206,7 @@ module Lorj
     #   - +order_array+   : Array of data classified per level/order
     #   - +data_to_check+ : data to check
     def _setup_attr_already_added?(order_array, data_to_check)
-      order_array.each_index do | order_index |
+      order_array.each_index do |order_index|
         attributes = order_array[order_index]
         return true unless attributes.index(data_to_check).nil?
       end
@@ -240,7 +240,7 @@ module Lorj
         return false
       end
 
-      meta = _get_meta_data(attr_name)
+      meta = _get_meta_data_auto(attr_name)
       return false unless meta.is_a?(Hash)
 
       ask_step = 0
@@ -250,8 +250,8 @@ module Lorj
       order_array = setup_steps[ask_step][:order]
 
       unless meta[:account].is_a?(TrueClass)
-        Lorj.debug(2, "'%s' used by '%s' won't be asked during setup."\
-                   ' :account = true not set.', attr_name, object_type)
+        Lorj.debug(2, "'%s' won't be asked during setup."\
+                   ' :account = true not set.', attr_name)
         return false
       end
 
@@ -263,7 +263,7 @@ module Lorj
       level = _setup_attr_add(order_array[level_index], attr_name, meta,
                               level_index)
       Lorj.debug(3, "S%s/L%s/%s: '%s' added in setup list. ",
-                 ask_step, level, order_index, attr_name)
+                 ask_step, level, level_index, attr_name)
 
       true
     end
@@ -300,12 +300,12 @@ module Lorj
         order_index = meta[:ask_sort]
         _setup_attr_add_at(level_array, attr_name, order_index)
         Lorj.debug(3, "S%s/L%s/O%s: '%s' added in setup list. ",
-                   ask_step, level_index, order_index, attr_name)
+                   meta[:ask_step], level_index, order_index, attr_name)
         "O#{level_index}"
       else
         level_array << attr_name
         Lorj.debug(3, "S%s/L%s/Last: '%s' added in setup list.",
-                   ask_step, level_index, attr_name)
+                   meta[:ask_step], level_index, attr_name)
         'Last'
       end
     end