lorj 0.2.0 → 1.0.0

data/example/students_3/controller/yaml_students.rb

@@ -14,81 +14,88 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-
 # This class describes how to process some actions, and will do everything prior
 # this task to make it to work.
 
-
 # declare yaml student API to the controller
 cur_path = File.dirname(__FILE__)
-api_file = File.expand_path(File.join(cur_path, "..", "..", "yaml_students", 'yaml_students.rb'))
+api_file = File.expand_path(File.join(cur_path, '..', '..',
+                                      'yaml_students', 'yaml_students.rb'))
 require api_file
 
 # The controller is a combination of 2 elements:
 # - Controller class
 #   Code which will interfere with the external API.
 #
-#   The file name must respect the name of the class. 1st letter already capitalized and letter after _ is capitalized.
+#   The file name must respect the name of the class. 1st letter already
+#   capitalized and letter after _ is capitalized.
 #   file: my_code.rb => needs to create MyCodeController class
 #
 # - Definition class
 #   This class declare any kind of mapping or additional fields to consider.
-#   Additionnal fields are unknow by the process. So, those fields will needs to be setup before.
+#   Additionnal fields are unknow by the process. So, those fields will needs
+#   to be setup before.
 #
 #   file name convention is identical than controller class.
 #   file: my_code.rb => needs to create MyCode class
 
-controller_file = File.expand_path(File.join(cur_path,'yaml_students_controller.rb'))
+controller_file = File.expand_path(File.join(cur_path,
+                                             'yaml_students_controller.rb'))
 require controller_file # Load controller mapping
 
 # Declare
-# - additional objects and their specific process (:connection using basic predefined :controller_create process)
+# - additional objects and their specific process (:connection using basic
+# predefined :controller_create process)
 # - data_mapping :
 #   :connection_string => :file_name
 #   :course            => :training
 #
-# If some data has been added by the controller, the main and process, won't take care and the framework will fails.
+# If some data has been added by the controller, the main and process,
+# won't take care and the framework will fails.
 # To eliminate this errors, there is 2 cases:
 # - detect this change in the process or the main.
-# - set it up, using lorj setup function, if the data is declared askable by the controller.
-#   The controller can define how the setup have to ask values, and even can get data
-#   from itself.
-
+# - set it up, using lorj setup function, if the data is declared askable by
+#   the controller.
+#   The controller can define how the setup have to ask values, and even can get
+#   data from itself.
 class YamlStudents
+  # This is a new object which is known by the controller only.
+  # Used to open the yaml file. Generically, I named it :connection.
+  # But this can be any name you want. Only the controller will deal with it.
+  define_obj(:connection,
+             # Nothing complex to do. So, simply call the controller create.
+             :create_e => :controller_create
+  )
 
-   # This is a new object which is known by the controller only.
-   # Used to open the yaml file. Generically, I named it :connection.
-   # But this can be any name you want. Only the controller will deal with it.
-   define_obj(:connection,{
-    :create_e => :controller_create # Nothing complex to do. So, simply call the controller create.
-   })
-
-   obj_needs   :data,   :connection_string,  :mapping => :file_name
-   undefine_attribute :id    # Do not return any predefined ID
-   undefine_attribute :name  # Do not return any predefined NAME
+  obj_needs :data,   :connection_string,  :mapping => :file_name
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
 
-   # The student model have to be expanded.
-   define_obj(:student)
-   # It requires to create a connection to the data, ie opening the yaml file.
-   # So, before working with the :student object, the controller requires a connection
-   # This connection will be loaded in the memory and provided to the controller
-   # when needed.
-   # obj_needs :CloudObject update the :student object to requires a connection before.
-   obj_needs   :CloudObject,              :connection
+  # The student model have to be expanded.
+  define_obj(:student)
+  # It requires to create a connection to the data, ie opening the yaml file.
+  # So, before working with the :student object, the controller requires a
+  # connection
+  # This connection will be loaded in the memory and provided to the controller
+  # when needed.
+  # obj_needs :CloudObject update the :student object to requires a connection
+  # before.
+  obj_needs :CloudObject,              :connection
 
