eco-helpers 3.0.31 → 3.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc3166aa570a24f55a90822a79ad103419cbbd176677a5f17fe3ef8a27553cf6
-  data.tar.gz: f3418aa7bd4e8c645b60eeb839038a03da00fb4328a6acd63bb1500dfe18cfb8
+  metadata.gz: c7282df5e6d33e1467e6d2ad2aa039984bad1fa4f4a4160e703f2e07f91367ec
+  data.tar.gz: 002bcef35564d7613bfb81c5cc9a09058c0323a4729fb0362a808f48bf64634e
 SHA512:
-  metadata.gz: 3ca74dcfcb34cc4b252c5613fcf3bf786eb85435920fae73b3ef24e293a6ce11f96698ff0ea7f16cd57e023ce9feee613eb2f8cb44e2352b501150098a6fc0cb
-  data.tar.gz: ad2f68c81259897a21267bbc914b6c79dda294191ce6eb9d293c080685be0bf829883b6a98c670e167602379a9af178bde80ec82f9fc0c390d48e801b7e96758
+  metadata.gz: d9429616ce050142667c011bb3ed1deeab286293349d344b4ad4290d87d9476c3249577f5efd73ab673315a1e95392102994bdbc20fb332233322c627f621d69
+  data.tar.gz: c5a88ca8ddb14ef5832e9541e03c3870ee12cbd9fa6be97cb4898fd638f7dd3cffb7b28e4d2f28298bbbb418af4d3df5aeeeeb3dcb7f32bee402907f40905dac

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.32] - 2025-04-xx
+## [3.0.34] - 2025-04-xx
 
 ### Added
 
@@ -10,10 +10,32 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
-## [3.0.31] - 2025-04-xx
+## [3.0.33] - 2025-04-08
 
 ### Added
 
+- `Mailer` to include `:general` channel messages.
+  - And simplified code
+- `CliDefault::Input` to log in `:general` channel what files have beens scoped.
+
+### Changed
+
+- **Improved** recursive `cause` on repeated error.
+- `AuxiliarLogger` to use `:debug` as default, when `:general` channel is used without specifying an actual log level.
+
+## [3.0.32] - 2025-04-08
+
+### Added
+
+- `MicroCase#with_each` added option to pick up the first user.
+
+### Fixed
+
+- `Eco::API::Organization::People`
+  - `MultipleSearchResults` and `Similarity` where in a different namespace.
+
+## [3.0.31] - 2025-04-04
+
 ### Changed
 
 - upgraded `ecoportal-api-gem`

data/lib/eco/api/common/loaders/config/workflow/mailer.rb

@@ -22,19 +22,14 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       next unless some_update_case?(io) || maybe_error_pages_or_tree_updates?(io)
 
       subject = base_subject
+      subject = "#{subject} & Errors"     if session.job_groups.errors?
+      subject = "#{subject} - Exception!" if error?
 
-      if session.job_groups.empty? && error?
-        subject = "#{subject} - Exception!"
-        session.mail(subject: subject, body: errors_n_warnings(io))
-      else
-        subject = "#{subject} & Errors"     if session.job_groups.errors?
-        subject = "#{subject} - Exception!" if error?
+      body    = general_messages(io)
+      body   << "\n#{session.summary}" unless session.job_groups.empty? && error?
+      body   << "\n#{errors_n_warnings(io)}"
 
-        msg     = "#{session.summary}\n"
-        msg    += errors_n_warnings(io)
-
-        session.mail(subject: subject, body: msg) unless msg.strip.empty?
-      end
+      session.mail(subject: subject, body: body) unless body.strip.empty?
     end
   end
 
@@ -66,6 +61,13 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       some_other_case?(io) && error?
     end
 
+    def general_messages(io)
+      gen_msg = io.logger.cache.logs(level: %i[general])
+      return if gen_msg.empty?
+
+      "GENERAL MESSAGES:\n#{gen_msg.join}\n"
+    end
+
     def errors_n_warnings(io)
       [error_message, log_err_n_warn(io)].join("\n")
     end

data/lib/eco/api/common/loaders/use_case/cli_identify.rb

@@ -4,6 +4,9 @@ class Eco::API::Common::Loaders::UseCase
       cli&.apply!
     end
 
+    # It uses the `cli_class` to install the Cli. If not given, it tries
+    # to identify if there's a `Case::Cli` constant defined that it is a Cli class.
+    # @todo check if `@cli` should really be fixed to a value (currently not).
     def cli(cli_class = nil)
       if cli_class.is_a?(Class)
         msg = 'cli_class should inherit from Eco::API::UseCases::Cli'

data/lib/eco/api/common/version_patches/exception.rb

@@ -1,5 +1,10 @@
 class ::Exception
-  def patch_full_message(trace_count: -1)
+  def patch_full_message(trace_count: -1, cause_levels: 3)
+    return unless cause_levels.positive?
+
+    cause_levels -= 1
+    trace_count   = 3 if trace_count.negative? || trace_count > 3
+
     tracing   = backtrace || []
     first_ln  = tracing[0]
     tracing   = tracing[1..trace_count]
@@ -14,7 +19,10 @@ class ::Exception
 
     unless cause.nil?
       msg << "\nCAUSE:"
