eco-helpers 3.0.20 → 3.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96eaee3dd7897d77b22857cf8f812ce6d0639af324565c54f649c1e8068b7fb4
-  data.tar.gz: c9af686fe8f01d45eb3ea6a0dc89de276b789dfd6e3f64b515e17107b233b2d3
+  metadata.gz: a7764e6e3e78228f59b9a5f5baf2aa8602c627882905a23270007b4fe1a09c9f
+  data.tar.gz: aca94b571b1c70c000e0d88f09182f2339a306187c5f9651968e9692981d79d9
 SHA512:
-  metadata.gz: 66bdc8b7c98b2aa0e60e205ac64b47a302e2cd8dbe1efd1720ad36c04a4f4c1a70b2cbb4d4978c67a17bd0f86893d34b47ff809f95a3e06952c002b872872553
-  data.tar.gz: f205d190dc159c0218bc1cafa52f139a6faaa133a01190ae1b189d2b8b6ef2470f49b634169effcf2021023803ec58f1793b8ce4c019db9d1dd025df7bbf5493
+  metadata.gz: bcef313643bc67ba9d90755e3ce8a3a3a39c1973404b2dcd35292b76c67d158ad3e9c666414e2f6254776eeb800f4d07fc2ab10953a15e9e2b293d2b8f15303e
+  data.tar.gz: 3d12155562df35e9ecadea021a758f922f35ab68d689592e4a319e41232b4865a87e22c0e333b1083e42340418f57388f24139748246d08652142ef52f1a041d

data/CHANGELOG.md

@@ -2,7 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.20] - 2024-12-xx
+## [3.0.21] - 2024-12-16
+
+### Added
+
+- `Eco::API::Common::Session::Logger`
+  - Implement **channels** logging.
+
+### Changed
+
+- Moved `input` and `people` **cli_default configurations** to a class definition
+- `Eco::Language::AuxiliarLogger#log`
+  - Allow for multiple levels
+  - Return `NilClass`
+
+### Fixed
+
+- `Eco::API::Session::Batch::Job#summary`
+  - Ensure a summary of pending jobs can be handled, even if `#launch` was NOT explicitly called.
+  - As we don't consolidate, it may give more actual updates than pending, yet this is better than providing the `count` of entries in the job's queue.
+
+## [3.0.20] - 2024-12-07
 
 ### Added
 
@@ -16,8 +36,6 @@ All notable changes to this project will be documented in this file.
 
 - On failure, `Eco::API::Session::Job#summary` to give precise estimates on what is pending to be run.
 
-### Fixed
-
 ## [3.0.19] - 2024-11-21
 
 ### Added

data/lib/eco/api/common/loaders/config/cli.rb

@@ -0,0 +1,9 @@
+class Eco::API::Common::Loaders::CliConfig < Eco::API::Common::Loaders::Config
+  class << self
+    def config
+      ASSETS.cli.config
+    end
+  end
+
+  delegate_missing_to :config
+end

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

@@ -33,5 +33,6 @@ class Eco::API::Common::Loaders::Config
   delegate_missing_to :config
 end
 
+require_relative 'config/cli'
 require_relative 'config/workflow'
 require_relative 'config/session'

data/lib/eco/api/common/people/default_parsers/xls_parser.rb

@@ -27,7 +27,7 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
   end
 
   def expected_headers
