eco-helpers 3.0.25 → 3.0.27

data/lib/eco/api/usecases/ooze_samples/register_update_case.rb

@@ -15,7 +15,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     end
   end
 
-  name "register-update-case"
+  name 'register-update-case'
   type :other
 
   attr_reader :retrieved_oozes, :non_retrieved_oozes
@@ -33,7 +33,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
           process_ooze(&block)
         end
       elsif mode == :delegate
-        raise "You need to pass a block when running main in `:delegate` mode" unless block_given?
+        raise 'You need to pass a block when running main in `:delegate` mode' unless block_given?
         yield
       end
     end
@@ -42,7 +42,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   end
 
   def process_ooze(_ooze = target)
-    raise "You need to define this method"
+    raise 'You need to define this method'
   end
 
   private
@@ -63,8 +63,8 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   def new_target(object, warn_pending_changes: false)
     enqueue(object)
-    super(object, warn_pending_changes: warn_pending_changes) do |pending|
-      #enqueue(pending)
+    super do |pending|
+      # enqueue(pending)
     end
   end
 
@@ -79,7 +79,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
         end
 
         if (pending = queue_shift(page_result.id)) && dirty?(pending)
-          msg  = "Inconsistent search results. "
+          msg  = 'Inconsistent search results. '
           msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
           log(:warn) { msg }
           update_ooze(pending)
@@ -186,7 +186,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   end
 
   def backup_patch!(ooze = target)
