eco-helpers 3.1.2 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab6e025cd47d9c9afb95fb6a311307141febeb6d518d500efa0a821f02c2d917
-  data.tar.gz: c66c7648b57210a687f1cd87cf864707e0486ee7ea7d7f68d7882ab6399a10f1
+  metadata.gz: d90d0437d82cfb02acb981d200aaf20a67c18c1d33e19f1c81fe29c6ca7c9501
+  data.tar.gz: 7e9c99c233adcda692cbe3f0e31c154a2bdcc970dbfa4cd853ed64039c205431
 SHA512:
-  metadata.gz: b0cd9971a814d6e580e1d96cb902ce7d4f2e03adf2f79c63252a50e28f56824d8ff03ef1671e8f64db3d15bc13d7d5c7390301230b6f225e7e16f4bf73563f4b
-  data.tar.gz: 6063ded8c5851cb7e01b464828eed8f92b2f213c9c1dcd6f80a4fbd8d3d687632de8a0007d0a466b6c2b72b6b2053e996eab8bbc8a8ae5f90567cb385b69c185
+  metadata.gz: 4a3ccbbb86b403a5fcbe77dd13b34b6088edd238b08293ab5d55b254a6ff987abefd6b00bcb0fdfda2ea03bc256082107264ab80fec83a266144dd421bf322bc
+  data.tar.gz: 436360d8633631c039b1a8caeec9781bc68a79cdcfe7cb943e1edfb65f873f3a916a158a647bbc7871003338fddc7f9760edce6c6c6e59b3cba44c5095a555be

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.1.3] - 2025-05-xx
+## [3.1.5] - 2025-05-xx
 
 ### Added
 
@@ -10,6 +10,34 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.1.4] - 2025-05-15
+
+### Changed
+
+- upgraded `ecoportal-api` gem.
+- `Eco::API::Session::Batch::Launcher`
+  - **Added** `#allowed_retries`: when in `:job` mode, it will NOT allow any re-tries.
+  - Renamed constant `TIMEOUT_RETRIES` to `ALLOWED_RETRIES` and **moved** to `Retry` module.
+  - ``Eco::API::Session::Batch::Launcher::ModeSize`
+    - **Increased** default Job max size to `500` (it was `100`).
+    - **Increased** default Job min size to `50`  (it was `15`).
+
+## [3.1.3] - 2025-05-14
+
+### Changed
+
+- upgraded `ecoportal-api-v2` and `ecoportal-api-graphql`
+
+### Fixed
+
+- `Eco::Language::Models::Workflow`
+  1. `::workflow_class`: prevent `class_name` collision.
+  2. Ensure `class_name` is representative of the stage's `name` and `path`.
+- `Eco::Language::Models::Workflow`
+  - **Overriding** `#clone` and `#dup` methods
+  - **Fixes** `Eco::API::Session::Config#clone`, called when the `session` is swapped from the `:general` to the one of the target environment.
+- `inheritable_class_vars` should join (uniq)
+
 ## [3.1.2] - 2025-05-05
 
 ### Added

data/eco-helpers.gemspec

@@ -41,9 +41,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bcrypt_pbkdf',  '~> 1.0'
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
-  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.10'
-  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4',  '>= 0.4.5'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.16'
+  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.11'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 1.1',  '>= 1.1.1'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 3.1',  '>= 3.1.1'
   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/loaders/config/workflow/mailer.rb

@@ -7,8 +7,6 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
     travis@ecoportal.co.nz
   ].freeze
 
-  inheritable_class_vars :config_block
-
   # @todo different emailing, depending on case type and/or preference
   config_block do
     #puts "running from class #{self}"

data/lib/eco/api/session/batch/launcher/mode_size.rb

@@ -7,8 +7,8 @@ module Eco
             include Eco::API::Session::Batch::Launcher::Options
 
             DEFAULT_BATCH_SIZE = 50
-            DEFAULT_JOB_SIZE   = 100
-            MIN_JOB_SIZE       = 15
+            DEFAULT_JOB_SIZE   = 500
+            MIN_JOB_SIZE       = 50
 
             def batch_size(opts = options)
               return job_mode_size if job_mode?(opts)
@@ -19,6 +19,7 @@ module Eco
             private
 
             # Swaps to batch endpoint on specific errors
+            # @note it does it only once.
             def batch_mode_on(
               *error_types,
               options:        self.options,

data/lib/eco/api/session/batch/launcher/retry.rb

@@ -4,6 +4,8 @@ module Eco
       class Batch
         module Launcher
           module Retry
+            ALLOWED_RETRIES = 2 # 3 times (including first launch)
+
             def self.included(base)
               unless base <= Eco::API::Session::Batch::Launcher
                 msg  = 'To be included only in Eco::API::Common::Session::BaseSession. '
@@ -16,7 +18,7 @@ module Eco
 
             private
 
-            def offer_retry_on(*error_types, retries_left: 3, &block)
+            def offer_retry_on(*error_types, retries_left: ALLOWED_RETRIES, &block)
               yield
             rescue *error_types => err
               raise err.class, err.message, cause: nil unless retries_left.positive?

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

@@ -28,7 +28,6 @@ module Eco
           include StatusHandling
           include Retry
 
-          TIMEOUT_RETRIES = 2
           RETRY_ON        = [
             Ecoportal::API::Errors::TimeOut,
             Ecoportal::API::Errors::StartTimeOut
@@ -58,6 +57,12 @@ module Eco
             )
           end
 
+          def allowed_retries(in_job_mode)
+            return 0 if in_job_mode
+
+            self.class::ALLOWED_RETRIES
+          end
+
           def launch_batch( # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
             data,
             method:,
@@ -99,7 +104,10 @@ module Eco
 
                   start_slice = Time.now
 
-                  offer_retry_on(*RETRY_ON, retries_left: TIMEOUT_RETRIES) do
+                  offer_retry_on(
+                    *RETRY_ON,
+                    retries_left: allowed_retries(as_job_mode)
+                  ) do
                     people_api.batch(job_mode: as_job_mode) do |batch|
                       slice.each do |person|
                         batch.public_send(method, person) do |response|

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

@@ -458,7 +458,8 @@ module Eco
 
         # @return [Eco::API::Session::Config::Workflow]
         def workflow
-          @workflow = self['workflow'] ||= Eco::API::Session::Config::Workflow.new(config: self)
+          @workflow = self['workflow'] ||=
+            Eco::API::Session::Config::Workflow.new(config: self)
           @workflow.tap do |wf|
             yield(wf) if block_given?
           end

data/lib/eco/cli_default/workflow/report.rb

@@ -2,15 +2,15 @@ class Eco::CliDefault::Workflow
   class Report < Eco::API::Common::Loaders::Workflow
     config_block(:workflow, :report) do
       on(:report) do |_wf_rep, io|
-        if (file = options.dig(:report, :people, :csv))
-          options.deep_merge!(export: {
-            options: {internal_names: true, nice_header: true, split_schemas: true},
-            file:    {name: file, format: :csv}
-          })
+        next unless (file = options.dig(:report, :people, :csv))
 
-          aux_io = io.new(data: data.updated_or_created)
-          session.process_case('to-csv', io: aux_io, type: :export)
-        end
+        options.deep_merge!(export: {
+          options: {internal_names: true, nice_header: true, split_schemas: true},
+          file:    {name: file, format: :csv}
+        })
+
+        aux_io = io.new(data: data.updated_or_created)
+        session.process_case('to-csv', io: aux_io, type: :export)
       end
     end
   end

data/lib/eco/cli_default/workflow.rb

@@ -31,7 +31,10 @@ class Eco::CliDefault::Workflow < Eco::API::Common::Loaders::Workflow
     Report,
     End
   ].each do |wf_config|
-    wf_config.config_copy(to: self, all: true)
+    wf_config.config_copy(
+      to:  self,
+      all: true
+    )
   end
 
   config_apply!(all: true)

data/lib/eco/language/klass/inheritable_class_vars.rb

@@ -5,22 +5,25 @@ module Eco::Language::Klass
     # Keeps track on class instance variables that should be inherited by child classes.
     # @note
     #   - 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)
+    #   - 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.
+    # @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
+      @inheritable_class_vars  |= vars
     end
 
     # 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
+        class_eval <<-DEF_CLSS_ATTR, __FILE__, __LINE__ + 1
+          class << self            # class << self
+            attr_accessor :#{attr} #   attr_accessor :coolio
+          end                      # end
+        DEF_CLSS_ATTR
       end
 
       inheritable_class_vars(*attrs)

data/lib/eco/language/models/workflow.rb

@@ -20,8 +20,10 @@ module Eco::Language::Models
         raise ArgumentError, msg
       end
 
-      def workflow_class(key)
-        class_name = to_constant(key.to_s)
+      def workflow_class(key, prefix: nil)
+        class_name = "#{key}::#{uid}"
+        class_name = "#{prefix}::#{class_name}" if prefix
+        class_name = to_constant(class_name)
 
         new_class(
           class_name,
@@ -36,7 +38,7 @@ module Eco::Language::Models
 
     def initialize(name = nil, config:, _parent: self) # rubocop:disable Lint/UnderscorePrefixedVariableName
       @config   = config
-      @name     = name
+      @name     = name || 'root'
 
       @stages   = {}
       @_parent  = _parent
@@ -48,6 +50,12 @@ module Eco::Language::Models
       @after    = []
     end
 
+    # We don't support cloning
+    def clone
+      self
+    end
+    alias_method :dup, :clone
+
     def name(with_path: false)
       return @name if !with_path || root?
 
@@ -243,6 +251,7 @@ module Eco::Language::Models
           io = run_it(io, &block) unless skip?
           io = run_after(io)
         end
+
         io
       ensure
         @pending = false
@@ -266,6 +275,10 @@ module Eco::Language::Models
     end
 
     def run_before(io)
+      io.session.log(:debug) {
+        "(Workflow: #{path}) running before callbacks..."
+      }
+
       @before.each do |c|
         io = io_result(io: io) do
           io.evaluate(self, io, &c)
@@ -276,6 +289,10 @@ module Eco::Language::Models
     end
 
     def run_after(io)
+      io.session.log(:debug) {
+        "(Workflow: #{path}) ...running after callbacks"
+      }
+
       @after.each do |c|
         io = io_result(io: io) do
           io.evaluate(self, io, &c)
@@ -348,7 +365,9 @@ module Eco::Language::Models
 
     def stage(key)
       self.class.validate_stage!(key)
-      @stages[key] ||= self.class.workflow_class(key).new(
+      prefix = path.gsub(':', '::')
+
+      @stages[key] ||= self.class.workflow_class(key, prefix: prefix).new(
         key,
         _parent: self,
         config:  config

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.1.2'.freeze
+  VERSION = '3.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.4
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-05 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -243,7 +243,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.10
+        version: 0.10.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -253,47 +253,47 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.10
+        version: 0.10.11
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.16
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.16
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement