Module: Mongoid::Extensions::String

Defined in:
lib/mongoid/extensions/string.rb

Overview

Adds type-casting behavior to String class.

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#unconvertable_to_bson ⇒ Object

Deprecated. 


12
13
14
 
# File 'lib/mongoid/extensions/string.rb', line 12

def unconvertable_to_bson
  @unconvertable_to_bson
end

#unconvertable_to_bson If the document is unconvertable.(Ifthedocumentisunconvertable.) ⇒ Object

Deprecated. 


12
 
# File 'lib/mongoid/extensions/string.rb', line 12

attr_accessor :unconvertable_to_bson

Instance Method Details

#__evolve_object_id__ ⇒ String | BSON::ObjectId

Evolve the string into an object id if possible.

Examples:

Evolve the string.

"test".__evolve_object_id__

Returns:

  • (String | BSON::ObjectId) —

    The evolved string.



21
22
23
 
# File 'lib/mongoid/extensions/string.rb', line 21

def __evolve_object_id__
  convert_to_object_id
end

#__mongoize_object_id__ ⇒ String | BSON::ObjectId | nil

Mongoize the string into an object id if possible.

Examples:

Evolve the string.

"test".__mongoize_object_id__

Returns:

  • (String | BSON::ObjectId | nil) —

    The mongoized string.



31
32
33
 
# File 'lib/mongoid/extensions/string.rb', line 31

def __mongoize_object_id__
  convert_to_object_id unless blank?
end

#__mongoize_time__ ⇒ Time | ActiveSupport::TimeWithZone

Note:

Returns a local time in the default time zone.

Mongoize the string for storage.

Examples:

Mongoize the string.

"2012-01-01".__mongoize_time__
# => 2012-01-01 00:00:00 -0500

Returns:

  • (Time | ActiveSupport::TimeWithZone) —

    Local time in the configured default time zone corresponding to this string.

Raises:

  • (ArgumentError) —

    The string is not a valid time string.



47
48
49
50
51
52
53
54
 
# File 'lib/mongoid/extensions/string.rb', line 47

def __mongoize_time__
  # This extra Time.parse is required to raise an error if the string
  # is not a valid time string. ActiveSupport::TimeZone does not
  # perform this check.
  ::Time.parse(self)

  ::Time.zone.parse(self)
end

#before_type_cast? ⇒ true | false

Does the string end with _before_type_cast?

Examples:

Is the string a setter method?

"price_before_type_cast".before_type_cast?

Returns:

  • (true | false) —

    If the string ends with “_before_type_cast”



127
128
129
 
# File 'lib/mongoid/extensions/string.rb', line 127

def before_type_cast?
  ends_with?("_before_type_cast")
end

#collectionize ⇒ String

Convert the string to a collection friendly name.

Examples:

Collectionize the string.

"namespace/model".collectionize

Returns:

  • (String) —

    The string in collection friendly form.



62
63
64
 
# File 'lib/mongoid/extensions/string.rb', line 62

def collectionize
  tableize.gsub("/", "_")
end

#mongoid_id? ⇒ true | false

Deprecated.

Is the string a valid value for a Mongoid id?

Examples:

Is the string an id value?

"_id".mongoid_id?

Returns:

  • (true | false) —

    If the string is id or _id.



73
74
75
 
# File 'lib/mongoid/extensions/string.rb', line 73

def mongoid_id?
  self =~ /\A(|_)id\z/
end

#numeric? ⇒ true | false

Is the string a number? The literals “NaN”, “Infinity”, and “-Infinity” are counted as numbers.

Examples:

Is the string a number.

"1234.23".numeric?

Returns:

  • (true | false) —

    If the string is a number.



85
86
87
88
89
 
# File 'lib/mongoid/extensions/string.rb', line 85

def numeric?
  !!Float(self)
rescue ArgumentError
  (self =~ /\A(?:NaN|-?Infinity)\z/) == 0
end

#reader ⇒ String

Get the string as a getter string.

Examples:

Get the reader/getter

"model=".reader

Returns:

  • (String) —

    The string stripped of “=”.



97
98
99
 
# File 'lib/mongoid/extensions/string.rb', line 97

def reader
  delete("=").sub(/\_before\_type\_cast\z/, '')
end

#unconvertable_to_bson? ⇒ true | false

Deprecated.

Is the object not to be converted to bson on criteria creation?

Examples:

Is the object unconvertable?

object.unconvertable_to_bson?

Returns:

  • (true | false) —

    If the object is unconvertable.



139
140
141
 
# File 'lib/mongoid/extensions/string.rb', line 139

def unconvertable_to_bson?
  @unconvertable_to_bson ||= false
end

#valid_method_name? ⇒ true | false

Is this string a valid_method_name?

Examples:

Is the string a valid Ruby identifier for use as a method name

"model=".valid_method_name?

Returns:

  • (true | false) —

    If the string contains a valid Ruby identifier.



117
118
119
 
# File 'lib/mongoid/extensions/string.rb', line 117

def valid_method_name?
  /[@$"-]/ !~ self
end

#writer? ⇒ true | false

Is this string a writer?

Examples:

Is the string a setter method?

"model=".writer?

Returns:

  • (true | false) —

    If the string contains “=”.



107
108
109
 
# File 'lib/mongoid/extensions/string.rb', line 107

def writer?
  include?("=")
end