eco-helpers 2.7.16 → 2.7.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c94232f6124e63e5b9df716e6e4550b10e3853e2cd2ad9ee5dc6289bf4a2a56
-  data.tar.gz: 224908e975dff3cf04d03c5c6cc55fde4472a622010a0548beb731cfb1e834d0
+  metadata.gz: 4f816f1f0ec131d756c11a4839629d57f90f2b9cc2a8a9008b54de0c57926272
+  data.tar.gz: 8e725e46c074927cf2db191471d29fe5dfce15c7aa121f9e49cfa30411f29bf2
 SHA512:
-  metadata.gz: 2521d794cfa6f6d47c938df024f48540d4bf6eb2401a4c5a2e805d556814e1bdfef3949a03f492b7ab00ce98f56b752438e06a0860aebdb788c5eda056b242de
-  data.tar.gz: 245b52b949c7c8141821ce61c0b58beed8242d5b0a6efd493892e1f9c96f58198db6fa4b2c0da0c08b275ff8a6eb7c6444e099dd1c1898a532bd8310a9201c8a
+  metadata.gz: 8427745673ff4ab4d19477fff524cb9cab781b9b818c072943c600282cc5d519f06b3a5807e6a241787fb1c259a1697530c282ccf18c9849d8d4f09ca89e64b7
+  data.tar.gz: 22da605e9eaa15e84ea50a6431ad4e9f7b98239b981e5ec7b07dbd93d92d72387232c222656ec8a79ed725c60d5088c150edc4dbed4547ce10fd97e01d6be6ae

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.7.16] - 2024-06-18
+## [2.7.19] - 2024-06-xx
 
 ### Added
 
@@ -10,14 +10,45 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
-- `RegisterUpdateCase` filters
+## [2.7.18] - 2024-07-01
 
-## [2.7.15] - 2024-06-18
+### Changed
+
+- `Eco::API::UseCases::GraphQL::Samples::Location::Service::TreeToList`
+  - Custom input node parsers: yield has_node and node as well.
+- `Eco::API::UseCases::GraphQL::Samples::Location::Service::TreeDiff`
+  - Exclude archived nodes from the file as **default**
+
+## [2.7.17] - 2024-06-22
 
 ### Added
 
+- **Stop on uknown** options will try to offer suggestions from now on
+- `Eco::CSV::count` class method to stream-count the number of rows
+  - Option `-start-at` allows to start the count at certain row idx
+
 ### Changed
 
+- Added options to case `-split-csv`
+  - `-start-at`
+  - `-simulate` a dry-run will return the count and won't generate the files.
+- `Eco::CSV::split`
+  - the `block` allows to filter what rows should be included
+
+### Fixed
+
+- `Workflow::Mailer`: shouldn't send notification when there is an **error** that doesn't really need to be notified.
+- `to-csv` case should accepte target folder as an argument
+- `options_set` sort namespaces
+
+## [2.7.16] - 2024-06-18
+
+### Fixed
+
+- `RegisterUpdateCase` filters
+
+## [2.7.15] - 2024-06-18
+
 ### Fixed
 
 - `Eco::API::Common::People::EntryFactor` super must be called before

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

@@ -17,7 +17,10 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       next unless session.mailer?
       next if     session.config.dry_run?
       next unless session.config.run_mode_remote?
-      next unless some_update?(io) || error?
+
+      # temporary contingency
+      maybe_error_pages_or_tree_updates = other_case?(io) && error?
+      next unless some_update?(io) || maybe_error_pages_or_tree_updates
 
       subject = base_subject
 
@@ -53,6 +56,12 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       end
     end
 
+    def other_case?(io)
+      cli.config.usecases.active(io: io).any? do |usecase, _data|
+        %i[other].any? { |type| usecase.type == type }
+      end
+    end
+
     def error?
       !!error
     end

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

@@ -7,18 +7,17 @@ module Eco
       def people_cache(filename = enviro.config.people.cache)
         logger.info("Going to get all the people via API")
 
-        start = Time.now
-        people = session.batch.get_people
+        start   = Time.now
+        people  = session.batch.get_people
         secs    = (Time.now - start).round(3)
         cnt     = people.count
         per_sec = (cnt.to_f / secs).round(2)
         logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
 
-        file   = file_manager.save_json(people, filename, :timestamp)
+        file = file_manager.save_json(people, filename, :timestamp)
         logger.info("#{people.length} people loaded and saved locally to #{file}.")
         Eco::API::Organization::People.new(people)
       end
-
     end
   end
 end

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

