eco-helpers 2.6.0 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796d1fc03564d9e1bd9389954b164c7d8e1469793871191390824a6e32fabc67
-  data.tar.gz: 7d820fb01377374aca6059f8df28f9bb596c1fa023f7ebbfdc4f94d011e703a7
+  metadata.gz: '0904af2dd434adc72c1ca3e889d4e0b11595ce991f6de1c997f613d80c8866ce'
+  data.tar.gz: b21748a878327830d5c813340ab2fcfe69ebace8137480bc9dfc42f290296cbf
 SHA512:
-  metadata.gz: c89c374aa377818d82d85eba913ffb9392343276373fbca166b53471dc2c70cdd3caa29c7050b7f2547ff3191d5078848238b11a6fe3264171ffc968bb38afb1
-  data.tar.gz: 98f7acfa91c4dd78b2c63340b620a2be5d7407bd074a23ea6908594ac79e126e6e3b1b837e5391acbd64dda59978ca380089f9b8d0b513563ca0c345b1d2b59a
+  metadata.gz: 2bccc140b8ec44d41aaccdffde8e5b51a1c755fc75dcede5e08526be6daed4482a5f733ceba6a75155f1dee74dbc8e2edc52ee9f2ab55f7ebf6521acfd3aac47
+  data.tar.gz: b362a14bf0a872ee04928ace6c05600df37ecfd56cb754b5f2a0cc3a417115cc8d9a889ce5f40de80ed41f281b16005eed78eadf04a330dc6fa80066baa56e63

data/CHANGELOG.md

@@ -1,16 +1,106 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.6.1] - 2024-02-xx
+## [2.6.2] - 2024-02-23
 
 ### Added
+  - `Eco::API::Session::Config::TagTree`: added **benchmarks** to locations structure live retrieval
+  - To all **Ooze** cases that use register update
+    - `Eco::API::UseCases::OozeSamples::Helpers::Creatable` native helpers
+    - to draft entries
+    - `Eco::API::UseCases::OozeSamples::RegisterMigrationCase` -> removed code double-up due to this addition to the register update case.
+  - `Eco::API::Common::Loaders::Base` added **methods**
+    - `#simulate?` and `#dry_run?`
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - added **kpis** attempted updates and attempted creations
+
 ### Changed
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - `#main` allows to tell it to just `yield`
+
 ### Fixed
+  - `Eco::Data::Locations::NodeDiff::Selectors` `any?` (typo)
+  - `Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase`
+    - fixed **kpis** tracking
+
+## [2.6.1] - 2024-02-11
 
