Class: JSONAPI::Relationship::ToOne

Inherits:
JSONAPI::Relationship show all
Defined in:
lib/jsonapi/relationship.rb

Instance Attribute Summary collapse

Attributes inherited from JSONAPI::Relationship

#acts_as_set, #always_include_linkage_data, #class_name, #eager_load_on_include, #foreign_key, #name, #options, #parent_resource, #polymorphic

Instance Method Summary collapse

Methods inherited from JSONAPI::Relationship

#_exclude_links, #exclude_link?, #exclude_links, #primary_key, #relation_name, #resource_klass, #table_name, #type, #type_for_source

Constructor Details

#initialize(name, options = {}) ⇒ ToOne

Returns a new instance of ToOne.



89
90
91
92
93
94
# File 'lib/jsonapi/relationship.rb', line 89

def initialize(name, options = {})
  super
  @class_name = options.fetch(:class_name, name.to_s.camelize)
  @foreign_key ||= "#{name}_id".to_sym
  @foreign_key_on = options.fetch(:foreign_key_on, :self)
end

Instance Attribute Details

#foreign_key_onObject (readonly)

Returns the value of attribute foreign_key_on.



87
88
89
# File 'lib/jsonapi/relationship.rb', line 87

def foreign_key_on
  @foreign_key_on
end

Instance Method Details

#belongs_to?Boolean

Returns:

  • (Boolean)


102
103
104
# File 'lib/jsonapi/relationship.rb', line 102

def belongs_to?
  foreign_key_on == :self
end

#polymorphic_typeObject



106
107
108
# File 'lib/jsonapi/relationship.rb', line 106

def polymorphic_type
  "#{name}_type" if polymorphic?
end

#to_sObject



96
97
98
99
100
# File 'lib/jsonapi/relationship.rb', line 96

def to_s
  # :nocov:
  "#{parent_resource}.#{name}(#{belongs_to? ? 'BelongsToOne' : 'ToOne'})"
  # :nocov:
end