eco-helpers 2.5.4 → 2.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444bec4cd18402a38eff718340932ca7d72c9959b865805964b0ec9787d94636
-  data.tar.gz: 97291544f70b525781d81f168ffc86c1d960151e53535a540ac1b7824b9eaf28
+  metadata.gz: d241b7bc57bd81e9b3a6b1d71ecab5f7530b7b6df176301adc21584722f2b247
+  data.tar.gz: a8beafa1e6cd1e3425291121c55b78fe144f155021ab149148fcc6ce35569984
 SHA512:
-  metadata.gz: 02360de987395d801aa1b1fb659dd4b6011c317a21058be33c3283b3a2856c69db519baf6eb85a022f7a2c7c4e826861b108c2cf09aefad3ca57b32d53b45c72
-  data.tar.gz: 402c880d701446c072f6534d4df35b2a104704dc79480e37e5033101df63a8b10baa25257911af1cc84994efe05744b15c608798dbc1637ad268811ca2d7d926
+  metadata.gz: 2bad589998061077bac0f6adb500fdbb9402b77578da68bf43a84f83101a2bf862213acb00707a363f5583c47ec94a876c367360c562043865e573232b272c4c
+  data.tar.gz: 7c33f358f5cbb7ab0b3118d7b0b20e86a9f686f2e1f49216e23bea5ab504ca4bb0bbb2eeab8bb37daf0d11b997af0160212ff7ab2d1fe382fa05a6b354529f48

data/CHANGELOG.md

@@ -1,12 +1,26 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.5.5] - 2023-07-xx
+## [2.5.6] - 2023-08-xx
 
 ### Added
 ### Changed
 ### Fixed
 
+## [2.5.5] - 2023-08-03
+
+### Added
+  - `Eco::API::Organization::TagTree` - **added/improved methods**
+    - `#as_json` new parameter `max_depth:` to be able to cut the tree
+    - `#active_tree` new method to exclude archived nodes.
+    - `#truncate` new method to obtain a tree cut to `max_depth:`
+  - `Eco::API::Session::Config::Tagtree`: **exposed** `include_archived:` (a.k.a. `inludeArchivedNodes`).
+    - This change states that `session.tagtree` does not retrieve archived nodes by default, while `session.live_tree` does retrieve archived nodes.
+    - This change required an update on the `ecoportal-api-graphql` **gem**
+
+### Fixed
+  - `Eco::API::Organization::TagTree#path` - dups the result (rather than exposing the internal path array)
+
 ## [2.5.4] - 2023-07-27
 
 ### Added

data/eco-helpers.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'ecoportal-api', '>= 0.9.4', '< 0.10'
   spec.add_dependency 'ecoportal-api-v2', '>= 1.1.3', '< 1.2'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.8', '< 0.4'
+  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.9', '< 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',  '< 3'

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

@@ -523,7 +523,6 @@ module Eco
             call_order = parsing? ? [ext, mad, int, fin] : [fin, int, mad, ext]
             call_order.each {|proc| proc.call}
           end
-
         end
       end
     end

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

@@ -76,9 +76,23 @@ module Eco
           @archived
         end
 
+        def active?
+          !archived?
+        end
+
         # @return [Eco::API::Organization::TagTree]
         def dup
-          self.class.new(as_json)
+          self.class.new(as_json, name: name, id: id)
+        end
+
+        # @return [Eco::API::Organization::TagTree] with **non** `archived` nodes only
+        def active_tree
+          self.class.new(as_json(include_archived: false), name: name, id: id)
+        end
+
+        # @return [Eco::API::Organization::TagTree] with nodes up to `max_depth`
+        def truncate(max_depth: total_depth)
+          self.class.new(as_json(max_depth: max_depth), name: name, id: id)
         end
 
         # Iterate through all the nodes of this tree
@@ -161,11 +175,26 @@ module Eco
         # Returns a tree of Hashes form nested via `nodes` (or just a list of hash nodes)
         # @yield [node_json, node] block for custom output json model
         # @yiledreturn [Hash] the custom json model.
