lorj 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed752c1a4519969b83c7f240f0ecbd36e1b5c691
-  data.tar.gz: 1e7dd04ad2bedb015039056a6c6cc3e373c37c22
+  metadata.gz: 63d7eabf0a0bfe1c20a49ea78ad77a37b6b5e521
+  data.tar.gz: 5170b2123e123a05028cd52cad7af4d1288acc09
 SHA512:
-  metadata.gz: c6cd78cba3f041dd7982afc192776075a9e3548195f0d8984dd194645b248986e21ccabbbee5015eb166812a89251ae553514e3247bd9780c1acd9f41c25042b
-  data.tar.gz: 6f42a29853960ae4778c3751226b56775ede547911a3bd691b14cf6297df4049c358ea66c1c3528c040c20e4c76a877540bc99f9d4294ce20d766c6bd76f5dae
+  metadata.gz: 88a9a2866f706cf5183caf65cce95bbeffec6073fc47b2457c233a28bc73d4fe175aade0ae4410e42eb050ac52f5ea1da782c2e1a1404f0a673c575acb2e959e
+  data.tar.gz: 96ec48620a59cc39ea1307fcea13e04eeb2a703d1466338cf18b74ecfac225caabe85e0ef2c1a61b4359fa1f0621bf46b2589c260ec3d2f54da277391806ea7c

data/example/students_1/students.rb

@@ -15,14 +15,13 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-if ENV['BYEBUG']
-  require 'byebug'
-  lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
-  $LOAD_PATH << lib_path
-end
-
 app_path = File.dirname(__FILE__)
 
+lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+$LOAD_PATH << lib_path
+
+require 'byebug' if ENV['BYEBUG']
+
 require 'lorj'
 
 # If you want to see what is happening in the framework, uncomment debug

data/example/students_2/students.rb

@@ -17,11 +17,10 @@
 
 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
+lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+$LOAD_PATH << lib_path
+
+require 'byebug' if ENV['BYEBUG']
 
 require 'lorj'
 

data/example/students_3/students.rb

@@ -17,11 +17,10 @@
 
 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
+lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+$LOAD_PATH << lib_path
+
+require 'byebug' if ENV['BYEBUG']
 
 require 'lorj'
 

data/example/students_4/students.rb

@@ -17,11 +17,10 @@
 
 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
+lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+$LOAD_PATH << lib_path
+
+require 'byebug' if ENV['BYEBUG']
 
 require 'lorj'
 

data/example/students_5/students.rb

@@ -17,11 +17,11 @@
 
 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
+lib_path = File.expand_path(File.join(app_path, '..', '..', 'lib'))
+$LOAD_PATH << lib_path
+
+require 'byebug' if ENV['BYEBUG']
+
 require 'lorj'
 require 'ansi'
 

data/lib/core/core.rb

@@ -319,6 +319,8 @@ module Lorj
 
       init_core_config(the_config)
 
+      PrcLib.model.config = @config
+
       model = initialize_model
 
       # Load Application processes
@@ -344,7 +346,10 @@ module Lorj
 
       process_list = [:cloud_process]
 
-      controller_mod = config_account.get(:provider_name)
+      controller_mod = config_account.get(:provider)
+
+      controller_mod = config_account.get(:provider_name) if controller_mod.nil?
+
       PrcLib.runtime_fail 'Provider_name not set. Unable to create'\
                            ' instance CloudCore.' if controller_mod.nil?
 

data/lib/core/core_controller.rb

@@ -12,15 +12,7 @@
 #    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.
+# - controler functions: controller functions called by Lorj::BaseProcess.
 module Lorj
   # Adding controller core functions.
   class BaseDefinition

data/lib/core/core_internal.rb

@@ -16,7 +16,8 @@
 
 # rubocop: disable Metrics/AbcSize
 
-# Module Lorj which contains several classes.
+# - Lorj::Core : Lorj exposed interface.
+#   - Initialization functions
 module Lorj
   # Define private initialize functions for processes
   class Core

data/lib/core/core_model.rb

@@ -18,20 +18,12 @@
 
 # TODO: Move most declaration functions to Model class for simplification.
 
-# 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::Model : Model class reference.
 module Lorj
   # Model Object
   class Model
     attr_accessor :meta_obj, :meta_data, :meta_predefined_values
-    attr_accessor :query_auto_map
+    attr_accessor :query_auto_map, :config
 
     # Model initialisation
     def initialize

data/lib/core/core_object_data.rb

@@ -78,6 +78,24 @@ module Lorj
       @params = {}
       @params[:hdata] = {} unless internal
       @internal = internal
