eco-helpers 3.0.4 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4768a5497ea319bbd31f09bceeb42c9d43567446b01c4e58894928ad6dec84c3
-  data.tar.gz: 4179baf86c6f45f8424fa6690eecc0d1fc5be0daf4059c0af63050e70fcc8a3b
+  metadata.gz: 18d17b73673167619a4e704756a4e59f5d81d61a97e495721e100fe3e10d2374
+  data.tar.gz: a873e8e8970c5d67aa224ac226bec8194f81e2025bcd434b4f1005b8ddba21a3
 SHA512:
-  metadata.gz: d45b4fa67247ac68ac53122759b934bc6c26d14e684774fb0e63184abfcf7799441e1e17384be726ada0d1a437228a5af152a589b9446fb582a1d4a5bbd140ad
-  data.tar.gz: 4cce2123784bdd2730b0052338f52838979aa4ac3435e2a105f56124029e2a3192a481bd2ec694e172763cef24c383485243d06f87b25031dc358d565d858023
+  metadata.gz: 362fa919cbbdd98a7d69e99fa793f42a31fd790513d4d0e62db1e5838bf4937526fceb03139f394c069fd376d7a10c2cfcedf7207cda9377838b441022fa1a2f
+  data.tar.gz: 95064a493e111f68cf5da145f6322e9a30d1c7a2ce48c022b776109fc581ba7c1fd63dbb0a26dae7dcbd0c67086ec5ee0c7c507deae55cf45aa8ed73704ecb4c

data/.rubocop.yml

@@ -98,3 +98,5 @@ Naming/MethodParameterName:
   AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io', 'to']
 Naming/RescuedExceptionsVariableName:
   Enabled: false
+Naming/BlockForwarding:
+  Enabled: false

data/CHANGELOG.md

@@ -2,18 +2,58 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.4] - 2024-08-xx
+## [3.0.7] - 2024-08-xx
 
 ### Added
 
-- `Eco::Csv::Split` add `total_count` and `copy_count`
-- `Eco::API::Common::People::PersonParser`
-  - added core attribute `brand_id`
+### Changed
+
+### Fixed
+
+## [3.0.6] - 2024-08-26
+
+### Added
 
 ### Changed
 
+- `Eco::API::Microcases#people_search`
+  - Change to `silence: false` by default
+- `Eco::Language::AuxiliarLogger#log`
+  - prevent call if `logger` object doesn't have method
+- Various refactors
+- Upgrade `ecoportal-api-v2` **gem**
+- `Eco::API::UseCases::Cli`
+  - Made **inheritable** the class vars: `description`, `cli_name`, `callback`, and `options`
+- Move case options to self-contained **cli** class
+  - `-restore-db`
+  - `-reinvite`, `-reinvite-from`
+  - `-codes-to-tags`
+  - `-tagtree-paths` (prev: `-create-tag-paths`)
+  - `-analyse-people`
+  - `-org-data-convert`
+  - `-identify-cyclic-supers`
+  - `-supers-hierarchy`
+
 ### Fixed
 
+- `Eco::API::Common::People::PersonEntryAttributeMapper`
+  - method `#to_internal`, was missing to correcty return `attr`
+- `Eco::Csv::Split`
+  - missing attr writers for `total_count` and `copy_count`
+- CLI **suggestions**: when no suggestions / corrections, show still the unknown option.
+- `Eco::API::Organization::TagTree`
+  - fix paths tracking
+- `Eco::API::Organization::LoginProviders`
+  - identify `magic_link`
+
+## [3.0.4] - 2024-08-14
+
+### Added
+
+- `Eco::Csv::Split` add `total_count` and `copy_count`
+- `Eco::API::Common::People::PersonParser`
+  - added core attribute `brand_id`
+
 ## [3.0.3] - 2024-08-13
 
 ### Added

data/eco-helpers.gemspec

@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dotenv',        '~> 3'
   spec.add_dependency 'ecoportal-api',         '~> 0.10'
   spec.add_dependency 'ecoportal-api-graphql', '~> 0.4', '>= 0.4.1'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0', '>= 2.0.8'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0', '>= 2.0.9'
   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/class_helpers.rb

@@ -2,7 +2,6 @@ module Eco
   module API
     module Common
       module ClassHelpers
-
         # Creates a class and instance object methods with name `name` to resolve `klass` name
         def class_resolver(name, klass)
           define_singleton_method(name) { resolve_class(klass) }
@@ -15,18 +14,18 @@ module Eco
           @resolved ||= {}
           @resolved[klass] ||=
             case klass
