Module: ActiveRecord::AttributeMethods
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
|
|
Instance Chain:
|
|
Defined in: | activerecord/lib/active_record/attribute_methods.rb, activerecord/lib/active_record.rb, activerecord/lib/active_record/attribute_methods/before_type_cast.rb, activerecord/lib/active_record/attribute_methods/dirty.rb, activerecord/lib/active_record/attribute_methods/primary_key.rb, activerecord/lib/active_record/attribute_methods/query.rb, activerecord/lib/active_record/attribute_methods/read.rb, activerecord/lib/active_record/attribute_methods/serialization.rb, activerecord/lib/active_record/attribute_methods/time_zone_conversion.rb, activerecord/lib/active_record/attribute_methods/write.rb |
Constant Summary
-
RESTRICTED_CLASS_METHODS =
# File 'activerecord/lib/active_record/attribute_methods.rb', line 24%w(private public protected allocate new name parent superclass)
::ActiveModel::AttributeMethods
- Included
::ActiveModel::AttributeMethods
- Attributes & Methods
- .attribute_aliases rw
- #attribute_aliases readonly
- .attribute_aliases? ⇒ Boolean rw
- #attribute_aliases? ⇒ Boolean readonly
- .attribute_method_matchers rw
- #attribute_method_matchers readonly
- .attribute_method_matchers? ⇒ Boolean rw
- #attribute_method_matchers? ⇒ Boolean readonly
Class Method Summary
::ActiveSupport::Concern
- Extended
class_methods | Define class methods from given block. |
included | Evaluate given block in context of base class, so that you can write class macros here. |
prepended | Evaluate given block in context of base class, so that you can write class macros here. |
::ActiveSupport::Autoload
- Extended
Instance Method Summary
-
#[](attr_name)
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, likeDate.new
(2004, 12, 12)). -
#[]=(attr_name, value)
Updates the attribute identified by
attr_name
with the specifiedvalue
. -
#accessed_fields
Returns the name of all database fields which have been read from this model.
-
#attribute_for_inspect(attr_name)
Returns an
#inspect
-like string for the value of the attributeattr_name
. -
#attribute_names
Returns an array of names for the attributes available on this object.
-
#attribute_present?(attr_name) ⇒ Boolean
Returns
true
if the specifiedattribute
has been set by the user or by a database load and is neithernil
norempty?
(the latter only applies to objects that respond toempty?
, most notably Strings). -
#attributes
Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
-
#has_attribute?(attr_name) ⇒ Boolean
Returns
true
if the given attribute is in the attributes hash, otherwisefalse
. -
#respond_to?(name, include_private = false) ⇒ Boolean
A Person object with a name attribute can ask
person.respond_to?(:name)
,person.respond_to?(:name=)
, andperson.respond_to?(:name?)
which will all returntrue
.
::ActiveModel::AttributeMethods
- Included
#attribute_missing |
|
#method_missing | Allows access to the object attributes, which are held in the hash returned by #attributes, as though they were first-class methods. |
#respond_to?, | |
#respond_to_without_attributes? | A |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class ActiveModel::AttributeMethods
DSL Calls
included
[ GitHub ]12 13 14 15 16 17 18 19 20 21 22
# File 'activerecord/lib/active_record/attribute_methods.rb', line 12
included do initialize_generated_modules include Read include Write include BeforeTypeCast include Query include PrimaryKey include TimeZoneConversion include Dirty include Serialization end
Class Attribute Details
.attribute_aliases (rw)
[ GitHub ]# File 'activemodel/lib/active_model/attribute_methods.rb', line 72
class_attribute :attribute_aliases, instance_writer: false, default: {}
.attribute_aliases? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activemodel/lib/active_model/attribute_methods.rb', line 72
class_attribute :attribute_aliases, instance_writer: false, default: {}
.attribute_method_matchers (rw)
[ GitHub ]# File 'activemodel/lib/active_model/attribute_methods.rb', line 73
class_attribute :attribute_method_matchers, instance_writer: false, default: [ ClassMethods::AttributeMethodMatcher.new ]
.attribute_method_matchers? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activemodel/lib/active_model/attribute_methods.rb', line 73
class_attribute :attribute_method_matchers, instance_writer: false, default: [ ClassMethods::AttributeMethodMatcher.new ]
Instance Attribute Details
#attribute_aliases (readonly)
[ GitHub ]# File 'activemodel/lib/active_model/attribute_methods.rb', line 72
class_attribute :attribute_aliases, instance_writer: false, default: {}
#attribute_aliases? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activemodel/lib/active_model/attribute_methods.rb', line 72
class_attribute :attribute_aliases, instance_writer: false, default: {}
#attribute_method_matchers (readonly)
[ GitHub ]# File 'activemodel/lib/active_model/attribute_methods.rb', line 73
class_attribute :attribute_method_matchers, instance_writer: false, default: [ ClassMethods::AttributeMethodMatcher.new ]
#attribute_method_matchers? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activemodel/lib/active_model/attribute_methods.rb', line 73
class_attribute :attribute_method_matchers, instance_writer: false, default: [ ClassMethods::AttributeMethodMatcher.new ]
Instance Method Details
#[](attr_name)
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 < ActiveRecord::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 'activerecord/lib/active_record/attribute_methods.rb', line 330
def [](attr_name) read_attribute(attr_name) { |n| missing_attribute(n, caller) } end
#[]=(attr_name, value)
Updates the attribute identified by attr_name
with the specified value
. (Alias for the protected #write_attribute
method).
class Person < ActiveRecord::Base
end
person = Person.new
person[:age] = '22'
person[:age] # => 22
person[:age].class # => Integer
# File 'activerecord/lib/active_record/attribute_methods.rb', line 344
def []=(attr_name, value) write_attribute(attr_name, value) end
#accessed_fields
Returns the name of all database fields which have been read from this model. This can be useful in development mode to determine which fields need to be selected. For performance critical pages, selecting only the required fields can be an easy performance win (assuming you aren’t using all of the fields on the model).
For example:
class PostsController < ActionController::Base
after_action :print_accessed_fields, only: :index
def index
@posts = Post.all
end
private
def print_accessed_fields
p @posts.first.accessed_fields
end
end
Which allows you to quickly change your code to:
class PostsController < ActionController::Base
def index
@posts = Post.select(:id, :title, :, :updated_at)
end
end
# File 'activerecord/lib/active_record/attribute_methods.rb', line 377
def accessed_fields @attributes.accessed end
#attribute_for_inspect(attr_name)
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 'activerecord/lib/active_record/attribute_methods.rb', line 284
def attribute_for_inspect(attr_name) attr_name = attr_name.to_s attr_name = self.class.attribute_aliases[attr_name] || attr_name value = _read_attribute(attr_name) format_for_inspect(attr_name, value) end
#attribute_names
Returns an array of names for the attributes available on this object.
class Person < ActiveRecord::Base
end
person = Person.new
person.attribute_names
# => ["id", "created_at", "updated_at", "name", "age"]
# File 'activerecord/lib/active_record/attribute_methods.rb', line 252
def attribute_names @attributes.keys end
#attribute_present?(attr_name) ⇒ Boolean
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 < ActiveRecord::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 'activerecord/lib/active_record/attribute_methods.rb', line 306
def attribute_present?(attr_name) attr_name = attr_name.to_s attr_name = self.class.attribute_aliases[attr_name] || attr_name value = _read_attribute(attr_name) !value.nil? && !(value.respond_to?(:empty?) && value.empty?) end
#attributes
Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
class Person < ActiveRecord::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 'activerecord/lib/active_record/attribute_methods.rb', line 264
def attributes @attributes.to_hash end
#has_attribute?(attr_name) ⇒ Boolean
Returns true
if the given attribute is in the attributes hash, otherwise false
.
class Person < ActiveRecord::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 'activerecord/lib/active_record/attribute_methods.rb', line 234
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
#respond_to?(name, include_private = false) ⇒ Boolean
A Person object with a name attribute can ask person.respond_to?(:name)
, person.respond_to?(:name=)
, and person.respond_to?(:name?)
which will all return true
. It also defines the attribute methods if they have not been generated.
class Person < ActiveRecord::Base
end
person = Person.new
person.respond_to?(:name) # => true
person.respond_to?(:name=) # => true
person.respond_to?(:name?) # => true
person.respond_to?('age') # => true
person.respond_to?('age=') # => true
person.respond_to?('age?') # => true
person.respond_to?(:nothing) # => false
# File 'activerecord/lib/active_record/attribute_methods.rb', line 207
def respond_to?(name, include_private = false) return false unless super # If the result is true then check for the select case. # For queries selecting a subset of columns, return false for unselected columns. # We check defined?(@attributes) not to issue warnings if called on objects that # have been allocated but not yet initialized. if defined?(@attributes) if name = self.class.symbol_column_to_string(name.to_sym) return _has_attribute?(name) end end true end