@@ -15,19 +15,23 @@ module Eco
       #   - `:file` if it is supposed to load people from a file.
       #   - `:save` if it is supposed to cache/save the data locally once obtained people from the server (`:api`)
       # @return [Eco::API::Organization::People] the `People` object with the data.
-      def people_load(filename = enviro.config.people.cache, modifier: [:newest, :api])
+      def people_load(filename = enviro.config.people.cache, modifier: %i[newest api]) # rubocop:disable Metrics/AbcSize
         modifier  = [modifier].flatten
-        load_file = [:file, :newest].any? {|flag| modifier.include?(flag)}
+        load_file = %i[file newest].any? {|flag| modifier.include?(flag)}
+
         case
         when filename && load_file
-          if file = people_load_filename(filename, newest: modifier.include?(:newest))
+          file = people_load_filename(filename, newest: modifier.include?(:newest))
+
+          if file
             file_manager.load_json(file).tap do |people|
               logger.info("#{people&.length} people loaded from file #{file}") if people.is_a?(Array)
             end
           else
             logger.error("could not find the file #{file_manager.dir.file(filename)}")
             exit unless modifier.include?(:api)
-            people_load(modifier: modifier - [:newest, :file])
+
+            people_load(modifier: modifier - %i[newest file])
           end
         when modifier.include?(:api)
           logger.info("Going to get all the people via API (load)")
@@ -39,12 +43,12 @@ module Eco
             per_sec = (cnt.to_f / secs).round(2)
             logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
 
-            if modifier.include?(:save) && people && people.length > 0
+            if modifier.include?(:save) && people && people.length.positive?
               file = file_manager.save_json(people, filename, :timestamp)
-              logger.info("#{people.length } people saved to file #{file}.")
+              logger.info("#{people.length} people saved to file #{file}.")
             end
           end
-        end.yield_self do |people|
+        end.then do |people|
           Eco::API::Organization::People.new(people)
         end
       end
@@ -61,7 +65,6 @@ module Eco
           file_manager.dir.file(filename, should_exist: true)
         end
       end
-
     end
   end
 end

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

@@ -9,24 +9,26 @@ module Eco
       # @param people [Eco::API::Organization::People] the people that needs refresh.
       # @param include_created [Boolean] include people created during this session? (will check `:create` batch jobs).
       # @return [Eco::API::Organization::People] the `People` object with the data.
-      def people_refresh(people:, include_created: true)
+      def people_refresh(people:, include_created: true) # rubocop:disable Metrics/AbcSize
         people = people.newFrom people.select do |person|
           !person.new? || !person.dirty?
         end
+
         ini = people.length
+
         if include_created
           session.job_groups.find_jobs(type: :create).map do |job|
-            to_add = job.people.select {|person| !person.dirty?}
+            to_add = job.people.reject(&:dirty?)
             people = people.merge(to_add)
           end
         end
 
         created = people.length - ini
-        msg  = "Going to refresh #{people.length} people with server data"
-        msg += " (including #{created} that were created)" if created > 0
+        msg    = "Going to refresh #{people.length} people with server data"
+        msg   += " (including #{created} that were created)" if created.positive?
         logger.info(msg)
 
-        start = Time.now
+        start   = Time.now
         entries = session.batch.get_people(people, silent: true)
         secs    = (Time.now - start).round(3)
         cnt     = entries.count
@@ -34,11 +36,10 @@ module Eco
         logger.info("Re-loaded #{cnt} people (out of #{people.length}) in #{secs} seconds (#{per_sec} people/sec)")
 
         missing = people.length - entries.length
-        logger.error("Missed to obtain #{missing} people during the refresh") if missing > 0
+        logger.error("Missed to obtain #{missing} people during the refresh") if missing.positive?
 
         Eco::API::Organization::People.new(entries)
       end
-
     end
   end
 end

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

@@ -5,52 +5,57 @@ module Eco
       # @note
       #   - this helper is normally used to **get partial** part of the people manager.
       #   - therefore, normally used with _**delta** input files_ (files with only the differences).
-      # @param data [Eco::API::Organization::People, Enumerable<Person>, Enumerable<Hash>] `People` to search against the server.
+      # @param data [Eco::API::Organization::People, Enumerable<Person>, Enumerable<Hash>]
+      #   `People` to search against the server.
       # @param options [Hash] the options.
       # @param silent [Boolean] `false` if low level search messages should be shown.
       # @return [Eco::API::Organization::People] the `People` object with the found persons.