-              when Class
-                klass
-              when String
-                begin
-                  Kernel.const_get(klass)
-                rescue NameError => e
-                  raise if exception
-                end
-              when Symbol
-                resolve_class(self.send(klass))
-              else
-                raise "Unknown class: #{klass}" if exception
+            when Class
+              klass
+            when String
+              begin
+                Kernel.const_get(klass)
+              rescue NameError
+                raise if exception
+              end
+            when Symbol
+              resolve_class(self.send(klass))
+            else
+              raise "Unknown class: #{klass}" if exception
             end
         end
 
@@ -34,9 +33,9 @@ module Eco
         # @param key [String, Symbol] to be normalized
         # @return [String] a correct constant name
         def to_constant(key)
-          str_name = key.to_s.strip.split(/[\-\_ ]/i).compact.map do |str|
+          key.to_s.strip.split(/[\-\_ ]/i).compact.map do |str|
             str.slice(0).upcase + str.slice(1..-1).downcase
-          end.join("")
+          end.join
         end
 
         # Helper to create an instance variable `name`
@@ -61,7 +60,7 @@ module Eco
           parent_space    = parent_space ? resolve_class(parent_space) : self
           full_class_name = "#{parent_space}::#{class_name}"
 
-          unless target_class = resolve_class(full_class_name, exception: false)
+          unless (target_class = resolve_class(full_class_name, exception: false))
             target_class = Class.new(inherits)
             parent_space.const_set class_name, target_class
           end
@@ -81,9 +80,9 @@ module Eco
           return [] if scope.empty?
           scope.select do |klass|
             klass < parent_class
-          end.sort do |k1, k2|
-            next -1 if k2 < k1
-            next  1 if k1 < k2
+          end.sort do |k_1, k_2|
+            next -1 if k_2 < k_1
+            next  1 if k_1 < k_2
             0
           end.tap do |siblings|
             if direct
@@ -98,7 +97,7 @@ module Eco
         # @param direct [Boolean] it will only include direct child classes.
         # @return [Boolean] `true` if the current class has child classes, and `false` otherwise.
         def descendants?(parent_class: self, direct: false)
-          descendants(parent_class: parent_class, direct: direct).length > 0
+          descendants(parent_class: parent_class, direct: direct).length.positive?
         end
 
         # Keeps track on class instance variables that should be inherited by child classes.
@@ -106,18 +105,20 @@ module Eco
         #   - subclasses will inherit the value as is at that moment
         #   - any change afterwards will be only on the specific class (in line with class instance variables)
         #   - adapted from https://stackoverflow.com/a/10729812/4352306
-        # TODO: this separates the logic of the method to the instance var. Think if would be possible to join them somehow.
+        # TODO: this separates the logic of the method to the instance var.
+        #   Think if would be possible to join them somehow.
         def inheritable_class_vars(*vars)
           @inheritable_class_vars ||= [:inheritable_class_vars]
           @inheritable_class_vars += vars
         end
 
-        # Builds the attr_reader and attr_writer of `attrs` and registers the associated instance variable as inheritable.
+        # Builds the attr_reader and attr_writer of `attrs` and registers
+        # the associated instance variable as inheritable.
         def inheritable_attrs(*attrs)
           attrs.each do |attr|
             class_eval %(
               class << self; attr_accessor :#{attr} end
-            )
+            ), __FILE__, __LINE__ - 2
           end
           inheritable_class_vars(*attrs)
         end

data/lib/eco/api/common/class_meta_basics.rb

@@ -2,14 +2,12 @@ module Eco
   module API
     module Common
       module ClassMetaBasics
-
         # Helps to define methods and keep track on them
         def define(name, &block)
           name = name.to_sym
           @helpers[name] = block
           define_method(name.to_sym, &block)
         end
-
       end
     end
   end

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

@@ -26,6 +26,7 @@ module Eco
                 @cli = cli_class
               elsif cli_class.nil?
                 return @cli if instance_variable_defined?(:@cli) && !@cli.nil?
+
                 # try to see if it's namespaced after the use case it provisions cli integration
                 begin
                   try_class = [to_s, 'Cli'].join('::')

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

@@ -128,7 +128,7 @@ module Eco
             # Support for multiple file
             if file.is_a?(Array)
               return file.each_with_object([]) do |f, out|
-                logger.info("Parsing file '#{f}'")
+                log(:info) { "Parsing file '#{f}'" }
                 curr = to_array_of_hashes(**kargs.merge(file: f))
                 out.concat(curr)
               end
@@ -141,7 +141,9 @@ module Eco
 
             case content
             when Hash
