eco-helpers 2.6.3 → 2.7.0

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

@@ -29,7 +29,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
     super(session, options, usecase) do
       if mode == :legacy
-        with_each_entry do |ooze|
+        with_each_entry do
           process_ooze(&block)
         end
       elsif mode == :delegate
@@ -41,21 +41,20 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     log_kpis
   end
 
-  def process_ooze(ooze = target)
+  def process_ooze(_ooze = target)
     raise "You need to define this method"
   end
 
   private
 
   def before_loading_new_target(ooze_id)
-    if pending = queue_shift(ooze_id)
-      update_ooze(pending).tap do |result|
-        if result.is_a?(Ecoportal::API::Common::Response)
-          if result.success?
-            @updated_oozes += 1
-          else
-            @failed_update_oozes +=1
-          end
+    return unless (pending = queue_shift(ooze_id))
+    update_ooze(pending).tap do |result|
+      if result.is_a?(Ecoportal::API::Common::Response)
+        if result.success?
+          @updated_oozes += 1
+        else
+          @failed_update_oozes +=1
         end
       end
     end
@@ -78,15 +77,13 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
           ooze_result_ids[page_result.id] = true
         end
 
-        if pending = queue_shift(page_result.id)
-          if dirty?(pending)
-            msg  = "Inconsistent search results. "
-            msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
-            logger.warn msg
-            update_ooze(pending)
-          end
+        if (pending = queue_shift(page_result.id)) && dirty?(pending)
+          msg  = "Inconsistent search results. "
+          msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
+          logger.warn msg
+          update_ooze(pending)
         end
-        if ooz = ooze(page_result.id)
+        if (ooz = ooze(page_result.id))
           @retrieved_oozes += 1
           yield(ooz)
         else
@@ -99,11 +96,11 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   end
 
   def enqueue(object)
-    return unless object && object.respond_to?(:id)
+    return unless object.respond_to?(:id)
     unless object.is_a?(Ecoportal::API::V2::Page) or object.is_a?(Ecoportal::API::V2::Pages::PageStage)
       raise "Queuing is just for entries. Expecting Page or PageStage. Given: #{object.class}"
     end
-    if elem = queue_get(object.id)
+    if (elem = queue_get(object.id))
       msg = "Something is wrong. Native case 'RegisterUpdateCase' is "
       if (elem != object) && dirty?(elem)
         msg << "trying to queue different objects with same page id:\n"
@@ -154,7 +151,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
       dry_run_feedback(draft)
       false
     else
-      apiv2.pages.create(draft, from: template_id).tap do |result|
+      apiv2.pages.create(draft, from: template_id).tap do
         @created_oozes += 1
       end
     end
@@ -182,28 +179,31 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   end
 
   def backup_patch!(ooze = target)
-    unless patch = (patch_doc(ooze) || {})["page"]
-      logger.info "No changes to update for #{object_reference(ooze)}."
-      return
-    end
+    return if (patch_doc(ooze) || {})["page"]
+    logger.info "No changes to update for #{object_reference(ooze)}."
   end
 
   def results_preview
     apiv2.registers.search(register_id, search_options.merge(only_first: true)).tap do |search_results|
       @total_search_oozes = search_results.total
       str_results = "Total target entries: #{search_results.total} (out of #{search_results.total_before_filtering})"
