eco-helpers 3.2.5 → 3.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2878273b593e2556be3d41de808563fdb2bf4995c488a61274552f828d0c5b59
-  data.tar.gz: 1cb620f1532563deee7671b28d8999c9a0dd877c572c542b840febc81646fde8
+  metadata.gz: bfe97cd5583e8650f73c0f7cb2557fde896d3b59b7e729703fdb01f9323d6fbb
+  data.tar.gz: e40c8fdeae21780ca957c043aa7a637d06d9e85088fdbca6eb7c488448c74ab5
 SHA512:
-  metadata.gz: 715d86772a51b17cfc928ea241e818ead64efca009f34f5e9bdbcb56fde97a4e44157ce08a5836b29011c9bd6911b138ed374a0fd53f8316a48669cc48b56631
-  data.tar.gz: ca74f83124a7ea16cd883ea1e34f4350f5a0505e3439ef6cc4eb729e7329dc6cd9eabbe1311e8992eeb7dd571f485404c748ea751678759572ded8d0bb35ad68
+  metadata.gz: c1f28e77164e7f8c439b09dba5d952594c34721457842963cfb9e037c90658de8049545c1029e25e6aa2aadda2a729a4fc103fb04335adcfb6359b1fe946ad60
+  data.tar.gz: '090c4c12745401c0191aec263bb3970bd92e5244c6b57f4d5ef6dd157acab37ab868ed239972d133bd52a4eb11ddcac0e4857a8e760e10321b7236f50a7d3c76'

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.2.6] - 2025-09-xx
+## [3.2.8] - 2025-09-xx
 
 ### Added
 
@@ -10,6 +10,30 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.2.7] - 2025-09-09
+
+### Added
+
+- `NodeBase` (and subclasses): **added** missed case `#self_parented?`
+
+### Fixed
+
+- **Added** early detection of `self-parented` nodes (from the input file).
+
+## [3.2.6] - 2025-09-05
+
+### Added
+
+- **Improvement**: classifications conversion to ignore ending `s` (plurals).
+
+### Fixed
+
+- Node `id` and `parent_id` **upcase** in `NodePlain` (**case insensitive**)
+  - It was failing to pair children with their parent (on input files).
+- **remove** _classifications treatment_ on `Organization::TagTree` and `NodePlain`
+  - This was a working around due to not using `as_nodes_json` as a **common** converter between `live_tree` and `file_tree` (which was fixed in a previous release).
+  - `as_nodes_json` already does the call to `node_parser_block`, which does the conversion of the **classifications**
+
 ## [3.2.5] - 2025-09-04
 
 ### Changed

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

@@ -66,10 +66,11 @@ module Eco
           treat_classication(val)
         end
 
+        # Enhances the lookup
         def treat_classication(value)
           return value unless value.is_a?(String)
 
-          value.strip.gsub(/\W+/, '').downcase
+          value.strip.downcase.gsub(/s(?:\W|$)/, '').gsub(/\W+/, '-')
         end
 
         def init_caches

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

@@ -211,9 +211,9 @@ module Eco
           &block
         )
           max_depth ||= total_depth
-          return nil if max_depth < depth
-          return []  if top? && !include_children
-          return nil if archived? && !include_archived
+          return    if max_depth < depth
+          return [] if top? && !include_children
+          return    if archived? && !include_archived
 
           if include_children
             child_nodes   = nodes
@@ -441,14 +441,13 @@ module Eco
 
         def init_node
           return if source.is_a?(Array)
+
           @id                   = source.values_at('tag', 'id').compact.first&.upcase
           @name                 = source['name']
           @weight               = source['weight']
           @archived             = as_boolean(source['archived'])
           @archived_token       = source['archived_token']
-          @classifications      = into_a(source['classifications']).map do |value|
-            treat_classication(value)
-          end
+          @classifications      = into_a(source['classifications'])
           @classification_names = into_a(source['classification_names'])
           @raw_nodes            = source['nodes'] || []
         end
@@ -491,11 +490,6 @@ module Eco
           [tnodes, ddepth]
         end
 
