123456789_123456789_123456789_123456789_123456789_

Module: ActiveRecord::Inheritance::ClassMethods

Relationships & Source Files
Defined in: activerecord/lib/active_record/inheritance.rb

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#abstract_class (rw)

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

[ GitHub ] 

  


# File 'activerecord/lib/active_record/inheritance.rb', line 127



attr_accessor :abstract_class


  








  

    #abstract_class?  ⇒ Boolean  (rw)
  



  

    

Returns whether this class is an abstract class or not.


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/inheritance.rb', line 130



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


  








  

    #descends_from_active_record?  ⇒ Boolean  (readonly)
  



  

    

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


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/inheritance.rb', line 67



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


  







Instance Method Details



  

    #base_class  
  



  

    

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.


  



  [ GitHub ]


  

  


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



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


  








  

    #new(*args, &block)  
  



  

    

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.


  



  [ GitHub ]


  

  


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



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_name  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/inheritance.rb', line 134



def sti_name
  store_full_sti_class ? name : name.demodulize
end


  








  

    #symbolized_base_class  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/inheritance.rb', line 82



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_name  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/inheritance.rb', line 87



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