eco-helpers 2.6.4 → 2.7.0

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

@@ -1,22 +1,23 @@
+# rubocop:disable Lint/SymbolConversion, Style/QuotedSymbols
 module Eco
   module API
     class UseCases
       class OozeSamples
         module Helpers
           module Filters
-            FILTER_TIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+            FILTER_TIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'.freeze
 
             def tags_filter(tags, any: true, negate: false)
               tags = [tags].flatten.compact
               return nil if tags.empty?
               key, name = field_key_name(:tags)
               {
-                "tags": tags,
-                "mode": any ? "any" : "all",
+                "tags":   tags,
+                "mode":   any ? "any" : "all",
                 "negate": negate,
-                "key": key,
-                "name": name,
-                "type": "tag_filter"
+                "key":    key,
+                "name":   name,
+                "type":   "tag_filter"
               }
             end
 
@@ -24,12 +25,12 @@ module Eco
               return nil unless from || to
               key, name = field_key_name(key)
               {
-                "relstart": "today",
+                "relstart":  "today",
                 "time_zone": "Pacific/Auckland",
-                "relative": false,
-                "key": key,
-                "name": name,
-                "type": "date_filter"
+                "relative":  false,
+                "key":       key,
+                "name":      name,
+                "type":      "date_filter"
               }.tap do |out|
                 out.merge!("lbound": to_date_filter(from)) if from
                 out.merge!("ubound": to_date_filter(to)) if to
@@ -40,15 +41,41 @@ module Eco
               daystart(date).utc.strftime(FILTER_TIME_FORMAT)
             end
 
-            def set_time(date, h, m, s); Time.new(date.year, date.month, date.day, h, m, s); end
-            def weeks(num); num * days(7); end
-            def days(num);  num * 60 * 60 * 24; end
-            def today; Date.today.to_time; end
-            def sunday(date); date + days(7 - weekday(date)); end
-            def midnight(date); set_time(date, 23, 59, 59); end
-            def daystart(date); set_time(date, 0, 0, 0); end
-            def previous_sunday(date); midnight(sunday(date - weeks(1)));  end
-            def this_monday(date); set_time(previous_sunday(as_at_date) + days(1), 0, 0, 0);  end
+            def set_time(date, h, m, s) # rubocop:disable Naming/MethodParameterName
+              Time.new(date.year, date.month, date.day, h, m, s)
+            end
+
+            def weeks(num)
+              num * days(7)
+            end
+
+            def days(num)
+              num * 60 * 60 * 24
+            end
+
+            def today
+              Date.today.to_time
+            end
+
+            def sunday(date)
+              date + days(7 - weekday(date))
+            end
+
+            def midnight(date)
+              set_time(date, 23, 59, 59)
+            end
+
+            def daystart(date)
+              set_time(date, 0, 0, 0)
+            end
+
+            def previous_sunday(date)
+              midnight(sunday(date - weeks(1)))
+            end
+
+            def this_monday(date)
+              set_time(previous_sunday(date) + days(1), 0, 0, 0)
+            end
 
             def field_key_name(value)
               case value
@@ -61,7 +88,7 @@ module Eco
               when :tags
                 ["tags", "Location Tags"]
               else
-                [nil , nil]
+                [nil, nil]
               end
             end
           end
@@ -70,3 +97,5 @@ module Eco
     end
   end
 end
+
+# rubocop:enable Lint/SymbolConversion, Style/QuotedSymbols

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

@@ -1,9 +1,11 @@
+# rubocop:disable Lint/DuplicateBranch
 module Eco
   module API
     class UseCases
       class OozeSamples
         module Helpers
           module OozeHandlers
+            # Helper to merge values of fields of same type and label name
             def merge_values(origin, append, klass: nil, delimiter: "\n")
               return origin if !append || append.to_s.strip.empty?
               return append if !origin || origin.to_s.strip.empty?
@@ -41,12 +43,17 @@ module Eco
               end
             end
 
-            def merge_arrays(ref, plus)
+            # Merges arrays `ref` and `plus` by keeping the order of `ref`
+            # but inserting additional elements of `plus` in the correct position
+            # (i.e. when those elements are between two elements that exist in `ref`)
+            # @note this can be used to combine two different header sequences
+            #   by using `ref` as a reference.
+            def merge_arrays(ref, plus) # rubocop:disable Metrics/AbcSize
               return ref if ref == plus