+### Added
+  - For use case `Eco::API::UseCases::Default::Locations::TagtreeExtract`
+    - New `-indent` option
+  - `Eco::API::UseCases::UseCase`
+    - Defines on loader object attr reader methods `people`, `input` and `usecase` unless they already exist.
+  - Some class / method helpers
+    - `Eco::Language::Methods::DelegateMissing` to redirect missing methods to one object
+    - `Eco::Language::Methods::DslAble` to allow direct method calls on blocks
+    - `Eco::Language::Klass:WhenInherited` to allow to defined a block that gets called when the class is inherited
+  - **DSL** capabilities (for block calls) for
+    - `Eco::API::Session::Batch::BasePolicy`
+    - `Eco::API::Session::Batch::Job`
+      - `api_excluded` block to be called in the Job's context
+    - `Eco::API::UseCases::BaseIO`
+      - This shortens code lines in workflow blocks
+      - `Eco::API::Session::Config::Workflow#run` has been adapted to boost the evalution of the workflow blocks within the context of the `BaseIO` that is carried throughout all the run process.
+  - **NEW** Loaders
+    - `Eco::API::Custom::Config` (**DSL** alike) allows to open up configuration via class
+      - Redirects to `Eco::API::Common::Loaders::Config`
+      - Re-usable sample child classes can created with the use of `config_block`, which in combination with `when_inherited` will load the basic config to custom config classes.
+    - `Eco::API::Custom::Workflow` (**DSL** alike) allows to open up workflow configurations via class
+      - Redirects to `Eco::API::Common::Loaders::Config::Workflow`
+    - `Eco::API::Custom::Mailer` (first **sample**) allows to just define some constants to modify the generic behaviour of this sample class you will want to inherit to enable mailing workflow.
+      - Redirects to `Eco::API::Common::Loaders::Config::Workflow::Mailer`
+  - `Eco::Assets#cli` able to yield the `cli` to a block
+  - `Eco::API::UseCases::BaseIO#process_case`
+    - **added method** `process_case`, which allows to pass the `io` itself as a paramter.
+    - When this is used, the `output` swap as `input` / `people` is performed (before and after).
+
+### Changed
+  - **IMPORTANT** overriden `Object#inspect` to `to_s` to prevent recursive deep introspection of object internals on `MethodError`
+  - `Eco::API::Common::Loaders::CaseBase`
+    - **removed** attr `usecase`
+  - `Eco::API::UseCases::BaseIO`
+    - `output` can be set on initialization
+    - `#new` carries the `output` as well.
+  - `Eco::API::Session::Config::Workflow`
+    - `#run`
+      - workflow blocks don't require to explicitly return the `BaseIO` when there isn't any to return. It will just keep the `io` as it was before the call.
+      - also made it so the returned io is **always** an **instance of** `Eco::API::UseCases::BaseIO` (so it won't return an instance of a child class). This change can be considered a fix. **Aside note:** only possible now that `output` is carried on through objects of type (so there's there's no data loss in the calls chain) `Eco::API::UseCases::BaseIO` (i.e. `io.new`)
+    - `#for`
+      - **now** it only requires a `block` if no `key` is provided
+    - `Eco::Data::Locations::NodeBase::TagValidations`
+      - made module re-usable, by removing dependency on `clean_id` method.
+  - Improved the **patch** on exception that adds method `#patch_full_message`
+    - Parameter `trace_count` added (`default: -1` for full trace)
+
+### Fixed
+  - `Eco::Data::Locations::NodeBase::Treeify`
+    - **bug** on strings and interpolation when building the warning/error messages
+    - **added** detection and _warnings_ for **unlinked parents**: as `get_children` is called from the top via `nil` (those that are top level nodes), and all the call chain to collect children goes through their `parent_id` relationship.
+      - If the input nodes had some where there's no direct link between `nil` and a node `id` that is a `parent_id`, `parents[node.id]` would never be called. Meaning that in an input with a list of nodes, there could be clusters of subtrees that do not add/link to the top level (`nil`).
+      - It now gathers those separated subtrees in an `Array` parameter called `unlinked_trees`
+  - `Eco::API::Session::Config::Workflow`
+    - Returning an `Eco::API::UseCases::BaseIO` from callbacks `before`, `after` and `run` would raise an `ArgumentError`.
+    - **Now** the original `io` is returned otherwise the returned value is a `BaseIO`
+  - `Eco::API::Session::Config::Workflow`
+    - **changed** `open` to alias method for `with` (open was clashing)
+  - `Eco::API::UseCases::GraphQL::Helpers::Location::Base`
+    - **removed** `enviro` param for org tagtree built
+  - `Eco::API::UseCases::Cli::DSL`
+    - `::callback` was not acting like a DSL method, which would just return `nil` always (lost `block`)
+    - CLI arguments are unique. If a Cli class has already been run, no need to re-run it. Cli class re-usability is still not in the pipeline, and therefore, it must be run only once.
+  - `Eco::Data::Locations::NodePlain`
+    - `serializer` referred to an non existing constant.
+    - **IMPORTANT** `parent_id` should be `cleaned` as well. Otherwise parents with an id cleanage don't match their children's `parent_id`
+  - `Eco::API::Common::ClassHelpers`
+    - `::inerited` method must call `super` to be able to chain other calls
+  - `Eco::API::Common::Session::Mailer`
+    - The logging message was not printing who the email was sent to.
 
 ## [2.6.0] - 2024-02-03
 
 ### Added
+  - New use case to `-export-tree` (**tagtree extract**)
+    - `Eco::API::UseCases::Default::Locations::TagtreeExtract`
   - `Eco::API::UseCases::UseCase`
     - added `#classed_definition` to expose the original class definition
     - injected further parameter as instance variables to the original class definition on run-time.

data/README.md

@@ -17,3 +17,8 @@ And then execute:
 Or install it yourself as:
 
     $ gem install eco-helpers
+
+
+## Changelog
+
+See {file:CHANGELOG.md} for a list of changes.

data/eco-helpers.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'
   spec.add_dependency 'amatch',        '>= 0.4.1',  '< 0.5'
   spec.add_dependency 'jaro_winkler',  '>= 1.5.6',  '< 1.6'
-  spec.add_dependency 'nokogiri',      '>= 1.13',   '< 1.16'
+  spec.add_dependency 'nokogiri',      '>= 1.13',   '< 1.17'
   spec.add_dependency 'roo',           '>= 2.10.1', '< 2.11'
   spec.add_dependency 'roo-xls',       '>= 1.2.0',  '< 1.3'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'

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

@@ -129,13 +129,13 @@ module Eco
         #   - mutating methods would reflect the changes on other classes as well
         #   - therefore, `freeze` will be called on the values that are inherited.
         def inherited(subclass)
+          super
           inheritable_class_vars.each do |var|
             instance_var = instance_variable_name(var)
             value        = instance_variable_get(instance_var)
             subclass.instance_variable_set(instance_var, value.freeze)
           end
         end
-
       end
     end
   end

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

@@ -32,6 +32,11 @@ module Eco
 
           private
 
+          def simulate?
+            options.dig(:simulate) || options.dig(:dry_run)
+          end
+          alias_method :dry_run?, :simulate?
+
           def session
             @session ||= ASSETS.session
           end

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

@@ -20,8 +20,6 @@ module Eco
             end
           end
 
-          attr_reader :usecase
-
           def name
             self.class.name
           end

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

@@ -0,0 +1,78 @@
+class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::Workflow
+  ORG = 'your organization'.freeze
+  TRACE_COUNT = 3
+
+  inheritable_class_vars :config_block
+
+  config_block do
+    puts "running from class #{self}"
+    exception do |err, io|
+      self.error = err
+      log(:debug) { err.patch_full_message }
+      workflow.run(:close, io: io)
+    end
+
+    after(:close) do |_wf, io|
+      next if options.dig(:workflow, :no_email)
+      next unless session.mailer?
+      next if session.config.dry_run?
+      next unless session.config.run_mode_remote?
+      next unless some_update?(io) || error?
+
+      subject = base_subject
+
+      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?
+
+        msg     = "#{session.summary}\n"
+        msg    += errors_n_warnings(io)
+
+        session.mail(subject: subject, body: msg) unless msg.strip.empty?
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :error
+
+    def org_name
+      self::ORG
+    end
+
+    def base_subject
+      "#{org_name} (#{active_enviro}) at #{Time.now.iso8601}"
+    end
+
+    def some_update?(io)
+      cli.config.usecases.active(io: io).any? do |usecase, data|
+        [:transform, :sync].any? { |type| usecase.type == type }
+      end
+    end
+
+    def error?
+      !!error
+    end
+
+    def errors_n_warnings(io)
+      [error_message, log_err_n_warn(io)].join("\n")
+    end
+
+    def log_err_n_warn(io)
+      warn_errors = io.logger.cache.logs(level: [:error, :warn])
+      return if warn_errors.empty?
+      "WARNINGS & ERRORS:\n#{warn_errors.join('')}\n"
+    end
+
+    def error_message
+      error&.patch_full_message(trace_count: 3)
+    end
+
+    def trace_count
+      self::TRACE_COUNT
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+class Eco::API::Common::Loaders::Workflow < Eco::API::Common::Loaders::Config
+  class << self
+    def workflow
+      config.workflow
+    end
+  end
+
+  delegate_missing_to :workflow
+end
+
+require_relative 'workflow/mailer'

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

@@ -0,0 +1,29 @@
+class Eco::API::Common::Loaders::Config
+  extend Eco::API::Common::ClassHelpers
+  extend Eco::Language::Methods::DelegateMissing
+  inheritable_class_vars :delegate_missing_to
+
+  class << self
+    # To create samples of configurations
+    def config_block(&block)
+      return @config_block unless block_given?
+      @config_block = block
+    end
+
+    def config
+      ASSETS.config
+    end
+
+    def cli
+      ASSETS.cli
+    end
+
+    def active_enviro
+      config.active_enviro
+    end
+  end
+
+  delegate_missing_to :config
+end
+
+require_relative 'config/workflow'

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

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class ErrorHandler < Eco::API::Common::Loaders::CaseBase
-
           class << self
             attr_writer :error
 
@@ -35,7 +34,6 @@ module Eco
           def error
             self.class.error
           end
-
         end
       end
     end

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

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class Parser < Eco::API::Common::Loaders::CaseBase
-
           # Helper class to scope what required attributes it depends on
           class RequiredAttrs < Struct.new(:attr, :type, :attrs)
             def active?(*input_attrs)

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

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class Policy < Eco::API::Common::Loaders::CaseBase
-
           def initialize(policies)
             raise "Expected Eco::API::Policies. Given #{policies.class}" unless policies.is_a?(Eco::API::Policies)
             policies.define(self.name, &self.method(:main))
@@ -17,7 +16,6 @@ module Eco
           def main(people, session, options, policy, job)
             raise "You should implement this method"
           end
-
         end
       end
     end

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

@@ -9,6 +9,7 @@ end
 
 require_relative 'loaders/base'
 require_relative 'loaders/case_base'
+require_relative 'loaders/config'
 require_relative 'loaders/use_case'
 require_relative 'loaders/policy'
 require_relative 'loaders/error_handler'

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

@@ -33,7 +33,9 @@ module Eco
                 }
               }
             ).tap do |response|
