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

Defined in:
lib/awesome_nested_set.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



266
267
268
 
# File 'lib/awesome_nested_set.rb', line 266

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

#==(comparison_object) ⇒ Object

Redefine to act like active record



271
272
273
274
275
276
 
# File 'lib/awesome_nested_set.rb', line 271

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



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

def ancestors
  without_self self_and_ancestors
end

#child? ⇒ Boolean

Returns true is this is a child node

Returns:

  • (Boolean) 


261
262
263
 
# File 'lib/awesome_nested_set.rb', line 261

def child?
  !parent_id.nil?
end

#children ⇒ Object

Returns a set of only this entry’s immediate children



334
335
336
 
# File 'lib/awesome_nested_set.rb', line 334

def children
  nested_set_scope.scoped :conditions => {parent_column_name => self}
end

#descendants ⇒ Object

Returns a set of all of its children and nested children



329
330
331
 
# File 'lib/awesome_nested_set.rb', line 329

def descendants
  without_self self_and_descendants
end

#is_ancestor_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#is_descendant_of?(other) ⇒ Boolean

Returns:

  • (Boolean) 


338
339
340
 
# File 'lib/awesome_nested_set.rb', line 338

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) 


350
351
352
 
# File 'lib/awesome_nested_set.rb', line 350

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) 


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

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

#leaf? ⇒ Boolean

Returns:

  • (Boolean) 


256
257
258
 
# File 'lib/awesome_nested_set.rb', line 256

def leaf?
  right - left == 1
end

#leaves ⇒ Object

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



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

def leaves
  descendants.scoped :conditions => "#{self.class.table_name}.#{quoted_right_column_name} - #{self.class.table_name}.#{quoted_left_column_name} = 1"
end

#left ⇒ Object

Value of the left column



242
243
244
 
# File 'lib/awesome_nested_set.rb', line 242

def left
  self[left_column_name]
end

#left_sibling ⇒ Object

Find the first sibling to the left



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

def left_sibling
  siblings.find(:first, :conditions => ["#{self.class.table_name}.#{quoted_left_column_name} < ?", left],
    :order => "#{self.class.table_name}.#{quoted_left_column_name} DESC")
end

#level ⇒ Object

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



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

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.



373
374
375
 
# File 'lib/awesome_nested_set.rb', line 373

def move_left
  move_to_left_of left_sibling
end

#move_possible?(target) ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



378
379
380
 
# File 'lib/awesome_nested_set.rb', line 378

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)



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

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)



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

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)



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

def move_to_right_of(node)
  move_to node, :right
end

#move_to_root ⇒ Object

Move the node to root nodes



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

def move_to_root
  move_to nil, :root
end

#parent ⇒ Object

Returns the immediate parent



284
285
286
 
# File 'lib/awesome_nested_set.rb', line 284

def parent
  nested_set_scope.find_by_id(parent_id) if parent_id
end

#parent_id ⇒ Object

Value of the parent column



237
238
239
 
# File 'lib/awesome_nested_set.rb', line 237

def parent_id
  self[parent_column_name]
end

#right ⇒ Object

Value of the right column



247
248
249
 
# File 'lib/awesome_nested_set.rb', line 247

def right
  self[right_column_name]
end

#right_sibling ⇒ Object

Find the first sibling to the right



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

def right_sibling
  siblings.find(:first, :conditions => ["#{self.class.table_name}.#{quoted_left_column_name} > ?", left])
end

#root ⇒ Object

Returns root



279
280
281
 
# File 'lib/awesome_nested_set.rb', line 279

def root
  self_and_ancestors.find(:first)
end

#root? ⇒ Boolean

Returns true if this is a root node.

Returns:

  • (Boolean) 


252
253
254
 
# File 'lib/awesome_nested_set.rb', line 252

def root?
  parent_id.nil?
end

#same_scope?(other) ⇒ Boolean

Check if other model is in the same scope

Returns:

  • (Boolean) 


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

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



289
290
291
292
293
 
# File 'lib/awesome_nested_set.rb', line 289

def self_and_ancestors
  nested_set_scope.scoped :conditions => [
    "#{self.class.table_name}.#{quoted_left_column_name} <= ? AND #{self.class.table_name}.#{quoted_right_column_name} >= ?", left, right
  ]
end

#self_and_descendants ⇒ Object

Returns a set of itself and all of its nested children



322
323
324
325
326
 
# File 'lib/awesome_nested_set.rb', line 322

def self_and_descendants
  nested_set_scope.scoped :conditions => [
    "#{self.class.table_name}.#{quoted_left_column_name} >= ? AND #{self.class.table_name}.#{quoted_right_column_name} <= ?", left, right
  ]
end

#self_and_siblings ⇒ Object

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



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

def self_and_siblings
  nested_set_scope.scoped :conditions => {parent_column_name => parent_id}
end

#siblings ⇒ Object

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



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

def siblings
  without_self self_and_siblings
end

#to_text ⇒ Object 



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

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