+      @refresh = nil
+    end
+
+    # Refresh setting
+    #
+    # This function is used to provide capability to an Object to be refreshed
+    # from Lorj Cache.
+    #
+    def refresh_set(base_def_instance, object_type, sEventType, as_controller)
+      @refresh = { :bd_obj => base_def_instance, :object_type => object_type,
+                   :event_type => sEventType, :controller => as_controller
+                 }
+    end
+
+    def refresh
+      return self if @refresh.nil?
+      # Do the refresh itself.
+      @refresh[:bd_obj].update_params(self, @refresh)
     end
 
     # Get function

data/lib/core/core_object_params.rb

@@ -15,9 +15,29 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+# Lorj implements Lorj::BaseDefinition core internal functions
 module Lorj
   # Class Definition internal function.
   class BaseDefinition
+    # function to update an existing ObjectData used as parameters to
+    # process or controller
+    #
+    # *parameters*:
+    # - data_to_refresh: ObjectData to refresh
+    # - refresh_par    : Hash providing the parameter context used to refresh it
+    #
+    # *return*:
+    # - data refreshed.
+    #
+    def update_params(data_to_refresh, refresh_par) # :nodoc:
+      object_type = refresh_par[:object_type]
+      event_type = refresh_par[:event_type]
+      as_controller = refresh_par[:controller]
+
+      _get_object_params(object_type, event_type, __callee__, as_controller,
+                         data_to_refresh)
+    end
+
     private
 
     # internal runtime function for process call
@@ -67,6 +87,8 @@ module Lorj
     #   - +new_params+    : Parameters ObjectData
     #   - +param_obj+     : parameter object
     #   - +param_options+ : parameter options
+    #     - :type   : hdata requires parameters to be :data.
+    #     - :decrypt: true if the data needs to be decrypted automatically.
     #   - +value+         : value to add in hdata Hash.
     #
     # *return*:
@@ -89,6 +111,10 @@ module Lorj
         value = value_mapping[value]
       end
 
+      if param_options[:decrypt].is_a?(TrueClass)
+        value = _get_encrypted_value(value, _get_encrypt_key)
+      end
+
       return unless param_options[:mapping]
 
       # NOTE: if mapping is set, the definition subtree
@@ -111,7 +137,7 @@ module Lorj
     #
     #
     # *return*:
-    # - value : return the parameter value.
+    # - value : return the parameter value or nil if is :CloudObject type.
     #
     # *raise*:
     #
@@ -126,7 +152,7 @@ module Lorj
            @object_data.type?(param_name) != :DataObject
           PrcLib.runtime_fail "Object '%s/%s' is not defined. '%s' "\
                                'requirement failed.',
-                              self.class, param_name, fname
+                              self.class, param_name, __callee__
         end
         if @object_data.exist?(param_name)
           new_params.add(@object_data[param_name, :ObjectData])
@@ -179,6 +205,10 @@ module Lorj
       _get_object_params(object_type, sEventType, fname, true)
     end
 
+    # TODO: Fix the Complexity
+    # rubocop: disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/PerceivedComplexity
+
     # internal runtime function for process call
     # Build a process/controller parameters object (ObjectData)
     #
@@ -197,7 +227,8 @@ module Lorj
     # *raise*:
     # - runtime error if required data is not set. (empty or nil)
     #
-    def _get_object_params(object_type, sEventType, fname, as_controller)
+    def _get_object_params(object_type, sEventType, fname, as_controller,
+                           new_params = nil)
       # Building handler parameters
       # hdata is built for controller. ie, ObjectData is NOT internal.
 
@@ -206,7 +237,9 @@ module Lorj
       PrcLib.runtime_fail "%s:'%s' Object data needs not set. Forgot "\
                            'obj_needs?', fname, object_type if obj_params.nil?
 
-      new_params = _obj_param_init(object_type, sEventType, as_controller)
+      if new_params.nil?
+        new_params = _obj_param_init(object_type, sEventType, as_controller)
+      end
 
       obj_params.each do |param_path, param_options|
         if param_options.key?(:for)
@@ -221,9 +254,15 @@ module Lorj
           _build_hdata(object_type, new_params, param_obj, param_options, value)
         end
       end
+      unless fname == :update_params
+        new_params.refresh_set(self, object_type, sEventType, as_controller)
+      end
       new_params
     end
 
+    # rubocop: enable Metrics/CyclomaticComplexity
+    # rubocop: enable Metrics/PerceivedComplexity
+
     # Internal runtime function for process call
     #
     # initialize Object parameters object (ObjectData)

data/lib/core/core_process.rb

