Class: Eco::API::Session::Config::TagTree

Inherits:
BaseConfig show all
Defined in:
lib/eco/api/session/config/tagtree.rb

Defined Under Namespace

Classes: MissingTagtree

Instance Attribute Summary

Attributes inherited from BaseConfig

#config

Instance Method Summary collapse

Methods inherited from BaseConfig

#apis, attr_key, #clone, #file_manager, #initialize

Methods inherited from Hash

#deep_merge, #deep_merge!

Constructor Details

This class inherits a constructor from Eco::API::Session::Config::BaseConfig

Instance Method Details

#live_tree(id: nil, enviro: nil, include_archived: false, **kargs, &block) ⇒ Object

Among all the locations structures it selects the one with more location nodes If id is provided, it only retrieves this locations structure.

Parameters:

  • used (enviro) —

    for re-caching



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/eco/api/session/config/tagtree.rb', line 52

def live_tree(id: nil, enviro: nil, include_archived: false, **kargs, &block) # rubocop:disable Metrics/AbcSize
  existing_cache   = !@live_tree.nil?
  first_load       = !existing_cache

  target_change    = existing_cache && id     && @live_tree.id != id
  enviro_change    = existing_cache && enviro && @live_tree.enviro != enviro

  switching_target = existing_cache && (target_change || enviro_change)
  _refresh_cache   = existing_cache && !switching_target

  kargs = {
    includeArchivedNodes: include_archived
  }.merge(kargs)

  if id
    args       = { id: id }.merge(kargs)
    @live_tree = live_tree_get(**args, &block)
  else
    trees      = live_trees(**kargs, &block)
    if trees.count > 1
      @live_tree = trees.reject(&:empty?).max do |a, b|
        a.count <=> b.count
      end
    else
      @live_tree = trees.first
    end
  end.tap do |tree|
    if tree
      msg = "LIVE LOCATIONS Structure (#{tree.id}): '#{tree.name}' (#{tree.count} nodes)"
      if first_load
        session_logger.info("Using #{msg}")
      elsif switching_target
        session_logger.info("Switched to #{msg}")
      else # refresh_cache
        session_logger.debug("Reloading #{msg}")
      end
    else
      session_logger.info "Could not retrive live tree (#{id})"
    end
  end
end

#live_tree_get(id: nil, include_archived: false, **kargs, &block) ⇒ Eco::API::Organization::TagTree, NilClass

Note:

it does not memoize

Gets a single locations structure

Parameters:

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

    whether or not to include archived nodes

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/eco/api/session/config/tagtree.rb', line 98

def live_tree_get(id: nil, include_archived: false, **kargs, &block)
  return nil unless (graphql = graphql_api)

  kargs = {
    id:                   id,
    includeArchivedNodes: include_archived
  }.merge(kargs)

  start = Time.now
  tree  = graphql.currentOrganization.locationStructure(**kargs, &block)
  return nil unless tree

  end_time = Time.now
  secs     = (end_time - start).round(3)

  Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name).tap do |eco_tree|
    cnt     = eco_tree.count
    per_sec = (cnt.to_f / secs).round(2)
    session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
  end
end

#live_trees(include_archived: false, **kargs, &block) ⇒ Array<Eco::API::Organization::TagTree>

Retrieves all the location structures of the organisation

Parameters:

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

    whether or not to include archived nodes

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/eco/api/session/config/tagtree.rb', line 123

def live_trees(include_archived: false, **kargs, &block)
  [].tap do |eco_trees|
    next unless (graphql = graphql_api)

    kargs = {
      includeArchivedNodes: include_archived
    }.merge(kargs)

    start = Time.now
    trees = graphql.currentOrganization.locationStructures(**kargs, &block)
    next unless trees

    end_time = Time.now
    secs     = (end_time - start).round(3)
    cnt      = 0
    trees.each do |tree|
      eco_tree = Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name)
      cnt += eco_tree.count
      eco_trees.push(eco_tree)
    end
    per_sec = (cnt.to_f / secs).round(2)
    session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
  end
end

#node_classifications(active: true) ⇒ Eco::API::Organization::NodeClassifications

The location node classifications of the organization

Returns:



13
14
15
16
17
18
 
# File 'lib/eco/api/session/config/tagtree.rb', line 13

def node_classifications(active: true)
  return [] unless (graphql = graphql_api)

  node_types = graphql.locationStructure.nodeClassifications(active: active)
  Eco::API::Organization::NodeClassifications.new(node_types)
end

#scope_tree(enviro: nil, include_archived: true, raise_on_missing: true) ⇒ Eco::API::Organization::TagTree

Note:

it retrieves the tree this way:

  1. If there's a file tagtree.json file, it uses it
  2. If no file, retrieves structure_id (config)

Parameters:

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

    whether or not it should include archived nodes.

Returns:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/eco/api/session/config/tagtree.rb', line 25

def scope_tree(enviro: nil, include_archived: true, raise_on_missing: true) # rubocop:disable Lint/UnusedMethodArgument
  return @tagtree if instance_variable_defined?(:@tagtree) && @tagtree.enviro == enviro

  kargs = {
    enviro:               enviro,
    includeArchivedNodes: include_archived
  }

  if (tree_file = file)
    if (tree = file_manager.load_json(tree_file)) && !tree.empty?
      @tagtree = Eco::API::Organization::TagTree.new(tree)
    end
  elsif structure_id
    kargs.merge(id: structure_id)
  end

  @tagtree ||= live_tree(**kargs).tap do |tr| # rubocop:disable Naming/MemoizedInstanceVariableName
    next if tr && !tr.empty?

    msg = "Could not find a local or live locations structure."
    raise MissingTagtree, msg
  end
end