-              href_idx  = array_indexes(ref)
-              hplus_idx = array_indexes(plus)
 
-              shared = ref & plus
+              href_idx        = array_indexes(ref)
+              hplus_idx       = array_indexes(plus)
+              shared          = ref & plus
               hshared_ref_idx = href_idx.slice(*shared)
 
               # hidx_plus_shared = hplus_idx.slice(*shared).each_with_object({}) do |(e, idx), reversed|
@@ -55,22 +62,23 @@ module Eco
               # shared_plus_idxs = hidx_plus_shared.keys.reverse
               shared_plus_idxs = hplus_idx.values_at(*shared).sort.reverse
 
-              only_plus = plus - ref
+              only_plus      = plus - ref
               honly_plus_idx = hplus_idx.slice(*only_plus)
 
-              hplus_ref_idx = honly_plus_idx.each_with_object({}) do |(e, idx), hplus_ref_idx|
+              hplus_ref_idx  = honly_plus_idx.each_with_object({}) do |(e, idx), href_idx_plus|
                 ps_idx = shared_plus_idxs.bsearch {|i| idx >= i}
                 rs_idx = ps_idx ? hshared_ref_idx[plus[ps_idx]] : -1
-                hplus_ref_idx[e] = rs_idx
-              end.group_by do |e, idx|
+                href_idx_plus[e] = rs_idx
+              end.group_by do |_e, idx|
                 idx
-              end.to_a.sort_by do |(idx, pairs)|
+              end.to_a.sort_by do |(idx, _pairs)|
                 idx
               end.reverse.to_h.transform_values do |pairs|
                 pairs.map(&:first)
               end
-              hplus_ref_idx.each_with_object(ref.dup) do |(idx, elements), ref|
-                ref.insert(idx+1, *elements)
+
+              hplus_ref_idx.each_with_object(ref.dup) do |(idx, elements), rf|
+                rf.insert(idx + 1, *elements)
               end
             end
 
@@ -83,3 +91,5 @@ module Eco
     end
   end
 end
+
+# rubocop:enable Lint/DuplicateBranch

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

@@ -46,9 +46,11 @@ module Eco
 
               def validate_base_type!(base)
                 return super if defined?(super)
+
                 msg  = "#{self} can only be included in Eco::API::Common::Loaders::Base"
                 msg << "\nCan't be included in #{base}"
                 raise LoadError, msg unless base <= Eco::API::Common::Loaders::Base
+
                 true
               end
             end

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

@@ -11,7 +11,7 @@ module Eco
 
             # Matches anything between two consecutive (), inclusive
             def bracked_regex
-              @bracked_regex ||= /(?<bracked>\([^\)]+?\))/
+              @bracked_regex ||= /(?<bracked>\([^\)]+?\))/ # rubocop:disable Style/RedundantRegexpEscape
             end
 
             # It always downcase, trim and remove double spaces.
@@ -24,10 +24,11 @@ module Eco
             def simplify_string(str, ignore: false)
               str = str.to_s.strip.downcase.gsub(/\s+/, ' ')
               return str unless ignore
+
               sub = non_letters_regex
               case ignore