-        def treat_classication(value)
-          return value unless value.is_a?(String)
-          value.strip.gsub(/\W+/, '').downcase
-        end
-
         # Helper to convert to array
         def into_a(value)
           if value.is_a?(String)
@@ -510,6 +504,7 @@ module Eco
           return true  if value == true
           return false if value.to_s.strip.empty?
           return true  if %w[yes x true].include?(value.downcase)
+
           false
         end
       end

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

@@ -5,39 +5,46 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
 
       private
 
+      def to_classification_ids(values)
+        values = [values].flatten unless values.is_a?(Array)
+
+        values = values.compact.map {|val| val.split('|')}.flatten
+        values.compact.map {|val| to_classification(val)}.compact.uniq
+      end
+
       # @note
       #   1. It returns `nil` unless there are classifications defined
       #   2. If the value is wrong, it warns and returns `nil`
       def to_classification(value)
-        return nil unless node_classifications?
+        return unless node_classifications?
 
-        raise ArgumentError, "Expecting a single element. Given: #{value.class}" if value.is_a?(Enumerator)
+        msg = "Expecting a single element. Given: #{value.class}"
+        raise ArgumentError, msg if value.is_a?(Enumerator)
 
-        return nil unless value.is_a?(String)
+        return unless value.is_a?(String)
 
         node_classifications.to_id(value).tap do |type|
-          unknown_clasification!(value) unless type
-        end
-      end
+          next if type
 
-      def to_classification_ids(values)
-        values = [values].flatten unless values.is_a?(Array)
-        values = values.compact.map {|val| val.split('|')}.flatten
-        values.compact.map {|val| to_classification(val)}.compact.uniq
+          unknown_classification!(value)
+        end
       end
 
       # @note
       #   1. It returns `nil` unless there are classifications defined
       #   2. If the value is wrong, it warns and returns `nil`
       def to_classification_name(value)
-        return nil unless node_classifications?
+        return unless node_classifications?
 
-        raise ArgumentError, "Expecting a single element. Given: #{value.class}" if value.is_a?(Enumerator)
+        msg = "Expecting a single element. Given: #{value.class}"
+        raise ArgumentError, msg if value.is_a?(Enumerator)
 
-        return nil unless value.is_a?(String)
+        return unless value.is_a?(String)
 
         node_classifications.to_name(value) do |name|
-          unknown_clasification!(value) unless name
+          next unless name
+
+          unknown_classification!(value)
         end
       end
 
@@ -49,10 +56,11 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
         @node_classifications ||= session.node_classifications
       end
 
-      def unknown_clasification!(value)
+      def unknown_classification!(value)
         return if unknown_classifications.include?(value)
 
         unknown_classifications << value
+
         log(:warn) {
           "Unknown location node classification '#{value}'"
         }

data/lib/eco/data/locations/node_base/builder.rb

@@ -11,15 +11,19 @@ module Eco::Data::Locations::NodeBase
       case data
       when ::CSV::Table
         return Eco::Data::Locations::NodePlain if Eco::Data::Locations::NodePlain.csv_matches_format?(csv)
-        return Eco::Data::Locations::NodeLevel if Eco::Data::Locations::NodeLevel.csv_matches_format?(csv)
+
+        Eco::Data::Locations::NodeLevel        if Eco::Data::Locations::NodeLevel.csv_matches_format?(csv)
       when Array
-        return nil unless sample = data.first
+        return unless (sample = data.first)
+
         node_class(sample)
       when Eco::Data::Locations::NodeBase
-        return nil unless data.class < Eco::Data::Locations::NodeBase
+        return unless data.class < Eco::Data::Locations::NodeBase
+
         data.class
       else
-        raise ArgumentError, "Expecting CSV::Table. Given: #{csv.class}" unless csv.is_a?(::CSV::Table)
+        msg ="Expecting CSV::Table. Given: #{csv.class}"
+        raise ArgumentError, msg unless csv.is_a?(::CSV::Table)
       end
     end
   end

