lorj 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39a783a3bdefa0193225dbdeeffa904220c3e212
-  data.tar.gz: b5d15179e5989d20e02dec91bcb5f6fd6cafb530
+  metadata.gz: 66366295d6d2bd7fe5249ae3a23204fbf6feb041
+  data.tar.gz: 5f82817cfe94a3663ff15a0b2084da299fde4a43
 SHA512:
-  metadata.gz: ed18aa7febd8d02e4e5d31bfa9b99407a40f5bc80a97d237bd0696281be2e330756e08d276fb4b77c7e6d90db239e569eb3fea4f661cffd0880ab04a89cb3bc1
-  data.tar.gz: 3c553c66bd2b48a15e0652c8b18c28ce2bafb4a7c37a47b3fef1712f71dccd761fed8ff992aedf41c8f9e89e9db3a8b230191bd38a6947cf137f9b4575f08ae0
+  metadata.gz: d3bc6abf89ad95748426300653103cf351ffcbc49ae1c319e6a77118444ccc819e88c8869cba6dac1a8f43ebd1e1e1720c855477a7ed8808b59d31b356ec2dc4
+  data.tar.gz: 8b0d0a9af74d981cb61a0f2330b697edffee5a0451071ba4ef4dc62a04184f91ca5c999b77de4993291c46a10b64b40e1b7be3485f11e2d2a86ea81142607078

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/example/students_1/process/students.rb

@@ -33,7 +33,7 @@ class Lorj::BaseDefinition # rubocop:disable Style/ClassAndModuleChildren
   define_obj(:student,
              # The function to call in the class Students
              :create_e => :create_student
-             )
+            )
 
   obj_needs :data,         :student_name,         :for => [:create_e]
 end

data/example/students_1/student_v1.md

@@ -18,6 +18,8 @@ First of all, write your first main. Create a file `example.rb` with following c
 
     # Initialize the framework
     processes = [ File.join(app_path, 'process', 'students.rb')]
+    processes = []
+    processes << { :process_path => File.join(app_path, 'process', 'students.rb') }
     student_core = Lorj::Core.new( nil, processes)
 
     # Ask the framework to create the object student 'Robert Redford'

data/example/students_1/students.rb

@@ -30,7 +30,8 @@ require 'lorj'
 #  PrcLib.core_level = 3 # framework debug levels.
 
 # Initialize the framework
-processes = [File.join(app_path, 'process', 'students.rb')]
+processes = []
+processes << { :process_path => File.join(app_path, 'process', 'students.rb') }
 
 student_core = Lorj::Core.new(nil, processes)
 

data/example/students_2/process/students.rb

@@ -42,7 +42,7 @@ class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
              :get_e => :controller_get,
              # We use predefined call to the controller delete
              :delete_e => :controller_delete
-             )
+            )
 
   obj_needs :data, :student_name, :for => [:create_e], :mapping => :name
 end

data/example/students_2/students.rb

@@ -30,10 +30,12 @@ require 'lorj'
 #  PrcLib.core_level = 3 # framework debug levels.
 
 # Initialize the framework
-processes = [File.join(app_path, 'process', 'students.rb')]
+processes = []
+processes << { :process_path => File.join(app_path, 'process', 'students.rb'),
+               :controller_name => :mock }
 
 #  byebug if ENV['BYEBUG'] # rubocop: disable Debugger
-student_core = Lorj::Core.new(nil, processes, :mock)
+student_core = Lorj::Core.new(nil, processes)
 # Ask the framework to create the object student 'Robert Redford'
 student_core.create(:student, :student_name => 'Robert Redford')
 

data/example/students_3/controller/yaml_students_def.rb

@@ -41,7 +41,7 @@ class YamlStudents
   define_obj(:connection,
              # Nothing complex to do. So, simply call the controller create.
              :create_e => :controller_create
-  )
+            )
 
   obj_needs :data,   :connection_string,  :mapping => :file_name
   undefine_attribute :id    # Do not return any predefined ID

