lorj 1.0.3 → 1.0.4

data/lib/core/definition.rb

@@ -116,6 +116,17 @@ module Lorj
     # - def_attr_mapping  : Define object attribute mapping.
     # - data_value_mapping: Define Data model values mapping.
     #
+    # * *Args*
+    #   - type     : Symbol. Object type to declare.
+    #   - handlers : Hash. List of Process handler to call for
+    #     create/query/get/delete/update/get_attr.
+    #     Handlers supported:
+    #     - :create_e   : Process function to call with create
+    #     - :delete_e   : Process function to call with delete
+    #     - :update_e   : Process function to call with update
+    #     - :get_e      : Process function to call with get
+    #     - :query_e    : Process function to call with query
+    #     - :get_attr_e : Process function to call with get_attr
     def self.define_obj(obj_type_name, handlers = nil)
       return nil unless [NilClass, String, Symbol].include?(obj_type_name.class)
       PrcLib.model.heap true
@@ -142,6 +153,16 @@ module Lorj
     end
 
     # Application process to defines query attributes.
+    #
+    # This function is depreciated.
+    #
+    # def_attribute or def_attr_mapping already set the attribute as
+    # queriable. If the controller needs to redefine how the attribute is
+    # queried, use it will needs to call query_mapping.
+    #
+    # But from process point of view, all attribute must be queriable.
+    #
+    # So, use def_attribute(process), then query_mapping(controller)
     def self.def_query_attribute(key)
       PrcLib.model.heap true
       query_mapping(key, key)
@@ -261,17 +282,16 @@ module Lorj
       return nil if options.class != Hash
       PrcLib.model.heap true
 
-      data = data.to_sym if data.class == String
+      data = KeyPath.new data, 2
       PrcLib.dcl_fail("%s: Config data '%s' unknown",
-                      self.class, data) unless Lorj.defaults.meta_exist?(data)
+                      self.class,
+                      data) unless Lorj.data.auto_meta_exist?(data.key)
 
       PrcLib.model.data_context data
 
-      section = _section_from(data)
+      section = Lorj.data.first_section(data.key)
 
-      cur_options = PrcLib.model.meta_data.rh_get(section, data)
-      return cur_options.merge!(options) if cur_options
-      PrcLib.model.meta_data.rh_set(options, section, data)
+      Lorj.data.define_controller_data(section, data.key, options)
     end
 
     # Controller to declare a model Data value mapping
