eco-helpers 3.0.19 → 3.0.21

data/lib/eco/api/session.rb

@@ -70,6 +70,7 @@ module Eco
       )
         if live && api?(version: :graphql)
           return live_tree(include_archived: include_archived, **kargs, &block) unless merge
+
           live_trees(include_archived: include_archived, **kargs, &block).inject(&:merge)
         else
           config.tagtree(recache: recache)
@@ -118,10 +119,12 @@ module Eco
       # @return [Eco::Data::Mapper] the mappings between the internal and external attribute/property names.
       def fields_mapper
         return @fields_mapper if instance_variable_defined?(:@fields_mapper)
+
         mappings = []
         if (map_file = config.people.fields_mapper)
           mappings = map_file ? file_manager.load_json(map_file) : []
         end
+
         @fields_mapper = Eco::Data::Mapper.new(mappings)
       end
 
@@ -166,9 +169,9 @@ module Eco
       # @param phase [Symbol] the phase when this parser should be active.
       # @return [Object] the parsed attribute.
       def parse_attribute(attr, source, phase = :internal, deps: {})
-        unless (parsers = entry_factory.person_parser)
-          raise "There are no parsers defined"
-        end
+        msg = "There are no parsers defined"
+        raise msg unless (parsers = entry_factory.person_parser)
+
         parsers.parse(attr, source, phase, deps: deps)
       end
 
@@ -390,18 +393,19 @@ module Eco
 
       # from schema `id` or `name` to a PersonSchema object
       def to_schema(value)
-        return nil unless value
         sch = nil
+        return unless value
+
         case value
         when String
-          unless (sch = schemas.schema(value))
-            fatal "The schema with id or name '#{value}' does not exist."
-          end
+          msg = "The schema with id or name '#{value}' does not exist."
+          fatal msg unless (sch = schemas.schema(value))
         when Ecoportal::API::V1::PersonSchema
           sch = value
         else
           fatal "Required String or Ecoportal::API::V1::PersonSchema. Given: #{value}"
         end
+
         sch
       end
     end

data/lib/eco/api/usecases/default/locations/tagtree_extract_case.rb

@@ -195,6 +195,7 @@ class Eco::API::UseCases::Default::Locations::TagtreeExtract < Eco::API::UseCase
 
   def excel(filename)
     require 'fast_excel'
+
     FastExcel.open(filename, constant_memory: true).tap do |workbook|
       yield(workbook)
       workbook.close

data/lib/eco/api/usecases/default/locations/tagtree_upload_case.rb

@@ -27,6 +27,7 @@ class Eco::API::UseCases::Default::Locations::TagtreeUpload < Eco::API::UseCases
         comms << insert_command(tree, pid: pid) unless top_id?(tree.id)
         pid    = tree.id
       end
+
       tree.nodes.map do |node|
         insert_commands(node, pid: pid)
       end.flatten(1).tap do |subs|
@@ -54,6 +55,7 @@ class Eco::API::UseCases::Default::Locations::TagtreeUpload < Eco::API::UseCases
 
   def top_id?(node_id = nil)
     return top_id.is_a?(String) if node_id.nil?
+
     node_id == top_id
   end
 

data/lib/eco/api/usecases/default_cases/samples/sftp_case.rb

@@ -7,7 +7,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   name "sftp"
   type :other
 
-  CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/.freeze
+  CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/
 
   def main(session, options, _usecase)
     options[:end_get] = false
@@ -31,7 +31,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   def file_pattern(require: true)
     fpc = file_pattern_const
     return fpc if fpc
-    return unless require
+    return     unless require
 
     msg  = "(#{self.class}) You should redefine the file_pattern function "
     msg << "as a RegEx expression that matches the target remote file"
@@ -41,6 +41,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   def file_pattern_const
     if (fpc = options.dig(:sftp, :file_pattern_const))
       raise WrongConst, "(#{self.class}) Invalid file pattern const referral: #{fpc}" unless fpc.match(CONST_REFERRAL)
+
       begin
         self.eval(fpc)
       rescue NameError
