eco-helpers 3.0.24 → 3.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82c49ee783ef70db3f477e8e340dfe54f7b8afb086402cede5ea1efc78da93b
-  data.tar.gz: 62137fa5d90eea73bfe07e7bf27f2d8d566feee689183abf0400423ba6774793
+  metadata.gz: 209a98dac82894462d5ba24f82a85965cb10c14513d617e86d09fcfb96d3f81a
+  data.tar.gz: 288706b5a0f8a3aa81376edd2a42d61d690aae49cf6be6af9b7be5b52f34764a
 SHA512:
-  metadata.gz: 530137a689b4894697cb7cb7f0cd0d436d65576c486bf56bc614a2798d3ee6fb603abc90530524365e822e33060d8eb008197dce7f1d432d170be80f033d1975
-  data.tar.gz: 31079964777cb0a632f4f401a210915289e91c31335bf47641b58574c32d6074aaa3f3643b8708608ebff19e4572938c7c2c3bba32c12e576b26f9ccbacfb03b
+  metadata.gz: 3507855864665cf289361e803d5e9a835b9eb24d06e66a7249b4b8f9e0388eb65b51f5d8f634c0141a4562979dd69fb2df96c753de9325ef350351a6719be7f6
+  data.tar.gz: 8ef26aec84fd8ceb559fbf4a938f30f2b06f2abc73ce9fdf09b70e48fb3d4f7e0f0904ef65c5cd1dc81d1d143b1888d24c50e884884a34c321baf54022547dd4

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.24] - 2025-03-xx
+## [3.0.26] - 2025-03-xx
 
 ### Added
 
@@ -10,6 +10,33 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.0.25] - 2025-03-23
+
+### Added
+
+- `Session::Config#structure_id=`
+- `Eco::API::UseCases::Lib`. Starting with:
+  - `Sftp` helpers
+  - `FilePattern` helper
+  - `ErrorHandling` helpers
+
+### Changed
+
+- upgraded `ecoportal-api-graphql`
+- upgraded `ecoportal-api-v2`
+- remove **warning** on `cli.apply!` against the same `cli` option.
+  - it is understandable it is called via inheritance.
+
+### Fixed
+
+- `clean-unknown-tags`: remove unused and undefined code.
+- `UseCases::GraphQL::Location::Base#target_structure_id`
+  - Lookup should include `Session::Config#structure_id` as a fallback.
+
+## [3.0.24] - 2025-03-11
+
+### Fixed
+
 - Preserve `structure_id` as target locations id
 
 ## [3.0.23] - 2025-03-10

data/eco-helpers.gemspec

@@ -41,8 +41,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
   spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.8'
-  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4',  '>= 0.4.4'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.15'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4',  '>= 0.4.5'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.16'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'

data/lib/eco/api/common/people/person_entry_attribute_mapper.rb

@@ -386,7 +386,7 @@ module Eco
 
           def debug(var, msg)
             return unless DEBUG
-            puts "\n  • #{msg}:"
+            puts "\n  * #{msg}:"
             pp var
           end
         end

data/lib/eco/api/common/session/sftp.rb

@@ -108,7 +108,7 @@ module Eco
             [files].flatten.compact.map do |fullname|
               basename = windows_basename(fullname)
               dest_fullname = File.join(local_folder || ".", basename)
-              puts " • #{dest_fullname}"
+              puts " * #{dest_fullname}"
               created_files << dest_fullname
               sftp_session.download(fullname, dest_fullname)
             end.each(&:wait)

data/lib/eco/api/microcases/person_update.rb

@@ -19,14 +19,14 @@ module Eco
           else
             msg  = "#{context} Error #{response.status}: #{response.body}\n"
             msg += " -- Failed to \"#{reason}\".\n"
-            msg += "  • Person: #{person_ref(person)}"
+            msg += "  * Person: #{person_ref(person)}"
             log(:error) { msg }
             false
           end
         else
           msg  = "#{context} Error (connection error)\n"
           msg += " -- Failed to \"#{reason}\".\n"