data/lib/eco/data/locations/node_base/parsing.rb

@@ -6,10 +6,19 @@ module Eco::Data::Locations::NodeBase
     # @param csv [CSV::Table]
     # @return [Array<NodePlain>, Array<NodeLevel>] with integrity issues resolved.
     def nodes_from_csv(csv)
-      raise ArgumentError, "Expecting CSV::Table. Given: #{csv.class}" unless csv.is_a?(::CSV::Table)
-      return Eco::Data::Locations::NodePlain.nodes_from_csv(csv) if Eco::Data::Locations::NodePlain.csv_matches_format?(csv)
-      return Eco::Data::Locations::NodeLevel.nodes_from_csv(csv) if Eco::Data::Locations::NodeLevel.csv_matches_format?(csv)
-      raise ArgumentError, "The input csv does not have the required format to read a locations structure."
+      msg = "Expecting CSV::Table. Given: #{csv.class}"
+      raise ArgumentError, msg unless csv.is_a?(::CSV::Table)
+
+      if Eco::Data::Locations::NodePlain.csv_matches_format?(csv)
+        return Eco::Data::Locations::NodePlain.nodes_from_csv(csv)
+      end
+
+      if Eco::Data::Locations::NodeLevel.csv_matches_format?(csv)
+        return Eco::Data::Locations::NodeLevel.nodes_from_csv(csv)
+      end
+
+      msg = "The input csv does not have the required format to read a locations structure."
+      raise ArgumentError, msg
     end
 
     # @yield [node, json] optional custom serializer
@@ -18,7 +27,9 @@ module Eco::Data::Locations::NodeBase
     # @yieldreturn [Hash] the serialized Node
     # @return [Array<Hash>] a hierarchical tree of nested Hashes via `nodes` key.
     def hash_tree_from_csv(csv, &block)
-      raise ArgumentError, "Expecting CSV::Table. Given: #{csv.class}" unless csv.is_a?(::CSV::Table)
+      msg = "Expecting CSV::Table. Given: #{csv.class}"
+      raise ArgumentError, msg unless csv.is_a?(::CSV::Table)
+
       treeify(nodes_from_csv(csv), &block)
     end
 

data/lib/eco/data/locations/node_base/tag_validations.rb

@@ -2,7 +2,7 @@ module Eco::Data::Locations::NodeBase
   module TagValidations
     include Eco::Language::AuxiliarLogger
 