-      def people_search(data, options: {}, silent: true)
+      def people_search(data, options: {}, silent: true) # rubocop:disable Metrics/AbcSize
         session.logger.info("Going to api get #{data.length} entries...")
 
         start = Time.now
-        people = session.batch.search(data, silent: silent).yield_self do |status|
-          secs    = (Time.now - start).round(3)
-          Eco::API::Organization::People.new(status.people).tap do |people|
+        people = session.batch.search(data, silent: silent).then do |status|
+          secs = (Time.now - start).round(3)
+          Eco::API::Organization::People.new(status.people).tap do |people| # rubocop:disable Lint/ShadowingOuterLocalVariable
             cnt     = people.count
             per_sec = (cnt.to_f / secs).round(2)
-            msg     = "... could get #{cnt} people (out of #{data.length} entries) in #{secs} seconds (#{per_sec} people/sec)"
+            msg     = "... could get #{cnt} people "
+            msg    << "(out of #{data.length} entries) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
           end
         end
 
         # get the supervisors of found people (current supervisors)
         supers = people_search_prepare_supers_request(people)
-        if supers.length > 0
+        if supers.length.positive?
           session.logger.info("  Going to api get #{supers.length} current supervisors...")
           start = Time.now
-          people = session.batch.search(supers, silent: silent).yield_self do |status|
+          people = session.batch.search(supers, silent: silent).then do |status|
             secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
             per_sec = (cnt.to_f / secs).round(2)
-            msg     = "... could find #{cnt} current supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
+            msg     = "... could find #{cnt} current supers "
+            msg    << "(out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
+
             people.merge(found, strict: micro.strict_search?(options))
           end
         end
 
         # get the supervisors referred in the input data (future supervisors)
         supers = people_search_prepare_supers_request(data, people)
-        if supers.length > 0
+        if supers.length.positive?
           session.logger.info("  Going to api get #{supers.length} supervisors as per input entries...")
           start = Time.now
 
-          people = session.batch.search(supers, silent: silent).yield_self do |status|
+          people = session.batch.search(supers, silent: silent).then do |status|
             secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
             per_sec = (cnt.to_f / secs).round(2)
-            msg     = "... could find #{cnt} input supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
+            msg     = "... could find #{cnt} input supers "
+            msg    << "(out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
             people.merge(found, strict: micro.strict_search?(options))
           end
@@ -66,25 +71,26 @@ module Eco
       def people_search_prepare_supers_request(data, people = data)
         data.each_with_object([]) do |entry, request|
           spr = {"id" => (sup_id = people_search_super_id(entry))}
-          unless !sup_id || request.include?(spr)
-            micro.with_supervisor(sup_id, people) do |supervisor|
-              request.push(spr) unless supervisor
-            end
+          next if !sup_id || request.include?(spr)
+
+          micro.with_supervisor(sup_id, people) do |supervisor|
+            request.push(spr) unless supervisor
           end
         end
       end
 
       # Gets the `supervisor_id` from `value`
       def people_search_super_id(value)
-        sup_id = if value.respond_to?(:supervisor_id)
-                value.supervisor_id
-              elsif value.is_a?(Hash) && value.key("supervisor_id")
-                value["supervisor_id"]
-              end
+        sup_id =
+          if value.respond_to?(:supervisor_id)
+            value.supervisor_id
+          elsif value.is_a?(Hash) && value.key("supervisor_id")
+            value["supervisor_id"]
+          end
+
         sup_id = nil if sup_id.to_s.strip.empty?
         sup_id
       end
-
     end
   end
 end

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

@@ -7,9 +7,10 @@ module Eco
           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}'"
+              puts "Warning: (#{self}) Tried to call again cli.apply! on '#{arg_case}'"
               return self
             end
+
             cli_config_case(arg_case)
             apply_options(arg_case)
             applied!(arg_case)
@@ -29,10 +30,11 @@ module Eco
           end
 
           attr_writer :usecase
+
           # Unless specified, assume Cli class hangs from its case namespace
           def usecase
-            raise "#{self} is to use to extend a class" unless self.is_a?(Class)
-            @usecase ||= Kernel.const_get(self.to_s.split('::')[0..-2].join('::'))
+            raise "#{self} is to use to extend a class" unless is_a?(Class)
+            @usecase ||= Kernel.const_get(to_s.split('::')[0..-2].join('::'))
           end
 
           def description(value = nil)
@@ -50,7 +52,7 @@ module Eco
 
           # It defaults to the use case preceded by dash
           def cli_name(arg_name = nil)