-          msg += "  • Person: #{person_ref(person)}"
+          msg += "  * Person: #{person_ref(person)}"
 
           log(:error) { msg }
           false

data/lib/eco/api/session/config.rb

@@ -249,6 +249,7 @@ module Eco
         def tagtree_id=(value)
           tagtree_config.structure_id = value
         end
+        alias_method :structure_id=, :tagtree_id=
 
         # The location node classifications of the organization
         # @return [Eco::API::Organization::NodeClassifications]

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

@@ -5,11 +5,9 @@ module Eco
         module DSL
           # Links the usecase to the Cli via `arg_case`
           def apply!(arg_case = cli_name)
-            #puts "DEFINING CLI for '#{arg_case}' via #{self}"
-            if applied?(arg_case)
-              puts "Warning: (#{self}) Tried to call again cli.apply! on '#{arg_case}'"
-              return self
-            end
+
+            # puts "Debug: (#{self}) Tried to call again cli.apply! on '#{arg_case}'"
+            return self if applied?(arg_case)
 
             cli_config_case(arg_case)
             apply_options(arg_case)

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

@@ -65,7 +65,7 @@ class Eco::API::UseCases::Default::Locations::TagtreeExtract < Eco::API::UseCase
       exit 1
     end
   rescue StandardError => err
-    log(:error) { "Something went wrong whene extracting '#{tree.name}':\n  • #{err}" }
+    log(:error) { "Something went wrong whene extracting '#{tree.name}':\n  * #{err}" }
     exit 1
   end
 

data/lib/eco/api/usecases/default/people/amend/clean_unknown_tags_case.rb

@@ -19,9 +19,6 @@ class Eco::API::UseCases::Default::People::Amend::CleanUnknownTags < Eco::API::C
     people.each do |person|
       update_job.add(person)
 
-      update_filter_tags!(person)
-      update_default_tag!(person)
-
       clean_unkown_tags!(person)
       clean_archived_nodes!(person) if clean_archived?
     end
@@ -92,10 +89,10 @@ class Eco::API::UseCases::Default::People::Amend::CleanUnknownTags < Eco::API::C
 
     cleaned_sorted = data.sort_by {|tag, count| [count * -1, tag]}
 
-    msg << "\n  • "
+    msg << "\n  * "
     msg += cleaned_sorted.map do |tag, count|
       "'#{tag}' (#{count})"
-    end.join("\n  • ")
+    end.join("\n  * ")
 
     log(:info) { msg }
     data.clear

data/lib/eco/api/usecases/default/people/amend/restore_db_case.rb

@@ -94,7 +94,7 @@ class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Comm
       msg << "There were #{re_starters.length} entries of the backup "
       msg << "that do not exist in the (filtered?) people manager."
       msg << "Some examples:"
-      msg << "  • #{examples.join("\n  • ")}"
+      msg << "  * #{examples.join("\n  * ")}"
       msg.join("\n")
     }
   end

data/lib/eco/api/usecases/default/people/migrate/remap_tags_case.rb

@@ -96,8 +96,8 @@ class Eco::API::UseCases::Default::People::Migrate::RemapTags < Eco::API::Common
 
     log(:info) {
       msg  = "Here list of the #{removed_src_tags.count} removed source-mapped tags..."
-      msg << "\n  • "
-      msg << removed_src_tags.sort.join("\n  • ")
+      msg << "\n  * "
+      msg << removed_src_tags.sort.join("\n  * ")
       msg
     }
   end
@@ -133,10 +133,10 @@ class Eco::API::UseCases::Default::People::Migrate::RemapTags < Eco::API::Common
 
     cleared_sorted = data.sort_by {|tag, count| [count * -1, tag]}
 
-    msg << "\n  • "
+    msg << "\n  * "
     msg += cleared_sorted.map do |tag, count|
       "'#{tag}' (#{count})"
-    end.join("\n  • ")
+    end.join("\n  * ")
 
     log(:info) { msg }
     data.clear

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