-              when Regexp; sub = ignore
-              when String; sub = /[#{ignore}]+/
+              when Regexp then sub = ignore
+              when String then sub = /[#{ignore}]+/
               when Array
                 return ignore.reduce(str) do |out, sub|
                   simplify_string(out, ignore: sub)
@@ -38,67 +39,74 @@ module Eco
 
             # Offers multiple simplification methods to compare two strings
             # @note only one of the values can be a Regexp
-            # @param value1 [String, Regexp, Nil]
-            # @param value2 [String, Regexp, Nil]
+            # @param value_1 [String, Regexp, Nil]
+            # @param value_2 [String, Regexp, Nil]
             # @param exact [Boolean]
             #   * when `true`: requiring the values to be exactly the same
             #   * otherwise (`false`): compares in downcase, with no extra spaces
             # @param mild [Boolean] only a-z comparison
             # @param ignore [see @simplify_string]
-            def same_string?(value1, value2, exact: false, mild: false, ignore: false)
-              return true  if value1.to_s.strip.empty? && value2.to_s.strip.empty?
-              return false if value1.to_s.strip.empty? || value2.to_s.strip.empty?
-              val1, val2 = value1, value2
+            def same_string?(value_1, value_2, exact: false, mild: false, ignore: false) # rubocop:disable Metrics/AbcSize
+              return true  if value_1.to_s.strip.empty? && value_2.to_s.strip.empty?
+              return false if value_1.to_s.strip.empty? || value_2.to_s.strip.empty?
+
+              val_1, val_2 = value_1, value_2 # rubocop:disable Style/ParallelAssignment
+
               unless exact
-                if val1.is_a?(String)
-                  val1 = simplify_string(val1, ignore: ignore) if ignore
-                  val1 = simplify_string(val1, ignore: non_letters_regex) if mild
+                if val_1.is_a?(String)
+                  val_1 = simplify_string(val_1, ignore: ignore) if ignore
+                  val_1 = simplify_string(val_1, ignore: non_letters_regex) if mild
                 end
-                if val2.is_a?(String)
-                  val2 = simplify_string(val2, ignore: ignore) if ignore
-                  val2 = simplify_string(val2, ignore: non_letters_regex) if mild
+                if val_2.is_a?(String)
+                  val_2 = simplify_string(val_2, ignore: ignore) if ignore
+                  val_2 = simplify_string(val_2, ignore: non_letters_regex) if mild
                 end
               end
-              case
-              when val1.is_a?(String) && val2.is_a?(String)
-                val1 == val2
-              when val1.is_a?(Regexp) && val2.is_a?(String)
-                val2 =~ val1
-              when val1.is_a?(String) && val2.is_a?(Regexp)
-                val1 =~ val2
+
+              if val_1.is_a?(String) && val_2.is_a?(String)
+                val_1 == val_2
+              elsif val_1.is_a?(Regexp) && val_2.is_a?(String)
+                val_2 =~ val_1
+              elsif val_1.is_a?(String) && val_2.is_a?(Regexp)
+                val_1 =~ val_2
               else
-                #val1 == val2
-                raise "Expected at least one String, and either a String or Regex. Given: (1: #{val1.class}) and (2: #{val2.class})"
+                #val_1 == val_2
+                msg  = "Expected at least one String, and either a String or Regex. "
+                msg << "Given: (1: #{val_1.class}) and (2: #{val_2.class})"
+                raise ArgumentError, msg
               end
             end
 
             def titleize(str)
               return nil unless str
               return str if str.strip.empty?
+
               str.split(/\s+/).map do |part|
                 part[0] = part[0].upcase
-                part[1..-1] = part[1..-1].downcase
+                part[1..-1] = part[1..].downcase
                 part
               end.join(" ")
             end
 
             def normalize_string(str)
               return nil unless str
-              str.gsub(/[^[:print:]]/, '')
-              .gsub(/[[:space:]]+/, ' ')
-              .gsub(/[[:space:]]$/, '')
-              .gsub(/[-\u2011\u2012\u2013]/, '-').yield_self do |str|
-                str = yield(str) if block_given?
-                str
-              end
+
+              str.gsub(/[^[:print:]]/, '').
+                gsub(/[[:space:]]+/, ' ').
+                gsub(/[[:space:]]$/, '').
+                gsub(/[-\u2011\u2012\u2013]/, '-').then do |aux|
+                  aux = yield(aux) if block_given?
+                  aux
+                end
             end
 
             def clean_question(str)
               return nil unless str
-              normalize_string(str) do |str|
-                str.gsub(/\r\n/, ' ').yield_self do |str|
-                  str = yield(str) if block_given?
-                  str
+
+              normalize_string(str) do |x|
+                x.gsub(/\r\n/, ' ').then do |aux|
+                  aux = yield(aux) if block_given?
+                  aux
                 end
               end
             end
@@ -116,7 +124,7 @@ module Eco
                 when Ecoportal::API::V2::Page::Section
                   ref << "Section '#{obj.heading || "(unnamed)"}'"
                 when Ecoportal::API::V2::Page::Component
-                  ref << "Component '#{obj.label || "(unnamed of type '#{obj.type}')"}' in #{object_reference(obj.section)}"
+                  ref << "Component '#{obj.label || "(unnamed of type '#{obj.type}')"}' in #{object_reference(obj.section)}" # rubocop:disable Layout/LineLength
                 when Ecoportal::API::V2::Page::Force
                   ref << "Force '#{obj.name}'"
                 when Ecoportal::API::V2::Page::Force::Binding
@@ -131,12 +139,10 @@ module Eco
             end
 
             # https://stackoverflow.com/a/5661695/4352306
-            def is_number?(value)
-              begin
-                true if Float(value)
-              rescue ArgumentError => e
-                false
-              end
+            def is_number?(value) # rubocop:disable Naming/PredicateName
+              true if Float(value)
+            rescue ArgumentError
+              false
             end
           end
         end

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

@@ -8,13 +8,13 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   attr_reader :target
 
-  SAVE_PATCH = "ooze_patch_update.json"
+  SAVE_PATCH = "ooze_patch_update.json".freeze
   DRY_COUNT  = 5
 
-  def main(session, options, usecase)
+  def main(_session, options, _usecase)
     options[:end_get] = false
     raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
-    @target  = nil
+    @target = nil
     yield
   end
 
@@ -77,7 +77,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
       end
     end
     flds.select do |fld|
-      value = (label == :unnamed) ? nil : label
+      value = label == :unnamed ? nil : label
       !label || same_string?(fld.label, value)
     end.each do |field|
       yield(field) if block_given?
@@ -87,8 +87,8 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   def with_sections(entry = target, type: nil, heading: nil)
     secs = entry.sections
     secs = secs.get_by_type(type) if type
-    secs = secs.select do |sec|
-      value = (heading == :unnamed) ? nil : heading
+    secs.select do |sec|
+      value = heading == :unnamed ? nil : heading
       !heading || same_string?(sec.heading, value)
     end.each do |sec|
       yield(sec) if block_given?
@@ -96,9 +96,8 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   def with_stage(name:)
-    if stage = target.stages.get_by_name(name)
-      yield(stage) if block_given?
-    end
+    return unless (stage = target.stages.get_by_name(name))
+    yield(stage) if block_given?
     stage
   end
 
@@ -106,6 +105,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   # Hook method to use before the target is switched
   def before_loading_new_target(ooze_id)
+    ooze_id
   end
 
   def ooze(ooze_id = nil, stage_id: nil)
@@ -122,13 +122,13 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   def stage(id_name = nil, ooze: target)
-    if ooze_id = ooze && ooze.id
+    if (ooze_id = ooze&.id)
       exit_error "#{object_reference(ooze)} does not have stages!" unless ooze.stages?
     else
       exit_error "There's no target ooze to retrieve stages from"
     end
 
-    if stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
+    if (stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name))
       return ooze if ooze.respond_to?(:current_stage_id) && (ooze.current_stage_id == stg.id)
       before_loading_new_target(ooze_id)
       return apiv2.pages.get(ooze_id, stage_id: stg.id).tap do |stage|
@@ -184,7 +184,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   def backup_patch!(ooze = target)
-    unless patch = (patch_doc(ooze) || {})["page"]
+    unless (patch = (patch_doc(ooze) || {})["page"])
       logger.info "No changes to update for #{object_reference(ooze)}."
       return
     end
@@ -200,11 +200,9 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   def display_patch(entry = target)
-    unless options.dig(:feedback, :only_stats)
-      if patch = (patch_doc(entry) || {})["page"]
-        pp patch
-      end
-    end
+    return if options.dig(:feedback, :only_stats)
+    return unless (patch = (patch_doc(entry) || {})["page"])
+    pp patch
   end
 
   def patch_doc(ooze = target)
@@ -229,8 +227,8 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     false
   end
 
-  def apiv2
-   @apiv2 ||= session.api(version: :oozes)
+  def apiv2 # rubocop:disable Naming/VariableNumber
+    @apiv2 ||= session.api(version: :oozes) # rubocop:disable Naming/VariableNumber
   end
 
   def exit_error(msg)

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

@@ -21,10 +21,9 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   attr_reader :session, :options, :usecase
   attr_reader :target
 
-  def main(session, options, usecase)
+  def main(_session, options, _usecase)
     options[:end_get] = false
-    @session = session; @options = options; @usecase = usecase
-    @target  = nil
+    @target = nil
     raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
 
     with_each_entry do |ooze|
@@ -48,9 +47,8 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   def with_each_entry
     batched_search_results do |page_results|
       page_results.each do |page_result|
-        if ooz = build_full_ooze(page_result.id)
-          yield(ooz)
-        end
+        next unless (ooz = build_full_ooze(page_result.id))
+        yield(ooz)
       end
     end
   end
@@ -59,36 +57,39 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   # @note If it's a page instance with stages, there's where it will be handy
   # @param ooze_id [String]
   # @return [Ecoportal::API::V2::Page]
-  def build_full_ooze(ooze_id)
-    if page = ooze(ooze_id)
-      return page unless page.is_a?(Ecoportal::API::V2::Pages::PageStage)
-      pending_stage_ids = page.stages.ordered.map(&:id) - [page.current_stage_id]
-      state  = page.state
-      secs_doc = page.sections.doc
-      flds_doc = page.components.doc
-      hsecs = secs_doc.each_with_object({}) {|sec, h| h[sec["id"]] = sec}
-      hflds = flds_doc.each_with_object({}) {|fld, h| h[fld["id"]] = fld}
-      pending_stage_ids.each do |id|
-        if other_stage = stage(id, ooze: page)
-          state = "inprogress" unless other_stage.state == "complete"
-          other_stage.sections.doc.each do |sec_doc|
-            unless hsecs.key?(id = sec_doc["id"])
-              hsecs[id] = sec_doc
-              secs_doc << sec_doc
-            end
-          end
-          other_stage.components.doc.each do |comp_doc|
-            unless hflds.key?(id = comp_doc["id"])
-              hflds[id] = comp_doc
-              flds_doc << comp_doc
-            end
-          end
+  def build_full_ooze(ooze_id) # rubocop:disable Metrics/AbcSize
+    return unless (page = ooze(ooze_id))
+    return page unless page.is_a?(Ecoportal::API::V2::Pages::PageStage)
+
+    pending_stage_ids = page.stages.ordered.map(&:id) - [page.current_stage_id]
+    state    = page.state
+    secs_doc = page.sections.doc
+    flds_doc = page.components.doc
+    hsecs    = secs_doc.each_with_object({}) {|sec, h| h[sec["id"]] = sec}
+    hflds    = flds_doc.each_with_object({}) {|fld, h| h[fld["id"]] = fld}
+
+    pending_stage_ids.each do |id|
+      next unless (other_stage = stage(id, ooze: page))
+
+      state = "inprogress" unless other_stage.state == "complete"
+      other_stage.sections.doc.each do |sec_doc|
+        unless hsecs.key?(id = sec_doc["id"])
+          hsecs[id] = sec_doc
+          secs_doc << sec_doc
         end
       end
-      Ecoportal::API::V2::Pages::PageStage.new(page.doc).tap do |ozz|
-        ozz.state = state
+
+      other_stage.components.doc.each do |comp_doc|
+        unless hflds.key?(id = comp_doc["id"])
+          hflds[id] = comp_doc
+          flds_doc << comp_doc
+        end
       end
     end
+
+    Ecoportal::API::V2::Pages::PageStage.new(page.doc).tap do |ozz|
+      ozz.state = state
+    end
   end
 
   def batched_search_results
@@ -118,7 +119,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   end
 
   def stage(id_name = nil, ooze: target)
-    if ooze_id = ooze && ooze.id
+    if (ooze_id = ooze&.id)
       exit_error "#{object_reference(ooze)} does not have stages!" unless ooze.stages?
     else
       exit_error "There's no target ooze to get retrieve stages from"
@@ -145,12 +146,16 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   def results_preview
     apiv2.registers.search(register_id, search_options.merge(only_first: true)).tap do |search_results|
       str_results = "Total target entries: #{search_results.total} (out of #{search_results.total_before_filtering})"
-      session.prompt_user("Do you want to proceed (y/N):", explanation: str_results, default: default_proceed, timeout: 10) do |res|
-        unless res.upcase.start_with?("Y")
-          puts "..."
-          logger.info "Aborting script..."
-          exit(0)
-        end
+      session.prompt_user(
+        "Do you want to proceed (y/N):",
+        explanation: str_results,
+        default:     default_proceed,
+        timeout:     10
+      ) do |res|
+        next if res.upcase.start_with?("Y")
+        puts "..."
+        logger.info "Aborting script..."
+        exit(0)
       end
     end
   end
@@ -165,20 +170,20 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   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
     options.dig(:source, :register_id)
   end
 
-  def apiv2
-   @apiv2 ||= session.api(version: :oozes)
+  def apiv2 # rubocop:disable Naming/VariableNumber
+    @apiv2 ||= session.api(version: :oozes) # rubocop:disable Naming/VariableNumber
   end
 
   def exit_error(msg)