eco-helpers 3.0.26 → 3.0.28

data/lib/eco/api/usecases/lib/{sftp.rb → files/sftp.rb}

@@ -1,4 +1,4 @@
-module Eco::API::UseCases::Lib
+module Eco::API::UseCases::Lib::Files
   module Sftp
     class UnspecifiedRemoteFolder < ArgumentError; end
 
@@ -8,6 +8,7 @@ module Eco::API::UseCases::Lib
 
     private
 
+    # @return [String, FalseClass] the path of the remote file or `false` if failed.
     def upload(local_file, subfolder: remote_subfolder, gid: sftp_group_id)
       sftp_session.upload(
         local_file,
@@ -18,6 +19,9 @@ module Eco::API::UseCases::Lib
     alias_method :sftp_upload, :upload
 
     def sftp_group_id
+      return super    if defined?(super) && !super.nil?
+      return group_id if respond_to?(:group_id, true)
+
       if (group_id = options.dig(:sftp, :group))
         group_id
       elsif self.class.const_defined?(:SFTP_GROUP)
@@ -31,15 +35,19 @@ module Eco::API::UseCases::Lib
       subfolder:    remote_subfolder,
       pattern:      nil,
       local_folder: self.local_folder,
+      only_latest:  false,
       &block
     )
       remote_files = with_remote_files(subfolder: subfolder, pattern: pattern)
-      return [] if remote_files.empty?
+
+      return []                           if remote_files.empty?
+      remote_files = [remote_files.first] if only_latest
 
       file_names = remote_files.map {|file| to_remote_path(file.name, subfolder: subfolder)}
 
       log(:info) {
-        msg  = "Getting the following files into the local folder '#{local_folder}':\n"
+        msg  = "Getting the following files into the local folder "
+        msg << "'#{local_folder || '.'}':\n"
         msg << '  * '
         msg << file_names.join("\n  * ")
         msg
@@ -80,7 +88,7 @@ module Eco::API::UseCases::Lib
       sftp_archive_file!(filename)
     end
 
-    def ensure_remote_empty(subfolder: remote_subfolder, pattern: nil)
+    def ensure_remote_empty(subfolder: remote_subfolder, pattern: nil, timeout: 3)
       files = with_remote_files(subfolder: subfolder, pattern: pattern)
       return if files.empty?
 
@@ -94,7 +102,7 @@ module Eco::API::UseCases::Lib
         'Do you want to proceed to delete? (Y/n):',
         explanation: msg,
         default:     'Y',
-        timeout:     3
+        timeout:     timeout
       ) do |response|
         next unless response.upcase.start_with?('Y')
 
@@ -109,12 +117,12 @@ module Eco::API::UseCases::Lib
     end
 
     def local_folder
+      return super if defined?(super) && !super.nil?
+
       if (local_dir = options.dig(:sftp, :local_folder))
         local_dir
       elsif self.class.const_defined?(:LOCAL_FOLDER)
         self.class::LOCAL_FOLDER
-      else
-        '.'
       end
     end
 
@@ -125,6 +133,8 @@ module Eco::API::UseCases::Lib
     # `remote_target_folder` overrides `sftp_config.remote_folder` as well as `remote_subfolder`
     # `remote_folder` overrides `sftp_config.remote_folder` but NOT `remote_subfolder`
     def remote_folder(subfolder = remote_subfolder)
+      return super if defined?(super) && !super.nil?
+
       rm_tf = options.dig(:sftp, :remote_target_folder)
       return rm_tf if rm_tf
 
@@ -133,6 +143,8 @@ module Eco::API::UseCases::Lib
     end
 
     def remote_subfolder(required: true)
+      return super if defined?(super) && !super.nil?
+
       remote_subdir   = options.dig(:sftp, :remote_subfolder)
       remote_subdir ||= self.class::REMOTE_FOLDER    if self.class.const_defined?(:REMOTE_FOLDER)
       remote_subdir ||= self.class::REMOTE_SUBFOLDER if self.class.const_defined?(:REMOTE_SUBFOLDER)

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

@@ -0,0 +1,7 @@
+module Eco::API::UseCases::Lib
+  module Files
+  end
+end
+
+require_relative 'files/sftp'
+require_relative 'files/file_pattern'

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

@@ -8,5 +8,4 @@ module Eco
 end
 
 require_relative 'lib/error_handling'