-    return if (patch_doc(ooze) || {})["page"]
+    return if (patch_doc(ooze) || {})['page']
 
     log(:info) {
       "No changes to update for #{object_reference(ooze)}."
@@ -198,17 +198,17 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
       @total_search_oozes = search_results.total
 
       str_results = "Total target entries: #{search_results.total} (out of #{search_results.total_before_filtering})"
-      default_answer = session.config.run_mode_remote?? "Y" : "N"
+      default_answer = session.config.run_mode_remote?? 'Y' : 'N'
 
       session.prompt_user(
-        "Do you want to proceed (y/N):",
+        'Do you want to proceed (y/N):',
         explanation: str_results,
         default:     default_answer,
         timeout:     10
       ) do |res|
-        next if res.upcase.start_with?("Y")
-        puts "..."
-        log(:info) { "Aborting script..." }
+        next if res.upcase.start_with?('Y')
+        puts '...'
+        log(:info) { 'Aborting script...' }
         exit(0)
       end
     end
@@ -233,7 +233,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   def kpis_message
     msg  = []
-    msg << "Run end:"
+    msg << 'Run end:'
     msg << "  * Search results: #{total_search_oozes}"
     msg << "  * Duplicated search results #{dupped_search_oozes}"
     msg << "  * Retrieved a total of #{retrieved_oozes}"
@@ -254,12 +254,13 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   end
 
   def conf_filters
-    return filters if respond_to?(:filters)
+    return filters if respond_to?(:filters, true)
+
     []
   end
 
   def conf_search
-    search if respond_to?(:search)
+    search if respond_to?(:search, true)
   end
 
   def register_id

data/lib/eco/api/usecases/samples/drivers/cli/sftp_cli.rb

@@ -1,45 +1,45 @@
 class  Eco::API::UseCases::Samples::Drivers::Sftp
   class Cli < Eco::API::UseCases::Cli
-    desc "SFTP case: manages remote files that match a file pattern"
+    desc 'SFTP case: manages remote files that match a file pattern'
 
-    add_option("-file-pattern-const", "Constant that should be used as a pattern") do |options|
-      pattern_const = SCR.get_arg("-file-pattern-const", with_param: true)
+    add_option('-file-pattern-const', 'Constant that should be used as a pattern') do |options|
+      pattern_const = SCR.get_arg('-file-pattern-const', with_param: true)
       options.deep_merge!(sftp: {file_pattern_const: pattern_const})
     end
 
-    add_option("-list", "It lists all the files present in the remote folder for the current environment.") do |options|
+    add_option('-list', 'It lists all the files present in the remote folder for the current environment.') do |options|
       options.deep_merge!(sftp: {command: :list})
     end
 
-    add_option("-get-last", "It gets the last file present in the remote folder for the current environment.") do |options|
+    add_option('-get-last', 'It gets the last file present in the remote folder for the current environment.') do |options|
       options.deep_merge!(sftp: {command: :get_last})
     end
 
-    add_option("-get", "It gets all the files present in the remote folder for the current environment.") do |options|
+    add_option('-get', 'It gets all the files present in the remote folder for the current environment.') do |options|
       options.deep_merge!(sftp: {command: :get})
     end
 
-    add_option("-archive", "It moves all the files present in the remote folder to the archive subfolder.") do |options|
+    add_option('-archive', 'It moves all the files present in the remote folder to the archive subfolder.') do |options|
       options.deep_merge!(sftp: {command: :archive})
     end
 
-    add_option("-local-folder", "Local folder to pull the remote files to.") do |options|
-      local_folder = SCR.get_file("-local-folder", required: true, should_exist: true)
+    add_option('-local-folder', 'Local folder to pull the remote files to.') do |options|
+      local_folder = SCR.get_file('-local-folder', required: true, should_exist: true)
       options.deep_merge!(sftp: {local_folder: local_folder})
     end
 
-    add_option("-remote-subfolder", "Remote sub folder to pull the remote files from.") do |options|
-      remote_subfolder = SCR.get_arg("-remote-subfolder", with_param: true)
+    add_option('-remote-subfolder', 'Remote sub folder to pull the remote files from.') do |options|
+      remote_subfolder = SCR.get_arg('-remote-subfolder', with_param: true)
       options.deep_merge!(sftp: {remote_subfolder: remote_subfolder})
     end
 
-    add_option("-remote-target-folder", "Overrides -remote-subfolder and -remote-folder.") do |options|
-      remote_target_folder = SCR.get_arg("-remote-target-folder", with_param: true)
+    add_option('-remote-target-folder', 'Overrides -remote-subfolder and -remote-folder.') do |options|
+      remote_target_folder = SCR.get_arg('-remote-target-folder', with_param: true)
       options.deep_merge!(sftp: {remote_target_folder: remote_target_folder})
     end
 
-    add_option("-remote-folder", "Overrides -remote-folder (but not -remote-subfolder).") do |options|
-      remote_folder = SCR.get_arg("-remote-folder", with_param: true)
+    add_option('-remote-folder', 'Overrides -remote-folder (but not -remote-subfolder).') do |options|
+      remote_folder = SCR.get_arg('-remote-folder', with_param: true)
       options.deep_merge!(sftp: {remote_folder: remote_folder})
     end
   end

data/lib/eco/api/usecases/samples/drivers/cli/url_pull_cli.rb

@@ -1,14 +1,14 @@
 class Eco::API::UseCases::Samples::Drivers::UrlPull
   class Cli < Eco::API::UseCases::Cli
-    desc "Url Pull sample: pull the file from a specific URL"
+    desc 'Url Pull sample: pull the file from a specific URL'
 
-    add_option("-target-url-const", "Constant that should be used as a pattern") do |options|
-      url_const = SCR.get_arg("-target-url-const", with_param: true)
+    add_option('-target-url-const', 'Constant that should be used as a pattern') do |options|
+      url_const = SCR.get_arg('-target-url-const', with_param: true)
       options.deep_merge!(url_pull: {target_url_const: url_const})
     end
 
-    add_option("-local-folder", "Local folder to pull the remote files to.") do |options|
-      local_folder = SCR.get_file("-local-folder", required: true, should_exist: true)
+    add_option('-local-folder', 'Local folder to pull the remote files to.') do |options|
+      local_folder = SCR.get_file('-local-folder', required: true, should_exist: true)
       options.deep_merge!(url_pull: {local_folder: local_folder})
     end
   end

data/lib/eco/api/usecases/samples/drivers/sftp_sample.rb

@@ -5,8 +5,8 @@ class Eco::API::UseCases::Samples::Drivers::Sftp < Eco::API::Common::Loaders::Us
   name 'sftp'
   type :other
 
-  include Eco::API::UseCases::Lib::Sftp
-  include Eco::API::UseCases::Lib::FilePattern
+  include Eco::API::UseCases::Lib::Files::Sftp
+  include Eco::API::UseCases::Lib::Files::FilePattern
 
   def main(session, options, _usecase)
     options[:end_get] = false

data/lib/eco/api/usecases/use_case.rb

@@ -106,32 +106,32 @@ module Eco
 
             if dt
               @data = dt
-              singleton_class.attr_reader(:data) unless respond_to?(:data)
+              singleton_class.attr_reader(:data) unless respond_to?(:data, true)
 
               case mdl
               when :people
                 @people = dt
-                singleton_class.attr_reader(:people) unless respond_to?(:people)
+                singleton_class.attr_reader(:people) unless respond_to?(:people, true)
               when :contractors
                 @contractors = dt
-                singleton_class.attr_reader(:contractors) unless respond_to?(:contractors)
+                singleton_class.attr_reader(:contractors) unless respond_to?(:contractors, true)
               end
             end
 
             if ent # entries/input
               @input = ent
-              singleton_class.attr_reader(:input) unless respond_to?(:input)
+              singleton_class.attr_reader(:input) unless respond_to?(:input, true)
 
               # Below problematic code... usage has cases where entries = (gets assigned)
               # @entries = ent
-              # singleton_class.attr_reader(:entries) unless respond_to?(:entries)
+              # singleton_class.attr_reader(:entries) unless respond_to?(:entries, true)
             end
 
             # `self` is the use case itself (when used the Loader)
             next unless is_a?(Eco::API::Common::Loaders::CaseBase)
 
             @usecase = use_case_self
-            singleton_class.attr_reader(:usecase) unless respond_to?(:usecase)
+            singleton_class.attr_reader(:usecase) unless respond_to?(:usecase, true)
           end
 
           true

data/lib/eco/api/usecases/use_case_chain/chaining.rb

@@ -37,10 +37,10 @@ class Eco::API::UseCases::UseCaseChain
       msg << "Looks like a recursive cyclic chain 'use'"
       raise msg if @@num_chains >= MAX_CHAINS
 
-      msg = "A UseCase can only be chained with another UseCase"
+      msg = 'A UseCase can only be chained with another UseCase'
       raise msg if usecase && !usecase.is_a?(UseCase)
 
-      msg = "Missuse. Please use either parameter or block but not both"
+      msg = 'Missuse. Please use either parameter or block but not both'
       raise msg if block_given? && usecase
 
       usecase = block if block_given?
@@ -51,7 +51,7 @@ class Eco::API::UseCases::UseCaseChain
     protected
 
     def chain_to(usecase)
-      msg = "A UseCase can only be chained with another UseCase"
+      msg = 'A UseCase can only be chained with another UseCase'
       raise msg if usecase && !usecase.is_a?(UseCase)
 
       usecase.chain(self)
@@ -60,7 +60,7 @@ class Eco::API::UseCases::UseCaseChain
     def resolved_chains(use_group = nil)
       return @resolved_chains if @resolved_chains
 
-      msg  = "Only Eco::API::UseCases object can contain resolved chains. "
+      msg  = 'Only Eco::API::UseCases object can contain resolved chains. '
       msg << "Given: #{use_group.class}"
       raise msg if use_group && !use_group.is_a?(Eco::API::UseCases)
 
@@ -68,7 +68,7 @@ class Eco::API::UseCases::UseCaseChain
       @resolved_chains = @chains.map do |usecase|
         usecase = usecase.call(use_group) if usecase.respond_to?(:call)
 
-        msg = "A UseCase can only be chained with another UseCase"
+        msg = 'A UseCase can only be chained with another UseCase'
         raise msg if usecase && !usecase.is_a?(UseCase)
 
         usecase.resolved_chains(use_group) if usecase.respond_to?(:resolved_chains)
@@ -81,7 +81,7 @@ class Eco::API::UseCases::UseCaseChain
     private
 
     def reset_chains!
-      @chains = []
+      @chains          = []
       @resolved_chains = nil
     end
   end

data/lib/eco/api/usecases/use_case_chain.rb

@@ -8,7 +8,7 @@ module Eco
 
         def initialize(name = nil, root:, type: nil, model: nil, usecase: nil, &block)
           if usecase
-            msg  = "Expected Eco::API::UseCases::UseCase. "
+            msg  = 'Expected Eco::API::UseCases::UseCase. '
             msg << "Given #{usecase.class}"
             raise msg unless usecase.is_a?(Eco::API::UseCases::UseCase)
 
@@ -25,14 +25,14 @@ module Eco
         def root=(value)
           return super unless @resolved_chains # rubocop:disable Lint/ReturnInVoidContext
 
-          msg = "You cannot change root Eco::API::UseCases "
-          msg << "once the chains have been resolved"
+          msg = 'You cannot change root Eco::API::UseCases '
+          msg << 'once the chains have been resolved'
           raise msg
         end
 
         # @see Eco::API::UseCases::UseCase#launch
         def launch(io: nil, **kargs)
-          super(io: io, **kargs).tap do |uio|
+          super.tap do |uio|
             next if resolved_chains.empty?
 
             resolved_chains.each do |usecase|

data/lib/eco/api/usecases/use_case_io.rb

@@ -27,6 +27,7 @@ module Eco
         def new(usecase:, **kargs)
           default = { usecase: usecase }
           default.merge!(job: @job) if @job
+
           super(**default.merge(kargs))
         end
 
@@ -59,7 +60,7 @@ module Eco
         # @see Eco::API::UseCases::BaseIO#params
         # Same as its superclass but adding `usecase` and `job` parameters
         def params(keyed: false, all: false)
-          super(keyed: keyed, all: all).tap do |res|
+          super.tap do |res|
             if keyed
               res.merge!(usecase: usecase)
               res.merge!(job: @job) if @job

data/lib/eco/api/usecases.rb

@@ -4,17 +4,17 @@ module Eco
     class UseCases
       class UnknownCase < StandardError
         def initialize(msg = nil, case_name: nil, type: nil)
-          msg ||= "Unknown case"
-          msg += ". Case name '#{case_name}'" if case_name
-          msg += ". Case type '#{type}'" if type
+          msg ||= 'Unknown case'
+          msg  << ". Case name '#{case_name}'" if case_name
+          msg  << ". Case type '#{type}'" if type
           super(msg)
         end
       end
 
       class AmbiguousCaseReference < StandardError
         def initialize(msg = nil, case_name: nil)
-          msg ||= "You must specify type when there are multiple cases with same name"
-          msg += ". Case name '#{case_name}'" if case_name
+          msg ||= 'You must specify type when there are multiple cases with same name'
+          msg  << ". Case name '#{case_name}'" if case_name
           super(msg)
         end
       end
@@ -22,8 +22,8 @@ module Eco
       extend  Eco::API::Common::ClassAutoLoader
       include Enumerable
 
-      autoloads_children_of "Eco::API::Common::Loaders::UseCase"
-      autoload_namespace_ignore "Eco::API"
+      autoloads_children_of 'Eco::API::Common::Loaders::UseCase'
+      autoload_namespace_ignore 'Eco::API'
 
       def initialize
         @usecases      = {}
@@ -160,11 +160,11 @@ module Eco
       end
 
       def name(key)
-        key.to_s.split(":").first
+        key.to_s.split(':').first
       end
 
       def type
-        key.to_s.split(":").last&.to_sym
+        key.to_s.split(':').last&.to_sym
       end
     end
   end

data/lib/eco/cli/config/options_set.rb

@@ -17,16 +17,16 @@ module Eco
         def help(refine: nil)
           indent     = 2
           spaces     = any_non_general_space_active? ? active_namespaces : namespaces
-          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ''
 
           ["The following are the available options#{refinement}:"].then do |lines|
             max_len = keys_max_len(options_args(spaces)) + indent
 
             spaces.each do |namespace|
               is_general = (namespace == :general)
-              str_indent = is_general ? "" : " " * indent
+              str_indent = is_general ? '' : ' ' * indent
 
-              lines << help_line(namespace, "", max_len) unless is_general
+              lines << help_line(namespace, '', max_len) unless is_general
 
               options_set(namespace).select do |_arg, option| # rubocop:disable Style/HashEachMethods
                 !refine.is_a?(String) || option.name.include?(refine)
@@ -63,7 +63,7 @@ module Eco
         # @param namespace [String] preceding command(s) argument that enables this option.
         # @param desc [String] description of the option.
         def add(option, desc = nil, namespace: :general, &block)
-          raise "Missing block to define the options builder" unless block_given?
+          raise 'Missing block to define the options builder' unless block_given?
 
           opts = [option].flatten.compact
           return self if opts.empty?

data/lib/eco/cli/config/use_cases.rb

@@ -27,7 +27,7 @@ module Eco
 
         # @return [String] summary of the use cases.
         def help(refine: nil)
-          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ''
 
           ["The following are the available use cases#{refinement}:"].then do |lines|
             max_len = keys_max_len(@linked_cases.keys)
@@ -103,7 +103,7 @@ module Eco
           processed = false
 
           active(io: io).each do |usecase, data|
-            raise "Something went wrong when scoping active cases" unless data
+            raise 'Something went wrong when scoping active cases' unless data
 
             processed = true
             io = case_io(io: io, usecase: usecase)
@@ -154,7 +154,7 @@ module Eco
         def validate_io!(io)
           return if io.is_a?(Eco::API::UseCases::BaseIO)
 
-          msg  = "You need to provide Eco::API::UseCases::BaseIO object. "
+          msg  = 'You need to provide Eco::API::UseCases::BaseIO object. '
           msg << "Given: #{io.class}"
           raise ArgumentError, msg
         end

data/lib/eco/cli/scripting/argument.rb

@@ -6,7 +6,7 @@ module Eco
 
         class << self
           def is_modifier?(value)
-            value&.start_with?("-")
+            value&.start_with?('-')
           end
         end
 

data/lib/eco/cli_default/input.rb

@@ -1,20 +1,20 @@
 class Eco::CliDefault::Input < Eco::API::Common::Loaders::CliConfig
   FORMATS = {
     csv:  {
-      option:  ["-csv"],
-      extname: [".csv", ".txt"]
+      option:  ['-csv'],
+      extname: ['.csv', '.txt']
     },
     xml:  {
-      option:  ["-xml"],
-      extname: [".xml"]
+      option:  ['-xml'],
+      extname: ['.xml']
     },
     xls:  {
-      option:  ["-xls", "-xlsx", "-excel"],
-      extname: [".xls", ".xlsx", ".xlsm"]
+      option:  ['-xls', '-xlsx', '-excel'],
+      extname: ['.xls', '.xlsx', '.xlsm']
     },
     json: {
-      option:  ["-json"],
-      extname: [".json"]
+      option:  ['-json'],
+      extname: ['.json']
     }
   }.freeze
 
@@ -45,7 +45,7 @@ class Eco::CliDefault::Input < Eco::API::Common::Loaders::CliConfig
     end
   end
 
-  input(default_option: "-entries-from") do |session, str_opt, options|
+  input(default_option: '-entries-from') do |session, str_opt, options|
     @options = options
     @session = session
     input    = []