-   # To simplify controller wrapper, we use hdata built by lorj, and passed to the API
-   # This hdata is a hash containing mapped data, thanks to set_hdata.
-   set_hdata :first_name
-   set_hdata :last_name
-   # Instead of 'course', the yaml API uses 'training'
-   set_hdata :course, :mapping => :training
+  # To simplify controller wrapper, we use hdata built by lorj, and passed to
+  # the API
+  # This hdata is a hash containing mapped data, thanks to def_hdata.
+  def_hdata :first_name
+  def_hdata :last_name
+  # Instead of 'course', the yaml API uses 'training'
+  def_hdata :course, :mapping => :training
 
-   get_attr_mapping :course, :training
-   # instead of 'student_name', the yaml API uses 'name'
-   get_attr_mapping :student_name, :name
+  def_attr_mapping :course, :training
+  # instead of 'student_name', the yaml API uses 'name'
+  def_attr_mapping :student_name, :name
 
-   # This controller will know how to manage a student file with those data.
-   # But note that the file can have a lot of more data than what the process
-   # usually manage. It is up to you to increase your process to manage more data.
-   # Then each controller may need to define mapping fields.
+  # This controller will know how to manage a student file with those data.
+  # But note that the file can have a lot of more data than what the process
+  # usually manage. It is up to you to increase your process to manage more data
+  # Then each controller may need to define mapping fields.
 end

data/example/students_3/controller/yaml_students_controller.rb

@@ -14,110 +14,123 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-
 # This class describes how to process some actions, and will do everything prior
 # this task to make it to work.
 
 # This Mock controller keep the data in memory in hash/Array data.
 
 # declare yaml student API to the controller
-cur_file = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), "..", "yaml_students", 'yaml_students.rb'))
-require cur_file
+yaml_students_file = File.expand_path(
+                      File.join(
+                        File.dirname(__FILE__),
+                        '..', '..', 'yaml_students', 'yaml_students.rb'))
+require yaml_students_file
 
 # The controller is a combination of 2 elements:
 # - Controller class
 #   Code which will interfere with the external API.
 #
-#   The file name must respect the name of the class. 1st letter already capitalized and letter after _ is capitalized.
+#   The file name must respect the name of the class. 1st letter already
+#   capitalized and letter after _ is capitalized.
 #   file: my_code.rb => needs to create MyCodeController class
 #
 # - Definition class
 #   This class declare any kind of mapping or additional fields to consider.
-#   Additionnal fields are unknow by the process. So, those fields will needs to be setup before.
+#   Additionnal fields are unknow by the process. So, those fields will needs
+#   to be setup before.
 #
 #   file name convention is identical than controller class.
 #   file: my_code.rb => needs to create MyCode class
-
 class YamlStudentsController
