Module: ActiveRecord::Inheritance::ClassMethods

Defined in:
activerecord/lib/active_record/inheritance.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#abstract_classObject

Set this to true if this is an abstract class (see abstract_class?). If you are using inheritance with ActiveRecord and don't want child classes to utilize the implied STI table name of the parent class, this will need to be true. For example, given the following:

class SuperClass < ActiveRecord::Base
  self.abstract_class = true
end
class Child < SuperClass
  self.table_name = 'the_table_i_really_want'
end

self.abstract_class = true is required to make Child<.find,.create, or any Arel method> use the_table_i_really_want instead of a table called super_classes


96
97
98
# File 'activerecord/lib/active_record/inheritance.rb', line 96

def abstract_class
  @abstract_class
end

Instance Method Details

#abstract_class?Boolean

Returns whether this class is an abstract class or not.

Returns:

  • (Boolean)

99
100
101
# File 'activerecord/lib/active_record/inheritance.rb', line 99

def abstract_class?
  defined?(@abstract_class) && @abstract_class == true
end

#base_classObject

Returns the class descending directly from ActiveRecord::Base, or an abstract class, if any, in the inheritance hierarchy.

If A extends AR::Base, A.base_class will return A. If B descends from A through some arbitrarily deep hierarchy, B.base_class will return A.

If B < A and C < B and if A is an abstract_class then both B.base_class and C.base_class would return B as the answer since A is an abstract_class.


69
70
71
72
73
74
75
76
77
78
79
# File 'activerecord/lib/active_record/inheritance.rb', line 69

def base_class
  unless self < Base
    raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
  end

  if superclass == Base || superclass.abstract_class?
    self
  else
    superclass.base_class
  end
end

#descends_from_active_record?Boolean

Returns true if this does not need STI type condition. Returns false if STI type condition needs to be applied.

Returns:

  • (Boolean)

36
37
38
39
40
41
42
43
44
# File 'activerecord/lib/active_record/inheritance.rb', line 36

def descends_from_active_record?
  if self == Base
    false
  elsif superclass.abstract_class?
    superclass.descends_from_active_record?
  else
    superclass == Base || !columns_hash.include?(inheritance_column)
  end
end

#finder_needs_type_condition?Boolean

:nodoc:

Returns:

  • (Boolean)

46
47
48
49
# File 'activerecord/lib/active_record/inheritance.rb', line 46

def finder_needs_type_condition? #:nodoc:
  # This is like this because benchmarking justifies the strange :false stuff
  :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
end

#new(*args, &block) ⇒ Object

Determines if one of the attributes passed in is the inheritance column, and if the inheritance column is attr accessible, it initializes an instance of the given subclass instead of the base class.


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'activerecord/lib/active_record/inheritance.rb', line 17

def new(*args, &block)
  if abstract_class? || self == Base
    raise NotImplementedError, "#{self} is an abstract class and cannot be instantiated."
  end

  attrs = args.first
  if subclass_from_attributes?(attrs)
    subclass = subclass_from_attributes(attrs)
  end

  if subclass
    subclass.new(*args, &block)
  else
    super
  end
end

#sti_nameObject


103
104
105
# File 'activerecord/lib/active_record/inheritance.rb', line 103

def sti_name
  store_full_sti_class ? name : name.demodulize
end

#symbolized_base_classObject


51
52
53
54
# File 'activerecord/lib/active_record/inheritance.rb', line 51

def symbolized_base_class
  ActiveSupport::Deprecation.warn("ActiveRecord::Base.symbolized_base_class is deprecated and will be removed without replacement.")
  @symbolized_base_class ||= base_class.to_s.to_sym
end

#symbolized_sti_nameObject


56
57
58
59
# File 'activerecord/lib/active_record/inheritance.rb', line 56

def symbolized_sti_name
  ActiveSupport::Deprecation.warn("ActiveRecord::Base.symbolized_sti_name is deprecated and will be removed without replacement.")
  @symbolized_sti_name ||= sti_name.present? ? sti_name.to_sym : symbolized_base_class
end