Class: ActiveFedora::Reflection::AssociationReflection

Inherits:
MacroReflection show all
Defined in:
lib/active_fedora/reflection.rb

Overview

Holds all the meta-data about an association as it was specified in the Active Record class.

Constant Summary collapse

VALID_AUTOMATIC_INVERSE_MACROS = 
[:has_many, :has_and_belongs_to_many, :belongs_to].freeze
INVALID_AUTOMATIC_INVERSE_OPTIONS = 
[:conditions, :through, :polymorphic, :foreign_key].freeze

Instance Attribute Summary collapse

Attributes inherited from MacroReflection

#active_fedora, #name, #options, #scope

Instance Method Summary collapse

Methods inherited from MacroReflection

#==, #autosave=, #compute_class, #klass

Methods inherited from AbstractReflection

#alias_candidate, #build_association, #class_name, #constraints, #through_reflection?

Constructor Details

#initialize(name, scope, options, active_fedora) ⇒ AssociationReflection

Returns a new instance of AssociationReflection.



266
267
268
269
 
# File 'lib/active_fedora/reflection.rb', line 266

def initialize(name, scope, options, active_fedora)
  super
  @constructable = calculate_constructable(macro, options)
end

Instance Attribute Details

#parent_reflection ⇒ Object

:nodoc:



264
265
266
 
# File 'lib/active_fedora/reflection.rb', line 264

def parent_reflection
  @parent_reflection
end

Instance Method Details

#association_class ⇒ Object

Raises:

  • (NotImplementedError) 


354
355
356
 
# File 'lib/active_fedora/reflection.rb', line 354

def association_class
  raise NotImplementedError
end

#belongs_to? ⇒ Boolean

Returns true if self is a belongs_to reflection.

Returns:

  • (Boolean) 


362
363
364
 
# File 'lib/active_fedora/reflection.rb', line 362

def belongs_to?
  false
end

#check_validity! ⇒ Object 



301
302
303
 
# File 'lib/active_fedora/reflection.rb', line 301

def check_validity!
  check_validity_of_inverse!
end

#check_validity_of_inverse! ⇒ Object

Raises:



305
306
307
308
 
# File 'lib/active_fedora/reflection.rb', line 305

def check_validity_of_inverse!
  return if options[:polymorphic] || !(has_inverse? && inverse_of.nil?)
  raise InverseOfAssociationNotFoundError, self
end

#collect_join_chain ⇒ Object Also known as: chain

A chain of reflections from this one back to the owner. For more see the explanation in ThroughReflection.



312
313
314
 
# File 'lib/active_fedora/reflection.rb', line 312

def collect_join_chain
  [self]
end

#collection? ⇒ Boolean

Returns whether or not this association reflection is for a collection association. Returns true if the macro is either has_many or has_and_belongs_to_many, false otherwise.

Returns:

  • (Boolean) 


337
338
339
 
# File 'lib/active_fedora/reflection.rb', line 337

def collection?
  false
end

#constructable? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


271
272
273
 
# File 'lib/active_fedora/reflection.rb', line 271

def constructable? # :nodoc:
  @constructable
end

#create_association(*options) ⇒ Object

Creates a new instance of the associated class, and immediately saves it with ActiveFedora::Base#save. options will be passed to the class’s creation method. Returns the newly created object.



278
279
280
 
# File 'lib/active_fedora/reflection.rb', line 278

def create_association(*options)
  klass.create(*options)
end

#foreign_key ⇒ Object 



282
283
284
 
# File 'lib/active_fedora/reflection.rb', line 282

def foreign_key
  @foreign_key ||= options[:foreign_key] || derive_foreign_key
end

#has_and_belongs_to_many? ⇒ Boolean

Returns:

  • (Boolean) 


370
371
372
 
# File 'lib/active_fedora/reflection.rb', line 370

def has_and_belongs_to_many?
  false
end

#has_inverse? ⇒ Boolean

Returns:

  • (Boolean) 


317
318
319
 
# File 'lib/active_fedora/reflection.rb', line 317

def has_inverse?
  inverse_name
end

#has_many? ⇒ Boolean

Returns:

  • (Boolean) 


366
367
368
 
# File 'lib/active_fedora/reflection.rb', line 366

def has_many?
  false
end

#inverse_of ⇒ Object 



321
322
323
324
325
 
# File 'lib/active_fedora/reflection.rb', line 321

def inverse_of
  return unless inverse_name

  @inverse_of ||= klass._reflect_on_association inverse_name
end

#macro ⇒ Object

Returns the macro type.

has_many :clients returns :has_many

Raises:

  • (NotImplementedError) 


330
331
332
 
# File 'lib/active_fedora/reflection.rb', line 330

def macro
  raise NotImplementedError
end

#predicate ⇒ Object

Returns the RDF predicate as defined by the :predicate option



287
288
289
 
# File 'lib/active_fedora/reflection.rb', line 287

def predicate
  options[:predicate]
end

#predicate_for_solr ⇒ Object 



291
292
293
 
# File 'lib/active_fedora/reflection.rb', line 291

def predicate_for_solr
  predicate.fragment || predicate.to_s.rpartition(/\//).last
end

#solr_key ⇒ Object 



295
296
297
298
299
 
# File 'lib/active_fedora/reflection.rb', line 295

def solr_key
  @solr_key ||= begin
    ActiveFedora.index_field_mapper.solr_name(predicate_for_solr, :symbol)
  end
end

#validate? ⇒ Boolean

Returns whether or not the association should be validated as part of the parent’s validation.

Unless you explicitly disable validation with :validate => false, validation will take place when:

  • you explicitly enable validation; :validate => true

  • you use autosave; :autosave => true

  • the association is a has_many association

Returns:

  • (Boolean) 


350
351
352
 
# File 'lib/active_fedora/reflection.rb', line 350

def validate?
  !options[:validate].nil? ? options[:validate] : (options[:autosave] == true || macro == :has_many)
end