-    log(:warn) {
+    log(:info) {
       "Headers detection is using your fields_map.json file (native behaviour)"
     }
     session.fields_mapper.list(:external).uniq

data/lib/eco/api/common/session/logger/cache.rb

@@ -4,7 +4,8 @@ module Eco
       module Session
         class Logger
           class Cache
-            LEVELS = %w[UNKNOWN FATAL ERROR WARN INFO DEBUG].freeze
+            LEVELS   = %w[UNKNOWN FATAL ERROR WARN INFO DEBUG].freeze
+            CHANNELS = Logger::CHANNELS.map(&:to_s).map(&:upcase).freeze
 
             def initialize
               reset
@@ -56,7 +57,8 @@ module Eco
             end
 
             def to_datetime(value)
-              return nil unless value
+              return unless value
+
               Time.parse(value)
             end
 
@@ -64,7 +66,7 @@ module Eco
               levels = [value].flatten.map {|v| to_level(v)}.compact
               return levels unless levels.empty?
 
-              LEVELS
+              valid_levels
             end
 
             def to_level(value)
@@ -75,7 +77,7 @@ module Eco
 
             def valid_level!(str)
               return true unless str
-              return true if LEVELS.any? {|lev| str == lev}
+              return true if valid_levels.any? {|lev| str == lev}
 
               msg = "Unknown level #{str}. Should be one of #{LEVELS}"
               raise ArgumentError, msg
@@ -87,6 +89,10 @@ module Eco
 
               value
             end
+
+            def valid_levels
+              @valid_levels ||= self.class::LEVELS | self.class::CHANNELS
+            end
           end
         end
       end

data/lib/eco/api/common/session/logger/channels.rb

@@ -0,0 +1,41 @@
+module Eco
+  module API
+    module Common
+      module Session
+        class Logger
+          module Channels
+            CHANNELS = %i[general].freeze
+
+            class << self
+              def included(base)
+                super
+                base.extend ClassMethods
+              end
+            end
+
+            module ClassMethods
+              def channels!(&def_block)
+                str = "Block with channel implementation expected. None given."
+                raise ArgumentError, str unless block_given?
+
+                channels.each do |channel|
+                  meth = channel.to_s.downcase.to_sym
+
+                  define_method(meth) do |msg = nil, &block|
+                    def_block.call(meth, msg, &block)
+                  end
+                end
+              end
+
+              private
+
+              def channels
+                self::CHANNELS
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,15 @@ module Eco
         class Logger < Eco::Language::BasicLogger
           TIMESTAMP_PATTERN = '%Y-%m-%dT%H:%M:%S'.freeze
 
+          require_relative 'logger/channels'
+          include Channels
+
+          channels! do |channel, message = nil, &block|
+            format_proc(console: true) do |severity, datetime, msg, formatted_msg|
+              cache.add(severity, datetime, msg, formatted_msg)
+            end.call(channel, Time.now, 'prog_name', message || block.call)
+          end
+
           attr_reader :cache
 
           def initialize(file_level: ::Logger::DEBUG, log_file: nil, enviro: nil, **kargs)

data/lib/eco/api/session/batch/job.rb

@@ -146,6 +146,16 @@ module Eco
             @pending
           end
 
+          # @note some times we need a summary of what actually
+          #   is going to be run without invoking `launch`
+          #   (i.e. when there's a uncompliance with the batch policy)
+          def ensure_requests!
+            return if instance_variable_defined?(:@requests)
+
+            pqueue    = processed_queue
+            @requests = as_update(pqueue)
+          end
+
           # @note it requires launch to be firstly invoked
           # @raise [Exception] if 'launch' has not firstly invoked
           # @return [Enumbrable<Hash>] the last requests that the queue will generate
@@ -250,6 +260,7 @@ module Eco
           def summary
             [].tap do |msg|
               msg << "PENDING Job -------->\n" if pending?
+              ensure_requests!
               msg << feedback.generate(requests, only_stats: true)
 
               if batch_policy && !batch_policy.compliant?(request_stats)

data/lib/eco/cli_default/input.rb

@@ -1,6 +1,5 @@
-# rubocop:disable Metrics/BlockLength
-ASSETS.cli.config do |cnf|
-  formats = {
+class Eco::CliDefault::Input < Eco::API::Common::Loaders::CliConfig
+  FORMATS = {
     csv:  {
       option:  ["-csv"],
       extname: [".csv", ".txt"]
@@ -17,51 +16,74 @@ ASSETS.cli.config do |cnf|
       option:  ["-json"],
       extname: [".json"]
     }
-  }
+  }.freeze
 
-  cnf.input(default_option: "-entries-from") do |session, str_opt, options|
-    input = []
+  class << self
+    attr_reader :options, :session
 
+    def encoding
+      options.dig(:input, :file, :encoding)
+    end
+
+    def format_by_cli
+      FORMATS.reduce(nil) do |matched, (frm, selectors)|
+        next matched if matched
+
+        used = selectors[:option].reduce(false) do |us, option|
+          SCR.get_arg(option) || us
+        end
+
+        next frm if used
+      end
+    end
+
+    def format_by_ext(ext)
+      FORMATS.reduce(nil) do |matched, (frm, selectors)|
+        next matched if matched
+        next frm     if selectors[:extname].any? {|e| ext == e}
+      end
+    end
+  end
+
+  input(default_option: "-entries-from") do |session, str_opt, options|
+    @options = options
+    @session = session
+    input    = []
     next input unless SCR.get_arg(str_opt)
 
     file = SCR.get_file(str_opt, required: true)
 
     # Command line check
-    format = formats.reduce(nil) do |matched, (frm, selectors)|
-      used = selectors[:option].reduce(false) {|us, option| SCR.get_arg(option) || us}
-      next matched if matched
-      next frm     if used
-    end
+    format = format_by_cli
 
     # File/Folder check
     file = File.expand_path(file)
+
     if File.directory?(file)
       folder = file
       file   = Dir.glob("#{file}/*").reject {|f| File.directory?(f)}
-      ext    = (format && formats[format][:extname]) || [File.extname(file.first)]
-      file   = file.select {|f| ext.any? {|e| File.extname(f) == e}}.tap do |files|
-        if files.empty?
-          session.log(:error) {
-            "Could not find any file with extension: #{ext} in folder '#{folder}'"
-          }
-          exit(1)
-        end
+      ext    = FORMATS.dig(format, :extname)
+      ext  ||= [File.extname(file.first)]
+      file   = file.select do |f|
+        ext.any? {|e| File.extname(f) == e}
+      end.tap do |files|
+        next unless files.empty?
+
+        session.log(:error) {
+          "Could not find any file with extension: #{ext} in folder '#{folder}'"
+        }
+        exit(1)
       end
     else
-      ext = File.extname(file)
+      ext = [File.extname(file)]
     end
 
-    format ||= formats.reduce(nil) do |matched, (frm, selectors)|
-      next matched if matched
-      next frm     if selectors[:extname].any? {|e| ext == e}
-    end
+    format ||= format_by_ext(ext.first)
     format ||= :csv
 
-    options.deep_merge!(input: {file: {name: file}})
+    options.deep_merge!(input: {file: {name:   file}})
     options.deep_merge!(input: {file: {format: format}})
 
-    encoding = options.dig(:input, :file, :encoding)
-
     case format
     when :xml
       [file].flatten.each {|f| session.config.files.validate(:xml, f)}
@@ -83,5 +105,3 @@ ASSETS.cli.config do |cnf|
     input
   end
 end
-
-# rubocop:enable Metrics/BlockLength

data/lib/eco/cli_default/options.rb

@@ -69,7 +69,10 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       sch_id   = session.schemas.to_id(sch_name)
 
       unless sch_id
-        msg = "You need to specify a correct schema id or name. '#{sch_name}' does not exist"
+        msg = "You need to specify a correct schema id or name. "
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(", ")
+
         session.log(:error) { msg }
         exit(1)
       end

data/lib/eco/cli_default/people.rb

@@ -1,69 +1,124 @@
-MAX_GET_PARTIAL = 12_000
+class Eco::CliDefault::People < Eco::API::Common::Loaders::CliConfig
+  MAX_GET_PARTIAL = 12_000
 
-ASSETS.cli.config do |cnf|
-  cnf.people do |input, session, options|
-    get         = options.dig(:people, :get)
-    get         = {} if get.nil?
+  class << self
+    attr_reader :options, :session
+    attr_writer :get_full, :get_partial
 
-    from_remote = get && get[:from] == :remote
-    from_local  = get && get[:from] == :local
+    def get_options # rubocop:disable Naming/AccessorMethodName
+      get = options.dig(:people, :get)
+      get = {} if get.nil?
+      get
+    end
+
+    def no_get?
+      get_options == false
+    end
 
-    get_full    = from_remote && get[:type] == :full
-    get_partial = from_remote && get[:type] == :partial
-    get_by_file = from_local  && get[:type] == :file
+    def from_remote?
+      return false unless get_options
+
+      get_options[:from] == :remote
+    end
+
+    def from_local?
+      return false unless get_options
+
+      get_options[:from] == :local
+    end
+
+    def get_full?
+      return @get_full  if instance_variable_defined?(:@get_full)
+      return false      unless from_remote?
+
+      get_options[:type] == :full
+    end
+
+    def get_partial?
+      return @get_partial if instance_variable_defined?(:@get_partial)
+      return false        unless from_remote?
+
+      @get_partial = (get_options[:type] == :partial)
+    end
+
+    def get_by_file?
+      return false unless from_local?
+
+      get_options[:type] == :file
+    end
+
+    def source_file
+      return unless get_by_file?
+
+      get_options[:file]
+    end
+
+    def switch_to_full_remote!
+      self.get_full    = true
+      self.get_partial = false
+
+      options.deep_merge!(people: {
+        get: {
+          from: :remote,
+          type: :full
+        }
+      })
+    end
+
+    def switch_to_full_local!
+      self.get_full    = true
+      self.get_partial = false
+
+      options.deep_merge!(people: {
+        get: {
+          from: :local,
+          type: :full
+        }
+      })
+    end
+
+    def optimize_get_partial!(input)
+      return unless get_partial?
 
-    # -get-partial: validate input present and under max
-    if get_partial
       msg = "To use -get-partial (partial updates), you need to use -entries-from"
       raise msg unless input.is_a?(Enumerable)
 
-      if input.count > MAX_GET_PARTIAL
-        get_full    = true
-        get_partial = false
-
-        msg  = "(Optimization) "
-        msg << "Switching from partial to full people download. "
-        msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
-        msg << "(#{MAX_GET_PARTIAL}) entries."
-        session.log(:info) { msg }
-
-        options.deep_merge!(people: {
-          get: {
-            from: :remote,
-            type: :full
-          }
-        })
-      end
+      return unless input.count > MAX_GET_PARTIAL
+
+      msg  = "(Optimization) "
+      msg << "Switching from partial to full people download. "
+      msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
+      msg << "(#{MAX_GET_PARTIAL}) entries."
+      session.log(:info) { msg }
+
+      switch_to_full_remote!
     end
+  end
+
+  people do |input, session, options|
+    @options = options
+    @session = session
 
-    if get == false
+    # -get-partial: validate input present and under max
+    optimize_get_partial!(input) if get_partial?
+
+    if no_get?
       Eco::API::Organization::People.new([])
-    elsif get_full
+    elsif get_full?
       # -get-people
       session.micro.people_cache
-    elsif get_partial
+    elsif get_partial?
       # -get-partial
       session.micro.people_search(input, options: options)
-    elsif get_by_file
+    elsif get_by_file?
       # -people-from-backup
-      session.micro.people_load(get[:file], modifier: :file)
+      session.micro.people_load(source_file, modifier: :file)
     else
-      options.deep_merge!(people: {
-        get: {
-          from: :local,
-          type: :full
-        }
-      })
-
+      switch_to_full_local!
       people = session.micro.people_load(modifier: %i[newest save])
 
       if people.empty?
-        options.deep_merge!(people: {
-          get: {
-            from: :remote,
-            type: :full
-          }
-        })
+        switch_to_full_remote!
         people = session.micro.people_cache
       end
 

data/lib/eco/cli_default/people_filters.rb

@@ -92,7 +92,10 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       sch_id   = session.schemas.to_id(sch_name)
 
       unless sch_id
-        msg = "You need to specify a correct schema id or name. '#{sch_name}' does not exist"
+        msg = "You need to specify a correct schema id or name. "
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(", ")
+
         session.log(:error) { msg }
         exit(1)
       end

data/lib/eco/language/auxiliar_logger.rb

@@ -21,10 +21,23 @@ module Eco
       end
 
       # Shortcut to logger.
-      def log(level, &block)
-        return unless logger.respond_to?(:level)
+      # @todo allow for more channels (atm it's just :general )
+      # @note when `:general` is included, it ensures at least
+      #   `:info` level is also logged.
+      # @return [NilClass]
+      def log(*levels, &block)
+        return unless logger
 
-        logger&.send(level, &block)
+        levels = levels.compact.uniq.map(&:to_sym)
+        levels.unshift(:info) if levels.include?(:general) && levels.length == 1
+
+        levels.each do |level|
+          next unless logger.respond_to?(:level)
+
+          logger.send(level, &block)
+        end
+
+        nil
       end
     end
   end

data/lib/eco/language/basic_logger.rb

@@ -67,6 +67,7 @@ module Eco
       def format_proc(console: true, &block)
         proc do |severity, datetime, _progname, msg|
           str_stamp = console ? console_timestamp(datetime) : timestamp(datetime)
+
           "#{severity.to_s[0]}: #{str_stamp}#{msg}\n".tap do |formatted_msg|
             block&.call(severity, datetime, msg, formatted_msg)
           end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.20'.freeze
+  VERSION = '3.0.21'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.20
+  version: 3.0.21
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-07 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -538,6 +538,7 @@ files:
 - lib/eco/api/common/loaders/base.rb
 - lib/eco/api/common/loaders/case_base.rb
 - lib/eco/api/common/loaders/config.rb
+- lib/eco/api/common/loaders/config/cli.rb
 - lib/eco/api/common/loaders/config/session.rb
 - lib/eco/api/common/loaders/config/workflow.rb
 - lib/eco/api/common/loaders/config/workflow/mailer.rb
@@ -580,6 +581,7 @@ files:
 - lib/eco/api/common/session/helpers/prompt_user.rb
 - lib/eco/api/common/session/logger.rb
 - lib/eco/api/common/session/logger/cache.rb
+- lib/eco/api/common/session/logger/channels.rb
 - lib/eco/api/common/session/logger/log.rb
 - lib/eco/api/common/session/mailer.rb
 - lib/eco/api/common/session/mailer/aws_provider.rb