Module: DataMapper::Model::Property

Extended by:
Chainable
Defined in:
lib/dm-core/model/property.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Chainable

chainable, extendable

Class Method Details

.extended(model) ⇒ Object 



14
15
16
17
18
 
# File 'lib/dm-core/model/property.rb', line 14

def self.extended(model)
  model.instance_variable_set(:@properties,               {})
  model.instance_variable_set(:@field_naming_conventions, {})
  model.instance_variable_set(:@paranoid_properties,      {})
end

Instance Method Details

#field_naming_convention(repository_name = default_storage_name) ⇒ #call

Gets the field naming conventions for this resource in the given Repository

Parameters:

  • repository_name (String, Symbol) (defaults to: default_storage_name) —

    the name of the Repository for which the field naming convention will be retrieved

Returns:

  • (#call) —

    The naming convention for the given Repository



170
171
172
 
# File 'lib/dm-core/model/property.rb', line 170

def field_naming_convention(repository_name = default_storage_name)
  @field_naming_conventions[repository_name] ||= repository(repository_name).adapter.field_naming_convention
end

#key(repository_name = default_repository_name) ⇒ Array

Gets the list of key fields for this Model in repository_name

Parameters:

  • repository_name (String) (defaults to: default_repository_name) —

    The name of the Repository for which the key is to be reported

Returns:

  • (Array) —

    The list of key fields for this Model in repository_name



151
152
153
 
# File 'lib/dm-core/model/property.rb', line 151

def key(repository_name = default_repository_name)
  properties(repository_name).key
end

#key_conditions(repository, key) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



198
199
200
 
# File 'lib/dm-core/model/property.rb', line 198

def key_conditions(repository, key)
  self.key(repository.name).zip(key.nil? ? [] : key).to_hash
end

#paranoid_properties ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



188
189
190
 
# File 'lib/dm-core/model/property.rb', line 188

def paranoid_properties
  @paranoid_properties
end

#properties(repository_name = default_repository_name) ⇒ Array

Gets a list of all properties that have been defined on this Model in the requested repository

Parameters:

  • repository_name (Symbol, String) (defaults to: default_repository_name) —

    The name of the repository to use. Uses the default Repository if none is specified.

Returns:

  • (Array) —

    A list of Properties defined on this Model in the given Repository



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/dm-core/model/property.rb', line 127

def properties(repository_name = default_repository_name)
  # TODO: create PropertySet#copy that will copy the properties, but assign the
  # new Relationship objects to a supplied repository and model.  dup does not really
  # do what is needed
  repository_name = repository_name.to_sym

  default_repository_name = self.default_repository_name

  @properties[repository_name] ||= if repository_name == default_repository_name
    PropertySet.new
  else
    properties(default_repository_name).dup
  end
end

#properties_with_subclasses(repository_name = default_repository_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/dm-core/model/property.rb', line 175

def properties_with_subclasses(repository_name = default_repository_name)
  properties = properties(repository_name).dup

  descendants.each do |model|
    model.properties(repository_name).each do |property|
      properties[property.name] ||= property
    end
  end

  properties
end

#property(name, type, options = {}) ⇒ Property

Defines a Property on the Resource

Parameters:

  • name (Symbol) —

    the name for which to call this property

  • type (Type) —

    the type to define this property ass

  • options (Hash(Symbol => String)) (defaults to: {}) —

    a hash of available options

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/dm-core/model/property.rb', line 50

def property(name, type, options = {})
  caller_method = caller[2]

  if TrueClass == type
    warn "#{type} is deprecated, use Boolean instead at #{caller_method}"
    type = DataMapper::Property::Boolean
  elsif BigDecimal == type
    warn "#{type} is deprecated, use Decimal instead at #{caller_method}"
    type = DataMapper::Property::Decimal
  end

  # if the type can be found within Property then
  # use that class rather than the primitive
  klass = DataMapper::Property.determine_class(type)

  unless klass
    raise ArgumentError, "+type+ was #{type.inspect}, which is not a supported type"
  end

  property = klass.new(self, name, options, type < DataMapper::Type ? type : nil)

  repository_name = self.repository_name
  properties      = properties(repository_name)

  properties << property

  # Add property to the other mappings as well if this is for the default
  # repository.
  if repository_name == default_repository_name
    @properties.except(repository_name).each do |repository_name, properties|
      next if properties.named?(name)

      # make sure the property is created within the correct repository scope
      DataMapper.repository(repository_name) do
        properties << klass.new(self, name, options, type)
      end
    end
  end

  # Add the property to the lazy_loads set for this resources repository
  # only.
  # TODO Is this right or should we add the lazy contexts to all
  # repositories?
  if property.lazy?
    context = options.fetch(:lazy, :default)
    context = :default if context == true

    Array(context).each do |context|
      properties.lazy_context(context) << self
    end
  end

  # add the property to the child classes only if the property was
  # added after the child classes' properties have been copied from
  # the parent
  descendants.each do |descendant|
    descendant.properties(repository_name)[name] ||= property
  end

  create_reader_for(property)
  create_writer_for(property)

  # FIXME: explicit return needed for YARD to parse this properly
  return property
end

#serial(repository_name = default_repository_name) ⇒ Object 



156
157
158
 
# File 'lib/dm-core/model/property.rb', line 156

def serial(repository_name = default_repository_name)
  key(repository_name).detect { |property| property.serial? }
end

#set_paranoid_property(name, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



193
194
195
 
# File 'lib/dm-core/model/property.rb', line 193

def set_paranoid_property(name, &block)
  paranoid_properties[name] = block
end