@@ -1,3 +1,4 @@
-class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::UseCases::Samples::Drivers::Sftp
+module Eco::API::UseCases::DefaultCases::Samples
+  class Sftp < Eco::API::UseCases::Samples::Drivers::Sftp
+  end
 end
-

data/lib/eco/api/usecases/graphql/helpers/base/error_handling.rb

@@ -1,70 +1,6 @@
 module Eco::API::UseCases::GraphQL::Helpers::Base
   # Basic stuff you would need in any use case
   module ErrorHandling
-    include Eco::Language::AuxiliarLogger
-
-    attr_reader :exception, :exiting
-
-    private
-
-    def exception_already_captured?(err)
-      err == exception
-    end
-
-    def interrupted?(err = exception)
-      interrupt_errors.any? {|klass| err.is_a?(klass)}
-    end
-
-    def error_raised?
-      exception && !interrupted?
-    end
-
-    def exiting?
-      @exiting
-    end
-
-    def exception?
-      error_raised? || exiting?
-    end
-
-    def rescued
-      yield
-    rescue StandardError => err
-      self.exception ||= err
-
-      return unless exception_already_captured?(err)
-
-      log(:error) { err.patch_full_message }
-    rescue SystemExit
-      @exiting = true
-      raise
-    end
-
-    def with_error_handling
-      @exception = nil
-      yield
-    rescue StandardError, SignalException => err
-      @exception = err
-      raise
-    rescue SystemExit
-      @exiting = true
-      raise
-    rescue *interrupt_errors
-      @exception = int
-      raise
-    rescue SystemStackError
-      puts $! # rubocop:disable Style/SpecialGlobalVars
-      puts caller[0..100]
-      raise
-    end
-
-    def interrupt_errors
-      return @interrupt_errors if @interrupt_errors
-
-      errs = [Interrupt]
-      errs << IRB::Abort if Object.const_defined?(:IRB) && IRB.const_defined?(:Abort)
-
-      @interrupt_errors = errs
-    end
+    include Eco::API::UseCases::Lib::ErrorHandling
   end
 end

data/lib/eco/api/usecases/graphql/helpers/location/base.rb

@@ -12,6 +12,8 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       @target_structure_id ||= tagtree_id
       @target_structure_id ||= target_structure_id_const
       @target_structure_id ||= current_tree.id if current_tree.respond_to?(:id)
+      @target_structure_id ||= config.tagtree_config.structure_id
+
       return @target_structure_id if @target_structure_id
 
       msg  = 'Const TARGET_STRUCTURE_ID has not been defined, '

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages.rb

@@ -40,12 +40,12 @@
 #       * However, to build the remap tags table, it does matter: from bottom to top. Children should be
 #       retagged first because retagging first parents changes the path of their children retags.
 #   (5) ARCHIVE (bottom-top) should happen always LAST, after nodes have been MOVED.
-#     • The order of archiving should probably be:
+#     * The order of archiving should probably be:
 #       (a) although firstly thought go from leafs to root to prevent the `archiveToken`
 #         it should go from top-to-bottom, so precisely the `archiveToken` is generated and history well sorted.
 #       (b) to preventing `already archived node` errors, we should only include the parent
 #   (6) RE-ARCHIVE (bottom-top) see (1.b) all those that were automatically unarchived but should remain archived.
-#     • The neat solution is to recalculate changes with the live_tree and the final desired result,
+#     * The neat solution is to recalculate changes with the live_tree and the final desired result,
 #       but perhaps only target those to be re-archived?
 class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
   module Stages

data/lib/eco/api/usecases/graphql/helpers/location/command/result.rb

@@ -49,7 +49,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
       feed.concat(error.validationErrors.map(&:message)) unless error.validationErrors.empty?
       feed << "Command: #{command_input_data.pretty_inspect}"
 
-      msg  << "  • #{feed.join("\n  • ")}"
+      msg  << "  * #{feed.join("\n  * ")}"
       msg.join("\n")
     end
 

