Module: Sequel::Plugins::SingleTableInheritance::ClassMethods
- Defined in:
- lib/sequel/plugins/single_table_inheritance.rb
Instance Attribute Summary collapse
-
#sti_dataset ⇒ Object
readonly
The base dataset for STI, to which filters are added to get only the models for the specific STI subclass.
-
#sti_key ⇒ Object
readonly
The column name holding the STI key for this model.
-
#sti_key_array ⇒ Object
readonly
Array holding keys for all subclasses of this class, used for the dataset filter in subclasses.
-
#sti_key_chooser ⇒ Object
readonly
A proc which returns the value to use for new instances.
-
#sti_key_map ⇒ Object
readonly
A hash/proc with class keys and column value values, mapping the the class to a particular value given to the sti_key column.
-
#sti_model_map ⇒ Object
readonly
A hash/proc with column value keys and class values, mapping the value of the sti_key column to the appropriate class to use.
Instance Method Summary collapse
-
#inherited(subclass) ⇒ Object
Copy the necessary attributes to the subclasses, and filter the subclass’s dataset based on the sti_kep_map entry for the class.
-
#sti_load(r) ⇒ Object
Return an instance of the class specified by sti_key, used by the row_proc.
-
#sti_subclass_added(key) ⇒ Object
Make sure that all subclasses of the parent class correctly include keys for all of their descendant classes.
Instance Attribute Details
#sti_dataset ⇒ Object (readonly)
The base dataset for STI, to which filters are added to get only the models for the specific STI subclass.
119 120 121 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 119 def sti_dataset @sti_dataset end |
#sti_key ⇒ Object (readonly)
The column name holding the STI key for this model
122 123 124 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 122 def sti_key @sti_key end |
#sti_key_array ⇒ Object (readonly)
Array holding keys for all subclasses of this class, used for the dataset filter in subclasses. Nil in the main class.
126 127 128 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 126 def sti_key_array @sti_key_array end |
#sti_key_chooser ⇒ Object (readonly)
A proc which returns the value to use for new instances. This defaults to a lookup in the key map.
140 141 142 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 140 def sti_key_chooser @sti_key_chooser end |
#sti_key_map ⇒ Object (readonly)
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.
132 133 134 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 132 def sti_key_map @sti_key_map end |
#sti_model_map ⇒ Object (readonly)
A hash/proc with column value keys and class values, mapping the value of the sti_key column to the appropriate class to use.
136 137 138 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 136 def sti_model_map @sti_model_map end |
Instance Method Details
#inherited(subclass) ⇒ Object
Copy the necessary attributes to the subclasses, and filter the subclass’s dataset based on the sti_kep_map entry for the class.
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 144 def inherited(subclass) super sk = sti_key sd = sti_dataset skm = sti_key_map smm = sti_model_map skc = sti_key_chooser key = Array(skm[subclass]).dup sti_subclass_added(key) rp = dataset.row_proc subclass.set_dataset(sd.filter(SQL::QualifiedIdentifier.new(table_name, sk)=>key), :inherited=>true) subclass.instance_eval do dataset.row_proc = rp @sti_key = sk @sti_key_array = key @sti_dataset = sd @sti_key_map = skm @sti_model_map = smm @sti_key_chooser = skc self.simple_table = nil end end |
#sti_load(r) ⇒ Object
Return an instance of the class specified by sti_key, used by the row_proc.
169 170 171 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 169 def sti_load(r) sti_class(sti_model_map[r[sti_key]]).call(r) end |
#sti_subclass_added(key) ⇒ Object
Make sure that all subclasses of the parent class correctly include keys for all of their descendant classes.
175 176 177 178 179 180 |
# File 'lib/sequel/plugins/single_table_inheritance.rb', line 175 def sti_subclass_added(key) if sti_key_array Sequel.synchronize{sti_key_array.push(*Array(key))} superclass.sti_subclass_added(key) end end |