Module: Sequel::Plugins::Tree::InstanceMethods

Defined in:
lib/sequel/plugins/tree.rb

Instance Method Summary collapse

Instance Method Details

#ancestorsObject

Returns list of ancestors, starting from parent until root.

subchild1.ancestors # => [child1, root]

87
88
89
90
91
92
93
94
# File 'lib/sequel/plugins/tree.rb', line 87

def ancestors
  node, nodes = self, []
  meth = model.parent_association_name
  while par = node.send(meth)
    nodes << node = par
  end
  nodes
end

#descendantsObject

Returns list of descendants

node.descendants # => [child1, child2, subchild1_1, subchild1_2, subchild2_1, subchild2_2]

99
100
101
102
103
# File 'lib/sequel/plugins/tree.rb', line 99

def descendants
  nodes = send(model.children_association_name).dup
  send(model.children_association_name).each{|child| nodes.concat(child.descendants)}
  nodes 
end

#rootObject

Returns the root node of the tree that this node descends from. This node is returned if it is a root node itself.


107
108
109
# File 'lib/sequel/plugins/tree.rb', line 107

def root
  ancestors.last || self
end

#root?Boolean

Returns true if this is a root node, false otherwise.

Returns:

  • (Boolean)

112
113
114
# File 'lib/sequel/plugins/tree.rb', line 112

def root?
  !new? && possible_root?
end

#self_and_siblingsObject

Returns all siblings and a reference to the current node.

subchild1.self_and_siblings # => [subchild1, subchild2]

119
120
121
122
123
124
125
# File 'lib/sequel/plugins/tree.rb', line 119

def self_and_siblings
  if parent = send(model.parent_association_name)
    parent.send(model.children_association_name)
  else
    model.roots
  end
end

#siblingsObject

Returns all siblings of the current node.

subchild1.siblings # => [subchild2]

130
131
132
# File 'lib/sequel/plugins/tree.rb', line 130

def siblings
  self_and_siblings - [self]
end