-   def initialize()
-      @@valid_attributes = [:name, :first_name, :last_name, :id, :status, :training]
-   end
-
-   def create(sObjectType, hParams)
-      case sObjectType
-         when :connection
-            required?(hParams, :hdata, :file_name)
-            YamlSchool.new(hParams[:hdata, :file_name])
-         when :student
-            required?(hParams, :connection)
-            required?(hParams, :student_name)
-
-            hParams[:connection].create_student(hParams[:student_name], hParams[:hdata])
-         else
-            Error "'%s' is not a valid object for 'create'" % sObjectType
-      end
-   end
-
-   # This function return a collection which have to provide:
-   # functions: [], length, each
-   # Used by network process.
-   def query(sObjectType, sQuery, hParams)
-      case sObjectType
-         when :student
-            required?(hParams, :connection)
-
-            hParams[:connection].query_student(sQuery)
-         else
-            Error "'%s' is not a valid object for 'create'" % sObjectType
-      end
-
-   end
-
-   def delete(sObjectType, hParams)
-      case sObjectType
-         when :student
-            required?(hParams, :connection)
-
-            hParams[:connection].delete_student(hParams[sObjectType][:id])
-         else
-            Error "'%s' is not a valid object for 'create'" % sObjectType
-      end
-   end
-
-   def get_attr(oControlerObject, key)
-      # This controller function read the data and
-      # extract the information requested by the framework.
-      # Those data will be mapped to the process data model.
-      # The key is an array, to get data from a level tree.
-      # [data_l1, data_l2, data_l3] => should retrieve data from structure like data[ data_l2[ data_l3 ] ]
-      begin
-         attributes = oControlerObject
-         raise "get_attr: attribute '%s' is unknown in '%s'. Valid one are : '%s'" % [key[0], oControlerObject.class, @@valid_attributes ] unless @@valid_attributes.include?(key[0])
-         Lorj::rhGet(attributes, key)
-      rescue => e
-         Error "get_attr: Unable to map '%s'. %s" % [key, e.message]
-      end
-   end
-
-   def set_attr(oControlerObject, key, value)
-      begin
-         attributes = oControlerObject
-         raise "set_attr: attribute '%s' is unknown in '%s'. Valid one are : '%s'" % [key[0], oControlerObject.class, @@valid_attributes ] unless @@valid_attributes.include?(key[0])
-         Lorj::rhSet(attributes, value, key)
-      rescue => e
-         Error "set_attr: Unable to map '%s' on '%s'" % [key, sObjectType]
-      end
-   end
-
-   def update(sObjectType, oObject, hParams)
-      case sObjectType
-         when :student
-            required?(hParams, :connection)
-
-            hParams[:connection].update_student(oObject)
-         else
-            Error "'%s' is not a valid object for 'create'" % sObjectType
-      end
-   end
-
+  # controller wrapper
+  # rubocop: disable Metrics/MethodLength
+  def create(sObjectType, hParams)
+    case sObjectType
+    when :connection
+      required?(hParams, :hdata, :file_name)
+      YamlSchool.new(hParams[:hdata, :file_name])
+    when :student
+      required?(hParams, :connection)
+      required?(hParams, :student_name)
+
+      hParams[:connection].create_student(hParams[:student_name],
+                                          hParams[:hdata])
+    else
+      Error format("'%s' is not a valid object for 'create'", sObjectType)
+    end
+  end
+  # rubocop: enable Metrics/MethodLength
+
+  # This function return a collection which have to provide:
+  # functions: [], length, each
+  # Used by network process.
+  def query(sObjectType, sQuery, hParams)
+    case sObjectType
+    when :student
+      required?(hParams, :connection)
+
+      hParams[:connection].query_student(sQuery)
+    else
+      Error format("'%s' is not a valid object for 'create'", sObjectType)
+    end
+  end
+
+  def delete(sObjectType, hParams)
+    case sObjectType
+    when :student
+      required?(hParams, :connection)
+
+      hParams[:connection].delete_student(hParams[sObjectType][:id])
+    else
+      Error format("'%s' is not a valid object for 'create'", sObjectType)
+    end
+  end
+
+  def get_attr(oControlerObject, key)
+    # This controller function read the data and
+    # extract the information requested by the framework.
+    # Those data will be mapped to the process data model.
+    # The key is an array, to get data from a level tree.
+    # [data_l1, data_l2, data_l3] => should retrieve data from structure like
+    # data[ data_l2[ data_l3 ] ]
+    attributes = oControlerObject
+
+    fail format("get_attr: attribute '%s' is unknown in '%s'. "\
+                "Valid one are : '%s'",
+                key[0],
+                oControlerObject.class,
+                valid_attributes) unless valid_attributes.include?(key[0])
+    attributes.rh_get(key)
+ rescue => e
+   Error format("get_attr: Unable to map '%s'. %s", key, e.message)
+  end
+
+  def set_attr(oControlerObject, key, value)
+    attributes = oControlerObject
+    fail format("set_attr: attribute '%s' is unknown in '%s'. "\
+                "Valid one are : '%s'",
+                key[0],
+                oControlerObject.class,
+                valid_attributes) unless valid_attributes.include?(key[0])
+    attributes.rh_set(value, key)
+ rescue
+   Error format("set_attr: Unable to map '%s' on '%s'", key, sObjectType)
+  end
+
+  def update(sObjectType, oObject, hParams)
+    case sObjectType
+    when :student
+      required?(hParams, :connection)
+
+      hParams[:connection].update_student(oObject)
+    else
+      Error format("'%s' is not a valid object for 'create'", sObjectType)
+    end
+  end
+
+  private
+
+  def valid_attributes
+    [:name, :first_name, :last_name, :id, :status, :training]
+  end
 end

data/example/students_3/process/students.rb

@@ -16,103 +16,167 @@
 
 # Students process - Define specific handlers
 class StudentsProcess