-    ALLOWED_CHARACTERS = "A-Za-z0-9 &_'\/.-".freeze
+    ALLOWED_CHARACTERS = "A-Za-z0-9 &_'/.-".freeze
     VALID_TAG_REGEX    = /^[#{ALLOWED_CHARACTERS}]+$/
     INVALID_TAG_REGEX  = /[^#{ALLOWED_CHARACTERS}]+/
     VALID_TAG_CHARS    = /[#{ALLOWED_CHARACTERS}]+/
@@ -11,9 +11,11 @@ module Eco::Data::Locations::NodeBase
     def clean_id(str, notify: true, ref: '')
       blanks_x2 = has_double_blanks?(str) # dubocop:disable Naming/VariableNumber
       partial   = replace_not_allowed(str)
+
       remove_double_blanks(partial).tap do |result|
         next unless notify
         next if invalid_warned?(str)
+
         if partial != str
           invalid_chars = identify_invalid_characters(str)
           log(:warn) {
@@ -24,6 +26,7 @@ module Eco::Data::Locations::NodeBase
             "* #{ref}Double blanks removed: '#{str}' :_converted_>> '#{result}'"
           }
         end
+
         invalid_warned!(str)
       end
     end
@@ -46,13 +49,15 @@ module Eco::Data::Locations::NodeBase
     end
 
     def remove_double_blanks(str)
-      return nil if str.nil?
+      return if str.nil?
+
       str.gsub(DOUBLE_BLANKS, ' ').strip
     end
 
     def replace_not_allowed(str)
-      return nil if str.nil?
+      return     if str.nil?
       return str if str.match(VALID_TAG_REGEX)
+
       str.gsub(INVALID_TAG_REGEX, ' ')
     end
 

data/lib/eco/data/locations/node_base/treeify.rb

@@ -28,10 +28,12 @@ module Eco::Data::Locations::NodeBase
     # @return [Array<Hash>] a hierarchical tree of nested Hashes via `nodes` key.
     def treeify(nodes, skipped: [], unlinked_trees: [], &block)
       return [] if nodes.empty?
+
       block  ||= nodes.first.class.serializer
       done_ids = {}
       warns    = []
       parents  = parents_hash(nodes)
+
       get_children(
         nil,                parents,
         done_ids: done_ids, skipped: skipped,
@@ -43,6 +45,7 @@ module Eco::Data::Locations::NodeBase
           skipped: skipped, unlinked_trees: unlinked_trees,
           warns:   warns,   &block
         )
+
         log(:warn) { warns.join("\n") } unless warns.empty?
       end
     end
@@ -52,8 +55,25 @@ module Eco::Data::Locations::NodeBase
     # @return [Hash] where `key`s are all the `parentId` of the nodes
     #   and `value` and `Array` of those nodes that have that `parentId`
     def parents_hash(nodes)
+      self_parented = []
+
       nodes.each_with_object({}) do |node, parents|
+        next self_parented.push(node) if node.self_parented?
+
         (parents[node.parentId] ||= []).push(node)
+      end.tap do
+        next if self_parented.empty?
+
+        log(:error) {
+          msg = "#{self_parented.count} nodes are self-parented: "
+          msg << self_parented.map(&:id).map do |node_id|
+            "'#{node_id}'"
+          end.join(', ')
+          msg << "\nPlease amend the data."
+          msg
+        }
+
+        exit 1
       end
     end
 
@@ -135,7 +155,6 @@ module Eco::Data::Locations::NodeBase
       # skipped keys is inherent, as they were excluded because of id clash with done_ids
       unlinked_parent_ids = (parents.keys - done_ids.keys).compact
 
-
       # The reason of missing nodes in the output tree is unknown!
       if skipped.empty? && unlinked_parent_ids.empty?
         msg  = []

data/lib/eco/data/locations/node_base.rb

@@ -14,6 +14,10 @@ module Eco::Data::Locations
 
     attr_accessor :tracked_level, :parent
 
+    def self_parented?
+      raise 'You should implement this method in child classes'
+    end
+
     def copy
       self.class.new.set_attrs(**to_h)
     end
@@ -23,7 +27,7 @@ module Eco::Data::Locations
     end
 
     def attr?(sym)
-      !attr(sym).to_s.strip.empty?
+      !attr(sym).to_s.strip.empty? # rubocop:disable Style/Attr
     end
 
     def set_attrs(**kargs)
@@ -57,6 +61,7 @@ module Eco::Data::Locations
 
     def slice(*attrs)
       return {} if attrs.empty?
+
       to_h(*attrs)
     end
   end

data/lib/eco/data/locations/node_level/parsing.rb

@@ -17,6 +17,7 @@ class Eco::Data::Locations::NodeLevel
     # @return [Boolean] whether or not it's worthy trying to parse with `NodeLevel`.
     def csv_matches_format?(csv)
       return false unless csv.is_a?(::CSV::Table)
+
       !Eco::Data::Locations::NodePlain.csv_matches_format?(csv)
     end
 
@@ -26,7 +27,8 @@ class Eco::Data::Locations::NodeLevel
     # @param `csv` [CSV::Table]
     # @return [Array<NodeLevel>]
     def nodes_from_csv(csv)
-      raise ArgumentError, "Expecting CSV::Table. Given: #{csv.class}" unless csv.is_a?(::CSV::Table)
+      msg = "Expecting CSV::Table. Given: #{csv.class}"
+      raise ArgumentError, msg unless csv.is_a?(::CSV::Table)
 
       possible_classifications = csv.headers
 
@@ -52,6 +54,7 @@ class Eco::Data::Locations::NodeLevel
 
         prev_node = node
       end
+
       tidy_nodes(nodes)
     end
   end

data/lib/eco/data/locations/node_level.rb

@@ -36,15 +36,23 @@ module Eco::Data::Locations
     end
 
     # In node level the parent id is set via parsing
-    attr_accessor :parentId # rubocop:disable Naming/MethodName
-    alias_method :parent_id=, :parentId=
-    alias_method :parent_id,  :parentId
+    attr_writer :parent_id
+    alias_method :parentId=, :parent_id= # rubocop:disable Naming/MethodName
+
+    def parent_id
+      @parent_id&.upcase
+    end
+    alias_method :parentId, :parent_id # rubocop:disable Naming/MethodName
 
     def id
       tag.upcase
     end
-    alias_method :nodeId,  :id
-    alias_method :node_id, :nodeId
+    alias_method :node_id, :id
+    alias_method :nodeId,  :id # rubocop:disable Naming/MethodName
+
+    def self_parented?
+      id == parent_id
+    end
 
     def name
       tag

data/lib/eco/data/locations/node_plain/parsing.rb

@@ -16,6 +16,7 @@ class Eco::Data::Locations::NodePlain
     # @return [Boolean] whether or not it's worthy trying to parse with `NodePlain`.
     def csv_matches_format?(csv)
       return false unless csv.is_a?(::CSV::Table)
+
       (basic_headers & csv.headers) == basic_headers
     end
 
@@ -23,7 +24,9 @@ class Eco::Data::Locations::NodePlain
     # @param `csv` [CSV::Table] with specific headers
     # @return [Array<NodePlain>]
     def nodes_from_csv(csv)
-      raise ArgumentError, "Expecting CSV::Table. Given: #{csv.class}" unless csv.is_a?(::CSV::Table)
+      msg = "Expecting CSV::Table. Given: #{csv.class}"
+      raise ArgumentError, msg unless csv.is_a?(::CSV::Table)
+
       # Convert to Eco::CSV::Table for a fresh start
       csv     = Eco::CSV.parse(csv.to_csv).nil_blank_cells.add_index_column(:row_num)
       headers = node_class::ALL_ATTRS.map(&:to_s)

data/lib/eco/data/locations/node_plain.rb

@@ -22,19 +22,30 @@ module Eco::Data::Locations
     PROP_ATTRS         = (ALL_ATTRS - ADDITIONAL_ATTRS).freeze
 
     def id
-      clean_id(super, ref: "(Row: #{row_num}) ")
+      clean_id(
+        super,
+        ref: "(Row: #{row_num}) "
+      )&.upcase
     end
     # backwards compatibility
     alias_method :tag, :id
 
-    def name
-      super || id
+    def parent_id
+      clean_id(
+        super,
+        notify: false,
+        ref:    "(Row: #{row_num} - parent_id) "
+      )&.upcase
     end
+    alias_method :parentId, :parent_id # rubocop:disable Naming/MethodName
 
-    def parent_id
-      clean_id(super, notify: false, ref: "(Row: #{row_num} - parent_id) ")
+    def self_parented?
+      id == parent_id
+    end
+
+    def name
+      super || id
     end
-    alias_method :parentId, :parent_id
 
     def archived
       value = super
@@ -42,13 +53,12 @@ module Eco::Data::Locations
       return true  if value == true
       return false if value.to_s.strip.empty?
       return true  if %w[yes x true].include?(value.downcase)
+
       false
     end
 
     def classifications
-      into_a(super).map do |value|
-        treat_classication(value)
-      end
+      into_a(super)
     end
 
     def classification_names
@@ -68,11 +78,6 @@ module Eco::Data::Locations
 
     private
 
-    def treat_classication(value)
-      return value unless value.is_a?(String)
-      value.strip.gsub(/\W+/, '').downcase
-    end
-
     # Helper to convert to array
     def into_a(value)
       if value.is_a?(String)

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.2.5'.freeze
+  VERSION = '3.2.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.7
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-04 00:00:00.000000000 Z
+date: 2025-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug