eco-helpers 2.0.9 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a468069bd29d7dc25347e6da7d4d9faebc52043eba8b4ea1e91f6d383a8690
-  data.tar.gz: dee338f8e23d4608f0d359bd44712377d15723c70730e823c11766f179f4877e
+  metadata.gz: b8ca1a088cf60b7608e9f92da680a631c73228ae92fed33484b5669c480350fb
+  data.tar.gz: 6733d55fbdcf24c2766529c275f86f3132f1c3232b4c8d31f34880f9253dbc82
 SHA512:
-  metadata.gz: 36c25c8a37c8fe894c57309e07126251e658846881698d4eec1660bf2a1a6cdc2e09f6b3f94c28434e47e7ea1f70cbf69196d2965d0a45609492867b2b356478
-  data.tar.gz: 98bdbf74599ab4a3ab98ac6c76d068bbcf7871774e3f7315f992dbcb9cc31066ac7d2293b8cbee1bc3019bf94e1b9f78c7fdf02b8751cafb403451be12c8c159
+  metadata.gz: d1cdc2aacd52c590230fe606b079d91e6f3dea01ddbd8857d48170467bbfd089ffa7081c8630aac93ebae4c6e3b8125a446cd7ddc8a6b290c174e906661b2474
+  data.tar.gz: 356ccf7e50d3f0e12f9ad1dde6f1fe7ad4fd13205334f9319cecd45736f110684eb404113512aca4b1d2c49070fe61eb48b1e69c3ae13f423ae8895288ea0d2d

data/CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.9] - 2021-03-xx
+## [2.0.10] - 2021-03-xx
+
+### Added
+  - `Eco::API::Common::People::PersonParser`
+    - `#defined_attrs`: list of all attribute defined parsers (regardless they belong to the model)
+  - `Eco::API::Organization::TagTree` methods
+    - `#total_depth` to know the total depth of a tree
+    - `#flat?` to know if the tagtree has only 1 level
+
+### Changed
+  - `Eco::API::Common::People::PersonParser`
+    - Renamed `#all_attrs` to `#all_model_attrs`
+    - Ranamed `#defined_attrs` to `#defined_model_attrs`
+    - Ranamed `#undefined_attrs` to `#undefined_model_attrs`
+
+### Fixed
+
+## [2.0.9] - 2021-03-19
 
 ### Added
 ### Changed

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

@@ -256,7 +256,7 @@ module Eco
           # @param mapped_entry [Hash] that with **internal** names but **external** values and types.
           # @return [Hash] with **external** names, values and types.
           def _external_serializing(mapped_entry)
-            target_attrs    = @emap.all_attrs | @emap.aliased_attrs
+            target_attrs    = @emap.all_model_attrs | @emap.aliased_attrs
             rest_keys       = mapped_entry.keys - target_attrs
             target_attrs   -= ["send_invites"]
             external_entry  = target_attrs.each_with_object({}) do |attr, hash|

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

@@ -6,14 +6,14 @@ module Eco
         # @attr_reader core_attrs [Array<String>] core attributes that are present in the person entry.
         # @attr_reader details_attrs [Array<String>] schema details attributes that are present in the person entry.
         # @attr_reader account_attrs [Array<String>] account attributes that are present in the person entry.
-        # @attr_reader all_attrs [Array<String>] all the attrs that are present in the person entry.
+        # @attr_reader all_model_attrs [Array<String>] all the attrs that are present in the person entry.
         # @attr_reader internal_attrs [Array<String>] all the internally named attributes that the person entry has.
         # @attr_reader aliased_attrs [Array<String>] only those internal attributes present in the person entry that have an internal/external name mapping.
         # @attr_reader direct_attrs [Array<String>] only those internal attributes present in the person entry that do **not** have an internal/external name mapping.
         class PersonEntryAttributeMapper
           @@cached_warnings = {}
 
-          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_attrs
+          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_model_attrs
           attr_reader :internal_attrs, :aliased_attrs, :direct_attrs
 
           # Helper class tied to `PersonEntry` that allows to track which attributes of a person entry are present
@@ -41,14 +41,14 @@ module Eco
               init_attr_trackers
             else  # SERIALIZING
               @person          = data
