Module: ActiveRecord::Core

Extended by:
ActiveSupport::Concern
Included in:
Base
Defined in:
activerecord/lib/active_record/core.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Instance Method Details

#<=>(other_object) ⇒ Object

Allows sort on objects


483
484
485
486
487
488
489
# File 'activerecord/lib/active_record/core.rb', line 483

def <=>(other_object)
  if other_object.is_a?(self.class)
    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.


450
451
452
453
454
455
# File 'activerecord/lib/active_record/core.rb', line 450

def ==(comparison_object)
  super ||
    comparison_object.instance_of?(self.class) &&
    !id.nil? &&
    comparison_object.id == id
end

#blank?Boolean

:nodoc:

Returns:

  • (Boolean)

495
496
497
# File 'activerecord/lib/active_record/core.rb', line 495

def blank? # :nodoc:
  false
end

#connection_handlerObject


518
519
520
# File 'activerecord/lib/active_record/core.rb', line 518

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, ... }}

435
436
437
438
439
# File 'activerecord/lib/active_record/core.rb', line 435

def encode_with(coder)
  self.class.yaml_encoder.encode(@attributes, coder)
  coder["new_record"] = new_record?
  coder["active_record_yaml_version"] = 2
end

#freezeObject

Clone and freeze the attributes hash such that associations are still accessible, even on destroyed records, but cloned models will not be frozen.


471
472
473
474
# File 'activerecord/lib/active_record/core.rb', line 471

def freeze
  @attributes = @attributes.clone.freeze
  self
end

#frozen?Boolean

Returns true if the attributes hash has been frozen.

Returns:

  • (Boolean)

477
478
479
480
# File 'activerecord/lib/active_record/core.rb', line 477

def frozen?
  sync_with_transaction_state if @transaction_state&.finalized?
  @attributes.frozen?
end

#hashObject

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) ]

460
461
462
463
464
465
466
# File 'activerecord/lib/active_record/core.rb', line 460

def hash
  if id
    self.class.hash ^ id.hash
  else
    super
  end
end

#init_with(coder, &block) ⇒ Object

Initialize an empty model object from coder. coder should be the result of previously encoding an Active Record model, using #encode_with.

class Post < ActiveRecord::Base
end

old_post = Post.new(title: "hello world")
coder = {}
old_post.encode_with(coder)

post = Post.allocate
post.init_with(coder)
post.title # => 'hello world'

357
358
359
360
361
# File 'activerecord/lib/active_record/core.rb', line 357

def init_with(coder, &block)
  coder = LegacyYamlAdapter.convert(self.class, coder)
  attributes = self.class.yaml_encoder.decode(coder)
  init_with_attributes(attributes, coder["new_record"], &block)
end

#init_with_attributes(attributes, new_record = false) {|_self| ... } ⇒ Object

Initialize an empty model object from attributes. attributes should be an attributes object, and unlike the `initialize` method, no assignment calls are made per attribute.

Yields:

  • (_self)

Yield Parameters:


367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'activerecord/lib/active_record/core.rb', line 367

def init_with_attributes(attributes, new_record = false) # :nodoc:
  @new_record = new_record
  @attributes = attributes

  init_internals

  yield self if block_given?

  _run_find_callbacks
  _run_initialize_callbacks

  self
end

#initialize(attributes = nil) {|_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')

Yields:

  • (_self)

Yield Parameters:


330
331
332
333
334
335
336
337
338
339
340
341
# File 'activerecord/lib/active_record/core.rb', line 330

def initialize(attributes = nil)
  @new_record = true
  @attributes = self.class._default_attributes.deep_dup

  init_internals
  initialize_internals_callback

  assign_attributes(attributes) if attributes

  yield self if block_given?
  _run_initialize_callbacks
end

#initialize_dup(other) ⇒ Object

:nodoc:


408
409
410
411
412
413
414
415
416
417
418
419
420
421
# File 'activerecord/lib/active_record/core.rb', line 408

def initialize_dup(other) # :nodoc:
  @attributes = @attributes.deep_dup
  @attributes.reset(@primary_key)

  _run_initialize_callbacks

  @new_record               = true
  @previously_new_record    = false
  @destroyed                = false
  @_start_transaction_state = nil
  @transaction_state        = nil

  super
end

#inspectObject

Returns the contents of the record as a nicely formatted string.


523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
# File 'activerecord/lib/active_record/core.rb', line 523

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.attribute_names.collect do |name|
      if has_attribute?(name)
        attr = _read_attribute(name)
        value = if attr.nil?
          attr.inspect
        else
          attr = format_for_inspect(attr)
          inspection_filter.filter_param(name, attr)
        end
        "#{name}: #{value}"
      end
    end.compact.join(", ")
  else
    "not initialized"
  end

  "#<#{self.class} #{inspection}>"
end

#present?Boolean

:nodoc:

Returns:

  • (Boolean)

491
492
493
# File 'activerecord/lib/active_record/core.rb', line 491

def present? # :nodoc:
  true
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.


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
# File 'activerecord/lib/active_record/core.rb', line 548

def pretty_print(pp)
  return super if custom_inspect_method_defined?
  pp.object_address_group(self) do
    if defined?(@attributes) && @attributes
      attr_names = self.class.attribute_names.select { |name| has_attribute?(name) }
      pp.seplist(attr_names, proc { pp.text "," }) do |attr_name|
        pp.breakable " "
        pp.group(1) do
          pp.text attr_name
          pp.text ":"
          pp.breakable
          value = _read_attribute(attr_name)
          value = inspection_filter.filter_param(attr_name, value) unless value.nil?
          pp.pp value
        end
      end
    else
      pp.breakable " "
      pp.text "not initialized"
    end
  end
end

#readonly!Object

Marks this record as read only.


514
515
516
# File 'activerecord/lib/active_record/core.rb', line 514

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.

Returns:

  • (Boolean)

501
502
503
# File 'activerecord/lib/active_record/core.rb', line 501

def readonly?
  @readonly
end

#slice(*methods) ⇒ Object

Returns a hash of the given methods with their names as keys and returned values as values.


572
573
574
# File 'activerecord/lib/active_record/core.rb', line 572

def slice(*methods)
  Hash[methods.flatten.map! { |method| [method, public_send(method)] }].with_indifferent_access
end

#strict_loading!Object


509
510
511
# File 'activerecord/lib/active_record/core.rb', line 509

def strict_loading!
  @strict_loading = true
end

#strict_loading?Boolean

Returns:

  • (Boolean)

505
506
507
# File 'activerecord/lib/active_record/core.rb', line 505

def strict_loading?
  @strict_loading
end