Class: Sequel::Model::Associations::ManyToManyAssociationReflection

Inherits:
AssociationReflection show all
Defined in:
lib/sequel/model/associations.rb

Constant Summary

Constants included from Inflections

Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP

Instance Method Summary collapse

Methods inherited from AssociationReflection

#_add_method, #_dataset_method, #_remove_all_method, #_remove_method, #_setter_method, #add_method, #associated_class, #association_method, #dataset_helper_method, #dataset_method, #dataset_need_primary_key?, #eager_graph_lazy_dataset?, #reciprocal_array?, #remove_all_method, #remove_method, #remove_should_check_existing?, #returns_array?, #set_reciprocal_to_self?, #setter_method

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

#&, #case, #sql_expr, #sql_negate, #sql_or, #|, #~

Instance Method Details

#associated_key_alias ⇒ Object

The alias to use for the associated key when eagerly loading



273
274
275
 
# File 'lib/sequel/model/associations.rb', line 273

def associated_key_alias
  self[:left_key_alias]
end

#associated_key_column ⇒ Object

The column to use for the associated key when eagerly loading



278
279
280
 
# File 'lib/sequel/model/associations.rb', line 278

def associated_key_column
  self[:left_key]
end

#associated_key_table ⇒ Object

The table containing the column to use for the associated key when eagerly loading



283
284
285
 
# File 'lib/sequel/model/associations.rb', line 283

def associated_key_table
  self[:join_table]
end

#can_have_associated_objects?(obj) ⇒ Boolean

many_to_many associations can only have associated objects if none of the :left_primary_keys options have a nil value.

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/sequel/model/associations.rb', line 289

def can_have_associated_objects?(obj)
  !self[:left_primary_keys].any?{|k| obj.send(k).nil?}
end

#default_associated_key_alias ⇒ Object

The default associated key alias(es) to use when eager loading associations via eager.



295
296
297
 
# File 'lib/sequel/model/associations.rb', line 295

def default_associated_key_alias
  self[:uses_left_composite_keys] ? (0...self[:left_keys].length).map{|i| :"x_foreign_key_#{i}_x"} : :x_foreign_key_x
end

#default_join_table ⇒ Object

Default name symbol for the join table.



300
301
302
 
# File 'lib/sequel/model/associations.rb', line 300

def default_join_table
  [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym
end

#default_left_key ⇒ Object

Default foreign key name symbol for key in join table that points to current table’s primary key (or :left_primary_key column).



306
307
308
 
# File 'lib/sequel/model/associations.rb', line 306

def default_left_key
  :"#{underscore(demodulize(self[:model].name))}_id"
end

#default_right_key ⇒ Object

Default foreign key name symbol for foreign key in join table that points to the association’s table’s primary key (or :right_primary_key column).



312
313
314
 
# File 'lib/sequel/model/associations.rb', line 312

def default_right_key
  :"#{singularize(self[:name])}_id"
end

#eager_loader_key ⇒ Object

The key to use for the key hash when eager loading



317
318
319
 
# File 'lib/sequel/model/associations.rb', line 317

def eager_loader_key
  self[:left_primary_key]
end

#eager_loading_use_associated_key? ⇒ Boolean

many_to_many associations need to select a key in an associated table to eagerly load

Returns:

  • (Boolean) 


322
323
324
 
# File 'lib/sequel/model/associations.rb', line 322

def eager_loading_use_associated_key?
  true
end

#need_associated_primary_key? ⇒ Boolean

Whether the associated object needs a primary key to be added/removed, true for many_to_many associations.

Returns:

  • (Boolean) 


328
329
330
 
# File 'lib/sequel/model/associations.rb', line 328

def need_associated_primary_key?
  true
end

#reciprocal ⇒ Object

Returns the reciprocal association symbol, if one exists.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/sequel/model/associations.rb', line 333

def reciprocal
  return self[:reciprocal] if include?(:reciprocal)
  left_keys = self[:left_keys]
  right_keys = self[:right_keys]
  join_table = self[:join_table]
  associated_class.all_association_reflections.each do |assoc_reflect|
    if assoc_reflect[:type] == :many_to_many && assoc_reflect[:left_keys] == right_keys &&
       assoc_reflect[:right_keys] == left_keys && assoc_reflect[:join_table] == join_table &&
       assoc_reflect.associated_class == self[:model]
      return self[:reciprocal] = assoc_reflect[:name]
    end
  end
  self[:reciprocal] = nil
end

#right_primary_key ⇒ Object

The primary key column(s) to use in the associated table (can be symbol or array).



349
350
351
 
# File 'lib/sequel/model/associations.rb', line 349

def right_primary_key
  self[:right_primary_key] ||= associated_class.primary_key
end

#right_primary_keys ⇒ Object Also known as: associated_object_keys

The primary key columns to use in the associated table (always array).



354
355
356
 
# File 'lib/sequel/model/associations.rb', line 354

def right_primary_keys
  self[:right_primary_keys] ||= Array(right_primary_key)
end

#select ⇒ Object

The columns to select when loading the association, associated_class.table_name.* by default.



360
361
362
363
 
# File 'lib/sequel/model/associations.rb', line 360

def select
 return self[:select] if include?(:select)
 self[:select] ||= Sequel::SQL::ColumnAll.new(associated_class.table_name)
end