lorj 1.0.1 → 1.0.2

data/example/students_5/students.rb

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (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.
+
+app_path = File.dirname(__FILE__)
+
+if ENV['BYEBUG']
+  require 'byebug'
+  lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+  $LOAD_PATH << lib_path
+end
+require 'lorj'
+require 'ansi'
+
+# Load global Config
+
+# This object is used to provide configuration data to lorj
+
+# The config search is:
+# 1- Application defaults (defaults.yaml) - Not defined by default. update the
+# following line and create defaults.yaml
+# PrcLib.app_defaults = $APP_PATH
+# 2- Local defaults (~/.<Application Name>/config.yaml) - <Application Name> is
+# 'Lorj' by default. Can be updated with following line.
+# PrcLib.app_name = 'myapp'
+# 3 - runtime. Those variables are set, with config[key] = value
+
+config = Lorj::Config.new # Use Simple Config Object
+
+# You can use an account object, which add an extra account level
+# between runtime and config.yaml/app default
+# config = Lorj::Account.new('MyAccount') #
+
+# If you want to see what is happening in the framework, uncomment
+# debug settings.
+#  PrcLib.level = Logger::DEBUG # Printed out to your console.
+#  PrcLib.core_level = 5 # framework debug levels.
+
+# Initialize the framework
+processes = [File.join(app_path, 'process', 'students.rb')]
+controller = File.join(app_path, 'controller', 'yaml_students.rb')
+
+# ~ student_core = Lorj::Core.new( config, processes, :mock)
+student_core = Lorj::Core.new(config, processes, controller)
+
+student_core.create(:connection, :connection_string => '/tmp/students.yaml')
+
+puts ANSI.bold('Create 1st student:')
+
+# Set the student name to use
+# There is different way to set them...
+# Those lines do the same using config object. Choose what you want.
+config.set(:first_name, 'Robert')
+config[:last_name]    = 'Redford'
+config[:student_name] = 'Robert Redford'
+config[:course]       = 'Art Comedy'
+
+# Ask the framework to create the object student 'Robert Redford'
+student_core.create(:student)
+
+puts ANSI.bold('Create 2nd student:')
+# We can set runtime configuration instantly from the Create call
+# The following line :
+student_core.create(:student,
+                    :student_name => 'Anthony Hopkins',
+                    :first_name => 'Anthony',
+                    :last_name => 'Hopkins',
+                    :course => 'Art Drama'
+)
+# config[:student_name] = "Anthony Hopkins"
+# config[:course] = "Art Drama"
+# student_core.Create(:student)
+
+puts ANSI.bold('Create 3rd student:')
+student_core.create(:student,
+                    :student_name => 'Marilyn Monroe',
+                    :first_name => 'Marilyn',
+                    :last_name => 'Monroe',
+                    :course => 'Art Drama'
+)
+# replaced the following :
+# config[:student_name] = "Anthony Hopkins"
+# student_core.Create(:student)
+
+puts ANSI.bold('Create mistake')
+student = student_core.create(:student,
+                              :student_name => 'Anthony Mistake',
+                              :first_name => 'Anthony',
+                              :last_name => 'Mistake',
+                              :course => 'what ever you want!!!'
+)
+
+puts format("Student created '%s'", student[:attrs])
+
+# Because the last student was the mistake one, we can directly delete it.
+# Usually, we use get instead.
+puts ANSI.bold('Remove mistake')
+student_core.delete(:student)
+puts format('Wrong student to remove: %s = %s',
+            student[:id], student[:student_name])
+
+puts ANSI.bold("List of students for 'Art Drama':")
+puts student_core.query(:student,  :course => 'Art Drama').to_a
+
+puts ANSI.bold('Deleted students:')
+puts student_core.query(:student, :status => :removed).to_a

data/example/yaml_students/students.rb

@@ -64,7 +64,7 @@ puts format("Student created: '%s'", student)
 puts ANSI.bold('Remove mistake')
 result = school.query_student(:name => 'Anthony Mistake')
 if result.length > 0
-  result.each do | a_student |
+  result.each do |a_student|
     puts format('Wrong student to remove: %s = %s',
                 a_student[:id], a_student[:name])
     school.delete_student(a_student[:id])

data/example/yaml_students/yaml_students.rb

@@ -24,12 +24,18 @@ class YamlSchool
   attr_accessor :file
   attr_accessor :data
 
+  # Initiliaze the API with the yaml file loaded.
+  #
+  # *Args*:
+  # - +file+ : File name to load.
   def initialize(file)
     @data = { :students => [] }
     @file = file
     load_data
   end
 
+  # Load data from a yaml file. File name is set at class initialization
+  # To change the file name, update the file attribute
   def load_data
     return false unless File.exist?(@file)
 
@@ -38,6 +44,8 @@ class YamlSchool
     @data[:students] = [] unless @data.key?(:students)
   end
 
+  # Save the data updated in memory.
+  # To change the file name, update the file attribute
   def save_data
     begin
       File.open(@file, 'w') do |out|
@@ -50,6 +58,21 @@ class YamlSchool
     true
   end
 
+  # create_student is a very basic function to create a new record in
+  # the student yaml file.
+  # The student is created in memory.
+  # To save it in the file, use save_data.
+  #
+  # *Args*:
+  # - +name+   : This is a generic name. It can be a surname as well
+  # - +fields+ : Fields is a Hash list of data to add in the student
+  #              It can be any kind of field name. But at least 2 are required:
+  #   - :first_name : First name of the student
+  #   - :last_name  : Last name of the student
+  #
+  # Ex:
+  # create_student('rob', :last_name => 'Redford', :first_name => 'Robert',
+  #                :class_room => 'Art Drama', :comment => 'Is a good student')
   def create_student(name, fields)
     if fields[:first_name].nil? || fields[:last_name].nil?
       puts 'YAML API: Unable to create a student. '\
@@ -63,24 +86,21 @@ class YamlSchool
     result
   end
 
-  def create_data(name, fields)
-    result = fields.clone
-    result[:name] = name
-    if name.nil?
-      result[:name] = format('%s %s', result[:first_name], result[:first_name])
-    end
-    result[:status] = :active
-
-    @data[:students] << result
-
-    result[:id] = @data[:students].length - 1
-    result
-  end
-
+  # delete_student is a very basic function to delete a record from
+  # the student yaml file.
+  # The student is deleted in memory.
+  # The deletion is simply an update of the :status to :removed
+  # To save it in the file, use save_data.
+  #
+  # *Args*:
+  # - id: If the student ID.
+  #
+  # Ex:
+  # delete_student(2)
   def delete_student(sId)
     return false unless File.exist?(file)
 
-    @data[:students].each do | value |
+    @data[:students].each do |value|
       next unless value[:id] == sId
 
       @data[:students][sId][:status] = :removed
@@ -90,12 +110,38 @@ class YamlSchool
     0
   end
 
+  # delete_student is a very basic function to delete a record from
+  # the student yaml file.
+  # The student is deleted in memory.
+  # The deletion is simply an update of the :status to :removed
+  # To save it in the file, use save_data.
+  #
+  # *Args*:
+  # - query: Hash of fields to use for the query
+  #          You can query any fields.
+  #          Standard one are:
+  #   - :id         : Student ID
+  #   - :name       : Student name or surname
+  #   - :first_name : First name of the student.
+  #   - :last_name  : Last name of the student.
+  #
+  # *returns*:
+  # - Array: List of records matching all fields.
+  #          The matching feature is basically limited to field equality.
+  #          if not found, the Array length will equal to 0.
+  #
+  # Ex:
+  # query_student(:id => 2)
+  # query_student(:first_name => 'Robert')
+  # query_student(:class => 'Art Drama')
   def query_student(hQuery)
     result = []
 
-    @data[:students].each do | hValue |
+    hQuery[:status] = :active unless hQuery.key?(:status)
+
+    @data[:students].each do |hValue|
       elem = hValue
-      hQuery.each do | query_key, query_value |
+      hQuery.each do |query_key, query_value|
         elem = nil if not_in_query?(hQuery, hValue, query_key, query_value)
       end
       result << elem if elem
@@ -103,6 +149,45 @@ class YamlSchool
     result
   end
 
+  # update_student is a very basic function to update a record of
+  # the student yaml file.
+  # The student is updated in memory.
+  # To save it in the file, use save_data.
+  #
+  # *Args*:
+  # - query: Hash of fields to use for the query
+  #          You can query any fields.
+  #          Standard one are:
+  #   - :id         : Student ID
+  #   - :name       : Student name or surname
+  #   - :first_name : First name of the student.
+  #   - :last_name  : Last name of the student.
+  #   - :status     : :removed if the record is deleted.
+  #
+  # Ex:
+  # query_student(2, :name => 'robby')
+  def update_student(id, fields)
+    list = query_student(:id => id)
+    list[0].merge(fields) if list.length == 1
+    save_data
+  end
+
+  private
+
+  def create_data(name, fields)
+    result = fields.clone
+    result[:name] = name
+    if name.nil?
+      result[:name] = format('%s %s', result[:first_name], result[:first_name])
+    end
+    result[:status] = :active
+
+    @data[:students] << result
+
+    result[:id] = @data[:students].length - 1
+    result
+  end
+
   # check query field and data value.
   # Return true if the query do not match the current data
   def not_in_query?(hQuery, hValue, query_key, query_value)
@@ -119,10 +204,4 @@ class YamlSchool
                     !hQuery.key?(:status)
     true
   end
-
-  def update_student(_sId, fields)
-    list = query_student(:id => Id)
-    list[0].merge(fields) if list.length == 1
-    save_data
-  end
 end

data/lib/concept.md

@@ -7,7 +7,7 @@ lorj framework model
 
 The framework is built over several pieces:
 
-![](img/forj-lib-concept.png "concept")
+![](../../lib/img/forj-lib-concept.png "concept")
 
 * Main
 
@@ -61,7 +61,7 @@ lorj defines 2 different objects to provide configuration data management. But y
 
 Short summary about Config `get`, `set` and `save`
 
-![](img/config_data_access.png)
+![](../../lib/img/config_data_access.png)
 
 
 * Lorj::Account
@@ -77,7 +77,7 @@ Short summary about Config `get`, `set` and `save`
 
 Short summary about Account `get`, `set` and `save`.
 
-![](img/account_data_access.png)
+![](../../lib/img/account_data_access.png)
 
 ###Application config file : defaults.yaml
 

data/lib/core/core.rb

@@ -52,13 +52,13 @@ module Lorj
   #
   #   oCloud = Lorj::CloudCore.new(oConfig, 'myhpcloud')
   #   oConfig.set(:server_name,'myservername')
-  #   oCloud.Create(:server)
+  #   oCloud.create(:server)
   #
   # Another basic example (See example directory)
   #
   #   oConfig = Lorj::Account.new()
   #   oPrc = Lorj::Core.new(oConfig, 'mySqlAccount')
-  #   oCloud.Create(:student, { :student_name => "Robert Redford"})
+  #   oCloud.create(:student, { :student_name => "Robert Redford"})
   #
   # See BaseProcess to check how you can write a process and what kind of
   # functions are available for your process to be kept controller independant.
@@ -116,7 +116,7 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def connect(oCloudObj, hConfig = {})
+    def connect(oCloudObj, hConfig = nil)
       return nil if !oCloudObj || !@core_object
       @core_object.process_create(oCloudObj, hConfig)
     end
@@ -144,7 +144,7 @@ module Lorj
     #
     # * *Raises* :
     #   No exceptions
-    def create(oCloudObj, hConfig = {})
+    def create(oCloudObj, hConfig = nil)
       return nil if !oCloudObj || !@core_object
       @core_object.process_create(oCloudObj, hConfig)
     end
@@ -164,7 +164,7 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def get_or_create(oCloudObj, hConfig = {})
+    def get_or_create(oCloudObj, hConfig = nil)
       return nil if !oCloudObj || !@core_object
       @core_object.process_create(oCloudObj, hConfig)
     end
@@ -186,7 +186,7 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def delete(oCloudObj, hConfig = {})
+    def delete(oCloudObj, hConfig = nil)
       return nil if !oCloudObj || !@core_object
 
       @core_object.process_delete(oCloudObj, hConfig)
@@ -208,7 +208,7 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def query(oCloudObj, sQuery, hConfig = {})
+    def query(oCloudObj, sQuery, hConfig = nil)
       return nil if !oCloudObj || !@core_object
 
       @core_object.process_query(oCloudObj, sQuery, hConfig)
@@ -231,7 +231,7 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def get(oCloudObj, sId, hConfig = {})
+    def get(oCloudObj, sId, hConfig = nil)
       return nil if !oCloudObj || !@core_object || sId.nil?
 
       @core_object.process_get(oCloudObj, sId, hConfig)
@@ -258,7 +258,7 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def update(oCloudObj, hConfig = {})
+    def update(oCloudObj, hConfig = nil)
       return nil if !oCloudObj || !@core_object
 
       @core_object.process_update(oCloudObj, hConfig)
@@ -324,8 +324,8 @@ module Lorj
       # Load Application processes
       init_processes(model, the_process_class)
 
-      fail Lorj::PrcError.new, 'Lorj::Core: No valid process loaded. '\
-                               'Aborting.' if model[:process_class].nil?
+      PrcLib.runtime_fail 'Lorj::Core: No valid process loaded. '\
+                           'Aborting.' if model[:process_class].nil?
 
       # Load Controller and Controller processes.
       init_controller(model, controller_class) if controller_class
@@ -342,11 +342,11 @@ module Lorj
     def initialize(oConfig, sAccount = nil, aProcesses = [])
       config_account = init_config(oConfig, sAccount)
 
-      process_list = [:CloudProcess]
+      process_list = [:cloud_process]
 
       controller_mod = config_account.get(:provider_name)
-      fail Lorj::PrcError.new, 'Provider_name not set. Unable to create'\
-                               ' instance CloudCore.' if controller_mod.nil?
+      PrcLib.runtime_fail 'Provider_name not set. Unable to create'\
+                           ' instance CloudCore.' if controller_mod.nil?
 
       init_controller_mod(process_list, controller_mod)
 
@@ -356,7 +356,7 @@ module Lorj
     private
 
     def init_config(oConfig, sAccount)
-      if !oConfig.is_a?(Lorj::Account)
+      if oConfig.is_a?(Lorj::Account)
         config_account = oConfig
       else
         config_account = Lorj::Account.new(oConfig)

data/lib/core/core_controller.rb

@@ -35,12 +35,14 @@ module Lorj
     # parameters:
     # - +object_type+: Lorj object type to use for the connection.
     # - +params+     : Parameters to use for connection.
-    def controller_connect(sObjectType, params = {})
-      controller_params = _get_object_params(sObjectType, :create_e, :connect,
-                                             true, params)
+    def controller_connect(sObjectType, params = nil)
+      _add_instant_config(params)
+
+      controller_params = _get_controller_params(sObjectType,
+                                                 :create_e, :connect)
       controller_obj = @controller.connect(sObjectType, controller_params)
       data_obj = Lorj::Data.new
-      data_obj.set(controller_obj, sObjectType) do | sObjType, oObject |
+      data_obj.set(controller_obj, sObjectType) do |sObjType, oObject|
         begin
           _return_map(sObjType, oObject)
        rescue => e
@@ -57,14 +59,16 @@ module Lorj
     # parameters:
     # - +object_type+: Lorj object type to use for the creation.
     # - +params+     : Parameters to use for creation.
-    def controller_create(sObjectType, params = {})
+    def controller_create(sObjectType, params = nil)
+      _add_instant_config(params)
+
       # The process ask the controller to create the object.
       # controller_params have to be fully readable by the controller.
-      controller_params = _get_object_params(sObjectType, :create_e, :create,
-                                             true, params)
+      controller_params = _get_controller_params(sObjectType,
+                                                 :create_e, :create)
       controller_obj = @controller.create(sObjectType, controller_params)
       data_obj = Lorj::Data.new
-      data_obj.set(controller_obj, sObjectType) do | sObjType, oObject |
+      data_obj.set(controller_obj, sObjectType) do |sObjType, oObject|
         begin
           _return_map(sObjType, oObject)
        rescue => e
@@ -74,6 +78,8 @@ module Lorj
       end
       @object_data.add data_obj
 
+      _remove_instant_config(params)
+
       data_obj
     end
 
@@ -86,14 +92,19 @@ module Lorj
     #
     # returns:
     # - The controller must return true to inform about the real deletion
-    def controller_delete(sObjectType, params = {})
-      controller_params = _get_object_params(sObjectType, :delete_e, :delete,
-                                             true, params)
+    def controller_delete(sObjectType, params = nil)
+      _add_instant_config(params)
+
+      controller_params = _get_controller_params(sObjectType,
+                                                 :delete_e, :delete)
       PrcLib.runtime_fail "delete Controller - %s: Object '%s' is not loaded.",
                           @controller.class,
                           key unless controller_params.exist?(sObjectType)
       state = @controller.delete(sObjectType, controller_params)
       @object_data.delete(sObjectType) if state
+
+      _remove_instant_config(params)
+
       state
     end
 
@@ -105,13 +116,15 @@ module Lorj
     #
     # returns:
     # - Return a Lorj::Data representing the data retrieved by the controller.
-    def controller_get(sObjectType, sUniqId, params = {})
-      controller_params = _get_object_params(sObjectType, :get_e, :get,
-                                             true, params)
+    def controller_get(sObjectType, sUniqId, params = nil)
+      _add_instant_config(params)
+
+      controller_params = _get_controller_params(sObjectType,
+                                                 :get_e, :get)
 
       controller_obj = @controller.get(sObjectType, sUniqId, controller_params)
       data_obj = Lorj::Data.new
-      data_obj.set(controller_obj, sObjectType) do | sObjType, oObject |
+      data_obj.set(controller_obj, sObjectType) do |sObjType, oObject|
         begin
           _return_map(sObjType, oObject)
        rescue => e
@@ -121,6 +134,8 @@ module Lorj
       end
       @object_data.add data_obj
 
+      _remove_instant_config(params)
+
       data_obj
     end
 
@@ -132,7 +147,9 @@ module Lorj
     #
     # returns:
     # - Returns a Lorj::Data object, containing a list of Lorj::Data element.
-    def controller_query(sObjectType, hQuery, params = {})
+    def controller_query(sObjectType, hQuery, params = nil)
+      _add_instant_config(params)
+
       # Check if we can re-use a previous query
       list = @object_data[:query, sObjectType]
       unless list.nil?
@@ -143,8 +160,8 @@ module Lorj
         end
       end
 
-      controller_params = _get_object_params(sObjectType, :query_e, :query,
-                                             true, params)
+      controller_params = _get_controller_params(sObjectType,
+                                                 :query_e, :query)
       controller_query = _query_map(sObjectType, hQuery)
 
       controller_obj = @controller.query(sObjectType, controller_query,
@@ -152,7 +169,7 @@ module Lorj
 
       data_obj = Lorj::Data.new :list
       data_obj.set(controller_obj,
-                   sObjectType, hQuery) do | sObjType, key |
+                   sObjectType, hQuery) do |sObjType, key|
         begin
           _return_map(sObjType, key)
        rescue => e
@@ -165,6 +182,9 @@ module Lorj
                  sObjectType, data_obj.length)
 
       @object_data.add data_obj
