Class: Eco::API::Organization::TagTree

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/eco/api/organization/tag_tree.rb

Overview

Note:

that currenlty the parsing assumes top level to be array. This does not allow to capture the name and id of the locations structure itself into the json storing model.

Provides helpers to deal with tagtrees.

Constant Summary collapse

HEADER = 
%w[
  id name weight parent_id
  archived archived_token
  classifications classification_names
  level
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tagtree = [], name: nil, id: nil, depth: -1,, path: [], parent: nil, _weight: nil) ⇒ TagTree

Returns a new instance of TagTree.

Examples:

Node format:

{"tag": "NODE NAME", "nodes": subtree}

Tree/subtree format:

[[Node], ...]

Input format example:

tree = [{"tag" => "AUSTRALIA", "nodes" => [
    {"tag" => "SYDNEY", "nodes" => []}
]}]
tree = TagTree.new(tree.to_json)

Parameters:

  • tagtree (String) (defaults to: []) —

    representation of the tagtree in json.

Raises:

  • (ArgumentError) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/eco/api/organization/tag_tree.rb', line 41

def initialize(
  tagtree = [],
  name:    nil,
  id:      nil,
  depth:   -1,
  path:    [],
  parent:  nil,
  _weight: nil # rubocop:disable Lint/UnderscorePrefixedVariableName
)
  @source = parse_source_input(tagtree)

  msg = "You are trying to initialize a TagTree with a null tagtree"
  raise ArgumentError, msg unless source

  @parent = parent
  @depth  = depth
  @path   = path || []

  if source.is_a?(Array)
    @id        = id
    @name      = name
    @raw_nodes = source
  else
    source['weight'] ||= _weight
    init_node
  end

  self.path.push(self.id) unless top?

  @nodes = @raw_nodes.map.with_index do |cnode, idx|
    self.class.new(cnode, depth: depth + 1, path: @path.dup, parent: self, _weight: idx)
  end

  init_hashes
end

Instance Attribute Details

#archived ⇒ Object

Returns the value of attribute archived.



24
25
26
 
# File 'lib/eco/api/organization/tag_tree.rb', line 24

def archived
  @archived
end

#archived_token ⇒ Object

Returns the value of attribute archived_token.



24
25
26
 
# File 'lib/eco/api/organization/tag_tree.rb', line 24

def archived_token
  @archived_token
end

#classification_names ⇒ Object

Returns the value of attribute classification_names.



25
26
27
 
# File 'lib/eco/api/organization/tag_tree.rb', line 25

def classification_names
  @classification_names
end

#classifications ⇒ Object

Returns the value of attribute classifications.



25
26
27
 
# File 'lib/eco/api/organization/tag_tree.rb', line 25

def classifications
  @classifications
end

#depth ⇒ Object (readonly)

Returns the value of attribute depth.



29
30
31
 
# File 'lib/eco/api/organization/tag_tree.rb', line 29

def depth
  @depth
end

#id ⇒ Object Also known as: tag

Returns the value of attribute id.



20
21
22
 
# File 'lib/eco/api/organization/tag_tree.rb', line 20

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/eco/api/organization/tag_tree.rb', line 23

def name
  @name
end

#nodes ⇒ Object (readonly)

Returns the value of attribute nodes.



28
29
30
 
# File 'lib/eco/api/organization/tag_tree.rb', line 28

def nodes
  @nodes
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



27
28
29
 
# File 'lib/eco/api/organization/tag_tree.rb', line 27

def parent
  @parent
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



18
19
20
 
# File 'lib/eco/api/organization/tag_tree.rb', line 18

def source
  @source
end

#weight ⇒ Object

Returns the value of attribute weight.



23
24
25
 
# File 'lib/eco/api/organization/tag_tree.rb', line 23

def weight
  @weight
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/eco/api/organization/tag_tree.rb', line 81

def active?
  !archived?
end

#active_tree ⇒ Eco::API::Organization::TagTree

Returns with non archived nodes only.

Returns:



109
110
111
 
# File 'lib/eco/api/organization/tag_tree.rb', line 109

def active_tree
  self.class.new(as_json(include_archived: false), name: name, id: id)
end

#all_nodes(&block) ⇒ Array<TagTree>

Note:

order is that of the parent to child relationships

All actual nodes of this tree

Returns:



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/eco/api/organization/tag_tree.rb', line 151

def all_nodes(&block)
  [].tap do |out_nodes|
    unless top?
      out_nodes.push(self)
      yield(self) if block_given?
    end
    nodes.each do |nd|
      out_nodes.concat(nd.all_nodes(&block))
    end
  end
end