@@ -54,6 +55,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   # Ex: "/IN/Personnel"
   def remote_subfolder(require: true)
     rm_sf = options.dig(:sftp, :remote_subfolder)
+
     return rm_sf if rm_sf
     return unless require
 
@@ -78,7 +80,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     options.dig(:sftp, :local_folder) || "."
   end
 
-  def with_remote_files(folder: self.remote_folder, pattern: self.file_pattern)
+  def with_remote_files(folder: remote_folder, pattern: file_pattern)
     sftp.files(folder, pattern: pattern).each do |remote_file|
       yield(remote_file) if block_given?
     end
@@ -100,22 +102,25 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
 
   def get_files
     with_remote_files.tap do |files|
-      unless files.empty?
-        file_names = files.map {|file| to_remote_path(file.name)}
-        puts "Getting the following files into the local folder '#{local_folder}':"
-        puts file_names
-        sftp.download(file_names, local_folder: local_folder)
-      end
+      next if files.empty?
+
+      file_names = files.map {|file| to_remote_path(file.name)}
+
+      puts "Getting the following files into the local folder '#{local_folder}':"
+      puts file_names
+
+      sftp.download(file_names, local_folder: local_folder)
     end
   end
 
   def get_last
     with_remote_files.last.tap do |file|
-      if file
-        file_name = to_remote_path(file.name)
-        puts "Getting the following file: #{file_name}"
-        sftp.download(file_name, local_folder: local_folder)
-      end
+      next unless file
+
+      file_name = to_remote_path(file.name)
+      puts "Getting the following file: #{file_name}"
+
+      sftp.download(file_name, local_folder: local_folder)
     end
   end
 
@@ -125,7 +130,9 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
       dest   = to_remote_path("#{archive_subfolder}/#{file.name}")
       move_file(source, dest)
     end.tap do |files|
-      puts "Moved the file(s) to the #{archive_subfolder} folder" unless files.empty?
+      next if files.empty?
+
+      puts "Moved the file(s) to the #{archive_subfolder} folder"
     end
   end
 

data/lib/eco/api/usecases/ooze_cases/export_register_case.rb

@@ -40,7 +40,7 @@ class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::Oo
 
   def build_tags_filter(mode = :any)
     tags = option_tags(mode)
-    return nil if !tags || tags.empty?
+    return if !tags || tags.empty?
 
     tags_filter(tags, any: mode == :any)
   end
@@ -48,7 +48,7 @@ class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::Oo
   def build_range_filter(key = :update_at)
     from = from_date(key)
     to   = to_date(key)
-    return nil unless from || to
+    return unless from || to
 
     date_range_filter(from: from, to: to, key: key)
   end
@@ -92,10 +92,10 @@ class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::Oo
 
   def filename
     @filename ||= (options[:file] || options.dig(:export, :file, :name)).tap do |filename|
-      unless filename
-        log(:error) { "Destination file not specified" }
-        return false
-      end
+      next if filename
+
+      log(:error) { "Destination file not specified" }
+      return false
     end
   end
 end

data/lib/eco/api/usecases/ooze_samples/helpers/exportable_register.rb

@@ -48,6 +48,7 @@ module Eco
 
             def header(refresh: false)
               return @header if instance_variable_defined?(:@header) && !refresh
+
               @header = typed_header.map do |name|
                 ExportableOoze.key_to_label(name)
               end

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

@@ -234,7 +234,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   def dry_count
     @dry_count ||= 0
-    @dry_count += 1
+    @dry_count  += 1
   end
 
   def dry_run_feedback(entry = target)

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

@@ -3,17 +3,19 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
   name "ooze-run-base"
   type :other
 
-  SAVE_PATCH = "ooze_patch_update.json"
+  SAVE_PATCH = "ooze_patch_update.json".freeze
 
   def main(session, options, usecase)
     super(session, options, usecase) do
-      if method(:process_ooze).parameters.count == 0
+      if method(:process_ooze).parameters.count.zero?
         ooze # retrieve ooze
         process_ooze
       else
         process_ooze(ooze)
       end
+
       yield(target) if block_given?
+
       exit_if_no_changes!
       update_ooze(target)
     end