@@ -12,15 +12,7 @@
 #    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.
+# - process functions: Process functions called by Core or BaseProcess.
 module Lorj
   # Adding process core functions.
   class BaseDefinition

data/lib/core/core_process_setup.rb

@@ -124,7 +124,7 @@ module Lorj
 
       setup_steps = _setup_load
 
-      @config.ac_load(sAccountName) if sAccountName
+      return nil unless _process_setup_init(sAccountName)
 
       Lorj.debug(2, "Setup is identifying account data to ask for '%s'",
                  sObjectType)
@@ -137,10 +137,36 @@ module Lorj
       Lorj.debug(2, "Setup will ask for :\n %s", setup_steps.to_yaml)
 
       _setup_ask(setup_steps)
-      PrcLib.info("Configuring account : '#{config[:account_name]}',"\
+
+      PrcLib.info("Configuring account : '#{sAccountName}',"\
                   " provider '#{config[:provider_name]}'")
     end
 
+    private
+
+    # Internal function to initialize the account.
+    #
+    # return true if initialized, false otherwise.
+    def _process_setup_init(sAccountName)
+      return false unless sAccountName
+
+      if @config.ac_load(sAccountName)
+        if @config[:provider] != @config[:provider_name]
+          s_ask = format("Account '%s' was configured with a different "\
+                         "provider '%s'.\nAre you sure to re-initialize this "\
+                         "account with '%s' provider instead? "\
+                         'All data will be lost',
+                         sAccountName, @config[:provider],
+                         @config[:provider_name])
+          PrcLib.fatal(0, 'Exited by user request.') unless agree(s_ask)
+          @config.ac_new(sAccountName, config[:provider_name])
+        end
+      else
+        @config.ac_new(sAccountName, config[:provider_name])
+      end
+      true
+    end
+
     # Internal function to insert the data after several data to ask.
     #
     # * *Args* :
@@ -191,7 +217,7 @@ module Lorj
     # * *Raises* :
     #
     def _setup_data_after(data_to_check)
-      meta = _get_meta_data_auto(data_to_check)
+      meta = _get_meta_data(data_to_check)
       return [] unless meta.rh_exist?(:after)
 
       datas_after = meta[:after]
@@ -240,7 +266,7 @@ module Lorj
         return false
       end
 
-      meta = _get_meta_data_auto(attr_name)
+      meta = _get_meta_data(attr_name)
       return false unless meta.is_a?(Hash)
 
       ask_step = 0
@@ -273,7 +299,7 @@ module Lorj
     # parameters:
     # - +order_array+ : array of levels of attributes ordered.
     # - +attr_name+   : attribute name
-    # - +depends_on+  : Dependendy Array.
+    # - +depends_on+  : Dependency Array.
     #
     # return:
     # - level_index to use.
@@ -284,7 +310,7 @@ module Lorj
                        attr_name) unless depends_on.nil?
         0
       else
-        _setup_find_dep_level(order_array, meta[:depends_on])
+        _setup_find_dep_level(order_array, depends_on)
       end
     end
 

data/lib/core/core_setup_ask.rb

@@ -34,12 +34,13 @@ module Lorj
     # new value
     #
     # * *Args* :
-    #  - +desc+   : Data description
-    #  - +data+   : Data to ask.
-    #  - +options+: list and validation options
+    #   - +desc+   : Data description
+    #   - +data+   : Data to ask.
+    #   - +options+: list and validation options
+    #     - +:post_step_function+ : Call a post process function.
     #
     # * *Returns*:
-    #   - value : value entered by the end user.
+    #   - nothing
     #
     # * *Raises* :
     #
@@ -52,22 +53,34 @@ module Lorj
                                             desc, options)
         end
 
-        @config.set(data, value)
-
+        # @config.set(data, value) ??? Why do we need that???
         section = _get_account_section(data)
-        @config.set(data, value, :name =>
-                    'account', :section => section) unless section.nil?
+        # We set the value only if there is a value entered by the user.
+        unless section.nil? || value.nil?
+          @config.set(data, value, :name => 'account', :section => section)
+        end
 
-        break if options[:post_step_function].nil?
+        result = _setup_ask_post_process(options[:post_step_function])
+        break unless result.is_a?(FalseClass)
+      end
+    end
 
-        proc = options[:post_step_function]
-        result = @process.method(proc).call
+    # Execute the post process on data entered by the user
+    #
+    # * *returns*
+    #   - false if the process ask the user to re-enter a value.
+    #   - true otherwise.
+    def _setup_ask_post_process(proc)
+      return true if proc.nil?
 