data/example/students_3/process/students.rb

@@ -42,7 +42,7 @@ class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
              :get_e => :controller_get,
              # We use predefined call to the controller delete
              :delete_e => :controller_delete
-             )
+            )
 
   obj_needs :data, :student_name, :for => [:create_e], :mapping => :name
 end

data/example/students_3/student_v3.md

@@ -20,9 +20,11 @@ processes = [File.join(app_path, 'process', 'students.rb')]
 # now we changed from mock to our own controller, located in
 controller = File.join(app_path, 'controller', 'yaml_students.rb')
 
-# controller/yaml_students.rb
-#  student_core = Lorj::Core.new(nil, processes, :mock)
-student_core = Lorj::Core.new(nil, processes, controller)
+processes = []
+processes << { :process_path => File.join(app_path, 'process', 'students.rb'),
+               :controller_path => File.join(app_path, 'controller', 'yaml_students.rb') }
+
+student_core = Lorj::Core.new(nil, processes)
 ```
 
 Now, let's write the controller file.

data/example/students_3/students.rb

@@ -30,15 +30,17 @@ PrcLib.level = Logger::DEBUG # Printed out to your console.
 PrcLib.core_level = 3 # framework debug levels.
 
 # Initialize the framework
-processes = [File.join(app_path, 'process', 'students.rb')]
-controller = File.join(app_path, 'controller', 'yaml_students.rb')
+processes = []
+processes << { :process_path => File.join(app_path, 'process', 'students.rb'),
+               :controller_path => File.join(app_path, 'controller',
+                                             'yaml_students.rb') }
 
 # now we changed from mock to our own controller, located in
 # controller/yaml_students.rb
 #  student_core = Lorj::Core.new(nil, processes, :mock)
 config = Lorj::Config.new
 config[:connection_string] = '/tmp/students.yaml'
-student_core = Lorj::Core.new(config, processes, controller)
+student_core = Lorj::Core.new(config, processes)
 
 # Ask the framework to create the object student 'Robert Redford'
 student_core.create(:student, :student_name => 'Robert Redford')

data/example/students_4/controller/yaml_students_def.rb

@@ -41,7 +41,7 @@ class YamlStudents
   define_obj(:connection,
              # Nothing complex to do. So, simply call the controller create.
              :create_e => :controller_create
-  )
+            )
 
   obj_needs :data,   :connection_string,  :mapping => :file_name
   undefine_attribute :id    # Do not return any predefined ID

data/example/students_4/process/students/definition/students.rb

@@ -30,7 +30,7 @@ class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
              :get_e => :controller_get,
              # 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.

data/example/students_4/students.rb

@@ -30,15 +30,17 @@ PrcLib.level = Logger::DEBUG # Printed out to your console.
 PrcLib.core_level = 3 # framework debug levels.
 
 # Initialize the framework
-processes = [File.join(app_path, 'process', 'students.rb')]
-controller = File.join(app_path, 'controller', 'yaml_students.rb')
+processes = []
+processes << { :process_path => File.join(app_path, 'process', 'students.rb'),
+               :controller_path => File.join(app_path, 'controller',
+                                             'yaml_students.rb') }
 
 # now we changed from mock to our own controller, located in
 # controller/yaml_students.rb
 #  student_core = Lorj::Core.new(nil, processes, :mock)
 config = Lorj::Config.new
 config[:connection_string] = '/tmp/students.yaml'
-student_core = Lorj::Core.new(config, processes, controller)
+student_core = Lorj::Core.new(config, processes)
 
 # Ask the framework to create the object student 'Robert Redford'
 student_core.create(:student, :student_name => 'Robert Redford')

data/example/students_5/controller/yaml_students.rb

@@ -70,7 +70,7 @@ class YamlStudents
   define_obj(:connection,
              # Nothing complex to do. So, simply call the controller create.
              :create_e => :controller_create
-  )
+            )
 
   obj_needs :data,   :connection_string,  :mapping => :file_name
   undefine_attribute :id    # Do not return any predefined ID

data/example/students_5/process/students.rb

@@ -149,7 +149,7 @@ module Lorj
                :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.

data/example/students_5/student_v5.md

@@ -136,12 +136,12 @@ This is a simple basic translation of `examples/yaml_students/students.rb`
     # PrcLib.level = Logger::DEBUG # Printed out to your console.
     # PrcLib.core_level = 3 # framework debug levels. Values between 0 to 5.
 
+    processes = []
+    processes << { :process_path => File.join(app_path, 'process', 'students.rb'),
+                   :controller_path => File.join(app_path, 'controller', 'yaml_students.rb') }
     # Initialize the framework
-    hProcesses = [ File.join($APP_PATH, 'process', 'students.rb')]
 
-    # You can try with mock instead. uncomment the next line and comment 2 next lines.
-    #~ oStudentCore = Lorj::Core.new( nil, hProcesses, :mock)
-    oStudentCore = Lorj::Core.new( nil, hProcesses, File.join($APP_PATH, 'controller', 'yaml_students.rb'))
+    oStudentCore = Lorj::Core.new( nil, processes)
     oStudentCore.Create(:connection, :connection_string => "/tmp/students.yaml")
 
     puts ANSI.bold("Create 1st student:")

data/example/students_5/students.rb

@@ -50,11 +50,12 @@ config = Lorj::Config.new # Use Simple Config Object
 #  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')
-
+processes = []
+processes << { :process_path => File.join(app_path, 'process', 'students.rb'),
+               :controller_path => 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 = Lorj::Core.new(config, processes)
 
 student_core.create(:connection, :connection_string => '/tmp/students.yaml')
 
@@ -79,7 +80,7 @@ student_core.create(:student,
                     :first_name => 'Anthony',
                     :last_name => 'Hopkins',
                     :course => 'Art Drama'
-)
+                   )
 # config[:student_name] = "Anthony Hopkins"
 # config[:course] = "Art Drama"
 # student_core.Create(:student)
@@ -90,7 +91,7 @@ student_core.create(:student,
                     :first_name => 'Marilyn',
                     :last_name => 'Monroe',
                     :course => 'Art Drama'
-)
+                   )
 # replaced the following :
 # config[:student_name] = "Anthony Hopkins"
 # student_core.Create(:student)
@@ -101,7 +102,7 @@ student = student_core.create(:student,
                               :first_name => 'Anthony',
                               :last_name => 'Mistake',
                               :course => 'what ever you want!!!'
-)
+                             )
 
 puts format("Student created '%s'", student[:attrs])
 

data/example/yaml_students/students.rb

@@ -31,7 +31,7 @@ if school.query_student(:name => 'Robert Redford').length == 0
                         :first_name => 'Robert',
                         :last_name => 'Redford',
                         :training => 'Art Comedy'
-  )
+                       )
 end
 
 puts ANSI.bold('Create 2nd student:')
@@ -40,7 +40,7 @@ if school.query_student(:name => 'Anthony Hopkins').length == 0
                         :first_name => 'Anthony',
                         :last_name => 'Hopkins',
                         :training => 'Art Drama'
-  )
+                       )
 end
 
 puts ANSI.bold('Create 3rd student:')
@@ -49,7 +49,7 @@ if school.query_student(:name => 'Marilyn Monroe').length == 0
                         :first_name => 'Marilyn',
                         :last_name => 'Mistake',
                         :training => 'Art Drama'
-  )
+                       )
 end
 
 puts ANSI.bold('Create mistake')
@@ -57,7 +57,7 @@ student = school.create_student('Anthony Mistake',
                                 :first_name => 'Anthony',
                                 :last_name => 'Mistake',
                                 :training => 'what ever you want!!!'
-)
+                               )
 
 puts format("Student created: '%s'", student)
 

data/lib/core/core.rb

@@ -268,8 +268,8 @@ module Lorj
     #
     # * *Args* :
     #   - +oCloudObj+    : Name of the object to initialize.
-    #   - +sAccountName+ : Account file name. If not set, Config[:account_name]
-    #                      is used.
+    #   - +sAccountName+ : Obsolete. You have to load the account data before
+    #
     #     If you use this variable, any other runtime config defined
     #     by the Data model will be cleaned before
     #
@@ -279,40 +279,37 @@ module Lorj
     # * *Raises* :
     #   No exceptions
 
-    def setup(oCloudObj, sAccountName = nil)
+    def setup(oCloudObj, _sAccountName = nil)
       return nil if !oCloudObj || !@core_object
-      @core_object.process_setup(oCloudObj, sAccountName)
+      @core_object.process_setup(oCloudObj)
     end
 
     # Core parameters are:
     # the_config : Optional. An instance of a configuration system which *HAVE*
     # to provide get/set/exist?/[]/[]=
     #
-    # processClass: Array of string or symbol, or string or symbol. Is the path
-    # or name of one or more ProcessClass to use.
-    #   This class is dynamically loaded and derived from BaseProcess class.
-    #   It loads the Process class content from a file
-    #   '$CORE_PROCESS_PATH/<process_class>.rb'
-    #   If process_class is a file path, this file will be loaded as a ruby
-    #   include.
-    #
-    #   <process_class>.rb file name is case sensible and respect RUBY Class
-    #   name convention
-    #
-    # controller_class: Optional. string or symbol. Is the path or name of
-    #                   ControllerClass to use.
-    #   This class is dynamically loaded and derived from BaseController class.
-    #   It loads the Controler class content from a file
-    #   '$PROVIDER_PATH/<controller_class>.rb'
-    #
-    #   The provider can redefine partially or totally some processes
-    #   Lorj::Core will load those redefinition from file:
-    #   $PROVIDER_PATH/<controller_class>Process.rb'
-    #
-    # <controller_class>.rb or <controller_class>Process.rb file name is case
-    # sensible and respect RUBY Class name convention
-    def initialize(the_config = nil, the_process_class = nil,
-                   controller_class = nil)
+    # * *Args*:
+    # - +Processes+: Array of processes with controller
+    #   This array, contains a list of process to load and optionnaly a
+    #   controller.
+    #
+    #   You can define your own process or a process module.
+    #   The array is structured as follow:
+    #   - each element contains a Hash with:
+    #     If you are using a process module, set the following:
+    #     - :process_module : Name of the process module to load
+    #
+    #     If you are not using a Process module, you need to set the following:
+    #     - :process_path   : Path to a local process code.
+    #       This path must contains at least 'process' subdir. And if needed
+    #       a 'controllers' path
+    #     - :process_name   : Name of the local process
+    #
+    #     Optionnally, you can set a controller name to use with the process.
+    #     - :controller_name: Name of the controller to use.
+    #     - :controller_path: Path to the controller file.
+    #
+    def initialize(the_config = nil, processes = nil, controller_class = nil)
       # Loading ProcessClass
       # Create Process derived from respectively BaseProcess
       PrcLib.core_level = 0 if PrcLib.core_level.nil?
@@ -323,65 +320,114 @@ module Lorj
 
       model = initialize_model
 
+      # Compatibility with old 'new syntax'
+      # `processes` will get an Array of string/symbol or simply a string/symbol
+      # `controller_class` is used to define the controller to load.
+      # string/symbol
+      processes = adapt_core_parameters(processes, controller_class)
+
       # Load Application processes
-      init_processes(model, the_process_class)
+      init_processes(model, processes)
 
       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
-
       # Create Core object with the application model loaded
       # (processes & controller)
       initialize_core_object(model)
       PrcLib.model.clear_heap
     end
-  end
 
-  # This class based on generic Core, defines a Cloud Process to use.
-  class CloudCore < Core
-    def initialize(oConfig, sAccount = nil, aProcesses = [])
-      config_account = init_config(oConfig, sAccount)
+    private
 
-      process_list = [:cloud_process]
+    # This function is used to keep compatibility with old way to load
+    # processes and controllers
+    # If processes is a Array of Hash => new way
+    # otherwise we need to create it.
+    def adapt_core_parameters(processes, controller)
+      return [] unless processes.is_a?(Array)
 
-      controller_mod = config_account.get(:provider)
+      return [] if processes.length == 0
+      return processes if processes[0].is_a?(Hash)
 
-      controller_mod = config_account.get(:provider_name) if controller_mod.nil?
+      PrcLib.warning('lorj initialization with Process & controller parameters'\
+                     ' is obsolete. Read Lorj::Core.new to update it and '\
+                     'eliminate this warning')
 
-      PrcLib.runtime_fail 'Provider_name not set. Unable to create'\
-                           ' instance CloudCore.' if controller_mod.nil?
+      # Declare processes
+      processes = processes_as_array(processes)
 
-      init_controller_mod(process_list, controller_mod)
+      processes_built = []
 
-      super(config_account, process_list.concat(aProcesses), controller_mod)
-    end
+      processes.each do |process|
+        process = process.to_s if process.is_a?(Symbol)
+        a_process = {}
 
-    private
+        if process.include?('/')
+          a_process[:process_path] = process
+          a_process[:process_name] = File.basename(process)
+        else
+          a_process[:process_module] = process
+        end
+        processes_built << a_process
+      end
 
-    def init_config(oConfig, sAccount)
-      if oConfig.is_a?(Lorj::Account)
-        config_account = oConfig
-      else
-        config_account = Lorj::Account.new(oConfig)
+      _adapt_with_controller(processes_built, controller)
 
-        config_account.ac_load(sAccount) unless sAccount.nil?
-      end
-      config_account
+      processes_built
     end
 
-    def init_controller_mod(process_list, controller_mod)
-      # TODO: Support for process full path, instead of predefined one.
-      controller_process_mod = File.join(PrcLib.controller_path, controller_mod,
-                                         controller_mod.capitalize +
-                                         'Process.rb')
-      if File.exist?(controller_process_mod)
-        process_list << controller_process_mod
+    def _adapt_with_controller(processes_built, controller)
+      return if controller.nil?
+
+      if controller.include?('/')
+        processes_built[-1][:controller_path] = controller
+        processes_built[-1][:controller_name] = File.basename(controller)
       else
-        Lorj.debug(1, format("No Provider process defined. File '%s' not "\
-                             'found.', controller_process_mod))
+        processes_built[-1][:controller_name] = controller
       end
     end
   end
+
+  module_function
+
+  # Any Lorj process module will need to declare itself to Lorj
+  # with this function.
+  #
+  # * *args* :
+  #   - +process_name+: name of the process declared to Lorj. This name must be
+  #     unique. Otherwise the declaration won't happen.
+  #
+  #   - +path+        : Path where process dir structure are located.
+  #     at least, it expects to find the process/<name>.rb
+  #     Each controllers found will be added as well.
+  #     It must be controllers/<controller_name>/<controller_name>.rb
+  #     You can change 'controllers' by any name, with :controllers_dir
+  #
+  #   - +properties   : Optional.
+  #     - :controllers_dir : Name of the controllers directory.
+  #       By default 'controllers'
+  #
+  #  The process will be added in Lorj.processes Hash
+  #
+  def declare_process(process_name, path, properties = {})
+    process_data = Lorj::ProcessResource.new(process_name, path, properties)
+
+    return nil if process_data.nil?
+
+    @processes = {} if @processes.nil?
+
+    return nil if process_data.process.nil?
+
+    process_name = process_data.name
+
+    @processes[process_name] = process_data unless @processes.key?(process_name)
+
+    process_data
+  end
+
+  # Define module data for lorj library configuration
+  class << self
+    attr_reader :processes
+  end
 end