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 = 
[
  'id', 'name', 'weight', 'parent_id',
  'archived', 'archived_token'
].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) 


37
38
39
40
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
 
# File 'lib/eco/api/organization/tag_tree.rb', line 37

def initialize(tagtree = [], name: nil, id: nil, depth: -1, path: [], parent: nil, _weight: nil)
  @depth  = depth
  @parent = parent

  case tagtree
  when String
    @source = JSON.parse(tagtree)
  else
    @source = tagtree
  end
  raise ArgumentError, "You are trying to initialize a TagTree with a null tagtree" if !@source

  if @source.is_a?(Array)
    @id        = id
    @name      = name
    @raw_nodes = @source
  else
    @id        = @source.values_at('tag', 'id').compact.first&.upcase
    @name      = @source['name']
    @archived  = @source['archived'] || false
    @archived_token   = @source['archived_token']
    @source['weight'] = @weight = @source['weight'] || _weight
    @raw_nodes = @source['nodes'] || []
  end

  @path  = path || []
  @path.push(@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.



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

def archived
  @archived
end

#archived_token ⇒ Object

Returns the value of attribute archived_token.



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

def archived_token
  @archived_token
end

#children_count ⇒ Integer (readonly)

Returns:

  • (Integer) 


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

def children_count
  @children_count
end

#depth ⇒ Object (readonly)

Returns the value of attribute depth.



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

def depth
  @depth
end

#id ⇒ Object Also known as: tag

Returns the value of attribute id.



14
15
16
 
# File 'lib/eco/api/organization/tag_tree.rb', line 14

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



16
17
18
 
# File 'lib/eco/api/organization/tag_tree.rb', line 16

def name
  @name
end

#nodes ⇒ Object (readonly)

Returns the value of attribute nodes.



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

def nodes
  @nodes
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



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

def parent
  @parent
end

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

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>) 


326
327
328
 
# File 'lib/eco/api/organization/tag_tree.rb', line 326

def path
  @path
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



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

def source
  @source
end

#weight ⇒ Object

Returns the value of attribute weight.



16
17
18
 
# File 'lib/eco/api/organization/tag_tree.rb', line 16

def weight
  @weight
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


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

def active?
  !archived?
end

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

Returns with non archived nodes only.

Returns:



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

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:



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/eco/api/organization/tag_tree.rb', line 145

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.



160
161
162
163
164
165
166
167
 
# File 'lib/eco/api/organization/tag_tree.rb', line 160

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

#archived? ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/eco/api/organization/tag_tree.rb', line 72

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]})



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/eco/api/organization/tag_tree.rb', line 190

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
  else
    values    = [id, name, weight, parent_id, archived, archived_token]
    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
end

#as_nodes_json(&block) ⇒ Array[Hash]

Returns a plain list form of hash nodes.

Returns:

  • (Array[Hash]) —

    where Hash is a plain node



220
221
222
 
# File 'lib/eco/api/organization/tag_tree.rb', line 220

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

#count ⇒ Integer

Returns the number of locations.

Returns:

  • (Integer) —

    the number of locations



230
231
232
 
# File 'lib/eco/api/organization/tag_tree.rb', line 230

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.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/eco/api/organization/tag_tree.rb', line 374

def default_tag(*values)
  values = filter_tags(values)
  nodes = []; ddepth = -1
  values.each do |tag|
    raise("Couldn't find the node of #{tag} in the tag-tree definition") unless cnode = node(tag)

    if cnode.depth > ddepth
      nodes = [cnode]
      ddepth = cnode.depth
    elsif cnode.depth == ddepth
      nodes.push(cnode)
    end
  end

  default_tag = nil
  if nodes.length > 1
    common      = nodes.reduce(self.tags.reverse) {|com, cnode| com & cnode.path.reverse}
    default_tag = common.first if common.length > 0 && ddepth > 0
  end
  default_tag ||= nodes.first&.tag  if (ddepth > 0) || flat?
  default_tag
end

#diff(tagtree, differences: {}, level: 0, **options) ⇒ Array

Returns with the differences.

Returns:

  • (Array) —

    with the differences



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

def diff(tagtree, differences: {}, level: 0, **options)
  require 'hashdiff'
  Hashdiff.diff(self.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:



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

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:



116
117
118
119
 
# File 'lib/eco/api/organization/tag_tree.rb', line 116

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.



225
226
227
 
# File 'lib/eco/api/organization/tag_tree.rb', line 225

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>) 


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

def filter_tags(list)
  return [] unless list && 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.



247
248
249
 
# File 'lib/eco/api/organization/tag_tree.rb', line 247

def flat?
  self.total_depth <= 0
end

#has_children? ⇒ Boolean

Returns it has subnodes.

Returns:

  • (Boolean) —

    it has subnodes



294
295
296
 
# File 'lib/eco/api/organization/tag_tree.rb', line 294

def has_children?
  children_count > 0
end

#leafs ⇒ Array<String>

Returns all the tags with no children

Returns:

  • (Array<String>) 


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

def leafs
  tags.select do |tag|
    !node(tag).has_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) 


95
96
97
98
99
100
 
# File 'lib/eco/api/organization/tag_tree.rb', line 95

def merge(other)
  raise ArgumentError, "Expecting Eco::API::Organization::TagTree. Given: #{other.class}" unless other.is_a?(Eco::API::Organization::TagTree)
  mid   = [self.id, other.id].join('|')
  mname = [self.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.



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

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)



170
171
172
 
# File 'lib/eco/api/organization/tag_tree.rb', line 170

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)



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

def parent_name
  parent.name unless parent.top?
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



138
139
140
 
# File 'lib/eco/api/organization/tag_tree.rb', line 138

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) 


123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/eco/api/organization/tag_tree.rb', line 123

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) 


276
277
278
 
# File 'lib/eco/api/organization/tag_tree.rb', line 276

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>) 


269
270
271
 
# File 'lib/eco/api/organization/tag_tree.rb', line 269

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) 


301
302
303
 
# File 'lib/eco/api/organization/tag_tree.rb', line 301

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>) 


257
258
259
260
261
262
263
264
265
 
# File 'lib/eco/api/organization/tag_tree.rb', line 257

def tags(depth: nil)
  if !depth || depth < 0
    @hash_tags.keys
  else
    @hash_tags.select do |t, n|
      n.depth == depth
    end.keys
  end
end

#top? ⇒ Boolean

Returns:

  • (Boolean) 


179
180
181
 
# File 'lib/eco/api/organization/tag_tree.rb', line 179

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.



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/eco/api/organization/tag_tree.rb', line 235

def total_depth
  @total_depth ||= if has_children?
      deepest_node = nodes.max_by do |nd|
        nd.total_depth
      end
      deepest_node.total_depth
    else
      depth
    end
end

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

Returns with nodes up to max_depth.

Returns:



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

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.



354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/eco/api/organization/tag_tree.rb', line 354

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    = final + custom     if preserve_custom
  new_tags = final - initial
  # keep same order as they where
  (initial & final) + new_tags
end