-            @cli_name = (arg_name.nil? ? @cli_name : arg_name).yield_self do |value|
+            @cli_name = (arg_name.nil? ? @cli_name : arg_name).then do |value|
               value = "-#{name}" if value.nil?
               value
             end
@@ -66,7 +68,7 @@ module Eco
           end
 
           def add_option(arg, desc = nil, &block)
-            self.tap do
+            tap do
               "Overriding option '#{arg}' on case '#{name}'" if options.key?(arg)
               @options[arg] = Eco::API::UseCases::Cli::Option.new(arg, desc, &block)
             end
@@ -75,7 +77,7 @@ module Eco
           private
 
           def apply_options(arg_case)
-            options.each do |_key, option|
+            options.each_value do |option|
               option.link_case(cli_config_case(arg_case))
             end
           end

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

@@ -13,6 +13,7 @@ class Eco::API::UseCases::Cli
 
     def link_case(cli_config_case)
       raise ArgumentError, "cli_config_case must have an 'add_option' method. Given: #{cli_config_case.class}" unless cli_config_case.respond_to?(:add_option)
+
       cli_config_case.add_option(name, desc, &callback)
     end
   end

data/lib/eco/api/usecases/default/utils/cli/split_csv_cli.rb

@@ -11,5 +11,10 @@ class Eco::API::UseCases::Default::People::Utils::SplitCsv
       count = SCR.get_arg("-max-rows", with_param: true)
       options.deep_merge!(output: {file: {max_rows: count}})
     end
+
+    add_option("-start-at", "Get only the last N-start_at rows") do |options|
+      count = SCR.get_arg("-start-at", with_param: true)
+      options.deep_merge!(output: {file: {start_at: count}})
+    end
   end
 end

data/lib/eco/api/usecases/default/utils/split_csv_case.rb

@@ -7,15 +7,27 @@ class Eco::API::UseCases::Default::People::Utils::SplitCsv < Eco::API::Common::L
   type :other
 
   def main(*_args)
-    Eco::CSV.split(input_file, max_rows: max_rows).each do |file|
-      log(:info) {
-        "Generated file '#{file}'"
-      }
+    if simulate?
+      count = Eco::CSV.count(input_file, start_at: start_at)
+      log(:info) { "CSV '#{input_file}' has #{count} rows." }
+    else
+      Eco::CSV.split(
+        input_file,
+        max_rows: max_rows,
+        start_at: start_at,
+        &filter
+      ).each do |file|
+        log(:info) { "Generated file '#{file}'" }
+      end
     end
   end
 
   private
 
+  def filter
+    nil
+  end
+
   def input_file
     options.dig(:source, :file)
   end
@@ -31,4 +43,12 @@ class Eco::API::UseCases::Default::People::Utils::SplitCsv < Eco::API::Common::L
     num = nil if num.zero?
     num
   end
+
+  def start_at
+    return nil unless (num = options.dig(:output, :file, :start_at))
+
+    num = num.to_i
+    num = nil if num.zero?
+    num
+  end
 end

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

@@ -2,6 +2,8 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   name "to-csv"
   type :export
 
+  OUT_FILENAME = 'pm'
+
   attr_reader :people
 
   def main(people, _session, options, _usecase)
@@ -16,8 +18,9 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
     if options.dig(:export, :options, :split_schemas)
       by_schema.each do |id, people|
         sch_name = schemas.to_name(id)
-        prefix = sch_name ? sch_name.gsub(" ", "_") : "No_Schema"
-        create_file!("#{prefix}_#{file}", people)
+        prefix   = sch_name ? sch_name.gsub(" ", "_").downcase : "no_schema"
+        filename = in_folder("#{prefix}_#{File.basename(file)}")
+        create_file!(filename, people)
       end
     else
       create_file!(file, people)
@@ -61,15 +64,13 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   end
 
   def nice_header_names(header, schema: nil)
-    schema ||= session.schema
-    name_maps = schema.fields_by_alt_id.each_with_object({}) do |(alt_id, fld), mappings|
-      mappings[alt_id] = fld.name
-    end.merge(nice_header_maps)
+    schema  ||= session.schema
+    name_maps = schema.fields_by_alt_id.transform_values(&:name).merge(nice_header_maps)
     header.map {|name| name_maps[name] || name}
   end
 
   def to_entry_type(person)
-    session.new_entry(person, dependencies: deps).yield_self do |person_entry|
+    session.new_entry(person, dependencies: deps).then do |person_entry|
       options.dig(:export, :options, :internal_names) ? person_entry.mapped_entry : person_entry.external_entry
     end
   end
@@ -79,14 +80,37 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   end
 
   def file
