Class: DataMapper::Property::String

Inherits:
Object show all
Includes:
PassThroughLoadDump
Defined in:
lib/dm-core/property/string.rb

Direct Known Subclasses

Binary, Text

Constant Summary collapse

DEFAULT_LENGTH = 
50

Constants inherited from DataMapper::Property

INVALID_NAMES, OPTIONS, PRIMITIVES, VISIBILITY_OPTIONS

Instance Attribute Summary

Attributes inherited from DataMapper::Property

#allow_blank, #allow_nil, #default, #index, #instance_variable_name, #model, #name, #options, #primitive, #reader_visibility, #repository_name, #required, #unique_index, #writer_visibility

Instance Method Summary collapse

Methods included from PassThroughLoadDump

#dump, #load

Methods inherited from Object

#dump, #load, #to_child_key

Methods inherited from DataMapper::Property

accept_options, accepted_options, #allow_blank?, #allow_nil?, #assert_valid_options, #bind, demodulized_names, descendants, determine_class, #determine_visibility, #field, find_class, #get, #get!, inherited, #inspect, #key?, #lazy?, #lazy_load, #lazy_load_properties, #loaded?, nullable, options, #primitive?, #properties, #required?, #serial?, #set, #set!, #typecast, #unique?, #valid?

Methods included from Chainable

#chainable, #extendable

Methods included from Equalizer

#equalize

Methods included from Deprecate

#deprecate

Methods included from Subject

#default?, #default_for

Methods included from Assertions

#assert_kind_of

Constructor Details

#initialize(model, name, options = {}) ⇒ String (protected)

Returns a new instance of String.



30
31
32
33
 
# File 'lib/dm-core/property/string.rb', line 30

def initialize(model, name, options = {})
  super
  @length = @options.fetch(:length, DEFAULT_LENGTH)
end

Instance Method Details

#length ⇒ Integer?

Returns maximum property length (if applicable). This usually only makes sense when property is of type Range or custom

Returns:

  • (Integer, nil) —

    the maximum length of this property



20
21
22
23
24
25
26
 
# File 'lib/dm-core/property/string.rb', line 20

def length
  if @length.kind_of?(Range)
    @length.max
  else
    @length
  end
end

#typecast_to_primitive(value) ⇒ String (protected)

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.

Typecast a value to a String

Parameters:

  • value (#to_s) —

    value to typecast

Returns:

  • (String) —

    String constructed from value



44
45
46
 
# File 'lib/dm-core/property/string.rb', line 44

def typecast_to_primitive(value)
  value.to_s
end