-              @internal_attrs  = @person_parser.all_attrs
+              @internal_attrs  = @person_parser.all_model_attrs
               @aliased_attrs   = @attr_map.list(:internal)
             end
 
             @core_attrs    = @person_parser.target_attrs_core(@internal_attrs)
             @details_attrs = @person_parser.target_attrs_details(@internal_attrs)
             @account_attrs = @person_parser.target_attrs_account(@internal_attrs)
-            @all_attrs     = @core_attrs | @account_attrs | @details_attrs
+            @all_model_attrs = @core_attrs | @account_attrs | @details_attrs
           end
 
           # To know if currently the object is in parse or serialize mode.
@@ -98,7 +98,7 @@ module Eco
               end
             end
 
-            return nil unless @person_parser.all_attrs.include?(attr)
+            return nil unless @person_parser.all_model_attrs.include?(attr)
           end
 
           # Serializing helper also used to do a reverse mapping when parsing:
@@ -146,9 +146,9 @@ module Eco
           # when parsing:
           def init_attr_trackers
             # (def) all internal attributes we can expect
-            def_all_attrs     = @person_parser.all_attrs
+            def_all_attrs     = @person_parser.all_model_attrs
             # (def) internal attrs with no aliasing nor parser definition (expected to be direct)
-            def_unlinked      = @person_parser.undefined_attrs.select { |attr| !to_external(attr) }
+            def_unlinked      = @person_parser.undefined_model_attrs.select { |attr| !to_external(attr) }
             # (def) those with parser or alias:
             def_linked        = def_all_attrs - def_unlinked
 
@@ -168,7 +168,7 @@ module Eco
             # (data) virtual internal attrs (the internal names of those virtual attrs)
             data_vi_int_aliased = data_vi_ext_alias.map do |attr|
               # to_internal(attr) can't be used here, becauase virtual fields would get filtered out,
-              # as they are not recognized by @parser.all_attrs.include?(attr)
+              # as they are not recognized by @parser.all_model_attrs.include?(attr)
               @attr_map.to_internal(attr)
             end.compact
 

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

@@ -7,7 +7,7 @@ module Eco
         #
         # @attr_reader schema [Ecoportal::API::V1::PersonSchema, nil] schema of person details that this parser will be based upon.
         # @attr_reader details_attrs [Array<String>] internal names of schema details attributes.
-        # @attr_reader all_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
+        # @attr_reader all_model_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
         class PersonParser
           extend  Eco::API::Common::ClassAutoLoader
           autoloads_children_of     "Eco::API::Common::Loaders::Parser"
@@ -19,8 +19,7 @@ module Eco
           FORMAT        = [:csv, :xml, :json]
 
           attr_reader :schema
-          attr_reader :details_attrs, :all_attrs
-          attr_reader :defined_attrs
+          attr_reader :details_attrs, :all_model_attrs
           attr_reader :patch_version
 
           # @example Example of usage:
@@ -46,7 +45,7 @@ module Eco
               @details_attrs  = @schema&.fields.map { |fld| fld.alt_id }
             end
 
-            @all_attrs = CORE_ATTRS + ACCOUNT_ATTRS + @details_attrs
+            @all_model_attrs = CORE_ATTRS + ACCOUNT_ATTRS + @details_attrs
             self.class.autoload_children(self)
           end
 
@@ -60,6 +59,11 @@ module Eco
 
           # @!group Scopping attributes (identifying, presence & active)
 
+          # All the internal name attributes, including _core_, _account_ and _details_.
+          def all_attrs(include_defined_parsers: false)
+            all_model_attrs | defined_model_attrs
+          end
+
           # Scopes `source_attrs` using the _**core** attributes_.
           # @note use this helper to know which among your attributes are **core** ones.
           # @param source_attrs [Array<String>]
@@ -93,14 +97,21 @@ module Eco
             @parsers.keys
           end
 
+          # Returns a list of all the internal attributes that have a parser defined.
+          # @note These attributes do not necessarily belong to the model. They could be virtual attributes
+          # @return [Array<String>] list of all attribute defined parsers.
+          def defined_attrs
+            defined_list - symbol_keys
+          end
+
           # Returns a list of all the internal attributes of the model that have a parser defined.
           # @note
           #  - it excludes any parser that is not in the model, such as type parsers (i.e. `:boolean`, `:multiple`)
           #  - the list is sorted according `CORE_ATTRS` + `ACCOUNT_ATTRS` + schema attrs
