Module: Mongoid::Extensions::String

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

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#unconvertable_to_bson ⇒ Object

Returns the value of attribute unconvertable_to_bson.



7
8
9
 
# File 'lib/mongoid/extensions/string.rb', line 7

def unconvertable_to_bson
  @unconvertable_to_bson
end

#unconvertable_to_bson If the document is unconvetable.(Ifthedocumentisunconvetable.) ⇒ Object 



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

attr_accessor :unconvertable_to_bson

Instance Method Details

#__evolve_object_id__ ⇒ String, Moped::BSON::ObjectId

Evolve the string into an object id if possible.

Examples:

Evolve the string.

"test".__evolve_object_id__

Returns:

Since:

  • 3.0.0



17
18
19
 
# File 'lib/mongoid/extensions/string.rb', line 17

def __evolve_object_id__
  convert_to_object_id
end

#__mongoize_object_id__ ⇒ String, ...

Mongoize the string into an object id if possible.

Examples:

Evolve the string.

"test".__mongoize_object_id__

Returns:

Since:

  • 3.0.0



29
30
31
 
# File 'lib/mongoid/extensions/string.rb', line 29

def __mongoize_object_id__
  convert_to_object_id unless blank?
end

#__mongoize_time__ ⇒ Time

Note:

The extra parse from Time is because ActiveSupport::TimeZone either returns nil or Time.now if the string is empty or invalid, which is a regression from pre-3.0 and also does not agree with the core Time API.

Mongoize the string for storage.

Examples:

Mongoize the string.

"2012-01-01".__mongoize_time__

Returns:

  • (Time) —

    The time.

Since:

  • 3.0.0



46
47
48
49
 
# File 'lib/mongoid/extensions/string.rb', line 46

def __mongoize_time__
  ::Time.parse(self)
  ::Time.configured.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”

Since:

  • 3.1.0



143
144
145
 
# File 'lib/mongoid/extensions/string.rb', line 143

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.

Since:

  • 1.0.0



59
60
61
 
# File 'lib/mongoid/extensions/string.rb', line 59

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

#mongoid_id? ⇒ true, false

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.

Since:

  • 2.3.1



71
72
73
 
# File 'lib/mongoid/extensions/string.rb', line 71

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

#numeric? ⇒ true, false

Is the string a number?

Examples:

Is the string a number.

"1234.23".numeric?

Returns:

  • (true, false) —

    If the string is a number.

Since:

  • 3.0.0



83
84
85
 
# File 'lib/mongoid/extensions/string.rb', line 83

def numeric?
  true if Float(self) rescue (self == "NaN")
end

#reader ⇒ String

Get the string as a getter string.

Examples:

Get the reader/getter

"model=".reader

Returns:

  • (String) —

    The string stripped of “=”.

Since:

  • 1.0.0



95
96
97
 
# File 'lib/mongoid/extensions/string.rb', line 95

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

#to_a ⇒ Array

Convert the string to an array with the string in it.

Examples:

Convert the string to an array.

"Testing".to_a

Returns:

  • (Array) —

    An array with only the string in it.

Since:

  • 1.0.0



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

def to_a
  [ self ]
end

#unconvertable_to_bson? ⇒ true, false

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.

Since:

  • 2.2.1



155
156
157
 
# File 'lib/mongoid/extensions/string.rb', line 155

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 idenfier for use as a method name

"model=".valid_method_name?

Returns:

  • (true, false) —

    If the string contains a valid Ruby identifier.

Since:

  • 3.0.15



131
132
133
 
# File 'lib/mongoid/extensions/string.rb', line 131

def valid_method_name?
  /[@$"]/ !~ to_sym.inspect
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 “=”.

Since:

  • 1.0.0



119
120
121
 
# File 'lib/mongoid/extensions/string.rb', line 119

def writer?
  include?("=")
end