-      default_answer = if session.config.run_mode_remote? then "Y" else "N" end
-      session.prompt_user("Do you want to proceed (y/N):", explanation: str_results, default: default_answer, timeout: 10) do |res|
-        unless res.upcase.start_with?("Y")
-          puts "..."
-          logger.info "Aborting script..."
-          exit(0)
-        end
+      default_answer = session.config.run_mode_remote?? "Y" : "N"
+      session.prompt_user(
+        "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 "..."
+        logger.info "Aborting script..."
+        exit(0)
       end
     end
   end
 
   def init_kpis
+    @total_search_oozes     = 0
     @retrieved_oozes        = 0
     @non_retrieved_oozes    = 0
     @dupped_search_oozes    = 0
@@ -242,12 +242,12 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   end
 
   def conf_filters
-    return filters if self.respond_to?(:filters)
+    return filters if respond_to?(:filters)
     []
   end
 
   def conf_search
-    return search if self.respond_to?(:search)
+    return search if respond_to?(:search)
   end
 
   def register_id

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

@@ -10,15 +10,13 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
   def with_each_entry
     batched_target_ids do |ids|
       ids.each do |id|
-        if pending = queue_shift(id)
-          if dirty?(pending)
-            msg  = "Same entry 'id' appears more than once. "
-            msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
-            console.warn msg
-            update_ooze(pending)
-          end
+        if (pending = queue_shift(id)) && dirty?(pending)
+          msg  = "Same entry 'id' appears more than once. "
+          msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
+          console.warn msg
+          update_ooze(pending)
         end
-        if ooz = ooze(id)
+        if (ooz = ooze(id))
           @retrieved_oozes += 1
           yield(ooz)
         else
@@ -49,7 +47,7 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
     @total_search_oozes  = target_ids.count
     @dupped_search_oozes = dups.count
 
-    dups_str = dups.count > 0 ? "There are #{dups.count} duplicated ids" : "No duplicates detected"
+    dups_str = dups.count.positive? ? "There are #{dups.count} duplicated ids" : "No duplicates detected"
     msg = "Total target entries: #{target_ids.count} (#{dups_str})"
 
     session.prompt_user("Do you want to proceed (y/N):", explanation: msg, default: "N", timeout: 10) do |res|
@@ -62,7 +60,7 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
   end
 
   def target_ids
-    @target_ids ||= input_csv.columns.first[1..-1]
+    @target_ids ||= input_csv.columns.first[1..]
   end
 
   def input_csv

data/lib/eco/api/usecases.rb

@@ -2,7 +2,6 @@ module Eco
   module API
     # Autoloading children is done on init and each time usecases it's queried
     class UseCases
-
       class UnknownCase < StandardError
         def initialize(msg = nil, case_name: nil, type: nil)
           msg ||= "Unknown case"

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

@@ -5,7 +5,7 @@ module Eco
         include Eco::CLI::Config::Help
         attr_reader :core_config
 
-        class CaseConfig < Struct.new(:cases_config, :option, :type, :description, :casename, :callback)
+        CaseConfig = Struct.new(:cases_config, :option, :type, :description, :casename, :callback) do
           def add_option(arg, desc = nil, &block)
             core_config.options_set.add(arg, desc, namespace: option, &block)
             self
@@ -18,8 +18,7 @@ module Eco
           end
         end
 
-        class ActiveCase < Struct.new(:index, :option, :callback)
-        end
+        ActiveCase = Struct.new(:index, :option, :callback)
 
         def initialize(core_config:)
           @core_config  = core_config
@@ -29,7 +28,7 @@ module Eco
         # @return [String] summary of the use cases.
         def help(refine: nil)
           refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
-          ["The following are the available use cases#{refinement}:"].yield_self do |lines|
+          ["The following are the available use cases#{refinement}:"].then do |lines|
             max_len = keys_max_len(@linked_cases.keys)
             @linked_cases.keys.sort.select do |key|
               !refine.is_a?(String) || key.include?(refine)
@@ -60,7 +59,7 @@ module Eco
         def cli_apply(io:)
           io.session.usecases.each do |usecase|
             next unless usecase.respond_to?(:classed_definition)
-            next unless original_case = usecase.classed_definition
+            next unless (original_case = usecase.classed_definition)
             original_case.cli_apply!
           end
         end
@@ -72,14 +71,15 @@ module Eco
         # @return [Hash] where keys are cases and values a `Hash` with `option` String and `callback`
         def active(io:)
           validate_io!(io)
-          return @active_cases unless !@active_cases
+          return @active_cases if @active_cases
+
           @active_cases = @linked_cases.each_with_object({}) do |(option_case, data), active_cases|
-            next nil unless SCR.get_arg(option_case)
-            if usecase = get_usecase(io: io, data: data)
-              index = SCR.get_arg_index(option_case)
-              active_cases[usecase] = ActiveCase.new(index, option_case, data.callback)
-            end
-          end.sort_by {|c, d| d.index}.to_h
+            next unless SCR.get_arg(option_case)
+            next unless (usecase = get_usecase(io: io, data: data))
+
+            index = SCR.get_arg_index(option_case)
+            active_cases[usecase] = ActiveCase.new(index, option_case, data.callback)
+          end.sort_by {|_c, d| d.index}.to_h
         end
 
         def process(io:)
@@ -111,28 +111,30 @@ module Eco
         end
 
         def get_usecase(io:, data:)
-          usecase    = if case_name = data.casename
-            io.session.usecases.case(case_name, type: data.type)
-          end
-          usecase  ||= if callback  = data.callback
-            # identify/retrieve usecase via callback
-            params  = io.params(keyed: true).merge(type: data.type)
-            io      = io.new(**params, validate: false)
-            callback.call(*io.params).tap do |usecase|
-              unless usecase.is_a?(Eco::API::UseCases::UseCase)
-                msg  = "When adding a usecase, without specifying 'case_name:', "
-                msg += "the block that integrates usecase for cli option '#{data.option}'"
-                msg += " must return an Eco::API::UseCases::UseCase object. It returns #{usecase.class}"
-                raise msg
+          usecase =
+            if (case_name = data.casename)
+              io.session.usecases.case(case_name, type: data.type)
+            end
+
+          usecase ||
+            if (callback = data.callback)
+              # identify/retrieve usecase via callback
+              params  = io.params(keyed: true).merge(type: data.type)
+              io      = io.new(**params, validate: false)
+              callback.call(*io.params).tap do |use|
+                unless use.is_a?(Eco::API::UseCases::UseCase)
+                  msg  = "When adding a usecase, without specifying 'case_name:', "
+                  msg += "the block that integrates usecase for cli option '#{data.option}'"
+                  msg += " must return an Eco::API::UseCases::UseCase object. It returns #{use.class}"
+                  raise msg
+                end
               end
             end
-          end
         end
 
         def validate_io!(io)
-          unless io && io.is_a?(Eco::API::UseCases::BaseIO)
-            raise "You need to provide Eco::API::UseCases::BaseIO object. Given: #{io.class}"
-          end
+          return if io.is_a?(Eco::API::UseCases::BaseIO)
+          raise ArgumentError, "You need to provide Eco::API::UseCases::BaseIO object. Given: #{io.class}"
         end
       end
     end

data/lib/eco/cli_default/input_filters.rb

@@ -40,11 +40,6 @@ ASSETS.cli.config do |cnf|
       end
     end
 
-    #filters.add("-input-supervisors") do |people, session, options|
-    #  options.deep_merge!(input: {filter: {subordinates: true}})
-    #  people.newFrom people.to_a.select {|person| person.subordinates > 0}
-    #end
-
     filters.add("-input-supervisor-id", "only those with certain supervisor id or external_id") do |input, session, options|
       id     = SCR.get_arg("-input-supervisor-id", with_param: true)
       options.deep_merge!(input: {filter: {supervisor_id: id}})

data/lib/eco/cli_default/people_filters.rb

@@ -21,10 +21,10 @@ ASSETS.cli.config do |cnf|
       people.external_id_present(false)
     end
 
-    filters.add("-supervisors", "only those that have subordinates") do |people, session, options|
-      options.deep_merge!(people: {filter: {subordinates: true}})
-      people.newFrom people.to_a.select {|person| person.subordinates > 0}
-    end
+    # filters.add("-supervisors", "only those that have subordinates") do |people, session, options|
+    #   options.deep_merge!(people: {filter: {subordinates: true}})
+    #   people.newFrom people.to_a.select {|person| person.subordinates > 0}
+    # end
 
     filters.add("-supervisor-id", "only those with certain supervisor") do |people, session, options|
       id     = SCR.get_arg("-supervisor-id", with_param: true)

data/lib/eco/cli_default/workflow.rb

@@ -1,6 +1,5 @@
-ASSETS.cli do |cli|
-  ASSETS.config.workflow do |wf|
-
+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|
@@ -20,7 +19,7 @@ ASSETS.cli do |cli|
     wf.for(:load) do |wf_load|
       wf_load.for(:input) do |wf_in|
         wf_in.on(:get) do |_wf_ig, io|
-          cases_with_input = cli.config.usecases.active(io: io).select do |usecase, data|
+          cases_with_input = cli.config.usecases.active(io: io).select do |usecase, _data|
             io.class.input_required?(usecase.type)
           end
 
@@ -38,13 +37,13 @@ ASSETS.cli do |cli|
 
         wf_in.on(:filter) do |_wf_if, io|
           next unless input && !input.empty?
-          io.new(input:  cli.config.input_filters.process(io: io))
+          io.new(input: cli.config.input_filters.process(io: io))
         end
       end
 
       wf_load.for(:people) do |wf_peo|
         wf_peo.on(:get) do |_wf_pg, io|
-          cases_with_people = cli.config.usecases.active(io: io).select do |usecase, data|
+          cases_with_people = cli.config.usecases.active(io: io).select do |usecase, _data|
             io.class.people_required?(usecase.type)
           end
           next if cases_with_people.empty? && !options.dig(:people, :get)
@@ -61,7 +60,7 @@ ASSETS.cli do |cli|
     wf.before(:usecases) do |_wf_ca, io|
       # save partial entries -> should be native to session.workflow
       get_people     = options.dig(:people, :get)
-      partial_update = get_people && get_people.dig(:type) == :partial
+      partial_update = get_people && get_people[:type] == :partial
       if !options[:dry_run] && partial_update
         partial_file = session.config.people.partial_cache
         session.file_manager.save_json(io.people, partial_file, :timestamp)
@@ -86,7 +85,7 @@ ASSETS.cli do |cli|
     wf.before(:post_launch) do |wf_post, io|
       next wf_post.skip! if session.post_launch.empty?
 
-      run_it  = !options[:dry_run] || options.dig(:post_launch, :run)
+      run_it = !options[:dry_run] || options.dig(:post_launch, :run)
       unless run_it
         wf_post.skip!
         log(:info) {
@@ -98,7 +97,7 @@ ASSETS.cli do |cli|
       end
 
       get_people     = options.dig(:people, :get)
-      partial_update = get_people && get_people.dig(:type) == :partial
+      partial_update = get_people && get_people[:type] == :partial
       refresh_data   = !options[:dry_run] && partial_update
 
       unless refresh_data
@@ -131,13 +130,13 @@ ASSETS.cli do |cli|
         end
       end
 
-      wf_post.on(:launch_jobs) do |_wf_pl, io|
+      wf_post.on(:launch_jobs) do |_wf_pl, _io|
         session.jobs_launch(simulate: options[:dry_run])
       end
     end
 
     wf.on(:report) do |_wf_rep, io|
-      if file = options.dig(:report, :people, :csv)
+      if (file = options.dig(:report, :people, :csv))
         options.deep_merge!(export: {
           options: {internal_names: true, nice_header: true, split_schemas: true},
           file:    {name: file, format: :csv}
@@ -149,11 +148,11 @@ ASSETS.cli do |cli|
 
     wf.on(:end) do |_wf_end, io|
       get_people     = options.dig(:people, :get)
-      partial_update = get_people && get_people.dig(:type) == :partial
+      partial_update = get_people && get_people[:type] == :partial
 
       unless !options[:end_get] || options[:dry_run] || partial_update
-        people_update_cases = cli.config.usecases.active(io: io).any? do |usecase, data|
-          [:transform, :sync].any? { |type| usecase.type == type }
+        people_update_cases = cli.config.usecases.active(io: io).any? do |usecase, _data|
+          %i[transform sync].any? { |type| usecase.type == type }
         end
 
         if !people_update_cases

data/lib/eco/csv/table.rb

@@ -5,7 +5,7 @@ module Eco
       #   - when `Array<Array>` => all `rows` as arrays where first array is the **header**
       def initialize(input)
         super(to_rows_array(input))
-        self.delete_if do |row|
+        delete_if do |row|
           values = row.fields
           values.all?(&:nil?) || values.map(&:to_s).all?(&:empty?)
         end
@@ -15,7 +15,7 @@ module Eco
       # @note assumes there are no repeated header names
       # @return [Eco::CSV::Table]
       def nil_blank_cells!
-        self.each do |row|
+        each do |row|
           row.dup.each do |header, value|
             value       = value.to_s.strip
             row[header] = value.empty?? nil : value
@@ -40,8 +40,7 @@ module Eco
       # It allows to rename the header names
       # @return [Eco::CSV::Table]
       def transform_headers
-        header = self.headers
-        cols   = self.columns
+        cols = columns
         cols.each do |col|
           col[0] = yield(col.first)
         end
@@ -52,8 +51,8 @@ module Eco
       # @note it also offers a way to resolve merge conflicts
       # @return [Eco::CSV::Table]
       def merge_same_header_names
-        dups = self.duplicated_header_names
-        out_rows = self.map do |row|
+        dups     = duplicated_header_names
+        out_rows = map do |row|
           row.to_a.each_with_object({}) do |(name, value), out|
             if dups.include?(name) && out.key?(name)
               if block_given?
@@ -76,7 +75,7 @@ module Eco
 
       # @return [Array<String>] list of duplicated header names
       def duplicated_header_names
-        header = self.headers
+        header = headers
         header.select {|e| header.count(e) > 1}.uniq
       end
 
@@ -113,7 +112,7 @@ module Eco
         when String
           csv_cols = columns
           csv_cols = index.each_with_object([]) do |name, cols|
-            col = csv_cols.find {|col| col.first == name}
+            col = csv_cols.find {|cl| cl.first == name}
             cols << col if col
           end
           columns_to_table(csv_cols)
@@ -157,14 +156,14 @@ module Eco
       # @return [Array<::CSV::Row>]
       def rows
         [].tap do |out|
-          self.each {|row| out << row}
+          each {|row| out << row}
         end
       end
 
       # It removes all rows where all columns' values are the same
       def delete_duplicates!
         unique_rows = []
-        self.by_row!.delete_if do |row|
+        by_row!.delete_if do |row|
           unique_rows.any? {|done| equal_rows?(row, done)}.tap do |found|
             unique_rows << row unless found
           end
@@ -174,9 +173,9 @@ module Eco
       # @param row1 [CSV:Row] row to be compared
       # @param row2 [CSV:Row] row to be compared
       # @param [Boolean] `true` if all values of `row1` are as of `row2`
-      def equal_rows?(row1, row2)
-        row1.fields.zip(row2.fields).all? do |(v1, v2)|
-          v1 == v2
+      def equal_rows?(row_1, row_2)
+        row_1.fields.zip(row_2.fields).all? do |(v_1, v_2)|
+          v_1 == v_2
         end
       end
 
@@ -198,9 +197,9 @@ module Eco
       # @note it will override columns with same header name
       # @return [Hash] keys are headers, values are arrays
       def columns_hash
-        columns.map do |col|
-          [col.first, col[1..-1]]
-        end.to_h
+        columns.to_h do |col|
+          [col.first, col[1..]]
+        end
       end
 
       # Returns an array of row hashes
@@ -218,29 +217,29 @@ module Eco
 
       def columns_to_table(columns_array)
         rows_data = columns_array.transpose
-        return self.class.new(rows_data) if rows_data.length > 0
-        raise ArgumentError.new("Expecting 'columns_array' to at least have header. Given: #{columns_array}")
+        return self.class.new(rows_data) if rows_data.length.positive?
+        raise ArgumentError, "Expecting 'columns_array' to at least have header. Given: #{columns_array}"
       end
 
-      def to_rows_array(data)
+      def to_rows_array(data) # rubocop:disable Metrics/AbcSize
         case data
         when ::CSV::Table
           to_rows_array(data.to_a)
         when Hash
           # hash of columns header as key and column array as value
-          rows_arrays = [a.keys].concat(a.values.first.zip(*a.values[1..-1]))
+          # rows_arrays = [a.keys].concat(a.values.first.zip(*a.values[1..]))
           to_rows_array(data.keys)
         when Enumerable
           data = data.dup.compact
-          return data unless data.count > 0
+          return data unless data.count.positive?
           sample = data.first
 
           case sample
           when ::CSV::Row
             data
           when Array
-            headers  = data.shift
-            data.push(Array.new(headers.length)) if data.count == 0
+            headers = data.shift
+            data.push(Array.new(headers.length)) if data.count.zero?
             data.map do |arr_row|
               ::CSV::Row.new(headers, arr_row)
             end.compact
@@ -248,15 +247,25 @@ module Eco
             headers     = sample.keys
             headers_str = headers.map(&:to_s)
             data.map do |hash|
-              ::CSV::Row.new(headers_str, hash.values_at(*headers))
+              values = hash.values_at(*headers).map do |value|
+                if_array_to_pipe_string(value)
+              end
+              ::CSV::Row.new(headers_str, values)
             end.compact
           else
-            raise "Expected data that can be transformed into Array<::CSV::Row>. Given 'Enumerable' of '#{sample.class}'"
+            msg  = "Expected data that can be transformed into Array<::CSV::Row>. "
+            msg << "Given 'Enumerable' of '#{sample.class}'"
+            raise msg
           end
         else
           raise "Input type not supported. Given: #{data.class}"
         end
       end
+
+      def if_array_to_pipe_string(value)
+        return value unless value.is_a?(Array)
+        value.join('|')
+      end
     end
   end
 end