-        # @include_children [Boolean] whether it should return a tree hash or just a list of hash nodes.
+        # @param include_children [Boolean] whether it should return a tree hash or just a list of hash nodes.
+        # @param include_archived [Boolean] whether it should include archived nodes.
+        # @param max_depth [Boolean] up to what level `depth` nodes should be included.
         # @return [Array[Hash]] where `Hash` is a `node` (i.e. `{"tag" => TAG, "nodes": Array[Hash]}`)
-        def as_json(include_children: true, &block)
-          return [] if top? && !include_children
-          children_json = nodes.map {|nd| nd.as_json(include_children: true, &block)} if include_children
+        def as_json(include_children: true, include_archived: true, max_depth: total_depth, &block)
+          max_depth ||= total_depth
+          return nil if max_depth < depth
+          return []  if top? && !include_children
+          return nil if archived? && !include_archived
+
+          if include_children
+            child_nodes   = nodes
+            child_nodes   = child_nodes.select(&:active?) unless include_archived
+            kargs         = {
+              include_children: include_children,
+              include_archived: include_archived,
+              max_depth:        max_depth
+            }
+            children_json = child_nodes.map {|nd| nd.as_json(**kargs, &block)}.compact
+          end
 
           if top?
             children_json
@@ -287,8 +316,8 @@ module Eco
         # @param key [String] tag to find the path to.
         # @return [Array<String>]
         def path(key = nil)
-          return @path if !key
-          @hash_paths[key.upcase]
+          return @path.dup if !key
+          @hash_paths[key.upcase].dup
         end
 
         # Helper to assign tags to a person account.

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

@@ -3,18 +3,30 @@ module Eco
     class Session
       class Config
         class TagTree < BaseConfig
+          class MissingTagtree < StandardError
+          end
+
           attr_key :file
 
-          def scope_tree(enviro: nil)
+          # @param include_archived [Boolean] whether or not it should include archived nodes.
+          # @return [Eco::API::Organization::TagTree]
+          def scope_tree(enviro: nil, include_archived: true, raise_on_missing: true)
             return @tagtree if instance_variable_defined?(:@tagtree) && @tagtree.enviro == enviro
             if tree_file = self.file
               if (tree = file_manager.load_json(tree_file)) && !tree.empty?
                 @tagtree  = Eco::API::Organization::TagTree.new(tree, enviro: enviro)
               end
             end
-            @tagtree ||= live_tree(enviro: enviro).tap do |tree|
+
+            kargs = {
+              enviro:               enviro,
+              includeArchivedNodes: include_archived
+            }
+
+            @tagtree ||= live_tree(**kargs).tap do |tree|
               unless tree && !tree.empty?
-                raise "Could not find a locations structure."
+                msg = "Could not find a local or live locations structure."
+                raise MissingTagtree, msg
               end
             end
           end
@@ -23,13 +35,18 @@ module Eco
           # If `id` is provided, it only retrieves this locations structure.
           def live_tree(id: nil, enviro: nil, include_archived: false, **kargs, &block)
             return @live_tree if instance_variable_defined?(:@live_tree) && @live_tree.enviro == enviro
+
+            kargs = {
+              enviro:               enviro,
+              includeArchivedNodes: include_archived
+            }.merge(kargs)
+
             if id
-              args       = {id: id, enviro: enviro, include_archived: include_archived}.merge(kargs)
+              args       = { id: id }.merge(kargs)
               @live_tree = live_tree_get(**args, &block)
             else
-              # note that `include_archived` nodes is NOT the same as including archived structures
-              # => In `live_tree` the paramter refers to nodes
-              trees      = live_trees(enviro: enviro, &block)
+              kargs
+              trees      = live_trees(**kargs, &block)
               @live_tree = trees.reject do |tree|
                 tree.empty?
               end.max do |a,b|
@@ -45,26 +62,33 @@ module Eco
 
           # Gets a single locations structure
           # @note it does not memoize