+
+      _remove_instant_config(params)
+
       data_obj
     end
 
@@ -176,19 +196,21 @@ module Lorj
     #
     # returns:
     # - The controller must return true to inform about the real deletion
-    def controller_update(sObjectType, params = {})
+    def controller_update(sObjectType, params = NIL)
+      _add_instant_config(params)
+
       # Need to detect data updated and update the Controler object with the
       # controler
 
-      controller_params = _get_object_params(sObjectType, :update_e, :update,
-                                             true, params)
+      controller_params = _get_controller_params(sObjectType,
+                                                 :update_e, :update)
 
       data_obj = @object_data[sObjectType, :ObjectData]
       controller_obj = data_obj[:object]
 
       is_updated = false
       attributes = data_obj[:attrs]
-      attributes.each do |key, value |
+      attributes.each do |key, value|
         attribute_obj = KeyPath.new(key)
 
         attribute_map = PrcLib.model.meta_obj.rh_get(sObjectType, :returns,
@@ -213,7 +235,7 @@ module Lorj
 
       Lorj.debug(1, '%s.%s - updated.',
                  @process.class, sObjectType) if is_done
-      data_obj.set(controller_obj, sObjectType) do | sObjType, an_object |
+      data_obj.set(controller_obj, sObjectType) do |sObjType, an_object|
         begin
           _return_map(sObjType, an_object)
        rescue => e
@@ -221,6 +243,9 @@ module Lorj
                              @process.class, sObjectType, e.message
         end
       end
+
+      _remove_instant_config(params)
+
       is_done
     end
   end

data/lib/core/core_internal.rb

@@ -221,7 +221,7 @@ module Lorj
     def init_processes(model, processes)
       process_array = processes_as_array(processes)
 
-      process_array.each do | a_process |
+      process_array.each do |a_process|
         a_process = a_process.to_s if a_process.is_a?(Symbol)
         unless load_process(model, a_process)
           PrcLib.warning("Process '%s' not properly loaded.", a_process)
@@ -295,7 +295,7 @@ module Lorj
 
       match_found = the_process_class.scan(/_[a-z]/)
       if match_found
-        match_found.each { | str | the_process_class[str] = str[1].capitalize }
+        match_found.each { |str| the_process_class[str] = str[1].capitalize }
       end
 
       the_process_class

data/lib/core/core_model.rb

@@ -293,16 +293,22 @@ module Lorj
     end
 
     # Object Context identifier (get/set)
-    # parameters: (Hash)
-    # - +:object+        : optional. Object to keep in context.
-    # - +:function_name+ : optional. Symbol. Call function name for error report
+    # parameters:
+    # - options: Hash.
+    #   - +:object+        : optional. Object to keep in context.
+    #   - +:function_name+ : optional. Symbol. Call function name for error
+    #                        report
     # return:
     # - string : Object name
     def object_context(options = nil)
-      if options.is_a?(Hash) && options.key?(:object)
-        @context[:oCurrentObj] = options[:object]
-        needs_optional false
-        needs_setup false
+      if options.is_a?(Hash)
+        if options.key?(:object)
+          @context[:oCurrentObj] = options[:object]
+          needs_optional false
+          needs_setup false
+        end
+      else
+        options = {}
       end
 
       msg = ''