@@ -30,7 +32,7 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
   end
 
   def stage(stage_id_name = stage_id, ooze: target)
-    super(stage_id_name, ooze: ooze)
+    super
   end
 
   def ooze_id
@@ -43,11 +45,12 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
 
   def update_ooze(ooz = target)
     prompt_to_confirm!
-    super(ooz)
+
+    super
   end
 
   def exit_if_no_changes!
-    return if (changes = !!patch_doc["page"])
+    return if !!patch_doc["page"]
 
     log(:info) { "No Changes!!" }
     exit(0)

data/lib/eco/cli_default/input.rb

@@ -1,6 +1,5 @@
-# rubocop:disable Metrics/BlockLength
-ASSETS.cli.config do |cnf|
-  formats = {
+class Eco::CliDefault::Input < Eco::API::Common::Loaders::CliConfig
+  FORMATS = {
     csv:  {
       option:  ["-csv"],
       extname: [".csv", ".txt"]
@@ -17,51 +16,74 @@ ASSETS.cli.config do |cnf|
       option:  ["-json"],
       extname: [".json"]
     }
-  }
+  }.freeze
 
-  cnf.input(default_option: "-entries-from") do |session, str_opt, options|
-    input = []
+  class << self
+    attr_reader :options, :session
 
+    def encoding
+      options.dig(:input, :file, :encoding)
+    end
+
+    def format_by_cli
+      FORMATS.reduce(nil) do |matched, (frm, selectors)|
+        next matched if matched
+
+        used = selectors[:option].reduce(false) do |us, option|
+          SCR.get_arg(option) || us
+        end
+
+        next frm if used
+      end
+    end
+
+    def format_by_ext(ext)
+      FORMATS.reduce(nil) do |matched, (frm, selectors)|
+        next matched if matched
+        next frm     if selectors[:extname].any? {|e| ext == e}
+      end
+    end
+  end
+
+  input(default_option: "-entries-from") do |session, str_opt, options|
+    @options = options
+    @session = session
+    input    = []
     next input unless SCR.get_arg(str_opt)
 
     file = SCR.get_file(str_opt, required: true)
 
     # Command line check
-    format = formats.reduce(nil) do |matched, (frm, selectors)|
-      used = selectors[:option].reduce(false) {|us, option| SCR.get_arg(option) || us}
-      next matched if matched
-      next frm     if used
-    end
+    format = format_by_cli
 
     # File/Folder check
     file = File.expand_path(file)
+
     if File.directory?(file)
       folder = file
       file   = Dir.glob("#{file}/*").reject {|f| File.directory?(f)}
-      ext    = (format && formats[format][:extname]) || [File.extname(file.first)]
-      file   = file.select {|f| ext.any? {|e| File.extname(f) == e}}.tap do |files|
-        if files.empty?
-          session.log(:error) {
-            "Could not find any file with extension: #{ext} in folder '#{folder}'"
-          }
-          exit(1)
-        end
+      ext    = FORMATS.dig(format, :extname)
+      ext  ||= [File.extname(file.first)]
+      file   = file.select do |f|
+        ext.any? {|e| File.extname(f) == e}
+      end.tap do |files|
+        next unless files.empty?
+
+        session.log(:error) {
+          "Could not find any file with extension: #{ext} in folder '#{folder}'"
+        }
+        exit(1)
       end
     else
-      ext = File.extname(file)
+      ext = [File.extname(file)]
     end
 
-    format ||= formats.reduce(nil) do |matched, (frm, selectors)|
-      next matched if matched
-      next frm     if selectors[:extname].any? {|e| ext == e}
-    end
+    format ||= format_by_ext(ext.first)
     format ||= :csv
 
-    options.deep_merge!(input: {file: {name: file}})
+    options.deep_merge!(input: {file: {name:   file}})
     options.deep_merge!(input: {file: {format: format}})
 
-    encoding = options.dig(:input, :file, :encoding)
-
     case format
     when :xml
       [file].flatten.each {|f| session.config.files.validate(:xml, f)}
@@ -83,5 +105,3 @@ ASSETS.cli.config do |cnf|
     input
   end
 end
