module ActiveEntity::AttributeMethods
Active Entity Attribute Methods¶ ↑
Constants
- RESTRICTED_CLASS_METHODS
Public Instance Methods
Returns the value of the attribute identified by attr_name
after it has been typecast (for example, “2004-12-12” in a date column is cast to a date object, like Date.new(2004, 12, 12)). It raises ActiveModel::MissingAttributeError
if the identified attribute is missing.
Note: :id
is always present.
class Person < ActiveEntity::Base belongs_to :organization end person = Person.new(name: 'Francesco', age: '22') person[:name] # => "Francesco" person[:age] # => 22 person = Person.select('id').first person[:name] # => ActiveModel::MissingAttributeError: missing attribute: name person[:organization_id] # => ActiveModel::MissingAttributeError: missing attribute: organization_id
# File lib/active_entity/attribute_methods.rb, line 282 def [](attr_name) read_attribute(attr_name) { |n| missing_attribute(n, caller) } end
Updates the attribute identified by attr_name
with the specified value
. (Alias for the protected write_attribute
method).
class Person < ActiveEntity::Base end person = Person.new person[:age] = '22' person[:age] # => 22 person[:age].class # => Integer
# File lib/active_entity/attribute_methods.rb, line 296 def []=(attr_name, value) write_attribute(attr_name, value) end
Returns an #inspect
-like string for the value of the attribute attr_name
. String attributes are truncated up to 50 characters, Date and Time attributes are returned in the :db
format. Other attributes return the value of #inspect
without modification.
person = Person.create!(name: 'David Heinemeier Hansson ' * 3) person.attribute_for_inspect(:name) # => "\"David Heinemeier Hansson David Heinemeier Hansson ...\"" person.attribute_for_inspect(:created_at) # => "\"2012-10-22 00:15:07\"" person.attribute_for_inspect(:tag_ids) # => "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]"
# File lib/active_entity/attribute_methods.rb, line 238 def attribute_for_inspect(attr_name) attr_name = attr_name.to_s value = _read_attribute(attr_name) format_for_inspect(value) end
Returns an array of names for the attributes available on this object.
class Person < ActiveEntity::Base end person = Person.new person.attribute_names # => ["id", "created_at", "updated_at", "name", "age"]
# File lib/active_entity/attribute_methods.rb, line 206 def attribute_names @attributes.keys end
Returns true
if the specified attribute
has been set by the user or by a database load and is neither nil
nor empty?
(the latter only applies to objects that respond to empty?
, most notably Strings). Otherwise, false
. Note that it always returns true
with boolean attributes.
class Task < ActiveEntity::Base end task = Task.new(title: '', is_done: false) task.attribute_present?(:title) # => false task.attribute_present?(:is_done) # => true task.title = 'Buy milk' task.is_done = true task.attribute_present?(:title) # => true task.attribute_present?(:is_done) # => true
# File lib/active_entity/attribute_methods.rb, line 259 def attribute_present?(attr_name) attr_name = attr_name.to_s value = _read_attribute(attr_name) !value.nil? && !(value.respond_to?(:empty?) && value.empty?) end
Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
class Person < ActiveEntity::Base end person = Person.create(name: 'Francesco', age: 22) person.attributes # => {"id"=>3, "created_at"=>Sun, 21 Oct 2012 04:53:04, "updated_at"=>Sun, 21 Oct 2012 04:53:04, "name"=>"Francesco", "age"=>22}
# File lib/active_entity/attribute_methods.rb, line 218 def attributes @attributes.to_hash end
Returns true
if the given attribute is in the attributes hash, otherwise false
.
class Person < ActiveEntity::Base alias_attribute :new_name, :name end person = Person.new person.has_attribute?(:name) # => true person.has_attribute?(:new_name) # => true person.has_attribute?('age') # => true person.has_attribute?(:nothing) # => false
# File lib/active_entity/attribute_methods.rb, line 188 def has_attribute?(attr_name) attr_name = attr_name.to_s attr_name = self.class.attribute_aliases[attr_name] || attr_name @attributes.key?(attr_name) end
Private Instance Methods
# File lib/active_entity/attribute_methods.rb, line 302 def attribute_method?(attr_name) # We check defined? because Syck calls respond_to? before actually calling initialize. defined?(@attributes) && @attributes.key?(attr_name) end
# File lib/active_entity/attribute_methods.rb, line 307 def format_for_inspect(value) if value.is_a?(String) && value.length > 50 "#{value[0, 50]}...".inspect elsif value.is_a?(Date) || value.is_a?(Time) %("#{value.to_s(:db)}") else value.inspect end end
# File lib/active_entity/attribute_methods.rb, line 317 def pk_attribute?(name) name == @primary_key end