Module: CollectiveIdea::Acts::NestedSet::Base::InstanceMethods

Defined in:
lib/nested_set/base.rb

Overview

Any instance method that returns a collection makes use of Rails 2.1’s named_scope (which is bundled for Rails 2.0), so it can be treated as a finder.

category.self_and_descendants.count
category.ancestors.find(:all, :conditions => "name like '%foo%'")

Instance Method Summary collapse

Instance Method Details

#<=>(x) ⇒ Object

order by left column



391
392
393
 
# File 'lib/nested_set/base.rb', line 391

def <=>(x)
  left <=> x.left
end

#==(comparison_object) ⇒ Object

Redefine to act like active record



396
397
398
399
400
401
 
# File 'lib/nested_set/base.rb', line 396

def ==(comparison_object)
  comparison_object.equal?(self) ||
    (comparison_object.instance_of?(self.class) &&
      comparison_object.id == id &&
      !comparison_object.new_record?)
end

#ancestors ⇒ Object

Returns an array of all parents



419
420
421
 
# File 'lib/nested_set/base.rb', line 419

def ancestors
  without_self self_and_ancestors
end

#child? ⇒ Boolean

Returns true is this is a child node

Returns:

  • (Boolean) 


386
387
388
 
# File 'lib/nested_set/base.rb', line 386

def child?
  !parent_id.nil?
end

#descendants ⇒ Object

Returns a set of all of its children and nested children



450
451
452
 
# File 'lib/nested_set/base.rb', line 450

def descendants
  without_self self_and_descendants
end

#is_ancestor_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


462
463
464
 
# File 'lib/nested_set/base.rb', line 462

def is_ancestor_of?(other)
  self.left < other.left && other.left < self.right && same_scope?(other)
end

#is_descendant_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


454
455
456
 
# File 'lib/nested_set/base.rb', line 454

def is_descendant_of?(other)
  other.left < self.left && self.left < other.right && same_scope?(other)
end

#is_or_is_ancestor_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


466
467
468
 
# File 'lib/nested_set/base.rb', line 466

def is_or_is_ancestor_of?(other)
  self.left <= other.left && other.left < self.right && same_scope?(other)
end

#is_or_is_descendant_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


458
459
460
 
# File 'lib/nested_set/base.rb', line 458

def is_or_is_descendant_of?(other)
  other.left <= self.left && self.left < other.right && same_scope?(other)
end

#leaf? ⇒ Boolean

Returns:

  • (Boolean) 


381
382
383
 
# File 'lib/nested_set/base.rb', line 381

def leaf?
  !new_record? && right - left == 1
end

#leaves ⇒ Object

Returns a set of all of its nested children which do not have children



434
435
436
 
# File 'lib/nested_set/base.rb', line 434

def leaves
  descendants.scoped.where("#{q_right} - #{q_left} = 1")
end

#left ⇒ Object

Value of the left column



367
368
369
 
# File 'lib/nested_set/base.rb', line 367

def left
  self[left_column_name]
end

#left_sibling ⇒ Object

Find the first sibling to the left



478
479
480
 
# File 'lib/nested_set/base.rb', line 478

def left_sibling
  siblings.where("#{q_left} < ?", left).reverse_order.first
end

#level ⇒ Object

Returns the level of this object in the tree root level is 0



440
441
442
 
# File 'lib/nested_set/base.rb', line 440

def level
  parent_id.nil? ? 0 : ancestors.count
end

#move_left ⇒ Object

Shorthand method for finding the left sibling and moving to the left of it.



488
489
490
 
# File 'lib/nested_set/base.rb', line 488

def move_left
  move_to_left_of left_sibling
end

#move_possible?(target) ⇒ Boolean

Returns:

  • (Boolean) 


517
518
519
520
521
522
523
 
# File 'lib/nested_set/base.rb', line 517

def move_possible?(target)
  self != target && # Can't target self
  same_scope?(target) && # can't be in different scopes
  # !(left..right).include?(target.left..target.right) # this needs tested more
  # detect impossible move
  !((left <= target.left && right >= target.left) or (left <= target.right && right >= target.right))
