Class Index [+]

Quicksearch

Sequel::Plugins::SingleTableInheritance::ClassMethods

Attributes

sti_dataset[R]

The base dataset for STI, to which filters are added to get only the models for the specific STI subclass.

sti_key[R]

The column name holding the STI key for this model

sti_key_array[R]

Array holding keys for all subclasses of this class, used for the dataset filter in subclasses. Nil in the main class.

sti_key_map[R]

A hash/proc with class keys and column value values, mapping the the class to a particular value given to the sti_key column. Used to set the column value when creating objects, and for the filter when retrieving objects in subclasses.

sti_model_map[R]

A hash/proc with column value keys and class values, mapping the value of the sti_key column to the appropriate class to use.

Public Instance Methods

inherited(subclass) click to toggle source

Copy the necessary attributes to the subclasses, and filter the subclass’s dataset based on the sti_kep_map entry for the class.

     # File lib/sequel/plugins/single_table_inheritance.rb, line 102
102:         def inherited(subclass)
103:           super
104:           sk = sti_key
105:           sd = sti_dataset
106:           skm = sti_key_map
107:           smm = sti_model_map
108:           key = skm[subclass] 
109:           sti_subclass_added(key)
110:           ska = [key]
111:           rp = dataset.row_proc
112:           subclass.set_dataset(sd.filter(SQL::QualifiedIdentifier.new(table_name, sk)=>ska), :inherited=>true)
113:           subclass.instance_eval do
114:             dataset.row_proc = rp
115:             @sti_key = sk
116:             @sti_key_array = ska
117:             @sti_dataset = sd
118:             @sti_key_map = skm
119:             @sti_model_map = smm
120:             self.simple_table = nil
121:           end
122:         end
sti_load(r) click to toggle source

Return an instance of the class specified by sti_key, used by the row_proc.

     # File lib/sequel/plugins/single_table_inheritance.rb, line 126
126:         def sti_load(r)
127:           sti_class(sti_model_map[r[sti_key]]).call(r)
128:         end
sti_subclass_added(key) click to toggle source

Make sure that all subclasses of the parent class correctly include keys for all of their descendant classes.

     # File lib/sequel/plugins/single_table_inheritance.rb, line 132
132:         def sti_subclass_added(key)
133:           if sti_key_array
134:             Sequel.synchronize{sti_key_array << key}
135:             superclass.sti_subclass_added(key)
136:           end
137:         end

Private Instance Methods

sti_class(v) click to toggle source

Return a class object. If a class is given, return it directly. Treat strings and symbols as class names. If nil is given or an invalid class name string or symbol is used, return self. Raise an error for other types.

     # File lib/sequel/plugins/single_table_inheritance.rb, line 145
145:         def sti_class(v)
146:           case v
147:           when String, Symbol
148:             constantize(v) rescue self
149:           when nil
150:             self
151:           when Class
152:             v
153:           else
154:             raise(Error, "Invalid class type used: #{v.inspect}")
155:           end
156:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.