-        PrcLib.debug("Warning: '%s' did not return any boolean"\
-                     ' value. Ignored', proc) unless result.boolean?
+      result = @process.method(proc).call
 
-        break unless result.is_a?(FalseClass)
+      unless result.boolean?
+        PrcLib.debug("Warning: '%s' did not return any boolean"\
+                     ' value. Ignored', proc)
+        result = true
       end
+      result
     end
 
     # Internal setup function to ask to the end user from a list.
@@ -173,12 +186,14 @@ module Lorj
     # Internal setup function to ask to the end user.
     #
     # * *Args* :
-    #  - +desc+   : Data description
-    #  - +data+   : Data to ask.
-    #  - +options+: list and validation options
+    #   - +desc+   : Data description
+    #   - +data+   : Data to ask.
+    #   - +options+: list and validation options
+    #     - :ask_function: Replace the _ask default call by a process function
+    #       This function should return a string or nil, if no value.
     #
     # * *Returns*:
-    #   - value : value entered by the end user.
+    #   - value : value entered by the end user or nil if no value.
     #
     # * *Raises* :
     #
@@ -196,24 +211,11 @@ module Lorj
       proc_ask = options[:ask_function]
 
       if proc_ask.nil?
-        # proc_method = _ask(desc, default, valid_regex,
-        #                    is_encrypted, is_required)
-        value = _ask(desc, default, valid_regex,
-                     is_encrypted, is_required)
+        value = _ask(desc, default, valid_regex, is_encrypted, is_required)
       else
-        # proc_method = @process.method(proc_ask)
         value = @process.method(proc_ask)
       end
-
-      # loop do
-      #   value = proc_method.call(desc, default, valid_regex,
-      #                            is_encrypted, is_required)
-      #   break if validate_proc.nil?
-
-      #   validate_method = @process.method(validate_proc)
-      #   break if validate_method.call(value)
-      # end
-      value
+      _nil_if_no_value(value)
     end
 
     # internal runtime function for process call
@@ -247,5 +249,11 @@ module Lorj
       end
       value.to_s
     end
+
+    # Internal function to return nil if value is empty.
+    def _nil_if_no_value(value)
+      return nil if value.nil? || value == ''
+      value
+    end
   end
 end

data/lib/core/core_setup_encrypt.rb

@@ -83,12 +83,7 @@ module Lorj
       return '' if enc_value.nil?
       value_hidden = ''
       begin
-        value_hidden = '*' * Encryptor.decrypt(
-          :value => Base64.strict_decode64(enc_value),
-          :key => entr[:key],
-          :iv => Base64.strict_decode64(entr[:iv]),
-          :salt => entr[:salt]
-        ).length
+        value_hidden = '*' * _get_encrypted_value(enc_value, entr).length
       rescue
         PrcLib.error('Unable to decrypt your %s. You will need to re-enter it.',
                      sDesc)
@@ -99,6 +94,34 @@ module Lorj
       value_hidden
     end
 
+    # internal runtime function for process call #_build_hdata and
+    # #_get_encrypted_value_hidden
+    # Get encrypted value
+    #
+    # *parameters*:
+    #   - +default+     : encrypted default value
+    #   - +entropy+     : Entropy Hash
+    #
+    # *return*:
+    # - value : decrypted value.
+    #
+    # *raise*:
+    #
+    def _get_encrypted_value(enc_value, entr)
+      return '' if enc_value.nil?
+      begin
+        Encryptor.decrypt(
+          :value => Base64.strict_decode64(enc_value),
+          :key => entr[:key],
+          :iv => Base64.strict_decode64(entr[:iv]),
+          :salt => entr[:salt]
+        )
+      rescue
+        PrcLib.error('Unable to decrypt your %s. You will need to re-enter it.',
+                     sDesc)
+      end
+    end
+
     # internal runtime function for process call
     # Ask encrypted function executed by _ask
     #

data/lib/core/core_setup_init.rb

@@ -37,7 +37,7 @@ module Lorj
     # * *Raises* :
     #
     def _setup_load
-      ask_steps = Lorj.defaults.data.rh_get(:setup, :ask_step)
+      ask_steps = Lorj.data.setup_data(:ask_step)
       setup_steps = []
       ask_steps.each do |value|
         setup_steps << {
@@ -214,7 +214,7 @@ module Lorj
         order_array.each_index do |iIndex|
           Lorj.debug(2, 'Ask order %s:', iIndex)
           order_array[iIndex].each do |data|
-            options = _get_meta_data_auto(data)
+            options = _get_meta_data(data)
             options = {} if options.nil?
 
             data_desc = _setup_display_data(data, options)