-   def create_student(sObjectType, hParams)
-      PrcLib::state ("Running creation process for object '%s' = '%s'" % [sObjectType, hParams[:student_name] ])
-
-      # config object is a reference to runtime/config data.
-      oList = Query(sObjectType, {:student_name => hParams[:student_name]})
-      case oList.length
-         when 0
-            oObject = controller_create(sObjectType)
-            raise "Student '%s' not created." % hParams[:student_name] if oObject.nil?
-            PrcLib::info ("'%s': '%s' created with id %s" % [sObjectType, hParams[:student_name],  oObject[:id]])
-         when 1
-            oObject = oList[0]
-            PrcLib::info ("'%s': '%s' loaded with id %s" % [sObjectType, hParams[:student_name],  oObject[:id]])
-         else
-            oObject = oList[0]
-            PrcLib::warning("More than one student named '%s' is found: %s records. Selecting the first one and removing duplicates." % [hParams[:student_name], oList.length])
-            iCount = 0
-            oList[1..-1].each { | elem |
-               register(elem)
-               iCount += controller_delete(sObjectType)
-            }
-            PrcLib::info ("'%s': %s duplicated '%s' removed. First loaded with id %s" % [sObjectType, iCount, hParams[:student_name],  oObject[:id]])
-      end
-      oObject
-   end
-
-   # The following handler is inactive.
-   # It provides a simple print-out code.
-   # If you want to activate it:
-   # * uncomment query_student function
-   # * update the :student data model
-   #   on query_e, replace controller_query by query_student
-
-   # def query_student(sObjectType, sQuery, hParams)
-   #    PrcLib::state ("Running query process for object '%s' with query '%s'" % [sObjectType, sQuery])
-   #
-   #   oObjects = controller_query(sObjectType, sQuery)
-   #   raise "Query error." if oObjects.nil?
-   #
-   #   PrcLib::info ("'%s': Queried. %s records found." % [sObjectType, oObjects.length])
-   #   oObjects
-   # end
-
-   # This handler is inactive.
-   # It provides a simple print-out code.
-   # If you want to activate it:
-   # * uncomment get_student function
-   # * update the :student data model
-   #   on get_e, replace controller_get by get_student
-
-   # def delete_student(sObjectType, hParams)
-   #    controller_delete(:student)
-   #    PrcLib::info ("'%s:%s' student removed" % [hParams[:student, :id], hParams[:student, :name]])
-   # end
+  # create_student process handler to get a student.
+  #
+  # * If not found, create it.
+  # * If multiple found, remove duplicates
+  # * otherwise return the one found.
+  # rubocop:disable Metrics/MethodLength
+  def create_student(sObjectType, hParams)
+    PrcLib.state(format("Running creation process for object '%s' = '%s'",
+                        sObjectType, hParams[:student_name]))
+
+    list = process_query(sObjectType, :student_name => hParams[:student_name])
+    case list.length
+    when 0
+      create_new_student(hParams[:student_name])
+    when 1
+      found_one_student(list[0], hParams[:student_name])
+    else
+      found_multiple_students(list, hParams[:student_name])
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  private
+
+  # Create a single new student
+  def create_new_student(student_name)
+    object = controller_create(:student)
+    fail format("Student '%s' not created.", student_name) if object.nil?
+
+    PrcLib.info(format("'student': '%s' created with id %s",
+                       student_name,
+                       object[:id]))
+    object
+  end
+
+  # Identified 1 student
+  def found_one_student(object, student_name)
+    PrcLib.info(format("'student': '%s' loaded with id %s",
+                       student_name, object[:id]))
+    object
+  end
+
+  # Identified multiple identical students
+  # It will remove duplicated.
+  def found_multiple_students(list, student_name)
+    object = list[0]
+    PrcLib.warning(format("More than one student named '%s' is found: %s "\
+                          'records. Selecting the first one and removing '\
+                          'duplicates.',
+                          student_name, list.length))
+    remove_multiple_students(list[1..-1], student_name)
+    object
+  end
+
+  # Remove list of identical students
+  def remove_multiple_students(list, student_name)
+    return false unless list.is_a?(Array)
+    return false if list.length == 0
+
+    count = 0
+    list.each { | elem | count += remove_student_object(elem) }
+    PrcLib.info(format("'student': %s duplicated '%s' removed. "\
+                       'First loaded with id %s',
+                       count, student_name, object[:id]))
+  end
+
+  def remove_student_object(object)
+    register(object)
+    controller_delete(:student)
+  end
+
+  # The following handler is inactive.
+  # It provides a simple print-out code.
+  # If you want to activate it:
+  # * uncomment query_student function
+  # * update the :student data model
+  #   on query_e, replace controller_query by query_student
+
+  # def query_student(sObjectType, sQuery, hParams)
+  #    PrcLib::state (format("Running query process for object '%s' "\
+  #                          "with query '%s'",
+  #                           sObjectType,
+  #                           sQuery))
+  #
+  #   objects = controller_query(sObjectType, sQuery)
+  #   raise "Query error." if objects.nil?
+  #
+  #   PrcLib::info (format("'%s': Queried. %s records found.",
+  #                        sObjectType,
+  #                        objects.length))
+  #   objects
+  # end
+
+  # This handler is inactive.
+  # It provides a simple print-out code.
+  # If you want to activate it:
+  # * uncomment get_student function
+  # * update the :student data model
+  #   on get_e, replace controller_get by get_student
+
+  # def delete_student(sObjectType, hParams)
+  #    controller_delete(:student)
+  #    PrcLib::info (format("'%s:%s' student removed",
+  #                         hParams[:student, :id],
+  #                         hParams[:student, :name]))
+  # end
 end
 