-require_relative 'lib/sftp'
-require_relative 'lib/file_pattern'
+require_relative 'lib/files'

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

@@ -1,13 +1,13 @@
 # Use case to export a register into a CSV
 class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::OozeSamples::RegisterExportCase
-  name "export-register"
+  name 'export-register'
   type :other
   batch_size 5
 
   def main(session, options, usecase)
-    super(session, options, usecase) do
+    super do
       # Save the File
-      CSV.open(filename, "w") do |csv|
+      CSV.open(filename, 'w') do |csv|
         csv << exportable_register.header(refresh: true)
         exportable_register.each(as_values: true) do |values|
           csv << values
@@ -79,7 +79,7 @@ class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::Oo
   end
 
   def options_delimiter
-    options.dig(:export, :options, :delimiter) || "|"
+    options.dig(:export, :options, :delimiter) || '|'
   end
 
   def include_deindexed?
@@ -94,7 +94,7 @@ class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::Oo
     @filename ||= (options[:file] || options.dig(:export, :file, :name)).tap do |filename|
       next if filename
 
-      log(:error) { "Destination file not specified" }
+      log(:error) { 'Destination file not specified' }
       return false
     end
   end

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

@@ -5,16 +5,16 @@ module Eco
         module Helpers
           # Class to ease the export process
           class ExportableOoze