-
-# rubocop:enable Metrics/BlockLength

data/lib/eco/cli_default/options.rb

@@ -69,7 +69,10 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       sch_id   = session.schemas.to_id(sch_name)
 
       unless sch_id
-        msg = "You need to specify a correct schema id or name. '#{sch_name}' does not exist"
+        msg = "You need to specify a correct schema id or name. "
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(", ")
+
         session.log(:error) { msg }
         exit(1)
       end

data/lib/eco/cli_default/people.rb

@@ -1,69 +1,124 @@
-MAX_GET_PARTIAL = 12_000
+class Eco::CliDefault::People < Eco::API::Common::Loaders::CliConfig
+  MAX_GET_PARTIAL = 12_000
 
-ASSETS.cli.config do |cnf|
-  cnf.people do |input, session, options|
-    get         = options.dig(:people, :get)
-    get         = {} if get.nil?
+  class << self
+    attr_reader :options, :session
+    attr_writer :get_full, :get_partial
 
-    from_remote = get && get[:from] == :remote
-    from_local  = get && get[:from] == :local
+    def get_options # rubocop:disable Naming/AccessorMethodName
+      get = options.dig(:people, :get)
+      get = {} if get.nil?
+      get
+    end
+
+    def no_get?
+      get_options == false
+    end
 
-    get_full    = from_remote && get[:type] == :full
-    get_partial = from_remote && get[:type] == :partial
-    get_by_file = from_local  && get[:type] == :file
+    def from_remote?
+      return false unless get_options
+
+      get_options[:from] == :remote
+    end
+
+    def from_local?
+      return false unless get_options
+
+      get_options[:from] == :local
+    end
+
+    def get_full?
+      return @get_full  if instance_variable_defined?(:@get_full)
+      return false      unless from_remote?
+
+      get_options[:type] == :full
+    end
+
+    def get_partial?
+      return @get_partial if instance_variable_defined?(:@get_partial)
+      return false        unless from_remote?
+
+      @get_partial = (get_options[:type] == :partial)
+    end
+
+    def get_by_file?
+      return false unless from_local?
+
+      get_options[:type] == :file
+    end
+
+    def source_file
+      return unless get_by_file?
+
+      get_options[:file]
+    end
+
+    def switch_to_full_remote!
+      self.get_full    = true
+      self.get_partial = false
+
+      options.deep_merge!(people: {
+        get: {
+          from: :remote,
+          type: :full
+        }
+      })
+    end
+
+    def switch_to_full_local!
+      self.get_full    = true
+      self.get_partial = false
+
+      options.deep_merge!(people: {
+        get: {
+          from: :local,
+          type: :full
+        }
+      })
+    end
+
+    def optimize_get_partial!(input)
+      return unless get_partial?
 
-    # -get-partial: validate input present and under max
-    if get_partial
       msg = "To use -get-partial (partial updates), you need to use -entries-from"
       raise msg unless input.is_a?(Enumerable)
 
-      if input.count > MAX_GET_PARTIAL
-        get_full    = true
-        get_partial = false
-
-        msg  = "(Optimization) "
-        msg << "Switching from partial to full people download. "
-        msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
-        msg << "(#{MAX_GET_PARTIAL}) entries."
-        session.log(:info) { msg }
-
-        options.deep_merge!(people: {
-          get: {
-            from: :remote,
-            type: :full
-          }
-        })
-      end
+      return unless input.count > MAX_GET_PARTIAL
+
+      msg  = "(Optimization) "
+      msg << "Switching from partial to full people download. "
+      msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
+      msg << "(#{MAX_GET_PARTIAL}) entries."
+      session.log(:info) { msg }
+
+      switch_to_full_remote!
     end
+  end
+
+  people do |input, session, options|
+    @options = options
+    @session = session
 
-    if get == false
+    # -get-partial: validate input present and under max
+    optimize_get_partial!(input) if get_partial?
+
+    if no_get?
       Eco::API::Organization::People.new([])
-    elsif get_full
+    elsif get_full?
       # -get-people
       session.micro.people_cache