-      msg << cause.patch_full_message(trace_count: trace_count)
+      msg << cause.patch_full_message(
+        trace_count:  trace_count,
+        cause_levels: cause_levels
+      )
     end
 
     msg.join("\n")

data/lib/eco/api/microcases/people/fetch/with_each.rb

@@ -45,7 +45,7 @@ module Eco
 
             private
 
-            def _with_each_prompt_to_select_user(error, entry: nil, increase_count: true) # rubocop:disable Metrics/AbcSize
+            def _with_each_prompt_to_select_user(error, entry: nil, increase_count: true) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
               unless error.is_a?(Eco::API::Organization::People::MultipleSearchResults)
                 raise "Expecting Eco::API::Organization::People::MultipleSearchResults. Given: #{error.class}"
               end
@@ -57,11 +57,12 @@ module Eco
               lines << "\n(#{@_with_each_prompts}) #{error}\n"
               lines << '  #index   - Select the correct person by its number index among the list above.'
               lines << '  (I)      - Just Skip/Ignore this one. I will deal with that input entry in another launch.'
+              lines << '  (U)      - The first person with a user account.'
               lines << '  (A)      - Ignore all the rest of input entries with this problem.'
               lines << '  (C)      - Create a new person.'
               lines << '  (B)      - Just break this script. I need to change the input file :/'
 
-              prompt_user('Type one option (#number/I/A/C/B):', explanation: lines.join("\n"), default: 'I') do |res|
+              prompt_user('Type one option (#number/I/U/A/C/B):', explanation: lines.join("\n"), default: 'I') do |res|
                 res = res.upcase
 
                 if res.start_with?('I')
@@ -83,6 +84,12 @@ module Eco
                   session.new_person
                 elsif res.start_with?('B')
                   raise error
+                elsif res.start_with?('U')
+                  error.first_user.tap do |person|
+                    next unless person
+
+                    log(:info) { "(first user) You selected #{person.identify}" }
+                  end
                 elsif res && !res.empty? && (pos = res.to_i rescue nil) && (pos < error.candidates.length) # rubocop:disable Style/RescueModifier
                   error.candidate(pos).tap do |person|
                     log(:info) { "Thanks!! You selected #{person.identify}" }

data/lib/eco/api/organization/people/multiple_search_results.rb

@@ -1,46 +1,52 @@
-module API
-  module Organization
-    class People
-      # Error class that allows to handle cases where multiple people were found for the same criterion.
-      # @note its main purpose to prevent the creation of duplicates or override information between different people.
-      class MultipleSearchResults < StandardError
-        attr_reader :candidates, :property
-
-        # @param msg [String] the basic message error.
-        # @param candiates [Array<Person>] the people that match the same search criterion.
-        # @param property [String] the property of the person model that triggered the error (base of the search criterion).
-        def initialize(msg, candidates: [], property: 'email')
-          @candidates = candidates
-          @property   = property
-          super("#{msg} #{candidates_summary}")
-        end
+module Eco
+  module API
+    module Organization
+      class People
+        # Error class that allows to handle cases where multiple people were found for the same criterion.
+        # @note its main purpose to prevent the creation of duplicates or override information between different people.
+        class MultipleSearchResults < StandardError
+          attr_reader :candidates, :property
 
-        # @param with_index [Boolean] to add an index to each candidate description.
-        # @return [Array<String>] the `candidates` identified
-        def identify_candidates(with_index: false)
-          candidates.map.each_with_index do |person, i|
-            index = with_index ? "#{i}. " : ''
+          # @param msg [String] the basic message error.
+          # @param candiates [Array<Person>] the people that match the same search criterion.
+          # @param property [String] the property of the person model that triggered the error (base of the search criterion).
+          def initialize(msg, candidates: [], property: 'email')
+            @candidates = candidates
+            @property   = property
+            super("#{msg} #{candidates_summary}")
+          end
 
-            msg = '(no account)'
-            if person.account
-              msg = '(user)'
-              msg = '(new user)' if person.account_added?
-            end
+          def first_user
+            candidates.detect(&:account)
+          end
+
+          # @param with_index [Boolean] to add an index to each candidate description.
+          # @return [Array<String>] the `candidates` identified
+          def identify_candidates(with_index: false)
+            candidates.map.each_with_index do |person, i|
+              index = with_index ? "#{i}. " : ''
+
+              msg = '(no account)'
+              if person.account
+                msg = '(user)'
+                msg = '(new user)' if person.account_added?
+              end
 
-            "#{index}#{msg} #{person.identify}"
+              "#{index}#{msg} #{person.identify}"
+            end
           end
-        end
 
-        # @return [Person] the `candidate` in the `index` position
-        def candidate(index)
-          candidates[index]
-        end
+          # @return [Person] the `candidate` in the `index` position
+          def candidate(index)
+            candidates[index]
+          end
 
-        private
+          private
 
-        def candidates_summary
-          lines = ["The following people have the same '#{property}':"]
-          lines.concat(identify_candidates(with_index: true)).join("\n  ")
+          def candidates_summary
+            lines = ["The following people have the same '#{property}':"]
+            lines.concat(identify_candidates(with_index: true)).join("\n  ")
+          end
         end
       end
     end