Module: ActiveRecord::Core
Defined Under Namespace
Modules: ClassMethods
Instance Method Summary collapse
-
#<=>(other_object) ⇒ Object
Allows sort on objects.
-
#==(comparison_object) ⇒ Object
(also: #eql?)
Returns true if
comparison_object
is the same exact object, orcomparison_object
is of the same type andself
has an ID and it is equal tocomparison_object.id
. - #connection_handler ⇒ Object
-
#encode_with(coder) ⇒ Object
Populate
coder
with attributes about this record that should be serialized. -
#freeze ⇒ Object
Clone and freeze the attributes hash such that associations are still accessible, even on destroyed records, but cloned models will not be frozen.
-
#frozen? ⇒ Boolean
Returns
true
if the attributes hash has been frozen. -
#has_transactional_callbacks? ⇒ Boolean
:nodoc:.
-
#hash ⇒ Object
Delegates to id in order to allow two records of the same type and id to work with something like: [ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ].
-
#init_with(coder) ⇒ Object
Initialize an empty model object from
coder
. -
#initialize(attributes = nil, options = {}) {|_self| ... } ⇒ Object
New objects can be instantiated as either empty (pass no construction parameter) or pre-set with attributes but not yet saved (pass a hash with key names matching the associated table column names).
-
#initialize_dup(other) ⇒ Object
:nodoc:.
-
#inspect ⇒ Object
Returns the contents of the record as a nicely formatted string.
-
#pretty_print(pp) ⇒ Object
Takes a PP and prettily prints this record to it, allowing you to get a nice result from ‘pp record` when pp is required.
-
#readonly! ⇒ Object
Marks this record as read only.
-
#readonly? ⇒ Boolean
Returns
true
if the record is read only. -
#set_transaction_state(state) ⇒ Object
:nodoc:.
-
#slice(*methods) ⇒ Object
Returns a hash of the given methods with their names as keys and returned values as values.
Instance Method Details
#<=>(other_object) ⇒ Object
Allows sort on objects
414 415 416 417 418 419 420 |
# File 'lib/active_record/core.rb', line 414 def <=>(other_object) if other_object.is_a?(self.class) self.to_key <=> other_object.to_key else super end end |
#==(comparison_object) ⇒ Object Also known as: eql?
Returns true if comparison_object
is the same exact object, or comparison_object
is of the same type and self
has an ID and it is equal to comparison_object.id
.
Note that new records are different from any other record by definition, unless the other record is the receiver itself. Besides, if you fetch existing records with select
and leave the ID out, you’re on your own, this predicate will return false.
Note also that destroying a record preserves its ID in the model instance, so deleted models are still comparable.
382 383 384 385 386 387 |
# File 'lib/active_record/core.rb', line 382 def ==(comparison_object) super || comparison_object.instance_of?(self.class) && !id.nil? && comparison_object.id == id end |
#connection_handler ⇒ Object
433 434 435 |
# File 'lib/active_record/core.rb', line 433 def connection_handler self.class.connection_handler end |
#encode_with(coder) ⇒ Object
Populate coder
with attributes about this record that should be serialized. The structure of coder
defined in this method is guaranteed to match the structure of coder
passed to the init_with
method.
Example:
class Post < ActiveRecord::Base
end
coder = {}
Post.new.encode_with(coder)
coder # => {"attributes" => {"id" => nil, ... }}
366 367 368 369 370 371 |
# File 'lib/active_record/core.rb', line 366 def encode_with(coder) # FIXME: Remove this when we better serialize attributes coder['raw_attributes'] = attributes_before_type_cast coder['attributes'] = @attributes coder['new_record'] = new_record? end |
#freeze ⇒ Object
Clone and freeze the attributes hash such that associations are still accessible, even on destroyed records, but cloned models will not be frozen.
403 404 405 406 |
# File 'lib/active_record/core.rb', line 403 def freeze @attributes = @attributes.clone.freeze self end |
#frozen? ⇒ Boolean
Returns true
if the attributes hash has been frozen.
409 410 411 |
# File 'lib/active_record/core.rb', line 409 def frozen? @attributes.frozen? end |
#has_transactional_callbacks? ⇒ Boolean
:nodoc:
486 487 488 |
# File 'lib/active_record/core.rb', line 486 def has_transactional_callbacks? # :nodoc: !_rollback_callbacks.empty? || !_commit_callbacks.empty? || !_create_callbacks.empty? end |
#hash ⇒ Object
Delegates to id in order to allow two records of the same type and id to work with something like:
[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
392 393 394 395 396 397 398 |
# File 'lib/active_record/core.rb', line 392 def hash if id id.hash else super end end |
#init_with(coder) ⇒ Object
Initialize an empty model object from coder
. coder
must contain the attributes necessary for initializing an empty model object. For example:
class Post < ActiveRecord::Base
end
post = Post.allocate
post.init_with('attributes' => { 'title' => 'hello world' })
post.title # => 'hello world'
297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/active_record/core.rb', line 297 def init_with(coder) @attributes = coder['attributes'] init_internals @new_record = coder['new_record'] self.class.define_attribute_methods _run_find_callbacks _run_initialize_callbacks self end |
#initialize(attributes = nil, options = {}) {|_self| ... } ⇒ Object
New objects can be instantiated as either empty (pass no construction parameter) or pre-set with attributes but not yet saved (pass a hash with key names matching the associated table column names). In both instances, valid attribute keys are determined by the column names of the associated table – hence you can’t have attributes that aren’t part of the table columns.
Example:
# Instantiates a single new object
User.new(first_name: 'Jamie')
272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/active_record/core.rb', line 272 def initialize(attributes = nil, = {}) @attributes = self.class._default_attributes.dup self.class.define_attribute_methods init_internals initialize_internals_callback # +options+ argument is only needed to make protected_attributes gem easier to hook. # Remove it when we drop support to this gem. init_attributes(attributes, ) if attributes yield self if block_given? _run_initialize_callbacks end |
#initialize_dup(other) ⇒ Object
:nodoc:
339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/active_record/core.rb', line 339 def initialize_dup(other) # :nodoc: @attributes = @attributes.dup @attributes.reset(self.class.primary_key) _run_initialize_callbacks @aggregation_cache = {} @association_cache = {} @new_record = true @destroyed = false super end |
#inspect ⇒ Object
Returns the contents of the record as a nicely formatted string.
438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/active_record/core.rb', line 438 def inspect # We check defined?(@attributes) not to issue warnings if the object is # allocated but not initialized. inspection = if defined?(@attributes) && @attributes self.class.column_names.collect { |name| if has_attribute?(name) "#{name}: #{attribute_for_inspect(name)}" end }.compact.join(", ") else "not initialized" end "#<#{self.class} #{inspection}>" end |
#pretty_print(pp) ⇒ Object
Takes a PP and prettily prints this record to it, allowing you to get a nice result from ‘pp record` when pp is required.
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/active_record/core.rb', line 455 def pretty_print(pp) return super if custom_inspect_method_defined? pp.object_address_group(self) do if defined?(@attributes) && @attributes column_names = self.class.column_names.select { |name| has_attribute?(name) || new_record? } pp.seplist(column_names, proc { pp.text ',' }) do |column_name| column_value = read_attribute(column_name) pp.breakable ' ' pp.group(1) do pp.text column_name pp.text ':' pp.breakable pp.pp column_value end end else pp.breakable ' ' pp.text 'not initialized' end end end |
#readonly! ⇒ Object
Marks this record as read only.
429 430 431 |
# File 'lib/active_record/core.rb', line 429 def readonly! @readonly = true end |
#readonly? ⇒ Boolean
Returns true
if the record is read only. Records loaded through joins with piggy-back attributes will be marked as read only since they cannot be saved.
424 425 426 |
# File 'lib/active_record/core.rb', line 424 def readonly? @readonly end |
#set_transaction_state(state) ⇒ Object
:nodoc:
482 483 484 |
# File 'lib/active_record/core.rb', line 482 def set_transaction_state(state) # :nodoc: @transaction_state = state end |
#slice(*methods) ⇒ Object
Returns a hash of the given methods with their names as keys and returned values as values.
478 479 480 |
# File 'lib/active_record/core.rb', line 478 def slice(*methods) Hash[methods.map! { |method| [method, public_send(method)] }].with_indifferent_access end |