-    elsif get_partial
+    elsif get_partial?
       # -get-partial
       session.micro.people_search(input, options: options)
-    elsif get_by_file
+    elsif get_by_file?
       # -people-from-backup
-      session.micro.people_load(get[:file], modifier: :file)
+      session.micro.people_load(source_file, modifier: :file)
     else
-      options.deep_merge!(people: {
-        get: {
-          from: :local,
-          type: :full
-        }
-      })
-
+      switch_to_full_local!
       people = session.micro.people_load(modifier: %i[newest save])
 
       if people.empty?
-        options.deep_merge!(people: {
-          get: {
-            from: :remote,
-            type: :full
-          }
-        })
+        switch_to_full_remote!
         people = session.micro.people_cache
       end
 

data/lib/eco/cli_default/people_filters.rb

@@ -92,7 +92,10 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       sch_id   = session.schemas.to_id(sch_name)
 
       unless sch_id
-        msg = "You need to specify a correct schema id or name. '#{sch_name}' does not exist"
+        msg = "You need to specify a correct schema id or name. "
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(", ")
+
         session.log(:error) { msg }
         exit(1)
       end

data/lib/eco/cli_default/workflow.rb

@@ -1,12 +1,14 @@
 ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
   ASSETS.config.workflow do |wf| # rubocop:disable Metrics/BlockLength
     rescued = false
+
     # default rescue
     wf.rescue do |err, io|
       next io if rescued
 
       rescued = true
       log(:debug) { err.patch_full_message }
+
       wf.run(:close, io: io)
     rescue StandardError => e
       puts "Some problem in workflow.rescue: #{e}"
@@ -74,10 +76,10 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
     end
 
     wf.on(:usecases) do |_wf_ca, io|
-      unless cli.config.usecases.process(io: io)
-        log(:info) { "No update operation specified... quitting" }
-        exit 0
-      end
+      next if cli.config.usecases.process(io: io)
+
+      log(:info) { "No update operation specified... quitting" }
+      exit 0
     end
 
     wf.before(:launch_jobs) do |_wf_jobs, _io|
@@ -95,11 +97,13 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
       run_it = !options[:dry_run] || options.dig(:post_launch, :run)
       unless run_it
         wf_post.skip!
+
         log(:info) {
           msg  = "Although there are post_launch cases, they will NOT be RUN"
           msg << ", because we are in dry-run (simulate)." if options[:dry_run]
           msg
         }
+
         next
       end
 
@@ -117,6 +121,7 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
           end
           msg
         }
+
         next
       end
 
@@ -131,6 +136,7 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
           use.launch(io: io).base
         rescue Eco::API::UseCases::BaseIO::MissingParameter => e
           raise unless e.required == :people
+
           log(:debug) {
             "Skipping use case '#{use.name}' -- no base people detected for the current run"
           }

data/lib/eco/csv/stream.rb

@@ -7,6 +7,7 @@ module Eco
 
       def initialize(filename, **kargs)
         raise ArgumentError, "File '#{filename}' does not exist" unless ::File.exist?(filename)
+
         @filename = filename
         @params   = {
           headers:     true,
@@ -55,6 +56,7 @@ module Eco
       # see https://dalibornasevic.com/posts/68-processing-large-csv-files-with-ruby
       def csv
         return @csv if instance_variable_defined?(:@csv)
+
         @fd  = ::File.open(filename, 'r')
         @csv = Eco::CSV.new(fd, **params)
       end

data/lib/eco/csv.rb

@@ -5,9 +5,9 @@ module Eco
       include Eco::Data::Files
 
       # @return [Eco::CSV::Table]
-      def parse(data, **kargs, &block)
+      def parse(data, **kargs)
         kargs = {headers: true, skip_blanks: true}.merge(kargs)
-        Eco::CSV::Table.new(super(data, **kargs, &block))
+        Eco::CSV::Table.new(super)
       end
 
       # @return [Eco::CSV::Table]
@@ -51,6 +51,7 @@ module Eco
           included = yield(row) if block_given?
           count += 1            if included
         end
+
         count
       end
     end