end

#move_right ⇒ Object

Shorthand method for finding the right sibling and moving to the right of it.



493
494
495
 
# File 'lib/nested_set/base.rb', line 493

def move_right
  move_to_right_of right_sibling
end

#move_to_child_of(node) ⇒ Object

Move the node to the child of another node (you can pass id only)



508
509
510
 
# File 'lib/nested_set/base.rb', line 508

def move_to_child_of(node)
  move_to node, :child
end

#move_to_left_of(node) ⇒ Object

Move the node to the left of another node (you can pass id only)



498
499
500
 
# File 'lib/nested_set/base.rb', line 498

def move_to_left_of(node)
  move_to node, :left
end

#move_to_right_of(node) ⇒ Object

Move the node to the left of another node (you can pass id only)



503
504
505
 
# File 'lib/nested_set/base.rb', line 503

def move_to_right_of(node)
  move_to node, :right
end

#move_to_root ⇒ Object

Move the node to root nodes



513
514
515
 
# File 'lib/nested_set/base.rb', line 513

def move_to_root
  move_to nil, :root
end

#parent_id ⇒ Object

Value of the parent column



362
363
364
 
# File 'lib/nested_set/base.rb', line 362

def parent_id
  self[parent_column_name]
end

#right ⇒ Object

Value of the right column



372
373
374
 
# File 'lib/nested_set/base.rb', line 372

def right
  self[right_column_name]
end

#right_sibling ⇒ Object

Find the first sibling to the right



483
484
485
 
# File 'lib/nested_set/base.rb', line 483

def right_sibling
  siblings.where("#{q_left} > ?", left).first
end

#root ⇒ Object

Returns root



404
405
406
 
# File 'lib/nested_set/base.rb', line 404

def root
  self_and_ancestors.first
end

#root? ⇒ Boolean

Returns true if this is a root node.

Returns:

  • (Boolean) 


377
378
379
 
# File 'lib/nested_set/base.rb', line 377

def root?
  parent_id.nil?
end

#same_scope?(other) ⇒ Boolean

Check if other model is in the same scope

Returns:

  • (Boolean) 


471
472
473
474
475
 
# File 'lib/nested_set/base.rb', line 471

def same_scope?(other)
  Array(acts_as_nested_set_options[:scope]).all? do |attr|
    self.send(attr) == other.send(attr)
  end
end

#self_and_ancestors ⇒ Object

Returns the array of all parents and self



414
415
416
 
# File 'lib/nested_set/base.rb', line 414

def self_and_ancestors
  nested_set_scope.scoped.where("#{q_left} <= ? AND #{q_right} >= ?", left, right)
end

#self_and_children ⇒ Object

Returns the array of all children and self



409
410
411
 
# File 'lib/nested_set/base.rb', line 409

def self_and_children
  nested_set_scope.scoped.where("#{q_parent} = ? or id = ?", id, id)
end

#self_and_descendants ⇒ Object

Returns a set of itself and all of its nested children



445
446
447
 
# File 'lib/nested_set/base.rb', line 445

def self_and_descendants
  nested_set_scope.scoped.where("#{q_left} >= ? AND #{q_right} <= ?", left, right)
end

#self_and_siblings ⇒ Object

Returns the array of all children of the parent, including self



424
425
426
 
# File 'lib/nested_set/base.rb', line 424

def self_and_siblings
  nested_set_scope.scoped.where(parent_column_name => parent_id)
end

#siblings ⇒ Object

Returns the array of all children of the parent, except self



429
430
431
 
# File 'lib/nested_set/base.rb', line 429

def siblings
  without_self self_and_siblings
end

#to_text ⇒ Object 



525
526
527
528
529
 
# File 'lib/nested_set/base.rb', line 525

def to_text
  self.class.map_with_level(self_and_descendants) do |node,level|
    "#{'*'*(level+1)} #{node.id} #{node.to_s} (#{node.parent_id}, #{node.left}, #{node.right})"
  end.join("\n")
end