Class: ActiveModel::Type::ImmutableString
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Value
|
|
Instance Chain:
self,
Value ,
SerializeCastValue
|
|
Inherits: |
ActiveModel::Type::Value
|
Defined in: | activemodel/lib/active_model/type/immutable_string.rb |
Overview
Active Model ImmutableString Type
::ActiveModel::Attribute
type to represent immutable strings. It casts incoming values to frozen strings.
class Person
include ActiveModel::Attributes
attribute :name, :immutable_string
end
person = Person.new
person.name = 1
person.name # => "1"
person.name.frozen? # => true
Values are coerced to strings using their to_s
method. Boolean values are treated differently, however: true
will be cast to "t"
and false
will be cast to "f"
. These strings can be customized when declaring an attribute:
class Person
include ActiveModel::Attributes
attribute :active, :immutable_string, true: "aye", false: "nay"
end
person = Person.new
person.active = true
person.active # => "aye"
Class Method Summary
- .new(**args) ⇒ ImmutableString constructor
Value
- Inherited
.new | Initializes a type with three basic configuration settings: precision, limit, and scale. |
Instance Attribute Summary
Value
- Inherited
#limit, #precision, #scale, | |
#binary? | These predicates are not documented, as I need to look further into their use, and see if they can be removed entirely. |
#mutable?, #serialized? |
Instance Method Summary
- #serialize(value)
- #type
- #cast_value(value) private
- #serialize_cast_value(value) Internal use only
Value
- Inherited
#==, #as_json, #assert_valid_value, | |
#cast |
|
#changed? | Determines whether a value has changed for dirty checking. |
#changed_in_place? | Determines whether the mutable value has been modified since it was read. |
#deserialize | Converts a value from database input to the appropriate ruby type. |
#eql? | Alias for Value#==. |
#hash, | |
#serializable? | Returns true if this type can convert |
#serialize | Casts a value from the ruby type to a type that the database knows how to understand. |
#type | Returns the unique type name as a |
#cast_value | Convenience method for types which do not need separate type casting behavior for user and database inputs. |
#force_equality?, #map, | |
#type_cast_for_schema |
|
#value_constructed_by_mass_assignment? |
SerializeCastValue
- Included
Constructor Details
.new(**args) ⇒ ImmutableString
# File 'activemodel/lib/active_model/type/immutable_string.rb', line 38
def initialize(**args) @true = -(args.delete(:true)&.to_s || "t") @false = -(args.delete(:false)&.to_s || "f") super end
Instance Method Details
#cast_value(value) (private)
[ GitHub ]# File 'activemodel/lib/active_model/type/immutable_string.rb', line 62
def cast_value(value) case value when true then @true when false then @false else value.to_s.freeze end end
#serialize(value)
[ GitHub ]# File 'activemodel/lib/active_model/type/immutable_string.rb', line 48
def serialize(value) case value when ::Numeric, ::Symbol, ActiveSupport::Duration then value.to_s when true then @true when false then @false else super end end
#serialize_cast_value(value)
# File 'activemodel/lib/active_model/type/immutable_string.rb', line 57
def serialize_cast_value(value) # :nodoc: value end
#type
[ GitHub ]# File 'activemodel/lib/active_model/type/immutable_string.rb', line 44
def type :string end