-          # @return [Array<String>] list of all attribute defined parsers.
-          def defined_attrs
+          # @return [Array<String>] list of all attribute defined parsers in the model.
+          def defined_model_attrs
             defined     = @parsers.keys
-            defined     = (all_attrs | defined) & defined
+            defined     = (all_model_attrs | defined) & defined
             defined - symbol_keys
           end
 
@@ -118,7 +129,7 @@ module Eco
           # @param process [Symbol] either `:parse` or `:serialize`, depending if we want to parse or serialize the `attr`.
           # @return [Array<String>] list of all attribute defined parsers that should be active for the given `source_data`.
           def active_attrs(source_data, phase = :any, process: :parse)
-            defined_attrs.select do |attr|
+            defined_model_attrs.select do |attr|
               if process == :serialize
                 @parsers[attr].serializer_active?(phase)
               else
@@ -130,8 +141,8 @@ module Eco
           # Returns a list of all the internal attributes of the model that do **not** have a parser defined.
           # @note it excludes any parser that is **not** in the model, such as type parsers (i.e. :boolean, :multiple)
           # @return [Array<String>] list of all attributes without a defined parser.
-          def undefined_attrs
-            all_attrs - defined_attrs
+          def undefined_model_attrs
+            all_model_attrs - defined_model_attrs
           end
 
           # @param attr [String] internal name of an attribute.
@@ -238,7 +249,7 @@ module Eco
           end
 
           def valid_attr?(attr)
-            attr.is_a?(String) && (!@schema || @all_attrs.include?(attr))
+            attr.is_a?(String) && (!@schema || @all_model_attrs.include?(attr))
           end
 
           def valid_type?(attr)

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

@@ -4,7 +4,7 @@ module Eco
 
       # Provides helpers to deal with tagtrees.
       class TagTree
-        attr_reader :tag, :nodes
+        attr_reader :tag, :nodes, :children_count
         attr_reader :depth, :path
         attr_reader :enviro
 
@@ -37,6 +37,7 @@ module Eco
 
           nodes = @source.is_a?(Array) ? @source : @source.dig('nodes') || []
           @nodes = nodes.map {|cnode| TagTree.new(cnode, depth: @depth + 1, path: @path.dup, enviro: @enviro)}
+          @children_count = @nodes.count
 
           init_hashes
         end
@@ -46,6 +47,21 @@ module Eco
           @has_tags.empty?
         end
 
+        # @return [Integer] the highest `depth` of all the children.
+        def total_depth
+          @total_depth ||= if children_count > 0
+              deepest_node = nodes.max_by {|node| node.total_depth}
+              deepest_node.depth
+            else
+              depth
+            end
+        end
+
+        # @return [Integer] if there's only top level.
+        def flat?
+          self.total_depth <= 0
+        end
+
         # Gets all the tags of the current node tree.
         # @note
         #   - this will include the upper level tag(s) as well
@@ -147,7 +163,8 @@ module Eco
         # * take the deepest tag (the one that is further down in the tree)
         # * if there are different options (several nodes at the same depth):
         #    * take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)
-        #    * if there's no common node between them, take the `first` (unless they are at top level of the tree)
+        #    * if there's no common node between them, take the `first`, unless they are at top level of the tree
+        #    * to the above, take the `first` also on top level, but only if there's 1 level for the entire tree
         # @param [Array<String>] values list of tags.
         # @return [String] default tag.
         def default_tag(*values)
@@ -169,7 +186,7 @@ module Eco
             common      = nodes.reduce(self.tags.reverse) {|com, cnode| com & cnode.path.reverse}
             default_tag = common.first if common.length > 0 && depth > 0
           end
-          default_tag = nodes.first&.tag if !default_tag && depth > 0
+          default_tag = nodes.first&.tag  if !default_tag && ( (depth > 0) || flat?)
           default_tag
         end
 

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.9"
+  VERSION = "2.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.0.10
 platform: ruby
 authors:
 - Oscar Segura