#ancestors ⇒ Array<TagTree>

Note:

it does not include the current node

All the acenstor nodes of the current node

Returns:

  • (Array<TagTree>) —

    ancestors sorted from top to bottom.



166
167
168
169
170
171
172
173
 
# File 'lib/eco/api/organization/tag_tree.rb', line 166

def ancestors
  [].tap do |ans|
    unless parent.top?
      ans << parent
      ans.concat(parent.ancestors)
    end
  end
end

#archived? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/eco/api/organization/tag_tree.rb', line 77

def archived?
  @archived
end

#as_json(include_children: true, include_archived: true, max_depth: total_depth) {|node_json, node| ... } ⇒ Array[Hash]

Returns a tree of Hashes form nested via nodes (or just a list of hash nodes)

Parameters:

  • include_children (Boolean) (defaults to: true) —

    whether it should return a tree hash or just a list of hash nodes.

  • include_archived (Boolean) (defaults to: true) —

    whether it should include archived nodes.

  • max_depth (Boolean) (defaults to: total_depth) —

    up to what level depth nodes should be included.

Yields:

  • (node_json, node) —

    block for custom output json model

Returns:

  • (Array[Hash]) —

    where Hash is a node (i.e. {"tag" => TAG, "nodes": Array[Hash]})



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/eco/api/organization/tag_tree.rb', line 196