data/lib/eco/api/usecases/graphql/helpers/location/command/results.rb

@@ -9,9 +9,9 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
 
     def stats
       msg       = ''
-      msg << "  • Errored: #{errored.count} #{first_err_str}\n" if errored?
-      msg << "  • Applied: #{errored.count} #{last_okay_str}\n" if some_applied?
-      msg << "  • Pending: #{pending.count}\n"                  if some_pending?
+      msg << "  * Errored: #{errored.count} #{first_err_str}\n" if errored?
+      msg << "  * Applied: #{errored.count} #{last_okay_str}\n" if some_applied?
+      msg << "  * Pending: #{pending.count}\n"                  if some_pending?
       msg
     end
 

data/lib/eco/api/usecases/graphql/helpers/location/tags_remap.rb

@@ -32,7 +32,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       "".tap do |str|
         each.map do |tags_map|
           from, to = tags_map.to_csv_row
-          str << " • '#{from}' => '#{to}'\n"
+          str << " * '#{from}' => '#{to}'\n"
         end
       end
     end

data/lib/eco/api/usecases/graphql/utils/sftp.rb

@@ -1,134 +1,6 @@
 module Eco::API::UseCases::GraphQL::Utils
   module Sftp
     include Eco::API::UseCases::GraphQL::Helpers::Base::CaseEnv
-
-    def upload(local_file, subfolder: remote_subfolder, gid: sftp_group_id)
-      sftp_session.upload(
-        local_file,
-        remote_folder: remote_folder(subfolder),
-        gid:           gid
-      )
-    end
-    alias_method :sftp_upload, :upload
-
-    def sftp_group_id
-      if self.class.const_defined?(:SFTP_GROUP)
-        self.class.const_get(:SFTP_GROUP)
-      elsif (group_id = options.dig(:sftp, :group))
-        group_id
-      end
-    end
-
-    def sftp_download_files(subfolder: remote_subfolder, pattern: nil, local_folder: self.local_folder, &block)
-      remote_files = with_remote_files(subfolder: subfolder, pattern: pattern)
-      return [] if remote_files.empty?
-
-      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 << "  • "
-        msg << file_names.join("\n  • ")
-        msg
-      }
-
-      sftp.download(file_names, local_folder: local_folder, &block)
-    end
-
-    def sftp_move_file(source, dest)
-      sftp.move(source, dest, 0x0001) do |response|
-        if response.ok?
-          log(:info) { "#{source}\n  -to-> #{dest}"    }
-        else
-          log(:info) { "Could not move file #{source}" }
-        end
-      end
-    end
-
-    def ensure_remote_empty(subfolder: remote_subfolder, pattern: nil)
-      files = with_remote_files(subfolder: subfolder, pattern: pattern)
-      return if files.empty?
-
-      msg  = "There are still files in the remote folder that will be deleted: '#{subfolder}':\n"
-      msg << "  • "
-      str  = files.map(&:longname).join("\n  • ")
-      str << "\n"
-      msg << str
-
-      session.prompt_user(
-        "Do you want to proceed to delete? (Y/n):",
-        explanation: msg,
-        default:     "Y",
-        timeout:     3
-      ) do |response|
-        next unless response.upcase.start_with?("Y")
-
-        files.each do |file|
-          remote_full_path = to_remote_path(file.name, subfolder: subfolder)
-          res              = sftp_session.remove(remote_full_path)
-          log(:info) {
-            "Deleted remote file: '#{remote_full_path}' (#{res})"
-          }
-        end
-      end
-    end
-
-    # @param subfolder [String] the subfolder.
-    def with_remote_files(subfolder: remote_subfolder, pattern: nil)
-      sftp.files(remote_folder(subfolder), pattern: pattern).each do |remote_file|
-        yield(remote_file) if block_given?
-      end
-    rescue ArgumentError
-      raise
-    rescue ::Net::SFTP::StatusException => err
-      log(:error) {
-        msg  = "(#{self.class}) There was an error trying to access "
-        msg << "the remote folder '#{subfolder}': #{err}"
-        msg
-      }
-      []
-    end
-
-    def to_remote_path(file, subfolder: remote_subfolder)
-      [remote_folder(subfolder), file].join('/')
-    end
-
-    def remote_subfolder
-      if (remote_dir = options.dig(:sftp, :remote_subfolder))
-        remote_dir
-      elsif self.class.const_defined?(:REMOTE_FOLDER)
-        self.class::REMOTE_FOLDER
-      end
-    end
-
-    def remote_folder(subfolder = remote_subfolder)
-      [sftp_env_base_path, subfolder].compact.join('/')
-    end
-
-    def sftp_env_base_path
-      sftp_config.remote_folder
-    end
-
-    def local_folder
-      if (local_dir = options.dig(:sftp, :local_folder))
-        local_dir
-      elsif self.class.const_defined?(:LOCAL_FOLDER)
-        self.class::LOCAL_FOLDER
-      else
-        "."
-      end
-    end
-
-    def sftp_config
-      session.config.sftp
-    end
-
-    def sftp_session
-      sftp.sftp_session
-    end
-
-    def sftp
-      session.sftp
-    end
+    include Eco::API::UseCases::Lib::Sftp
   end
 end

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

