Module: Sequel::Plugins::HybridTableInheritance::ClassMethods

Defined in:
lib/sequel/plugins/hybrid_table_inheritance.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cti_instance_dataset ⇒ Object (readonly)

The dataset that table instance datasets are based on. Used for database modifications



238
239
240
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 238

def cti_instance_dataset
  @cti_instance_dataset
end

#cti_models ⇒ Object (readonly)

An array of each model in the inheritance hierarchy that uses an backed by a new table.



209
210
211
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 209

def cti_models
  @cti_models
end

#cti_subclass_datasets ⇒ Object (readonly)

A hash with subclass models keys and datasets to load that subclass assuming the current model has already been loaded. Used for eager loading



227
228
229
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 227

def cti_subclass_datasets
  @cti_subclass_datasets
end

#cti_subclass_load ⇒ Object (readonly)

Eager loading option



230
231
232
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 230

def cti_subclass_load
  @cti_subclass_load
end

#cti_table_columns ⇒ Object (readonly)

An array of column symbols for the backing database table, giving the columns to update in each backing database table.



234
235
236
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 234

def cti_table_columns
  @cti_table_columns
end

#cti_table_map ⇒ Object (readonly)

A hash with class name symbol keys and table name symbol values. Specified with the :table_map option to the plugin, and used if the implicit naming is incorrect.



248
249
250
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 248

def cti_table_map
  @cti_table_map
end

#cti_tables ⇒ Object (readonly)

An array of table symbols that back this model. The first is cti_base_model table symbol, and the last is the current model table symbol.



243
244
245
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 243

def cti_tables
  @cti_tables
end

Instance Method Details

#cti_base_model ⇒ Object

The parent/root/base model for this class table inheritance hierarchy. This is the only model in the hierarchy that loads the class_table_inheritance plugin. Only needed to be compatible with class_table_inheritance plugin



215
216
217
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 215

def cti_base_model
  @cti_models.first
end

#cti_columns ⇒ Object

Hash with table name symbol keys and arrays of column symbol values, giving the columns to update in each backing database table. Only needed to be compatible with class_table_inheritance plugin



253
254
255
256
257
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 253

def cti_columns
  h = {}
  cti_models.each { |m| h[m.table_name] = m.cti_table_columns }
  h
end

#cti_key ⇒ Object

Alias to single_table_inheritance methods to be compatible with class_table_inheritance plugin



261
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 261

def cti_key; sti_key; end

#cti_model_map ⇒ Object 



262
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 262

def cti_model_map; sti_model_map; end

#cti_table_model ⇒ Object

Last model in the inheritance hierarchy to use a new table



220
221
222
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 220

def cti_table_model
  @cti_models.last
end

#inherited(subclass) ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 266

def inherited(subclass)
  ds = sti_dataset

  # Prevent inherited in model/base.rb from setting the dataset
  subclass.instance_eval { @dataset = nil }

  super

  # Set table if this is a class table inheritance
  table = nil
  columns = nil
  if (n = subclass.name) && !n.empty?
    if table = cti_table_map[n.to_sym]
      columns = db.from(table).columns
    else
      table = subclass.implicit_table_name
      columns = db.from(table).columns rescue nil
      table = nil if !columns || columns.empty?
    end
  end
  table = nil if table && (table == table_name)

  return unless table

  pk = primary_key
  subclass.instance_eval do
    if cti_tables.length == 1
      ds = ds.select(*self.columns.map{|cc| Sequel.qualify(table_name, Sequel.identifier(cc))})
    end
    sel_app = (columns - [pk]).map{|cc| Sequel.qualify(table, Sequel.identifier(cc))}
    @sti_dataset = ds.join(table, pk=>pk).select_append(*sel_app)
    set_dataset(@sti_dataset)
    set_columns(self.columns)
    dataset.row_proc = lambda{|r| subclass.sti_load(r)}

    unless cti_subclass_load == :lazy_only
      cti_models.each do |model|
        sd = model.instance_variable_get(:@cti_subclass_datasets)
        unless d = sd[cti_table_model]
          sd[self] = db.from(table).select(*columns.map{|cc| Sequel.qualify(table, Sequel.identifier(cc))})
        else
          sd[self] = d.join(table, pk=>pk).select_append(*sel_app)
        end
      end
    end
    unless cti_subclass_load == :eager_only
      (columns - [pk]).each{|a| define_lazy_attribute_getter(a, :dataset=>dataset, :table=>table)}
    end

    @cti_models += [self]
    @cti_tables += [table]
    @cti_table_columns = columns
    @cti_instance_dataset = db.from(table)

    cti_tables.reverse.each do |ct|
      db.schema(ct).each{|sk,v| db_schema[sk] = v}
    end
  end
end

#sti_class_from_key(key) ⇒ Object 



331
332
333
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 331

def sti_class_from_key(key)
  sti_class(sti_model_map[key])
end

#table_name ⇒ Object

The table name for the current model class’s main table.



327
328
329
 
# File 'lib/sequel/plugins/hybrid_table_inheritance.rb', line 327

def table_name
  cti_tables ? cti_tables.last : super
end