-              logger.error("Input data as 'Hash' not supported. Expecting 'Enumerable' or 'String'")
+              log(:error) {
+                "Input data as 'Hash' not supported. Expecting 'Enumerable' or 'String'"
+              }
               exit(1)
             when String
               deps = {check_headers: true} if kargs[:check_headers]
@@ -221,12 +223,12 @@ module Eco
           private
 
           def abort(message)
-            logger.error(message)
+            log(:error) { message }
             exit(1)
           end
 
           def fatal(msg)
-            logger.fatal(msg)
+            log(:fatal) { msg }
             raise msg
           end
         end

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

@@ -4,6 +4,7 @@ module Eco
       module People
         class PersonEntry
           DEBUG = false
+          include Eco::Language::AuxiliarLogger
 
           # This class is meant to provide a common interface to access entries of source data that come in
           # different formats.
@@ -217,7 +218,8 @@ module Eco
               set_part(person, attr, value)
             rescue StandardError => e
               raise unless attr == "email"
-              logger.error("#{e} - setting blank email instead.")
+
+              log(:error) { "#{e} - setting blank email instead." }
               set_part(person, attr, nil)
             end
           end
@@ -515,12 +517,8 @@ module Eco
           end
 
           # LOGGER
-          def logger
-            @logger || ::Logger.new(IO::NULL)
-          end
-
           def fatal(msg)
-            logger.fatal(msg)
+            log(:fatal) { msg }
             raise msg
           end
 

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

@@ -2,8 +2,12 @@ module Eco
   module API
     module Common
       module People
-        # @attr_reader direct_attrs [Array<String>] only those internal attributes present in the person entry that do **not** have an internal/external name mapping.
+        # @attr_reader direct_attrs [Array<String>] only those
+        #   internal attributes present in the person entry that
+        #   do **not** have an internal/external name mapping.
         class PersonEntryAttributeMapper
+          include Eco::Language::AuxiliarLogger
+
           DEBUG = false
           @@cached_warnings = {} # rubocop:disable Style/ClassVars
 
@@ -11,7 +15,8 @@ module Eco
 
           # Helper class tied to `PersonEntry` that allows to track which attributes of a person entry are present
           # and how they should be mapped between internal and external names if applicable.
-          # This class is meant to help in providing a common interface to access entries of source data that come in different formats.
+          # This class is meant to help in providing a common interface to access entries of source
+          #   data that come in different formats.
           # @note
           #   - if `data` is a `Person` object, its behaviour is `serialise`.
           #   - if `data` is **not** a `Person` object, it does a `parse`.
@@ -116,13 +121,15 @@ module Eco
           #  2. if it doesn't exist, returns `nil`.
           # @note
           #  1. the **scope of attributes** is based on all the attributes recognized by the person parser.
-          #  2. the attributes recognized by the person parser are those of of the `Person` model (where details attributes depend on the `schema`).
+          #  2. the attributes recognized by the person parser are those of of the `Person` model
+          #    (where details attributes depend on the `schema`).
           # @param value [String, Array<String>] value(s) to be translated into internal names.
           # @return [String, nil, Array<String] the internal name(s) of `value`.
           def to_internal(value)
             # TODO: check PersonEntry#to_internal and #to_external in init_attr_trackers
             # => when attr_map is avoided, it doesn't work as it should
             return value unless @attr_map
+
             attr = value
             case value
             when Array
@@ -136,19 +143,21 @@ module Eco
                 unless cached_warning("external", "spaces", value)
                   msg  = "The external person field name '#{value}' contains "
                   msg << "additional spaces in the reference file"
-                  logger.warn(msg)
+                  log(:warn) { msg }
                 end
+
                 attr = @attr_map.to_internal(value.strip)
               elsif [value, value.strip, value.strip.downcase].any? {|val| @attr_map.internal?(val)}
                 unless cached_warning("external", "reversed", value)
                   msg  = "The mapper [external, internal] attribute names "
                   msg << "may be declared reversedly for EXTERNAL attribute: '#{value}'"
-                  logger.info(msg)
+                  log(:info) { msg }
                 end
               end
             end
 
-            return nil unless @person_parser.all_model_attrs.include?(attr)
+            return unless @person_parser.all_model_attrs.include?(attr)
+            attr
           end
 
           # Serializing helper also used to do a reverse mapping when parsing:
@@ -160,11 +169,13 @@ module Eco
           #  2. if it doesn't exist, returns `nil`.
           # @note
           #  1. the **scope of attributes** is based on all the attributes defined in the current entry.
