module ActiveLdap::Acts::Tree

Public Class Methods

included(base) click to toggle source
# File lib/active_ldap/acts/tree.rb, line 4
def self.included(base)
  base.class_eval do
    extend(ClassMethods)
    association_accessor(:children) do |target|
      Association::Children.new(target, {})
    end
  end
end

Public Instance Methods

ancestors() click to toggle source

Returns list of ancestors, starting from parent until root.

subchild1.ancestors # => [child1, root]
# File lib/active_ldap/acts/tree.rb, line 22
def ancestors
  node, nodes = self, []
  nodes << node = node.parent while node.parent
  nodes
end
parent() click to toggle source
# File lib/active_ldap/acts/tree.rb, line 49
def parent
  if base == self.class.base
    nil
  else
    find(:first, :base => base, :scope => :base)
  end
end
parent=(entry) click to toggle source
# File lib/active_ldap/acts/tree.rb, line 57
def parent=(entry)
  if entry.is_a?(String) or entry.is_a?(DN)
    base = entry.to_s
  elsif entry.respond_to?(:dn)
    base = entry.dn.to_s
    if entry.respond_to?(:clear_association_cache)
      entry.clear_association_cache
    end
  else
    message = _("parent must be an entry or parent DN: %s") % entry.inspect
    raise ArgumentError, message
  end

  unless new_entry?
    begin
      self.class.modify_rdn_entry(dn, "#{dn_attribute}=#{id}",
                                  true, base,
                                  :connection => connection)
    rescue NotImplemented
      self.class.delete_entry(dn, :connection => connection)
      @new_entry = true
    end
  end

  self.dn = "#{dn_attribute}=#{id},#{base}"
  save if new_entry?
end
root() click to toggle source

Returns the root node of the tree.

# File lib/active_ldap/acts/tree.rb, line 29
def root
  node = self
  node = node.parent while node.parent
  node
end
self_and_siblings() click to toggle source

Returns all siblings and a reference to the current node.

subchild1.self_and_siblings # => [subchild1, subchild2]
# File lib/active_ldap/acts/tree.rb, line 45
def self_and_siblings
  parent ? parent.children : [self]
end
siblings() click to toggle source

Returns all siblings of the current node.

subchild1.siblings # => [subchild2]
# File lib/active_ldap/acts/tree.rb, line 38
def siblings
  self_and_siblings - [self]
end