eco-helpers 2.4.7 → 2.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ab1e50c5ccc57fd84bd6b21b40a9d455455e3457c89248f7bf60177fe82293a
-  data.tar.gz: 169a31ded9574a5fd8a135a0cfe3f388fe71c48e87f7f67969e12036ba40ab3f
+  metadata.gz: 5f4b841b95f31b7f25c9b5fd33c949bedbc46f2850c0c68b863818f3c75105b1
+  data.tar.gz: 4ec1d5c2859303fa6943974d19d07c7a4391f4d76fe2a01682510a26e9f92016
 SHA512:
-  metadata.gz: 7de4657000ee0181e9c7dcea3536365c5a66fc26d5b25999715129ce4ebed459ba67042de42736b96879b617aba2adc063f92403f0ff063cac13fd5301562191
-  data.tar.gz: e9518629a51f623b07d795eedad394682b53bc23edf1389cb2185f34519ccaed8cf2c746eba8c8ae0c4e12b41068b7444f2f6f263e3a30cd5ab91aa45be09185
+  metadata.gz: 84a0e4e6191ec10cf37088afce2fff53f9450b4d14f5d8c6206b152d4a0b4758127e5b8df0e3807c99c7dc99263de434fa92787baa778de9322ef56704ea9acd
+  data.tar.gz: 26b7d8b4e627c8638dd2b392063a25f4f7a633ea13ee3fe6f71bfccff81a3160cee957abc905d1f07e9f6c9e029a507e85b2f256120729fe5096fb2ea83c5018

data/CHANGELOG.md

@@ -1,12 +1,37 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.4.8] - 2023-04-xx
+## [2.4.10] - 2023-04-xx
 
 ### Added
 ### Changed
 ### Fixed
 
+## [2.4.9] - 2023-04-17
+
+### Added
+  - `Eco::API::UseCases#source_object` to retrieve the original use case definition object
+    - This allows the `Eco::API::UseCases::UseCase` object to access the object that defined the usecase and initialize `@session`.
+    - It now can know what `type` of use case created the `@callback`
+    - Next steps with this may be play a bit with the `aritity` of the `@callback` block, allow parsers to skip the serializer definition (so the default one runs), etc.
+  - `Eco::API::Common::Loaders::Base` the above feature allowed to initialize the `@options`, and therefore...
+    - `#options` method **added** (based on `@options` instance var)
+
+### Changed
+  - `Eco::API::Common::Loaders::Base`
+    - `#session` method is based on `@session` instance var, which allows to override without having to redefine `session` (`attr_reader :session` is no longer necessary)
+  - Softened max version of **gem** dependencies
+  - Upgraded self-managed **gem** dependencies
+
+### Fixed
+  - `Eco::API::Common::ClassAutoLoader::autoload_children`
+    - Skip `singleton_classes`
+
+## [2.4.8] - 2023-04-03
+
+### Added
+  - `Eco::API::Organization::TagTree#ancestors` returns the ancestor nodes.
+
 ## [2.4.7] - 2023-04-03
 
 ### Added

data/eco-helpers.gemspec

@@ -24,24 +24,24 @@ Gem::Specification.new do |spec|
   #spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.4.8",  "< 2.5"
-  spec.add_development_dependency "rspec",     ">= 3.10.0", "< 3.11"
-  spec.add_development_dependency "rake",      ">= 13.0.3", "< 13.1"
-  spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
-  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
+  spec.add_development_dependency "bundler",   ">= 2.4.8",  "< 3"
+  spec.add_development_dependency "rspec",     ">= 3.10.0", "< 4"
+  spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
+  spec.add_development_dependency "yard",      ">= 0.9.26", "< 1"
+  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 4"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.9.3', '< 0.10'
-  spec.add_dependency 'ecoportal-api-v2', '>= 1.1.1', '< 1.2'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.5', '< 0.4'
+  spec.add_dependency 'ecoportal-api', '>= 0.9.4', '< 0.10'
+  spec.add_dependency 'ecoportal-api-v2', '>= 1.1.2', '< 1.2'
+  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.6', '< 0.4'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
-  spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'
-  spec.add_dependency 'net-sftp',      '>= 3.0.0', '< 3.1'
-  spec.add_dependency 'hashdiff',      '>= 1.0.1', '< 1.1'
-  spec.add_dependency 'fuzzy_match',   '>= 2.1.0', '< 2.2'
-  spec.add_dependency 'amatch',        '>= 0.4.0', '< 0.5'
-  spec.add_dependency 'jaro_winkler',  '>= 1.5.4', '< 1.6'
-  spec.add_dependency 'roo',           '>= 2.8.3', '< 2.9'
-  spec.add_dependency 'roo-xls',       '>= 1.2.0', '< 1.3'
-  spec.add_dependency 'docx',          '>= 0.6.2', '< 0.7'
+  spec.add_dependency 'dotenv',        '>= 2.7.6',  '< 3'
+  spec.add_dependency 'net-sftp',      '>= 3.0.0',  '< 4'
+  spec.add_dependency 'hashdiff',      '>= 1.0.1',  '< 1.1'
+  spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'
+  spec.add_dependency 'amatch',        '>= 0.4.0',  '< 0.5'
+  spec.add_dependency 'jaro_winkler',  '>= 1.5.4',  '< 1.6'
+  spec.add_dependency 'roo',           '>= 2.8.3',  '< 2.9'
+  spec.add_dependency 'roo-xls',       '>= 1.2.0',  '< 1.3'
+  spec.add_dependency 'docx',          '>= 0.6.2',  '< 0.7'
 end

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