-          #  2. the attributes recognized by the person parser are those of of the `Person` model (where details attributes depend on the `schema`).
+          #  2. the attributes recognized by the person parser are those of of the `Person` model
+          #    (where details attributes depend on the `schema`).
           # @param value [String, Array<String>] value(s) to be translated or aliased into external ones.
           # @return [String, nil, Array<String] the external name(s) of `value`.
           def to_external(value)
             return value unless @attr_map
+
             attr = value
             case value
             when Array
@@ -178,7 +189,7 @@ module Eco
                 unless cached_warning("internal", "spaces", value)
                   msg  = "The internal person field name '#{value}' contains "
                   msg << "additional spaces in the reference file"
-                  logger.warn(msg)
+                  log(:warn) { msg }
                 end
                 attr = @attr_map.to_external(value.strip)
               elsif [value, value.strip, value.strip.downcase].any? {|val| @attr_map.external?(val)}
@@ -186,12 +197,12 @@ module Eco
                   msg  = "The mapper [external, internal] attribute names "
                   msg << "may be declared reversedly for "
                   msg << "INTERNAL attribute: '#{value}'"
-                  logger.info(msg)
+                  log(:info) { msg }
                 end
               end
             end
 
-            return nil unless !@external_entry || attributes(@external_entry).include?(attr)
+            return unless !@external_entry || attributes(@external_entry).include?(attr)
             attr
           end
 
@@ -200,12 +211,14 @@ module Eco
           # Whether the maps include this `attr` as mapped to itself
           def self_mapped_attr?(attr)
             return false unless @attr_map
+
             @attr_map.self_mapped?(attr)
           end
 
           # Whether the maps include this `attr` as mapped from to some other or itself
           def external_attr?(attr)
             return false unless @attr_map
+
             @attr_map.external?(attr)
           end
 
@@ -357,7 +370,7 @@ module Eco
           end
 
           def cached_warning(*args)
-            unless exists = !!@@cached_warnings.dig(*args)
+            unless (exists = !!@@cached_warnings.dig(*args)) # rubocop:disable Style/DoubleNegation
               args.reduce(@@cached_warnings) do |cache, level|
                 cache[level] = {} unless cache.key?(level)
                 cache[level]
@@ -367,7 +380,7 @@ module Eco
           end
 
           def fatal(msg)
-            logger.fatal(msg)
+            log(:fatal) { msg }
             raise msg
           end
 

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

@@ -53,6 +53,7 @@ module Eco
           def initialize(schema: nil)
             msg = "Constructor needs a PersonSchema. Given: #{schema.class}"
             raise msg if schema && !schema.is_a?(Ecoportal::API::V1::PersonSchema)
+
             @details_attrs = []
             @parsers       = {}
             @patch_version = 0
@@ -103,6 +104,7 @@ module Eco
           # All the internal name attributes, including _core_, _account_ and _details_.
           def all_attrs(include_defined_parsers: false)
             return all_model_attrs | defined_model_attrs if include_defined_parsers
+
             all_model_attrs
           end
 
@@ -114,6 +116,7 @@ module Eco
           #   if `source_attrs` is not `nil`. All the _core attributes_, otherwise.
           def target_attrs_core(source_attrs = nil)
             return CORE_ATTRS unless source_attrs
+
             scoped_attrs(source_attrs, CORE_ATTRS)
           end
 
@@ -125,6 +128,7 @@ module Eco
           #   if `source_attrs` is not `nil`. All the _details attributes_, otherwise.
           def target_attrs_details(source_attrs = nil)
             return @details_attrs unless source_attrs
+
             scoped_attrs(source_attrs, @details_attrs)
           end
 
@@ -136,6 +140,7 @@ module Eco
           #   All the _account attributes_, otherwise.
           def target_attrs_account(source_attrs = nil)
             return ACCOUNT_ATTRS unless source_attrs
+
             scoped_attrs(source_attrs, ACCOUNT_ATTRS)
           end
 
@@ -213,6 +218,7 @@ module Eco
           # @return [Eco::API::Common::People::PersonParser] the current object (to ease chainig).
           def merge(parser)
             return self unless parser
+
             msg = "Expected a PersonParser object. Given #{parser.class}"
             raise msg unless parser.is_a?(PersonParser)
 
@@ -237,10 +243,12 @@ module Eco
               msg << "not match any type: #{@details_attrs}"
               raise msg
             end
+
             Eco::API::Common::People::PersonAttributeParser.new(attr, dependencies: dependencies).tap do |parser|
               @parsers[attr] = parser
               definition.call(parser)
             end
+
             patched!
             self
           end

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

@@ -74,7 +74,7 @@ module Eco
 
           # TODO: paremeter for the exception
           def fatal(msg)
-            logger.fatal(msg)
+            log(:fatal) { msg }
             raise msg
           end
         end

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