+          # @param include_archived [Boolean] whether or not to include archived **nodes**
+          # @return [Eco::API::Organization::TagTree, NilClass]
           def live_tree_get(id: nil, enviro: nil, include_archived: false, **kargs, &block)
             return nil unless apis.active_api.version_available?(:graphql)
             return nil unless graphql = apis.api(version: :graphql)
-            #kargs = { includeArchived: include_archived }.merge(kargs).slice(:includeArchived)
-            # For now, this endpoint only accepts `id` as a parameter. It is pending to
-            # expose further parameters via query
-            return nil unless tree = graphql.currentOrganization.locationStructure(id: id, &block)
+
+            kargs = {
+              id:                   id,
+              includeArchivedNodes: include_archived
+            }.merge(kargs)
+
+            return nil unless tree = graphql.currentOrganization.locationStructure(**kargs, &block)
             args = { enviro: enviro, id: tree.id, name: tree.name }
             Eco::API::Organization::TagTree.new(tree.treeify, **args)
           end
 
           # Retrieves all the location structures of the organisation
+          # @param include_archived [Boolean] whether or not to include archived **nodes**
+          # @return [Array<Eco::API::Organization::TagTree>]
           def live_trees(enviro: nil, include_archived: false, **kargs, &block)
             [].tap do |eco_trees|
               next unless apis.active_api.version_available?(:graphql)
               next unless graphql = apis.api(version: :graphql)
+
               kargs = {
-                includeArchived:    include_archived,
-                includeUnpublished: false
-              }.merge(kargs).slice(:includeArchived, :includeUnpublished)
+                includeArchivedNodes: include_archived
+              }.merge(kargs)
 
               next unless trees = graphql.currentOrganization.locationStructures(**kargs, &block)
               trees.each do |tree|

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

@@ -235,9 +235,15 @@ module Eco
         end
 
         # It uses the `tagtree.json` file and in its absence, if `graphql` enabled, the largest `life_tagtree`
+        # @note it does NOT include archived nodes by default.
+        #   - This is for legacy (most usecases don't)
+        # @param include_archived [Boolean] whether or not it should include archived nodes.
         # @return [Eco::API::Organization::TagTree]
-        def tagtree(enviro: nil)
-          @tagtree ||= tagtree_config.scope_tree(enviro: enviro)
+        def tagtree(enviro: nil, include_archived: false, raise_on_missing: true)
+          kargs = {
+            enviro: enviro, include_archived: include_archived, raise_on_missing: raise_on_missing
+          }
+          @tagtree ||= tagtree_config.scope_tree(**kargs)
         end
 
         # It obtains the first of the live tagtree in the org

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

@@ -12,9 +12,9 @@ class Eco::API::UseCases::DefaultCases::ReinviteTransCase < Eco::API::Common::Lo
     invite   = session.new_job("main", "invite", :update, usecase, :account)
     users.each do |person|
       if force_invite?
-        person.account.send_invites = true
-      else
         person.account.force_send_invites = true
+      else
+        person.account.send_invites = true
       end
       invite.add(person)
     end

data/lib/eco/api/usecases/graphql/helpers/location/base.rb

@@ -68,7 +68,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       msg << "nor options(:source, :structure_id). "
       msg << "Infering active locations structure."
       log(:warn) { msg }
-      if self.current_tree = session.live_tree
+      if self.current_tree = session_live_tree
         @target_structure_id = current_tree.id
       end
     end
@@ -81,7 +81,13 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       tree_init = current_tree
       target_id = target_structure_id
       return current_tree if current_tree != tree_init
-      self.current_tree = session.live_tree(id: target_id, include_archived: true)
+      self.current_tree = session_live_tree(id: target_id)
+    end
+
+    # Unique access point to retrieve the live tree
+    # @note ensures archived nodes are retrieved.
+    def session_live_tree(id: nil)
+      session.live_tree(id: id, include_archived: true)
     end
   end
 end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.5.4"
+  VERSION = "2.5.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.5.5
 platform: ruby
 authors:
 - Oscar Segura
@@ -156,7 +156,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.3.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.4'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.3.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.4'