-    @file ||= (options[:file] || options.dig(:export, :file, :name)).tap do |filename|
-      unless filename
-        session.logger.error("Destination file not specified")
-        return false
-      end
+    @file ||= out_filename.tap do |filename|
+      next if filename
+
+      log(:error) { "Destination file not specified" }
+      return false
     end
   end
 
+  def out_filename
+    return options_file unless options_folder?
+
+    File.join(options_file, "#{config.active_enviro}_#{OUT_FILENAME}.csv")
+  end
+
+  def in_folder(filename)
+    basename = File.basename(filename)
+    return basename unless options_folder?
+
+    File.join(options_file, basename)
+  end
+
+  def options_folder?
+    return false unless (value = options_file)
+
+    File.directory?(value)
+  end
+
+  def options_file
+    options[:file] || options.dig(:export, :file, :name)
+  end
+
   def by_schema
     people.group_by do |person|
       if (details = person.details)

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff.rb

@@ -102,10 +102,22 @@ module Eco::API::UseCases::GraphQL::Samples
       #     - `as_nodes_json`
       #   2. `org_tree` is native from `Eco::Data::Locations::NodeBase::CsvConvert`
       def file_nodes_list
-        @file_nodes_list ||= as_nodes_json(org_tree(input_csv)).tap do |list|
+        @file_nodes_list ||= as_nodes_json(file_tree).tap do |list|
           log(:info) { "Converted input csv file to list of #{list.count} hash-nodes" }
         end
       end
+
+      def file_tree
+        org_tree(input_csv).then do |tree|
+          next tree if include_file_archived?
+
+          tree.active_tree
+        end
+      end
+
+      def include_file_archived?
+        options.dig(:input, :file, :include, :archived)
+      end
     end
   end
 end

data/lib/eco/api/usecases/graphql/samples/location/service/tree_to_list/converter/parser.rb

@@ -14,11 +14,11 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
           return @node_parser_block if instance_variable_defined?(:@node_parser_block)
           custom_before = custom_node_parser_before_block
           custom_after  = custom_node_parser_block
-          @node_parser_block = proc do |node_hash|
+          @node_parser_block = proc do |node_hash, node|
             node_hash.tap do
-              custom_before&.call(node_hash)
-              default_node_parse(node_hash)
-              custom_after&.call(node_hash)
+              custom_before&.call(node_hash, node)
+              default_node_parse(node_hash, node)
+              custom_after&.call(node_hash, node)
             end
           end
         end
@@ -35,7 +35,7 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
         end
 
         # Generic parsing
-        def default_node_parse(node_hash)
+        def default_node_parse(node_hash, _node)
           class_ids = to_classification_ids(node_hash['classifications'])
           node_hash['classifications'] = class_ids
         end

data/lib/eco/api/usecases/graphql/samples/location/service/tree_to_list/converter.rb

@@ -24,12 +24,10 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
             next key unless node_attr_maps.key?(key)
             node_attr_maps[key]
           end.tap do |node_hash|
-            node_parser_block&.call(node_hash)
-            yield(node_hash) if block_given?
+            node_parser_block&.call(node_hash, node)
+            yield(node_hash, node) if block_given?
           end
-        end.tap do |list|
-          list.each(&node_parser_block)
-        end
+        end.compact.reject(&:empty?)
       end
     end
   end

data/lib/eco/cli/config/filters.rb

@@ -15,7 +15,8 @@ module Eco
         def help(msg = nil, refine: nil)
           refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
           msg ||= "The following are the available filters#{refinement}:"
-          [msg].yield_self do |lines|
+
+          [msg].then do |lines|
             max_len = keys_max_len(@filters.keys)
             @filters.keys.sort.select do |key|
               !refine.is_a?(String) || key.include?(refine)
@@ -26,10 +27,19 @@ module Eco
           end.join("\n")
         end
 
+        def available(keys: false)
+          return @filters.keys if keys
+
+          @filters.keys.map do |key|
+            [key, @filters[key], @description[key]]
+          end
+        end
+
         # @param option [String] the command line option that activates this filter.
         # @param desc [String] description of the filter.
         def add(option, desc = nil, &block)
-          raise "Missing block to define the filters builder" unless block_given?
+          raise ArgumentError, "Missing block to define the filters builder" unless block_given?
+
           callback = block
           [option].flatten.compact.each do |opt|
             @filters[opt]     = callback
@@ -38,7 +48,7 @@ module Eco
           self
         end
 
-        def process(io:)
+        def process(*)
           raise "You need to override this method in child classes"
         end
       end