@@ -59,6 +59,13 @@ module Eco
           def api?(version:)
             config.apis.active_api.version_available?(version)
           end
+
+          # Shortcut to logger.
+          def log(level, &block)
+            return unless logger.respond_to?(:level)
+
+            logger&.send(level, &block)
+          end
         end
       end
     end

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

@@ -4,6 +4,7 @@ module Eco
       module Session
         class FileManager
           include Eco::Data::Files
+          include Eco::Language::AuxiliarLogger
 
           attr_reader :dir, :dir_path
           attr_accessor :timestamp_pattern
@@ -20,11 +21,13 @@ module Eco
             @dir      = Eco::Data::Files::Directory.new(value)
             @dir_path = @dir.create
           rescue StandardError => err
-            logger.error("could not create or make any sense of directory '#{value}': #{err}")
+            log(:error) {
+              "could not create or make any sense of directory '#{value}': #{err}"
+            }
           end
 
           def logger
-            @enviro&.logger || ::Logger.new(IO::NULL)
+            @enviro&.logger || super
           end
 
           #####    FILE   #####
@@ -40,11 +43,13 @@ module Eco
             file = dir.file(filename, should_exist: true)
 
             unless file
-              logger.error("Can't read from file '#{filename}' because it does not exist.")
+              log(:error) {
+                "Can't read from file '#{filename}' because it does not exist."
+              }
               return nil
             end
 
-            logger.debug("Reading from file '#{file}'")
+            log(:debug) { "Reading from file '#{file}'" }
             mode ? File.read(file, mode: mode) : File.read(file)
           end
 
@@ -52,7 +57,9 @@ module Eco
             file = dir.file(filename, should_exist: true)
 
             unless file
-              logger.error("Can't read from file '#{filename}' because it does not exist.")
+              log(:error) {
+                "Can't read from file '#{filename}' because it does not exist."
+              }
               return nil
             end
 
@@ -77,7 +84,7 @@ module Eco
               FileManager.file_fullpath(file)
             )
 
-            logger.debug("Writting to file '#{file}'")
+            log(:debug) { "Writting to file '#{file}'" }
 
             mode = mode == :binary ? 'wb' : 'w'
 
@@ -103,7 +110,7 @@ module Eco
               FileManager.file_fullpath(file)
             )
 
-            logger.debug("Writting to file '#{file}'")
+            log(:debug) { "Writting to file '#{file}'" }
 
             mode = mode == :binary ? 'wb' : 'w'
             File.open(file, mode) { |fd| fd << content }
@@ -114,7 +121,7 @@ module Eco
           def append(content, filename, mode: :string)
             file = dir.file(filename)
 
-            logger.debug("Appending to file '#{file}'")
+            log(:debug) { "Appending to file '#{file}'" }
 
             mode = mode == :binary ? 'ab' : 'a'
             File.open(file, mode) { |fd| fd << "#{content}\n" }

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

@@ -4,7 +4,7 @@ module Eco
       module Session
         class Logger
           class Cache
-            LEVELS = ["UNKNOWN", "FATAL", "ERROR", "WARN", "INFO", "DEBUG"]
+            LEVELS = %w[UNKNOWN FATAL ERROR WARN INFO DEBUG].freeze
 
             def initialize
               reset
@@ -44,10 +44,11 @@ module Eco
             private
 
             def where(start_time, end_time)
-              tstart = to_datetime(start_time)
-              tend   = to_datetime(end_time)
-              condition = Proc.new do |log|
+              tstart    = to_datetime(start_time)
+              tend      = to_datetime(end_time)
+              condition = proc do |log|
                 next true unless tstart || tend
+
                 log.after?(tstart) && log.before?(tend)
               end
 
@@ -61,7 +62,9 @@ module Eco
 
             def to_levels(value)
               levels = [value].flatten.map {|v| to_level(v)}.compact
-              levels = levels.empty?? LEVELS : levels
+              return levels unless levels.empty?
+
+              LEVELS
             end
 
             def to_level(value)
@@ -71,18 +74,19 @@ module Eco
             end
 
             def valid_level!(str)
-              return true if !str
-              unless LEVELS.any? {|lev| str == lev}
-                raise "Unknown level #{str}. Should be one of #{LEVELS}"
-              end
+              return true unless str
+              return true if LEVELS.any? {|lev| str == lev}
+
+              msg = "Unknown level #{str}. Should be one of #{LEVELS}"
+              raise ArgumentError, msg
             end
 
             def nil_or_upcase(value)
               value = value.to_s.upcase if value
               return yield(value) if block_given?
+
               value
             end
-
           end
         end
       end