@@ -288,7 +308,7 @@ module Lorj
       section = _section_from(data)
 
       Lorj.debug(2, format("%s/%s: Define config data value mapping: '%s' => "\
-                           "'%s'", section, data, value, map))
+                           "'%s'", section, data.fpath, value, map))
       PrcLib.model.meta_data.rh_set(map, section, data,
                                     :value_mapping,  :controller, value)
       PrcLib.model.meta_data.rh_set(value, section, data,
@@ -333,6 +353,8 @@ module Lorj
     # Controller declaration to map an query attribute
     # By default, def_attribute configure those attributes as queriable.
     # The controller can redefine the query part.
+    # Use def_attribute or def_attr_mapping
+    # All attributes are considered as queriable.
     def self.query_mapping(key, map)
       PrcLib.model.heap true
       _query_mapping(key, map)
@@ -495,9 +517,10 @@ module Lorj
       [key_path_obj.fpath, map_path_obj.fpath]
     end
 
-    # Internal section detection
+    # Internal section detection based on a keyPath Object
     def self._section_from(data)
-      section = Lorj.defaults.get_meta_section(data)
+      return data.key[0] if data.length == 2
+      section = Lorj.defaults.get_meta_section(data.key)
       section = :runtime if section.nil?
 
       section
@@ -575,7 +598,7 @@ module Lorj
     # Internal function
     def self._obj_needs_data(object_attr, msg_action, new_params)
       attr_name = PrcLib.model.attribute_context
-      if Lorj.defaults.meta_exist?(attr_name)
+      if Lorj.data.auto_meta_exist?(attr_name)
         Lorj.debug(2, "%-28s: %s predefined config '%s'.",
                    _object_name(PrcLib.model.object_context),
                    msg_action, attr_name)

data/lib/core/definition_internal.rb

@@ -22,26 +22,22 @@ module Lorj
 
     # return Object data meta data.
     def _get_meta_data(key)
-      meta_default = Lorj.defaults.get_meta(key)
-      return nil if meta_default.nil?
-      meta_default = meta_default.clone
+      Lorj.data.auto_section_data(key)
+      #  meta_default = Lorj.defaults.get_meta_auto(key)
+      #  return nil if meta_default.nil?
+      #  meta_default = meta_default.clone
 
-      section = Lorj.defaults.get_meta_section(key)
-      return meta_default if section.nil?
-      meta = PrcLib.model.meta_data.rh_get(section, key)
-      return meta_default if meta.nil?
+      #  section = Lorj.defaults.get_meta_section(key)
+      #  return meta_default if section.nil?
+      #  meta = PrcLib.model.meta_data.rh_get(section, key)
+      #  return meta_default if meta.nil?
 
-      meta_default.merge!(meta)
-    end
-
-    def _get_meta_data_auto(key)
-      return nil if key.nil?
-      Lorj.defaults.get_meta_auto(key)
+      #  meta_default.merge!(meta)
     end
 
     def _get_account_section(key)
       return nil if key.nil?
-      Lorj.defaults.get_meta_section(key)
+      Lorj.data.first_section(key)
     end
 
     # internal runtime function for process call

data/lib/core/lorj_basedefinition.rb

@@ -14,16 +14,9 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-# Module Lorj which contains several classes.
+# Module Lorj implements ERBConfig, and initialization functions for
+# Lorj::BaseDefinition
 #
-# Those classes describes :
-# - processes (BaseProcess)   : How to create/delete/edit/query object.
-# - controler (BaseControler) : If a provider is defined, define how will do
-#                               object creation/etc...
-# - definition(BaseDefinition): Functions to declare objects, query/data mapping
-#                               and setup
-# this task to make it to work.
-
 module Lorj
   # This class limits ERC template to access only to config object data.
   class ERBConfig
@@ -80,21 +73,9 @@ module Lorj
     # Ex: object.set_data(...)
     #     config
 
-    # Function to manipulate the config object.
-    # 2 kind of functions:
-    # - set (key, value) and []=(key, value)
-    #   From processes, you can set a runtime data with:
-    #     config.set(key, value)
-    #   OR
-    #     config[key] = value
+    # Reference to the config object.
     #
-    # - get (key, default) and [](key, default)
-    #   default is an optional value.
-    #   From processes, you can get a data (runtime/account/config.yaml or
-    #   defaults.yaml) with:
-    #     config.get(key)
-    #   OR
-    #     config[key]
+    # See Lorj::Config or Lorj::Account for details
     def config
       PrcLib.runtime_fail 'No config object loaded.' unless @config
       @config
@@ -187,7 +168,7 @@ module Lorj
       @object_data.add data_objects
     end
 
-    # Function to get Lorj core data cache.
+    # Function to get attributes of objects stored in the Lorj core data cache.
     #
     # *Args*
     # - object_type : Object type to get
@@ -201,6 +182,17 @@ module Lorj
       @object_data[sObjectType, *key]
     end
 
+    # Function to get Lorj core data cache keys.
+    #
+    # *Args*
+    #
+    # *Return*
+    # - List of objects in cache.
+    #
+    def cache_objects_keys
+      @object_data[].keys
+    end
+
     # get an attribute/object/... from an object.
     def get_data(oObj, *key)
       if oObj.is_a?(Hash) && oObj.key?(:object_type)

data/lib/core/lorj_baseprocess.rb

@@ -15,16 +15,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-# Module Lorj which contains several classes.
-#
-# Those classes describes :
-# - processes (BaseProcess)   : How to create/delete/edit/query object.
-# - controler (BaseControler) : If a provider is defined, define how will do
-#                               object creation/etc...
-# - definition(BaseDefinition): Functions to declare objects, query/data mapping
-#                               and setup
-# this task to make it to work.
-
+# - Lorj::BaseProcess   : Process functions to call create/delete/edit/query
+#   processes on other objects.
 module Lorj
   # class describing generic Object Process
   # with controller calls
@@ -48,37 +40,37 @@ module Lorj
 
     attr_writer :base_object
 
-    def controller_connect(sObjectType, params = nil)
+    def controller_connect(sObjectType, params = nil) #:doc:
       process_error 'No Controler object loaded.' unless @base_object
       params = nil unless params.is_a?(Hash)
       @base_object.controller_connect(sObjectType, params)
     end
 
-    def controller_create(sObjectType, params = nil)
+    def controller_create(sObjectType, params = nil) #:doc:
       process_error 'No Controler object loaded.' unless @base_object
       params = nil unless params.is_a?(Hash)
       @base_object.controller_create(sObjectType, params)
     end
 
-    def controller_query(sObjectType, sQuery, params = nil)
+    def controller_query(sObjectType, sQuery, params = nil) #:doc:
       process_error 'No Controler object loaded.' unless @base_object
       params = nil unless params.is_a?(Hash)
       @base_object.controller_query(sObjectType, sQuery, params)
     end
 
-    def controller_update(sObjectType, params = nil)
+    def controller_update(sObjectType, params = nil) #:doc:
       process_error 'No Controler object loaded.' unless @base_object
       params = nil unless params.is_a?(Hash)
       @base_object.controller_update(sObjectType, params)
     end
 
-    def controller_delete(sObjectType, params = nil)
+    def controller_delete(sObjectType, params = nil) #:doc:
       process_error 'No Controler object loaded.' unless @base_object
       params = nil unless params.is_a?(Hash)
       @base_object.controller_delete(sObjectType, params)
     end
 
-    def controller_get(sObjectType, sId, params = nil)
+    def controller_get(sObjectType, sId, params = nil) #:doc:
       process_error 'No Controler object loaded.' unless @base_object
       params = nil unless params.is_a?(Hash)
       @base_object.controller_get(sObjectType, sId, params)
@@ -88,29 +80,29 @@ module Lorj
   # class describing generic Object Process
   # with process calls
   class BaseProcess
-    def process_create(sObjectType)
+    def process_create(sObjectType, hConfig = nil) #:doc:
       process_error 'No Base object loaded.' unless @base_object
-      @base_object.process_create(sObjectType)
+      @base_object.process_create(sObjectType, hConfig)
     end
 
-    def process_query(sObjectType, sQuery)
+    def process_query(sObjectType, sQuery, hConfig = nil) #:doc:
       process_error 'No Base object loaded.' unless @base_object
-      @base_object.process_query(sObjectType, sQuery)
+      @base_object.process_query(sObjectType, sQuery, hConfig)
     end
 
-    def process_update(sObjectType)
+    def process_update(sObjectType, hConfig = nil) #:doc:
       process_error 'No Base object loaded.' unless @base_object
-      @base_object.process_update(sObjectType)
+      @base_object.process_update(sObjectType, hConfig)
     end
 
-    def process_get(sObjectType, sId)
+    def process_get(sObjectType, sId, hConfig = nil) #:doc:
       process_error 'No Base object loaded.' unless @base_object
-      @base_object.process_get(sObjectType, sId)
+      @base_object.process_get(sObjectType, sId, hConfig)
     end
 
-    def process_delete(sObjectType)
+    def process_delete(sObjectType, hConfig = nil) #:doc:
       process_error 'No Base object loaded.' unless @base_object
-      @base_object.process_delete(sObjectType)
+      @base_object.process_delete(sObjectType, hConfig)
     end
   end
 
@@ -119,12 +111,12 @@ module Lorj
   class BaseProcess
     private
 
-    def query_cache_cleanup(sObjectType)
+    def query_cache_cleanup(sObjectType) #:doc:
       fail Lorj::PrcError.new, 'No Base object loaded.' unless @base_object
       @base_object.query_cleanup(sObjectType)
     end
 
-    def object_cache_cleanup(sObjectType)
+    def object_cache_cleanup(sObjectType) #:doc:
       fail Lorj::PrcError.new, 'No Base object loaded.' unless @base_object
       @base_object.object_cleanup(sObjectType)
     end
@@ -143,21 +135,45 @@ module Lorj
       @base_object
     end
 
-    def format_object(sObjectType, oMiscObj)
+    def format_object(sObjectType, oMiscObj) #:doc:
       PrcLib.runtime_fail 'No Base object loaded.' unless @base_object
       @base_object.format_object(sObjectType, oMiscObj)
     end
 
-    def format_query(sObjectType, oMiscObj, hQuery)
+    def format_query(sObjectType, oMiscObj, hQuery) #:doc:
       PrcLib.runtime_fail 'No Base object loaded.' unless @base_object
       @base_object.format_list(sObjectType, oMiscObj, hQuery)
     end
 
-    def data_objects(sObjectType, *key)
+    # Function to provides Lorj Core data cache access.
+    #
+    # See BaseDefinition#data_objects for details.
+    #
+    # AVOID CALLING THIS FUNCTION, except in debug case.
+    # Usually, if you are using this function to access some data,
+    # it means you need to declare those data in your object model.
+    #
+    # As normally this data should be accessible to the function parameter
+    # call. Please review.
+    #
+    def data_objects(sObjectType, *key) #:doc:
+      PrcLib.debug('data_objects is depreciated. To access "%s", you should '\
+                   'declare it with obj_needs of "%s" and if needed, refresh '\
+                   'hParams with hParams.refresh. Please update your code'\
+                   "\nSee %s", sObjectType, sObjectType, caller[0])
       PrcLib.runtime_fail 'No Base object loaded.' unless @base_object
       @base_object.data_objects(sObjectType, *key)
     end
 
+    # Function to provides Lorj Core data cache access.
+    #
+    # See BaseDefinition#cache_objects_keys for details.
+    #
+    def cache_objects_keys #:doc:
+      PrcLib.runtime_fail 'No Base object loaded.' unless @base_object
+      @base_object.cache_objects_keys
+    end
+
     def get_data(oObj, *key)
       PrcLib.warning('get_data call is obsolete. Please update your code. '\
                      "Use [] instead.\n%s", caller)
@@ -165,17 +181,78 @@ module Lorj
       @base_object.get_data(oObj, :attrs, key)
     end
 
-    def register(oObject, sObjectType = nil)
+    def register(oObject, sObjectType = nil) #:doc:
       PrcLib.runtime_fail 'No Base object loaded.' unless @base_object
       @base_object.register(oObject, sObjectType)
     end
 
-    def config
+    def config #:doc:
       PrcLib.runtime_fail 'No Base object loaded.' unless @base_object
       @base_object.config
     end
 
-    def query_single(sCloudObj, sQuery, name, sInfoMsg = {})
+    # Function to execute a query and return one or no record.
+    #
+    # * *Args*
+    #   - +type+   : Symbol. meta object type to query.
+    #   - +sQuery+ : Hash. Represents the query to execute
+    #   - +name+   : String. Human name of the object to search.
+    #   - +info+   : List of message to format. This string is printed out
+    #     thanks to #Lorj.debug or #PrcLib.info
+    #     - :notfound   : not found string formated with: type, name
+    #     - :checkmatch : checking match string formated with: type, name
+    #     - :nomatch    : No match string formated with: type, name
+    #     - :found      : Found string formated with: type, item
+    #       item string built from :items and :items_form
+    #     - :more       : Found several string formated with: type, name
+    #     - :items_form : Combined with :items. Represent a valid format string
+    #       for Ruby format function
+    #     - :items      : Symbol or Array of Symbol.
+    #       List of elements extracted from the first element of the query
+    #       result.
+    #       It is used to format the `item` string with :items_form format
+    #       string.
+    #       by default, the element extracted is :name and :items_form is '%s'.
+    #
+    # * *returns*
+    #   - Lorj::Data of type :list. It represents the query result.
+    #     It contains 0 or more Lorj::Data of type :data
+    #
+    # Example: following info is the default setting. If this setting is what
+    # want, then info can be missed. Otherwise, set one or all of this setting
+    # to change the default query_single print out.
+    #
+    #    info = {
+    #            :notfound => "No %s '%s' found",
+    #            :checkmatch => "Found 1 %s. checking exact match for '%s'.",
+    #            :nomatch => "No %s '%s' match",
+    #            :found => "Found %s '%s'.",
+    #            :more => "Found several %s. Searching for '%s'.",
+    #            :items_form => '%s',
+    #            :items => [:name]
+    #           }
+    #    item_searched = 'forj'
+    #    query = { :name => item_searched }
+    #    query_single(:network, query, item_searched, info)
+    #    # if no record is found
+    #    # => Will print "No network 'forj' found"
+    #
+    #    # If found one record.
+    #    # => Will print "Found 1 network. checking exact match for 'forj'."
+    #
+    #    # if found but no match the query.
+    #    # => Will print "No network 'forj' match"
+    #
+    #    # if several record is returned:
+    #    # => Will print "Found several network. Searching for 'forj'."
+    #
+    #    # Considering query should return records with at least the attribute
+    #    # :name, if the query return the wanted record, :name should be 'forj'.
+    #    #
+    #    # As defined by :items and :items_form, an item string will be set
+    #    # with format('%s', record[:name]). ie 'forj'
+    #    # So, in this case, query_single will print "Found network 'forj'."
+    def query_single(sCloudObj, sQuery, name, sInfoMsg = {}) #:doc:
       list = controller_query(sCloudObj, sQuery)
 
       info = _qs_info_init(sInfoMsg)
@@ -263,9 +340,6 @@ module Lorj
       end
     end
 
-    # qs_info_init is not omplex as well described. Disabling rubocop
-    # rubocop: disable PerceivedComplexity, CyclomaticComplexity
-
     def _qs_info_init(sInfoMsg)
       info = {
         :notfound => "No %s '%s' found",
@@ -276,13 +350,8 @@ module Lorj
         :items_form => '%s',
         :items => [:name]
       }
-      info[:notfound]     = sInfoMsg[:notfound]   if sInfoMsg.key?(:notfound)
-      info[:checkmatch]   = sInfoMsg[:checkmatch] if sInfoMsg.key?(:checkmatch)
-      info[:nomatch]      = sInfoMsg[:nomatch]    if sInfoMsg.key?(:nomatch)
-      info[:found]        = sInfoMsg[:found]      if sInfoMsg.key?(:found)
-      info[:more]         = sInfoMsg[:more]       if sInfoMsg.key?(:more)
-      info[:items]        = sInfoMsg[:items]      if sInfoMsg.key?(:items)
-      info[:items_form]   = sInfoMsg[:items_form] if sInfoMsg.key?(:items_form)
+
+      info.each { |key, _| info[key] = sInfoMsg[key] if sInfoMsg.key?(key) }
       info
     end
   end

data/lib/core/lorj_data.rb

@@ -12,15 +12,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-# Module Lorj which contains several classes.
-#
-# Those classes describes :
-# - processes (BaseProcess)   : How to create/delete/edit/query object.
-# - controler (BaseControler) : If a provider is defined, define how will do
-#                               object creation/etc...
-# - definition(BaseDefinition): Functions to declare objects, query/data mapping
-#                               and setup
-# this task to make it to work.
+# - Lorj::Data : Defines how to manage Objects data between processes,
+#   controllers and internally in the core of Lorj.
 module Lorj
   # This class is the Data object used by lorj object!
   # This is a key component of lorj

data/lib/core/lorj_keypath.rb

@@ -48,9 +48,10 @@ module Lorj
   # puts oKey.tree      # => [:test,:test2,:test3]
   #
   class KeyPath
-    def initialize(sKeyPath = nil)
+    def initialize(sKeyPath = nil, max_level = -1)
       @keypath = []
-      set sKeyPath
+      @max_level = max_level
+      set sKeyPath unless sKeyPath.nil?
     end
 
     def key=(sKeyPath)
@@ -65,6 +66,8 @@ module Lorj
       elsif sKeyPath.is_a?(String)
         @keypath = string_to_sarray(sKeyPath)
       end
+      PrcLib.error 'key path size limit (%s) reached',
+                   @max_level if @max_level > 0 && @keypath.length > @max_level
     end
 
     def tree # rubocop: disable TrivialAccessors

data/lib/core_process/cloud/process/common.rb

@@ -17,13 +17,10 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
-# Define framework object on BaseDefinition
-module Lorj
-  # Common definition
-  class BaseDefinition
-    # All objects used by this process are built from a Controller
-    process_default :use_controller => true
-  end
+# Common definition
+class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
+  # All objects used by this process are built from a Controller
+  process_default :use_controller => true
 end
 
 # Class to manage retry on errors before failing

data/lib/core_process/cloud/process/connection.rb

@@ -17,6 +17,8 @@
 
 # It requires Core objects to be defined + default ForjProcess functions.
 
+# rubocop: disable Style/ClassAndModuleChildren
+
 # Connection process code
 class CloudProcess
   def connect(sCloudObj, hParams)
@@ -36,58 +38,55 @@ class CloudProcess
   end
 end
 
-# Define framework object on BaseDefinition
-module Lorj
-  # Define services model
-  class BaseDefinition
-    # predefined list of objects.
-    # Links between objects is not predefined. To do it, use needs declaration
-    # in your provider class.
+# Define services model
+class Lorj::BaseDefinition
+  # predefined list of objects.
+  # Links between objects is not predefined. To do it, use needs declaration
+  # in your provider class.
 
-    # object to get list of services
-    # Defines Process handler to call
-    define_obj(:services,
+  # object to get list of services
+  # Defines Process handler to call
+  define_obj(:services,
 
-               :create_e => :connect
-               )
-    obj_needs :data, :auth_uri
-    obj_needs :data, :account_id
-    obj_needs :data, :account_key
-    obj_needs :data, :tenant
+             :create_e => :connect
+             )
+  obj_needs :data, :auth_uri
+  obj_needs :data, :account_id
+  obj_needs :data, :account_key
+  obj_needs :data, :tenant
 
-    undefine_attribute :id    # Do not return any predefined ID
-    undefine_attribute :name  # Do not return any predefined NAME
-  end
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
+end
 
-  # compute_connection
-  class BaseDefinition
-    define_obj(:compute_connection,
+# compute_connection
+class Lorj::BaseDefinition
+  define_obj(:compute_connection,
 
-               :create_e => :connect # Will call ForjProcess connect
-               )
-    obj_needs :data, :account_id
-    obj_needs :data, :account_key
-    obj_needs :data, :auth_uri
-    obj_needs :data, :tenant
-    obj_needs :data, :compute
+             :create_e => :connect # Will call ForjProcess connect
+             )
+  obj_needs :data, :account_id
+  obj_needs :data, :account_key
+  obj_needs :data, :auth_uri
+  obj_needs :data, :tenant
+  obj_needs :data, :compute
 
-    undefine_attribute :id    # Do not return any predefined ID
-    undefine_attribute :name  # Do not return any predefined NAME
-  end
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
+end
 
-  # network_connection
-  class BaseDefinition
-    define_obj(:network_connection,
+# network_connection
+class Lorj::BaseDefinition
+  define_obj(:network_connection,
 
-               :create_e => :connect
-               )
-    obj_needs :data, :account_id
-    obj_needs :data, :account_key
-    obj_needs :data, :auth_uri
-    obj_needs :data, :tenant
-    obj_needs :data, :network
+             :create_e => :connect
+             )
+  obj_needs :data, :account_id
+  obj_needs :data, :account_key
+  obj_needs :data, :auth_uri
+  obj_needs :data, :tenant
+  obj_needs :data, :network
 
-    undefine_attribute :id    # Do not return any predefined ID
-    undefine_attribute :name  # Do not return any predefined NAME
-  end
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
 end