Module: CollectiveIdea::Acts::NestedSet::Model

Extended by:
ActiveSupport::Concern
Defined in:
lib/awesome_nested_set/awesome_nested_set.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#ancestors ⇒ Object

Returns an array of all parents



342
343
344
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 342

def ancestors
  without_self self_and_ancestors
end

#child? ⇒ Boolean

Returns true is this is a child node

Returns:

  • (Boolean) 


317
318
319
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 317

def child?
  !root?
end

#descendants ⇒ Object

Returns a set of all of its children and nested children



376
377
378
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 376

def descendants
  without_self self_and_descendants
end

#is_ancestor_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


388
389
390
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 388

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

#is_descendant_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


380
381
382
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 380

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) 


392
393
394
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 392

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) 


384
385
386
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 384

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

#leaf? ⇒ Boolean

Returns true if this is the end of a branch.

Returns:

  • (Boolean) 


312
313
314
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 312

def leaf?
  persisted? && right.to_i - left.to_i == 1
end

#leaves ⇒ Object

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



357
358
359
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 357

def leaves
  descendants.where("#{quoted_right_column_full_name} - #{quoted_left_column_full_name} = 1")
end

#left ⇒ Object

Value of the left column



297
298
299
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 297

def left
  self[left_column_name]
end

#left_sibling ⇒ Object

Find the first sibling to the left



404
405
406
407
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 404

def left_sibling
  siblings.where(["#{quoted_left_column_full_name} < ?", left]).
          order("#{quoted_left_column_full_name} DESC").last
end

#level ⇒ Object

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



363
364
365
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 363

def level
  parent_id.nil? ? 0 : compute_level
end

#move_left ⇒ Object

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



415
416
417
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 415

def move_left
  move_to_left_of left_sibling
end

#move_possible?(target) ⇒ Boolean

Returns:

  • (Boolean) 


477
478
479
480
481
482
483
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 477

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.



420
421
422
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 420

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)



435
436
437
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 435

def move_to_child_of(node)
  move_to node, :child
end

#move_to_child_with_index(node, index) ⇒ Object

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



440
441
442
443
444
445
446
447
448
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 440

def move_to_child_with_index(node, index)
  if node.children.empty?
    move_to_child_of(node)
  elsif node.children.count == index
    move_to_right_of(node.children.last)
  else
    move_to_left_of(node.children[index])
  end
end

#move_to_left_of(node) ⇒ Object

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



425
426
427
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 425

def move_to_left_of(node)
  move_to node, :left
end

#move_to_ordered_child_of(parent, order_attribute, ascending = true) ⇒ Object

Order children in a nested set by an attribute Can order by any attribute class that uses the Comparable mixin, for example a string or integer Usage example when sorting categories alphabetically: @new_category.move_to_ordered_child_of(@root, “name”)



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 458

def move_to_ordered_child_of(parent, order_attribute, ascending = true)
  self.move_to_root and return unless parent
  left = nil # This is needed, at least for the tests.
  parent.children.each do |n| # Find the node immediately to the left of this node.
    if ascending
      left = n if n.send(order_attribute) < self.send(order_attribute)
    else
      left = n if n.send(order_attribute) > self.send(order_attribute)
    end
  end
  self.move_to_child_of(parent)
  return unless parent.children.count > 1 # Only need to order if there are multiple children.
  if left # Self has a left neighbor.
    self.move_to_right_of(left)
  else # Self is the left most node.
    self.move_to_left_of(parent.children[0])
  end
end

#move_to_right_of(node) ⇒ Object

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



430
431
432
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 430

def move_to_right_of(node)
  move_to node, :right
end

#move_to_root ⇒ Object

Move the node to root nodes



451
452
453
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 451

def move_to_root
  move_to nil, :root
end

#parent_id ⇒ Object

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%'")

Value of the parent column



292
293
294
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 292

def parent_id
  self[parent_column_name]
end

#right ⇒ Object

Value of the right column



302
303
304
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 302

def right
  self[right_column_name]
end

#right_sibling ⇒ Object

Find the first sibling to the right



410
411
412
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 410

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

#root ⇒ Object

Returns root



322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 322

def root
  if persisted?
    self_and_ancestors.where(parent_column_name => nil).first
  else
    if parent_id && current_parent = nested_set_scope.find(parent_id)
      current_parent.root
    else
      self
    end
  end
end

#root? ⇒ Boolean

Returns true if this is a root node.

Returns:

  • (Boolean) 


307
308
309
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 307

def root?
  parent_id.nil?
end

#same_scope?(other) ⇒ Boolean

Check if other model is in the same scope

Returns:

  • (Boolean) 


397
398
399
400
401
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 397

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



335
336
337
338
339
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 335

def self_and_ancestors
  nested_set_scope.where([
    "#{quoted_left_column_full_name} <= ? AND #{quoted_right_column_full_name} >= ?", left, right
  ])
end

#self_and_descendants ⇒ Object

Returns a set of itself and all of its nested children



368
369
370
371
372
373
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 368

def self_and_descendants
  nested_set_scope.where([
    "#{quoted_left_column_full_name} >= ? AND #{quoted_left_column_full_name} < ?", left, right
    # using _left_ for both sides here lets us benefit from an index on that column if one exists
  ])
end

#self_and_siblings ⇒ Object

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



347
348
349
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 347

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

#siblings ⇒ Object

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



352
353
354
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 352

def siblings
  without_self self_and_siblings
end

#to_text ⇒ Object 



485
486
487
488
489
 
# File 'lib/awesome_nested_set/awesome_nested_set.rb', line 485

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