@@ -80,8 +80,14 @@ module Eco
           return false if pending_children.empty?
           @loading_children = true
           pending_children.each do |klass|
-            @child = klass.new(object)
-            autoloaded_children.push(klass)
+            begin
+              @child = klass.new(object)
+            rescue TypeError => e
+              # Can't create from this class (must be the singleton class)
+              # Just ignore
+            ensure
+              autoloaded_children.push(klass)
+            end
           end
           @loading_children = false
           true
@@ -102,7 +108,6 @@ module Eco
         def new_classes
           ObjectSpace.each_object(::Class).to_a - known_classes
         end
-
       end
     end
   end

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

@@ -36,7 +36,11 @@ module Eco
           private
 
           def session
-            ASSETS.session
+            @session ||= ASSETS.session
+          end
+
+          def options
+            @options ||= {}
           end
 
           def config

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

@@ -11,7 +11,7 @@ module Eco
           # @return [RequiredAttrs]
           def required_attrs
             @required_attrs ||= @dependencies[:required_attrs]
-            #@required_attrs ||= RequiredAttrs.new(attr, :unkown, [attr])
+            #@required_attrs ||= RequiredAttrs.new(attr, :unknown, [attr])
           end
 
           # @see Eco::Language::Models::ParserSerializer#def_parser

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

@@ -174,7 +174,7 @@ module Eco
 
           # Helper to define and associate a parser/serializer to a type or attribute.
           # @raise [Exception] if trying to define a parser/serializer for:
-          #   - an unkown attribute (`String`)
+          #   - an unknown attribute (`String`)
           #   - an unrecognized type or format (`Symbol`)
           # @param attr [String] type (`Symbol`) or attribute (`String`) to define the parser/serializer to.
           # @param dependencies [Hash] dependencies to be used when calling the parser/serializer.

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

@@ -57,8 +57,8 @@ module Eco
             return log(:fatal, *args, &block)
           end
 
-          def unkown(msg, &block)
-            return log(:unkown, *args, &block)
+          def unknown(msg, &block)
+            return log(:unknown, *args, &block)
           end
 
           def << (msg)

data/lib/eco/api/error.rb

@@ -4,7 +4,7 @@ module Eco
     class Error < StandardError
       class UnknownErrorClass < StandardError
         def initialize(msg = nil, klass:)
-          msg ||= "Unkown api error class #{klass}"
+          msg ||= "Unknown api error class #{klass}"
           super(msg)
         end
       end
@@ -60,19 +60,19 @@ module Eco
         @str_err = "Invalid ObjectId."
         @match   = /'(.*?)' is an invalid ObjectId./
       end
-      class UnkownField < Eco::API::Error
+      class UnknownField < Eco::API::Error
         @str_err = "Unknown field."
         @match   = /(.+?) is an unknown field/
 
-        class UnkownCoreField < UnkownField
+        class UnknownCoreField < UnknownField
           @str_err = "Unknown core field."
           @match   = /(.+?) is an unknown field/
         end
-        class UnkownAccountField < UnkownField
+        class UnknownAccountField < UnknownField
           @str_err = "Unknown account field."
           @match   = /account \> (.+?) is an unknown field/
         end
-        class UnkownDetailsField < UnkownField
+        class UnknownDetailsField < UnknownField
           @str_err = "Unknown details field."
           @match   = /details \> (.+?) is an unknown field/
         end

data/lib/eco/api/organization/tag_tree.rb

@@ -84,7 +84,7 @@ module Eco
 
         # All actual nodes of this tree
         # @note order is that of the parent to child relationships
-        # @return [Array[]]
+        # @return [Array<TagTree>]
         def all_nodes(&block)
           [].tap do |out_nodes|
             unless top?