-              logger.debug("Sent email to #{to} (MessageId: #{response.message_id})")
+              msg = "Sent email (MessageId: #{response.message_id}) to #{fetch_destination(to: to, cc: cc, bcc: bcc)}"
+              puts msg
+              logger.debug(msg)
             end
           end
 

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

@@ -1,9 +1,9 @@
 class ::Exception
-  def patch_full_message
+  def patch_full_message(trace_count: -1)
     begin
       msg = []
       tracing   = backtrace ? backtrace : []
-      tracing   = (self.class == SystemStackError) ? tracing[1..30] : tracing[1..-1]
+      tracing   = (self.class == SystemStackError) ? tracing[1..30] : tracing[1..trace_count]
       tracing ||= []
       msg << "\n#{tracing.first} \n#{message} (#{self.class.to_s})"
       tracing.each_with_index {|bt, i| msg << "#{" "*8}#{i+1}: from #{bt}"}

data/lib/eco/api/common/version_patches/ruby3/object.rb

@@ -0,0 +1,18 @@
+class Object
+  # From ruby3
+  # `NameError` prints the internals of the object as well as subobjects
+  # which is really unnecessary
+  # @example
+  #     class Foo; attr_writer :bar; end
+  #     foo = Foo.new
+  #     foo2 = Foo.new
+  #     foo.bar = foo2
+  #     h = {a: 1, b: 2, c: foo}
+  #     foo2.bar = h
+  #     h.foo
+  #     #=> undefined method `foo' for {:a=>1, :b=>2, :c=>#<Foo:0x000002343276b520 @bar=#<Foo:0x0000023437e91ca0 @bar={...}>>}:Hash (NoMethodError)
+  # What's the use of such a detail when it's just a missing method at the top of it?
+  def inspect
+    to_s
+  end
+end

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