def as_json( # rubocop:disable Metrics/AbcSize
  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

    return children_json if top?
  end

  values = [
    id,       name,
    weight,   parent_id,
    archived, archived_token,
    classifications.dup,
    classification_names.dup,
    depth + 1
  ]
  node_json = self.class::HEADER.zip(values).to_h
  node_json["nodes"] = children_json if include_children
  node_json = yield(node_json, self) if block_given?
  node_json
end

#as_nodes_json(&block) ⇒ Array[Hash]

Returns a plain list form of hash nodes.

Returns:

  • (Array[Hash]) —

    where Hash is a plain node



235
236
237
 
# File 'lib/eco/api/organization/tag_tree.rb', line 235

def as_nodes_json(&block)
  all_nodes.map {|nd| nd.as_json(include_children: false, &block)}
end

#children? ⇒ Boolean

Returns it has subnodes.

Returns:

  • (Boolean) —

    it has subnodes



308
309
310
 
# File 'lib/eco/api/organization/tag_tree.rb', line 308

def children?
  children_count&.positive?
end

#children_count ⇒ Integer

Returns:

  • (Integer) 


303
304
305
 
# File 'lib/eco/api/organization/tag_tree.rb', line 303

def children_count
  nodes.count
end

#count ⇒ Integer

Returns the number of locations.

Returns:

  • (Integer) —

    the number of locations



245
246
247
 
# File 'lib/eco/api/organization/tag_tree.rb', line 245

def count
  @hash_tags.keys.count
end

#default_tag(*values) ⇒ String

Helper to decide which among the tags will be the default.

  • 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
    • to the above, take the first also on top level, but only if there's 1 level for the entire tree

Parameters:

  • values (Array<String>) —

    list of tags.

Returns:

  • (String) —

    default tag.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/eco/api/organization/tag_tree.rb', line 396

def default_tag(*values)
  default_tag    = nil
  values         = filter_tags(values)
  tnodes, ddepth = get_deepest_nodes_among_tags(*values)

  unless tnodes.empty?
    common = tnodes.reduce(tags.reverse) do |com, cnode|
      com & cnode.path.reverse
    end
    default_tag = common.first if common.any? && ddepth&.positive?
  end

  default_tag ||= tnodes.first&.tag if ddepth&.positive? || flat?
  default_tag
end

#diff(tagtree, _differences: {}, _level: 0, **options) ⇒ Array

Returns with the differences.

Returns:

  • (Array) —

    with the differences



92
93
94
95
 
# File 'lib/eco/api/organization/tag_tree.rb', line 92

def diff(tagtree, _differences: {}, _level: 0, **options)
  require 'hashdiff'
  Hashdiff.diff(as_json, tagtree.as_json, **options.slice(:array_path, :similarity, :use_lcs))
end

#dup ⇒ Eco::API::Organization::TagTree

Note:

that archived nodes will also be passed over to the copy

Returns:



87
88
89
 
# File 'lib/eco/api/organization/tag_tree.rb', line 87

def dup
  self.class.new(as_json, name: name, id: id)
end

#each {|node| ... } ⇒ Enumerable<Eco::API::Organization::TagTree>

Iterate through all the nodes of this tree

Yields:

  • (node) —

    do some stuff with one of the nodes of the tree

Yield Parameters:

Returns:



122
123
124
125
 
# File 'lib/eco/api/organization/tag_tree.rb', line 122

def each(&block)
  return to_enum(:each) unless block
  all_nodes.each(&block)
end

#empty? ⇒ Boolean

Returns true if there are tags in the node, false otherwise.

Returns:

  • (Boolean) —

    true if there are tags in the node, false otherwise.



240
241
242
 
# File 'lib/eco/api/organization/tag_tree.rb', line 240

def empty?
  count <= 1
end

#filter_tags(list) ⇒ Array<String>

Filters tags out that do not belong to the tree

Parameters:

  • list (Array<String>) —

    source tags.

Returns:

  • (Array<String>) 


330
331
332
333
 
# File 'lib/eco/api/organization/tag_tree.rb', line 330

def filter_tags(list)
  return [] unless list.is_a?(Array)
  list.select {|str| tag?(str)}
end

#flat? ⇒ Integer

Returns if there's only top level.

Returns:

  • (Integer) —

    if there's only top level.



260
261
262
 
# File 'lib/eco/api/organization/tag_tree.rb', line 260

def flat?
  total_depth <= 0
end

#leafs ⇒ Array<String>

Returns all the tags with no children

Returns:

  • (Array<String>) 


296
297
298
299
300
 
# File 'lib/eco/api/organization/tag_tree.rb', line 296

def leafs
  tags.reject do |tag|
    node(tag).children?
  end
end

#merge(other) ⇒ Eco::API::Organization::TagTree

Note:

it merges the first level nodes (and their children) as it comes

It generates a merged tagtree out of two sources

Returns:

Raises:

  • (ArgumentError) 


100
101
102
103
104
105
106
 
# File 'lib/eco/api/organization/tag_tree.rb', line 100

def merge(other)
  msg = "Expecting Eco::API::Organization::TagTree. Given: #{other.class}"
  raise ArgumentError, msg unless other.is_a?(Eco::API::Organization::TagTree)
  mid   = [id, other.id].join('|')
  mname = [name, other.name].join('|')
  self.class.new(as_json | other.as_json, id: mid, name: mname)
end

#node(key) ⇒ TagTree?

Finds a subtree node.

Parameters:

  • key (String) —

    parent node of subtree.

Returns:

  • (TagTree, nil) —

    if the tag key is a node, returns that node.



322
323
324
325
 
# File 'lib/eco/api/organization/tag_tree.rb', line 322

def node(key)
  return nil unless tag?(key)
  @hash_tags[key.upcase]
end

#parent_id ⇒ String

Returns the id of the parent (unless we are on a top level node).

Returns:

  • (String) —

    the id of the parent (unless we are on a top level node)



176
177
178
 
# File 'lib/eco/api/organization/tag_tree.rb', line 176

def parent_id
  parent.id unless parent.top?
end

#parent_name ⇒ String

Returns the name of the parent (unless we are on a top level node).

Returns:

  • (String) —

    the name of the parent (unless we are on a top level node)



181
182
183
 
# File 'lib/eco/api/organization/tag_tree.rb', line 181

def parent_name
  parent.name unless parent.top?
end

#path(key = nil) ⇒ Array<String>

Note:

the path is not relative to the subtree, but absolute to the entire tree.

Finds the path from a node key to its root node in the tree. If key is not specified, returns the path from current node to root.

Parameters:

  • key (String) (defaults to: nil) —

    tag to find the path to.

Returns:

  • (Array<String>) 


340
341
342
343
 
# File 'lib/eco/api/organization/tag_tree.rb', line 340

def path(key = nil)
  return @path.dup unless key
  @hash_paths[key.upcase].dup
end

#reject(&block) ⇒ Array<TagTree>

Note:

rejected nodes will not include their children nodes

Returns plain list of nodes.

Returns:

  • (Array<TagTree>) —

    plain list of nodes



144
145
146
 
# File 'lib/eco/api/organization/tag_tree.rb', line 144

def reject(&block)
  select(when_is: false, &block)
end

#select(when_is: true, &block) ⇒ Array<TagTree>

Note:

rejected nodes will not include their children nodes

Returns plain list of nodes.

Returns:

  • (Array<TagTree>) —

    plain list of nodes

Raises:

  • (ArgumentError) 


129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/eco/api/organization/tag_tree.rb', line 129

def select(when_is: true, &block)
  raise ArgumentError, "Missing block" unless block_given?
  [].tap do |out_nodes|
    selected = false
    selected = (yield(self) == when_is) unless top?
    out_nodes.push(self)                if selected
    next                                unless selected || top?
    nodes.each do |nd|
      out_nodes.concat(nd.select(when_is: when_is, &block))
    end
  end
end

#subtag?(key) ⇒ Boolean

Verifies if a tag exists in the subtree(s).

Parameters:

  • key (String) —

    tag to verify.

Returns:

  • (Boolean) 


290
291
292
 
# File 'lib/eco/api/organization/tag_tree.rb', line 290

def subtag?(key)
  subtags.include?(key&.upcase)
end

#subtags ⇒ Array<String>

Gets all but the upper level tags of the current node tree.

Returns:

  • (Array<String>) 


283
284
285
 
# File 'lib/eco/api/organization/tag_tree.rb', line 283

def subtags
  tags - tags(depth: depth)
end

#tag?(key) ⇒ Boolean

Verifies if a tag exists in the tree.

Parameters:

  • key (String) —

    tag to verify.

Returns:

  • (Boolean) 


315
316
317
 
# File 'lib/eco/api/organization/tag_tree.rb', line 315

def tag?(key)
  @hash_tags.key?(key&.upcase)
end

#tags(depth: nil) ⇒ Array<String>

Note:
  • this will include the upper level tag(s) as well
  • to get all but the upper level tag(s) use subtags method instead

Gets all the tags of the current node tree.

Parameters:

  • depth (Integer) (defaults to: nil) —

    if empty, returns the list of tag nodes of that level. Otherwise the list of tag nodes of the entire subtree.

Returns:

  • (Array<String>) 


271
272
273
274
275
276
277
278
279
 
# File 'lib/eco/api/organization/tag_tree.rb', line 271

def tags(depth: nil)
  if !depth || depth&.negative?
    @hash_tags.keys
  else
    @hash_tags.select do |_t, n|
      n.depth == depth
    end.keys
  end
end

#top? ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/eco/api/organization/tag_tree.rb', line 185

def top?
  depth == -1
end

#total_depth ⇒ Integer

Returns the highest depth of all the children.

Returns:

  • (Integer) —

    the highest depth of all the children.



250
251
252
253
254
255
256
257
 
# File 'lib/eco/api/organization/tag_tree.rb', line 250

def total_depth
  @total_depth ||=
    if children?
      nodes.max_by(&:total_depth)&.total_depth
    else
      depth
    end
end

#truncate(max_depth: total_depth) ⇒ Eco::API::Organization::TagTree

Returns with nodes up to max_depth.

Returns:



114
115
116
 
# File 'lib/eco/api/organization/tag_tree.rb', line 114

def truncate(max_depth: total_depth)
  self.class.new(as_json(max_depth: max_depth), name: name, id: id)
end

#user_tags(initial: [], final: [], preserve_custom: true, add_custom: false) ⇒ Array<String>

Helper to assign tags to a person account.

  • It preserves the :initial order, in case the :final tags are the same

Examples:

Usage example:

tree = [{"tag" => "Australia", "nodes" => [
     {"tag" => "SYDNEY", "nodes" => []},
     {"tag" => "MELBOURNE", "nodes" => []}
]}]

tree = TagTree.new(tree.to_json)
original = ["SYDNEY", "RISK"]
final    = ["MELBOURNE", "EVENT"]

tree.user_tags(initial: original, final: final)
# out: ["MELBOURNE", "RISK"]
tree.user_tags(initial: original, final: final, preserve_custom: false)
# out: ["MELBOURNE"]
tree.user_tags(initial: original, final: final, add_custom: true)
# out: ["MELBOURNE", "RISK", "EVENT"]
tree.user_tags(initial: original, final: final, preserve_custom: false, add_custom: true)
# out: ["MELBOURNE", "EVENT"]

Parameters:

  • initial (Array<String>) (defaults to: []) —

    original tags a person has in their account.

  • final (Array<String>) (defaults to: []) —

    target tags the person should have in their account afterwards.

  • preserve_custom (Boolean) (defaults to: true) —

    indicates if original tags that are not in the tree should be added/preserved.

  • add_custom (Boolean) (defaults to: false) —

    indicates if target tags that are not in the tree should be really added.

Returns:

  • (Array<String>) —

    with the treated final tags.



375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/eco/api/organization/tag_tree.rb', line 375

def user_tags(initial: [], final: [], preserve_custom: true, add_custom: false)
  initial = [initial].flatten.compact
  final   = [final].flatten.compact
  raise "Expected Array for initial: and final:" unless initial.is_a?(Array) && final.is_a?(Array)

  final     = filter_tags(final) unless add_custom
  custom    = initial - filter_tags(initial)
  final    |= custom if preserve_custom
  new_tags  = final - initial
  # keep same order as they where
  (initial & final) + new_tags
end