@@ -97,6 +97,18 @@ module Eco
           end
         end
 
+        # All the acenstor nodes of the current node
+        # @note it does not include the current node
+        # @return [Array<TagTree>] ancestors sorted from top to bottom.
+        def ancestors
+          [].tap do |ans|
+            unless parent.top?
+              ans << parent
+              ans.concat(parent.ancestors)
+            end
+          end
+        end
+
         # @return [Array] with the differences
         def diff(tagtree, differences: {}, level: 0, **options)
           require 'hashdiff'
@@ -114,8 +126,11 @@ module Eco
             nodes_json
           else
             {
-              "id"    => tag,
-              "nodes" => nodes_json
+              "id"        => tag,
+              "archived"  => archived,
+              "archived_token" => archived_token,
+              "weight"    => weight,
+              "nodes"     => nodes_json
             }
           end
         end

data/lib/eco/api/usecases/use_case.rb

@@ -17,6 +17,11 @@ module Eco
           @times_launched = 0
         end
 
+        def source_object
+          return nil unless callback_from_loader?
+          callback_self
+        end
+
         def chainer
           # TODO: root is a Eco::API::UseCases that will not point to this new case.
           # => Moreover, the name and type will be the same as self
@@ -42,6 +47,7 @@ module Eco
           UseCaseIO.new(**kargs).tap do |uio|
             @options   = uio.options
             uio.session.logger.debug("#{self.class}: going to process '#{name}'")
+            set_session_n_options(session: uio.session, options: uio.options) if callback_from_loader?
             uio.output = @callback.call(*uio.params)
             @times_launched += 1
           end
@@ -53,8 +59,28 @@ module Eco
           @callback
         end
 
-      end
+        def callback_self
+          eval("self", @callback.binding)
+        end
 
+        def callback_from_loader?
+          callback_self.is_a?(Eco::API::Common::Loaders::Base)
+        end
+
+        # Set the instance variables `@session` and `@options`
+        # in the use case definition
+        # @note this only works when the use case was defined
+        #   via an children class of `Eco::API::Common::Loaders::Base`
+        def set_session_n_options(session:, options: @options)
+          return false unless callback_from_loader?
+          callback_self.instance_eval do
+            # `self` is the use case itself (when used the Loader)
+            @session = session
+            @options = options
+          end
+          true
+        end        
+      end
     end
   end
 end

data/lib/eco/api/usecases.rb

@@ -2,9 +2,9 @@ module Eco
   module API
     class UseCases
 
-      class UnkownCase < StandardError
+      class UnknownCase < StandardError
         def initialize(msg = nil, case_name: nil, type: nil)
-          msg ||= "Unkown case"
+          msg ||= "Unknown case"
           msg += ". Case name '#{case_name}'" if case_name
           msg += ". Case type '#{type}'" if type
           super(msg)
@@ -112,9 +112,9 @@ module Eco
         if type && target_case = to_h[key(name, type)]
           return target_case
         elsif type
-          raise UseCases::UnkownCase.new(case_name: name, type: type)
+          raise UseCases::UnknownCase.new(case_name: name, type: type)
         end
-        raise UseCases::UnkownCase.new(case_name: name, type: type) unless cases = by_name[name]
+        raise UseCases::UnknownCase.new(case_name: name, type: type) unless cases = by_name[name]
         raise UseCases::AmbiguousCaseReference.new(case_name: name) if cases.length > 1
         cases.first
       end

data/lib/eco/cli/scripting/arguments.rb

@@ -46,7 +46,7 @@ module Eco
           end
         end
 
-        def any_unkown?(exclude: [])
+        def any_unknown?(exclude: [])
           unknown(exclude: exclude).length > 0
         end
 

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.4.7"
+  VERSION = "2.4.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.4.7
+  version: 2.4.9
 platform: ruby
 authors:
 - Oscar Segura
@@ -19,7 +19,7 @@ dependencies:
         version: 2.4.8
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 2.4.8
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 3.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 3.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: 13.0.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13.1'
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: 13.0.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13.1'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
         version: 0.9.26
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: 0.9.26
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: 3.5.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,14 +109,14 @@ dependencies:
         version: 3.5.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: ecoportal-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.9.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.9.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.2'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.2'
@@ -156,7 +156,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 0.3.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.4'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 0.3.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.4'
@@ -219,7 +219,7 @@ dependencies:
         version: 2.7.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -229,7 +229,7 @@ dependencies:
         version: 2.7.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +239,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -249,7 +249,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: hashdiff
   requirement: !ruby/object:Gem::Requirement