@@ -0,0 +1 @@
+require_relative 'ruby3/object'

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

@@ -7,6 +7,9 @@ module Eco
   end
 end
 
+if Gem::Version.create('3.0.0') <=  Gem::Version.create(RUBY_VERSION)
+  require_relative 'version_patches/ruby3'
+end
 require_relative 'version_patches/object'
 require_relative 'version_patches/exception'
 require_relative 'version_patches/hash'

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

@@ -0,0 +1,10 @@
+# Helper class to create a custom `Config`
+# @example Example of usage:
+#  class Custom::Config::BatchPolicies < Eco::API::Custom::Config
+#    batch_policies do
+#      create.max = 5
+#      update.max = 20
+#    end
+#  end
+class Eco::API::Custom::Config < Eco::API::Common::Loaders::Config
+end

data/lib/eco/api/custom/mailer.rb

@@ -0,0 +1,9 @@
+# Helper class to create a custom `Config`
+# @example Example of usage:
+#  class Custom::Workflow::Mailer < Eco::API::Custom::Mailer
+#    ORG = "Org Name"
+#  end
+class Eco::API::Custom::Mailer < Eco::API::Common::Loaders::Workflow::Mailer
+  extend Eco::Language::Klass::WhenInherited
+  when_inherited(&config_block)
+end

data/lib/eco/api/custom/namespace.rb

@@ -4,4 +4,6 @@ module Custom
   module Policy; end
   module ErrorHandler; end
   module Parser; end
+  module Config; end
+  module Workflow; end
 end

data/lib/eco/api/custom/workflow.rb

@@ -0,0 +1,9 @@
+# Helper class to create a custom `Config`
+# @example Example of usage:
+#  class Custom::Config::DefaultOptions < Eco::API::Custom::Workflow
+#    after(:options) do
+#      options.deep_merge!(send_invites: false) unless options.dig(:send_invites)
+#    end
+#  end
+class Eco::API::Custom::Workflow < Eco::API::Common::Loaders::Workflow
+end

data/lib/eco/api/custom.rb

@@ -7,6 +7,9 @@ module Eco
 end
 
 require_relative 'custom/namespace'
+require_relative 'custom/config'
+require_relative 'custom/workflow'
+require_relative 'custom/mailer'
 require_relative 'custom/use_case'
 require_relative 'custom/policy'
 require_relative 'custom/error_handler'

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

@@ -20,9 +20,10 @@ module Eco
         # @attr_reader min [Integer] `min` **required** number of occurrences of the property
         class BasePolicy
           extend Eco::API::Common::ClassHierarchy
+          # adds evaluate method to enable block calls as DSL
+          include Eco::Language::Methods::DslAble
 
           class << self
-
             # If the class for `key` exists, it returns it. Otherwise it generates it.
             # @note for this to work, `key` should be one of the submodels of the current class' `model`
             # @return [Eco::API::Session::Batch::BasePolicy] or subclass thereof
@@ -52,16 +53,14 @@ module Eco
                   end
 
                   if block
-                    block.call(policy)
+                    policy.evaluate(policy, &block)
                     self
                   else
                     policy
                   end
                 end
-
               end
             end
-
           end
 
           include Enumerable
@@ -75,6 +74,16 @@ module Eco
             @policies = {}
           end
 
+          def max(value = :unused)
+            return @max if value == :unused
+            self.max = value
+          end
+
+          def min(value = :unused)
+            return @min if value == :unused
+            self.min = value
+          end
+
           def attr(as_namespace: false)
             return @attr if !as_namespace || root?
             "#{@_parent.attr(as_namespace: true)}:#{@attr}"
@@ -222,7 +231,6 @@ module Eco
             return model if model.is_a?(Hash)
             model.to_h if model.respond_to?(:to_h)
           end
-
         end
       end
     end

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

@@ -9,6 +9,8 @@ module Eco
         # @attr_reader status [Eco::API::Session::Batch::Status] if launched: the `status` of the `batch`
         # @attr_reader feedback [Eco::API::Session::Batch::Feedback] helper class for feedback and end-user decision making
         class Job < Eco::API::Common::Session::BaseSession
+          include Eco::Language::Methods::DslAble
+
           @types = [:get, :create, :update, :delete]
           @sets  = [:core, :details, :account]
 
@@ -278,14 +280,15 @@ module Eco
           def api_included(full_queue)
             return full_queue if type == :create
             return full_queue unless excluded_callback = session.config.people.api_excluded
-            excluded = options.dig(:include, :excluded)
-            if excluded.is_a?(Hash) && excluded[:only]
-              full_queue.select {|entry| excluded_callback.call(entry, session, options, self)}
-            elsif options.dig(:include, :excluded)
-              full_queue
-            else
-              full_queue.select {|entry| !excluded_callback.call(entry, session, options, self)}
+
+            inc_excluded  = options.dig(:include, :excluded)
+            excluded_only = inc_excluded.is_a?(Hash) && excluded[:only]
+            is_excluded   = Proc.new do |entry|
+              evaluate(entry, session, options, self, &excluded_callback)
             end
+            return full_queue.select(&is_excluded) if excluded_only
+            return full_queue                      if inc_excluded
+            full_queue.reject(&is_excluded)
           end
 
           # Applies the changes introduced by api policies

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

@@ -93,9 +93,16 @@ module Eco
               includeArchivedNodes: include_archived
             }.merge(kargs)
 
+            start = Time.now
             return nil unless tree = graphql.currentOrganization.locationStructure(**kargs, &block)
+            end_time = Time.now
+            secs    = (end_time - start).round(3)
 
-            Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name)
+            Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name).tap do |eco_tree|
+              cnt     = eco_tree.count
+              per_sec = (cnt.to_f / secs).round(2)
+              session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
+            end
           end
 
           # Retrieves all the location structures of the organisation
@@ -110,11 +117,18 @@ module Eco
                 includeArchivedNodes: include_archived
               }.merge(kargs)
 
+              start = Time.now
               next unless trees = graphql.currentOrganization.locationStructures(**kargs, &block)
+              end_time = Time.now
+              secs     = (end_time - start).round(3)
+              cnt      = 0
               trees.each do |tree|
                 eco_tree = Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name)
+                cnt += eco_tree.count
                 eco_trees.push(eco_tree)
               end
+              per_sec = (cnt.to_f / secs).round(2)
+              session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
             end
           end