@@ -0,0 +1,70 @@
+module Eco::API::UseCases::Lib
+  # Basic stuff you would need in any use case
+  module ErrorHandling
+    include Eco::Language::AuxiliarLogger
+
+    attr_reader :exception, :exiting
+
+    private
+
+    def exception_already_captured?(err)
+      err == exception
+    end
+
+    def interrupted?(err = exception)
+      interrupt_errors.any? {|klass| err.is_a?(klass)}
+    end
+
+    def error_raised?
+      exception && !interrupted?
+    end
+
+    def exiting?
+      @exiting
+    end
+
+    def exception?
+      error_raised? || exiting?
+    end
+
+    def rescued
+      yield
+    rescue StandardError => err
+      self.exception ||= err
+
+      return unless exception_already_captured?(err)
+
+      log(:error) { err.patch_full_message }
+    rescue SystemExit
+      @exiting = true
+      raise
+    end
+
+    def with_error_handling
+      @exception = nil
+      yield
+    rescue StandardError, SignalException => err
+      @exception = err
+      raise
+    rescue SystemExit
+      @exiting = true
+      raise
+    rescue *interrupt_errors
+      @exception = int
+      raise
+    rescue SystemStackError
+      puts $! # rubocop:disable Style/SpecialGlobalVars
+      puts caller[0..100]
+      raise
+    end
+
+    def interrupt_errors
+      return @interrupt_errors if @interrupt_errors
+
+      errs = [Interrupt]
+      errs << IRB::Abort if Object.const_defined?(:IRB) && IRB.const_defined?(:Abort)
+
+      @interrupt_errors = errs
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Eco::API::UseCases::Lib
+  module FilePattern
+    class WrongConst < ArgumentError; end
+
+    CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/
+
+    attr_reader :options
+
+    private
+
+    # Can't pass this via CLI option, as it breaks the regular expression
+    def file_pattern(required: true)
+      fpc = file_pattern_const
+      return fpc if fpc
+      return     unless required
+
+      msg  = "(#{self.class}) You should redefine the file_pattern function "
+      msg << 'as a RegEx expression that matches the target remote file'
+      raise WrongConst, msg
+    end
+
+    def file_pattern_const
+      if (fpc = options.dig(:sftp, :file_pattern_const))
+        msg = "(#{self.class}) Invalid file pattern const referral: #{fpc}"
+        raise WrongConst, msg unless fpc.match(CONST_REFERRAL)
+
+        begin
+          self.eval(fpc)
+        rescue NameError
+          self.class.const_get(fpc)
+        end
+      end
+    rescue NameError
+      raise WrongConst, "(#{self.class}) Unknown constant: #{fpc}"
+    end
+  end
+end