-# Declaring your data model and handlers.
-# Process Handlers functions have to be declared before, as lorj check their existence during data model definition.
-
-class Lorj::BaseDefinition
-
-   # We need to define the student object data model and process handlers to use.
-   # Process handlers must manipulate data defined here.
-   #
-   # The controller can redefine object for it needs, but should NEVER impact the main process.
-   # The controller can add specific process to deal with internal controller objects.
-   # But this should never influence the original process model.
-
-   # Use define_obj, to declare the new object managed by lorj with process handlers.
-   define_obj(:student,
-   {
-      :create_e => :create_student,   # The function to call in the class Students
-      :query_e  => :controller_query, # We use predefined call to the controller query
-      :delete_e => :controller_delete # We use predefined call to the controller delete
-   })
-
-   # obj_needs is used to declare parameters to pass to handlers.
-   # :for indicates those parameters to be passed to create_e handler only.
-   # Those data (or objects) will be collected and passed to the process handler as hParams.
-
-   obj_needs   :data,   :student_name,          { :for => [:create_e] }
-
-   # By default, all data are required.
-   # You can set it as optional. Your process will need to deal with this optional data.
-   obj_needs_optional
-   obj_needs   :data,   :first_name,            { :for => [:create_e] }
-   obj_needs   :data,   :last_name,             { :for => [:create_e] }
-   obj_needs   :data,   :course  # Note that in this model, the training is renamed as course.
-                                 # the controller will need to map it to 'training'.
-
-   # def_attribute defines the data model.
-   # The process will be able to access those data
-   def_attribute :course
-   def_attribute :student_name
-   def_attribute :first_name
-   def_attribute :last_name
-   def_attribute :status
-
-   undefine_attribute :name
+module Lorj
+  # Declaring your data model and handlers.
+  # Process Handlers functions have to be declared before, as lorj check their
+  # existence during data model definition.
+  class BaseDefinition
+    # We need to define the student object data model and process handlers to
+    # use.
+    # Process handlers must manipulate data defined here.
+    #
+    # The controller can redefine object for it needs, but should NEVER impact
+    # the main process.
+    # The controller can add specific process to deal with internal controller
+    # objects.
+    # But this should never influence the original process model.
+
+    # Use define_obj, to declare the new object managed by lorj with process
+    # handlers.
+
+    define_obj(:student,
+               # The function to call in the class Students
+               :create_e => :create_student,
+               # We use predefined call to the controller query
+               :query_e => :controller_query,
+               # We use predefined call to the controller delete
+               :delete_e => :controller_delete
+               )
+
+    # obj_needs is used to declare parameters to pass to handlers.
+    # :for indicates those parameters to be passed to create_e handler only.
+    # Those data (or objects) will be collected and passed to the process
+    # handler as hParams.
+
+    obj_needs :data,   :student_name,           :for => [:create_e]
+
+    # By default, all data are required.
+    # You can set it as optional. Your process will need to deal with this
+    # optional data.
+    obj_needs_optional
+    obj_needs :data,   :first_name,             :for => [:create_e]
+    obj_needs :data,   :last_name,              :for => [:create_e]
+    obj_needs :data,   :course
+    # Note that in this model, the training is renamed as course.
+
+    # the controller will need to map it to 'training'.
+
+    # def_attribute defines the data model.
+    # The process will be able to access those data
+    def_attribute :course
+    def_attribute :student_name
+    def_attribute :first_name
+    def_attribute :last_name
+    def_attribute :status
+
+    undefine_attribute :name
+  end
 end