-            MERGE_DELIMITER = "#:#".freeze
+            MERGE_DELIMITER = '#:#'.freeze
             META_FIELDS     = {
-              "id"         => "Internal ID",
-              "uid"        => "Unique ID",
-              "name"       => "Name of Page",
-              "state"      => "State of Page",
-              "time_zone"  => "Time Zone",
-              "created_at" => "Page Created",
-              "updated_at" => "Last updated",
-              "tags"       => "Location Tags"
+              'id'         => 'Internal ID',
+              'uid'        => 'Unique ID',
+              'name'       => 'Name of Page',
+              'state'      => 'State of Page',
+              'time_zone'  => 'Time Zone',
+              'created_at' => 'Page Created',
+              'updated_at' => 'Last updated',
+              'tags'       => 'Location Tags'
             }.freeze
             DEFAULT_OPTIONS = {
               delimiter:     "\n",
@@ -31,9 +31,10 @@ module Eco
               def label(field, default: nil)
                 value   = nil
                 value ||= field.label.to_s.strip if field.respond_to?(:label)
-                value   = nil unless value && !value.empty?
+                value   = nil                    unless value && !value.empty?
                 return value if value || !default
-                default || "Unnamed field:"
+
+                default || 'Unnamed field:'
               end
 
               def key_ref_label(field, default: nil)
@@ -157,6 +158,7 @@ module Eco
               return false if opts[:only_indexed]  && !self.class.indexed?(field)
               return false if opts[:only_labeled]  && !self.class.label?(field)
               return false if opts[:only_with_ref] && !self.class.with_ref?(field)
+
               true
             end
 
@@ -167,6 +169,7 @@ module Eco
             def to_value(field, delimiter: self.delimiter)
               return nil unless field.respond_to?(:to_s)
               return field.to_s unless offers_delimiter?(field.method(:to_s))
+
               field.to_s(delimiter: delimiter)
             end
 

data/lib/eco/api/usecases/ooze_samples/helpers_migration/copying.rb

@@ -69,7 +69,8 @@ class Eco::API::UseCases::OozeSamples
       # @note
       #   - When used with `type: nil` it may pair fields of different type. There isn't refinement for this yet.
       def with_src_dst_field_pair(src, dst, label: nil, label_dst: label, type: nil, src_excluded: [], dst_excluded: []) # rubocop:disable Metrics/AbcSize
-        msg = "These helpers are to be included in class cases inheriting from Eco::API::UseCases::OozeSamples::RegisterUpdateCase"
+        msg  = "These helpers are to be included in class cases "
+        msg << "inheriting from Eco::API::UseCases::OozeSamples::RegisterUpdateCase"
         raise msg unless respond_to?(:with_fields, true)
 
         src_flds = with_fields(src, label: label, type: type)
@@ -82,7 +83,7 @@ class Eco::API::UseCases::OozeSamples
           msg     = "There isn't a '#{type}'"
           dst_msg = dst_flds.empty?? "destination field named '#{label_dst}'" : nil
           src_msg = src_flds.empty?? "source field named '#{label}'" : nil
-          msg    << " #{[dst_msg, src_msg].join(" or ")} (source: '#{src.id}')"
+          msg    << " #{[dst_msg, src_msg].join(' or ')} (source: '#{src.id}')"
 
           log(:warn) { msg }
           return nil, nil
@@ -132,52 +133,42 @@ class Eco::API::UseCases::OozeSamples
       def copy_field_content(src, dst) # rubocop:disable Metrics/AbcSize
         type = src.type
         case type
-        when "select"
+        when 'select'
           src.values.each {|val| dst.select(val)} # rubocop:disable Style/HashEachMethods
           dst.other_desc = src.other_desc if src.other && src.other_desc && dst.other
-        when "plain_text", "date", "number", "gauge"
+        when 'plain_text', 'date', 'number', 'gauge'
           dst.value = src.value
-        when "rich_text"
+        when 'rich_text'
           dst.content = src.content
-        when "cross_reference"
+        when 'cross_reference'
           src.reference_ids.each {|id| dst.add(id)}
-        when "people"
+        when 'people'
           dst.people_ids << src.people_ids.to_a
-        when "geo"
+        when 'geo'
           src_coo = src.coordinates
           dst_coo = dst.coordinates
           dst_coo.lat, dst_coo.lon = src_coo.lat, src_coo.lon # rubocop:disable Style/ParallelAssignment
-        when "file"
+        when 'file'
           src.items.each do |src_item|
             dst.add_file(src_item.file_container_id) do |dst_item|
               dst_item.label = src_item.label
             end
           end
-        when "image_gallery"
+        when 'image_gallery'
           src.images.each do |src_image|
             dst.add_image(src_image.upload_id) do |dst_image|
               dst_image.caption = src_image.caption
             end
           end
-        when "checklist"
+        when 'checklist'
           src.items.each do |src_item|
             dst.add_item(label: src_item.label) do |dst_item|
               dst_item.checked = src_item.checked
             end
           end
-        when "law"
+        when 'law', 'page_action', 'actions_list', 'signature'
           "won't copy"
-        when "page_action"
-          "won't copy"
-        when "actions_list"
-          "won't copy"
-        when "signature"
-          "can't copy"
-        when "tag_field"
-          "can't copy"
-        when "chart"
-          "won't copy"
-        when "frequency_rate_chart"
+        when 'tag_field', 'chart', 'frequency_rate_chart'
           "won't copy"
         end
       end

data/lib/eco/api/usecases/ooze_samples/helpers_migration/typed_fields_pairing.rb

@@ -12,7 +12,7 @@ class Eco::API::UseCases::OozeSamples
     class TypedFieldsPairing
       include Eco::API::UseCases::OozeSamples::Helpers::Shortcuts
 
-      EXCLUDED_TYPES = ["tag_field", "chart", "frequency_rate_chart"]
+      EXCLUDED_TYPES = %w[tag_field chart frequency_rate_chart].freeze
 
       attr_reader :src, :dst
       attr_reader :src_unpaired, :dst_unpaired
@@ -20,11 +20,12 @@ class Eco::API::UseCases::OozeSamples
 
       def initialize(source, destination, src_excluded: nil, dst_excluded: nil,
           exclude_ximport: false)
-        @src = source
-        @dst = destination
-        @src_excluded = src_excluded || []
-        @dst_excluded = dst_excluded || []
-        @exclude_ximport = !!exclude_ximport
+        @src             = source
+        @dst             = destination
+        @src_excluded    = src_excluded || []
+        @dst_excluded    = dst_excluded || []
+        @exclude_ximport = exclude_ximport
+
         reset!
         process(exact: true)
         process
@@ -37,28 +38,36 @@ class Eco::API::UseCases::OozeSamples
       end
 
       def report_src_unpaired(only_present: true, only_indexed: false)
-        return nil if src_unpaired.empty?
-        msg  = "Source entry with unpaired fields (#{object_reference(src)}):\n"
+        return if src_unpaired.empty?
+
+        msg = "Source entry with unpaired fields (#{object_reference(src)}):\n"
+
         src_filtered = src_unpaired.values.flatten.reject do |src_fld|
           only_present && src_fld.empty?
         end.reject do |src_fld|
           only_indexed && src_fld.deindex
         end
-        return nil if src_filtered.empty?
+
+        return if src_filtered.empty?
+
         msg << src_filtered.map do |src_fld|
           "  * #{object_reference(src_fld)}"
         end.join("\n")
       end
 
       def report_dst_unpaired(only_required: false, exclude_ximport: true)
-        return nil if dst_unpaired.empty?
-        msg  = "Destination entry with unpaired fields (#{object_reference(src)}):\n"
+        return if dst_unpaired.empty?
+
+        msg = "Destination entry with unpaired fields (#{object_reference(src)}):\n"
+
         dst_filtered = dst_unpaired.values.flatten.reject do |dst_fld|
           only_required && !dst_fld.required
         end.reject do |dst_fld|
           exclude_ximport && ximport?(dst_fld)
         end
-        return nil if dst_filtered.empty?
+
+        return if dst_filtered.empty?
+
         msg << dst_filtered.map do |dst_fld|
           "  * #{object_reference(dst_fld)}"
         end.join("\n")
@@ -66,23 +75,27 @@ class Eco::API::UseCases::OozeSamples
 
       def report_multi_pairs(only_present: true, only_indexed: false, dst_exclude_ximport: true)
         return nil if src_dst_multi.empty?
-        "".tap do |msg|
-          msg << "Source fields in (#{object_reference(src)}) paired with multiple destination fields:\n"
-          msg_flds = ""
+        ''.tap do |msg|
+          msg     << "Source fields in (#{object_reference(src)}) paired with multiple destination fields:\n"
+          msg_flds = ''
           src_dst_multi.each do |type, pairs|
             pairs.each do |(src_fld, dst_flds)|
               next if (only_present && src_fld.empty?) || (only_indexed && src_fld.deindex)
+
               dst_filtered = dst_flds.reject do |dst_fld|
                 dst_exclude_ximport && ximport?(dst_fld)
               end
               next if dst_filtered.empty?
+
               msg_flds << "  * #{object_reference(src_fld)}\n"
               msg_flds << dst_filtered.map do |dst_fld|
                 "    * #{object_reference(dst_fld)}"
               end.compact.join("\n")
             end
           end
+
           return nil if msg_flds.empty?
+
           msg << msg_flds
         end
       end
@@ -91,8 +104,10 @@ class Eco::API::UseCases::OozeSamples
       def resolve(*flds)
         flds.each do |fld|
           next if unpaired_delete(fld, src_unpaired)
+
           unpaired_delete(fld, dst_unpaired)
         end
+
         multi_delete(*flds)
       end
 
@@ -120,11 +135,13 @@ class Eco::API::UseCases::OozeSamples
       def process(exact: false)
         src_unpaired.each do |type, src_pend|
           next unless (dst_pend = dst_unpaired[type]) && !dst_pend.empty?
+
           src_pend.dup.each do |src_fld|
             dst_candidates = dst_pend.select do |dst_fld|
               str_eq?(src_fld.label, dst_fld.label, exact: exact)
             end
             next if dst_candidates.empty?
+
             if dst_candidates.count == 1
               pair_add(src_fld, dst_candidates.first)
             else
@@ -134,14 +151,14 @@ class Eco::API::UseCases::OozeSamples
         end
       end
 
-      def str_eq?(str1, str2, exact: false)
-        same_string?(str1, str2, **str_eq_params.merge(exact: exact))
+      def str_eq?(str_1, str_2, exact: false)
+        same_string?(str_1, str_2, **str_eq_params, exact: exact)
       end
 
       def str_eq_params
         {
-          exact: exact?,
-          mild: only_letters?,
+          exact:  exact?,
+          mild:   only_letters?,
           ignore: false
         }.tap do |params|
           params.merge!(ignore: bracked_regex) if non_bracked?
@@ -158,13 +175,15 @@ class Eco::API::UseCases::OozeSamples
         type = fld.type
         return false unless unpaired.key?(type)
         return false unless (flds = unpaired[type]).delete(fld)
+
         unpaired.delete(type) if flds.empty?
         true
       end
 
       def multi_add(type, src_fld, *dst_flds)
         (src_dst_multi[type] ||= []) << (pair = [src_fld, dst_flds])
-        @src_multi[src_fld] = pair
+        @src_multi[src_fld]          = pair
+
         dst_flds.each do |dst_fld|
           (@dst_multi[dst_fld] ||= []) << pair
         end
@@ -172,8 +191,9 @@ class Eco::API::UseCases::OozeSamples
 
       def multi_delete(*flds)
         flds.each do |fld|
-          next unless type_pairs = src_dst_multi[fld.type]
-          if pairs = @dst_multi.delete(fld)
+          next unless (type_pairs = src_dst_multi[fld.type])
+
+          if (pairs = @dst_multi.delete(fld))
             pairs.each do |pair|
               src_fld = pair.first
               dst_flds = pair.last
@@ -186,12 +206,14 @@ class Eco::API::UseCases::OozeSamples
           elsif @src_multi.key?(fld)
             pair = @src_multi.delete(fld)
             type_pairs.delete(pair)
+
             pair.last.each do |dst_fld|
               pairs = @dst_multi[dst_fld]
               pairs.delete(pair)
               @dst_multi.delete(dst_fld) if pairs.empty?
             end
           end
+
           src_dst_multi.delete(fld.type) if type_pairs.empty?
         end
       end
@@ -215,20 +237,20 @@ class Eco::API::UseCases::OozeSamples
       end
 
       def ximport?(fld)
-        fld && fld.tooltip.to_s.include?("ximport")
+        fld && fld.tooltip.to_s.include?('ximport')
       end
 
       def reset!
-        @src_unpaired = by_type(src_components)
-        @dst_unpaired = by_type(dst_components)
+        @src_unpaired  = by_type(src_components)
+        @dst_unpaired  = by_type(dst_components)
         @src_dst_pairs = []
         reset_multi!
       end
 
       def reset_multi!
         @src_dst_multi = {}
-        @src_multi = {}
-        @dst_multi = {}
+        @src_multi     = {}
+        @dst_multi     = {}
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # @attr_reader target [Ecoportal::API::V2::Page] current target ooze.
 class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders::UseCase
-  name "ooze-base"
+  name 'ooze-base'
   type :other
 
   include Eco::API::UseCases::OozeSamples::Helpers
@@ -8,7 +8,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   attr_reader :target
 
-  SAVE_PATCH = "ooze_patch_update.json".freeze
+  SAVE_PATCH = 'ooze_patch_update.json'.freeze
   DRY_COUNT  = 5
 
   def main(_session, options, _usecase)
@@ -37,7 +37,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   def create_page(page = nil, template_id: nil, retrieve: false)
     template_id = template_id.id        if template_id.is_a?(Ecoportal::API::V2::Page)
     template_id ||= page.template_id    if page.respond_to?(:template_id)
-    template_id ||= page["template_id"] if page.is_a?(Hash)
+    template_id ||= page['template_id'] if page.is_a?(Hash)
     page = new_page(template_id)        unless page || !template_id
 
     yield(page) if block_given?
@@ -190,8 +190,8 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   def new_target(object, warn_pending_changes: true)
     if dirty?(target)
       if warn_pending_changes
-        msg =  "You you are switching to a new target #{object_reference(object)}"
-        msg += " after doing unsaved changes to #{object_reference(target)}"
+        msg  =  "You you are switching to a new target #{object_reference(object)}"
+        msg << " after doing unsaved changes to #{object_reference(target)}"
         log(:warn) { msg }
       end
 
@@ -202,17 +202,17 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   def dirty?(object)
-    object && patch_doc(object)["page"]
+    object && patch_doc(object)['page']
   end
 
   def backup_patch!(ooze = target)
-    unless (patch = (patch_doc(ooze) || {})["page"])
+    unless (patch = (patch_doc(ooze) || {})['page'])
       log(:info) { "No changes to update for #{object_reference(ooze)}." }
       return
     end
 
     # store the request
-    File.open(SAVE_PATCH, "w") do |file|
+    File.open(SAVE_PATCH, 'w') do |file|
       #file << (patch_doc || {}).to_json
       file << JSON.pretty_generate(patch || {})
     end
@@ -222,7 +222,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   def display_patch(entry = target)
     return if options.dig(:feedback, :only_stats)
-    return unless (patch = (patch_doc(entry) || {})["page"])
+    return unless (patch = (patch_doc(entry) || {})['page'])
 
     pp patch
   end

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

@@ -6,7 +6,7 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
   SAVE_PATCH = 'ooze_patch_update.json'.freeze
 
   def main(session, options, usecase)
-    super(session, options, usecase) do
+    super do
       if method(:process_ooze).parameters.count.zero?
         ooze # retrieve ooze
         process_ooze