Module: ActiveRecord::Core

Extended by:
ActiveSupport::Concern
Includes:
ActiveModel::Access
Included in:
Base
Defined in:
lib/active_record/core.rb

Overview

Active Record Core

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#strict_loading_mode ⇒ Object (readonly)

Returns the value of attribute strict_loading_mode.



703
704
705
 
# File 'lib/active_record/core.rb', line 703

def strict_loading_mode
  @strict_loading_mode
end

Instance Method Details

#<=>(other_object) ⇒ Object

Allows sort on objects



639
640
641
642
643
644
645
 
# File 'lib/active_record/core.rb', line 639

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.



605
606
607
608
609
610
 
# File 'lib/active_record/core.rb', line 605

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

#blank? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


651
652
653
 
# File 'lib/active_record/core.rb', line 651

def blank? # :nodoc:
  false
end

#connection_handler ⇒ Object 



724
725
726
 
# File 'lib/active_record/core.rb', line 724

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



561
562
563
564
565
 
# File 'lib/active_record/core.rb', line 561

def encode_with(coder)
  self.class.yaml_encoder.encode(@attributes, coder)
  coder["new_record"] = new_record?
  coder["active_record_yaml_version"] = 2
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.



628
629
630
631
 
# File 'lib/active_record/core.rb', line 628

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

#frozen? ⇒ Boolean

Returns true if the attributes hash has been frozen.

Returns:

  • (Boolean) 


634
635
636
 
# File 'lib/active_record/core.rb', line 634

def frozen?
  @attributes.frozen?
end

#full_inspect ⇒ Object

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



734
735
736
 
# File 'lib/active_record/core.rb', line 734

def full_inspect
  inspect_with_attributes(all_attributes_for_inspect)
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) ]



615
616
617
618
619
620
621
622
623
 
# File 'lib/active_record/core.rb', line 615

def hash
  id = self.id

  if primary_key_values_present?
    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'



479
480
481
482
483
 
# File 'lib/active_record/core.rb', line 479

def init_with(coder, &block)
  coder = LegacyYamlAdapter.convert(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:



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/active_record/core.rb', line 489

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:



452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/active_record/core.rb', line 452

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

  init_internals
  initialize_internals_callback

  super

  yield self if block_given?
  _run_initialize_callbacks
end

#initialize_dup(other) ⇒ Object

:nodoc:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/active_record/core.rb', line 531

def initialize_dup(other) # :nodoc:
  @attributes = @attributes.deep_dup
  if self.class.composite_primary_key?
    @primary_key.each { |key| @attributes.reset(key) }
  else
    @attributes.reset(@primary_key)
  end

  _run_initialize_callbacks

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

  super
end

#inspect ⇒ Object

Returns the attributes specified by .attributes_for_inspect as a nicely formatted string.



729
730
731
 
# File 'lib/active_record/core.rb', line 729

def inspect
  inspect_with_attributes(attributes_for_inspect)
end

#present? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


647
648
649
 
# File 'lib/active_record/core.rb', line 647

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.



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/active_record/core.rb', line 740

def pretty_print(pp)
  return super if custom_inspect_method_defined?
  pp.object_address_group(self) do
    if @attributes
      attr_names = attributes_for_inspect.select { |name| _has_attribute?(name.to_s) }
      pp.seplist(attr_names, proc { pp.text "," }) do |attr_name|
        attr_name = attr_name.to_s
        pp.breakable " "
        pp.group(1) do
          pp.text attr_name
          pp.text ":"
          pp.breakable
          value = attribute_for_inspect(attr_name)
          pp.text value
        end
      end
    else
      pp.breakable " "
      pp.text "not initialized"
    end
  end
end

#readonly! ⇒ Object

Marks this record as read only.

customer = Customer.first
customer.readonly!
customer.save # Raises an ActiveRecord::ReadOnlyRecord



720
721
722
 
# File 'lib/active_record/core.rb', line 720

def readonly!
  @readonly = true
end

#readonly? ⇒ Boolean

Returns true if the record is read only.

Returns:

  • (Boolean) 


656
657
658
 
# File 'lib/active_record/core.rb', line 656

def readonly?
  @readonly
end

#strict_loading!(value = true, mode: :all) ⇒ Object

Sets the record to strict_loading mode. This will raise an error if the record tries to lazily load an association.

user = User.first
user.strict_loading! # => true
user.address.city
=> ActiveRecord::StrictLoadingViolationError
user.comments.to_a
=> ActiveRecord::StrictLoadingViolationError

Parameters

  • value - Boolean specifying whether to enable or disable strict loading.

  • :mode - Symbol specifying strict loading mode. Defaults to :all. Using :n_plus_one_only mode will only raise an error if an association that will lead to an n plus one query is lazily loaded.

Examples

user = User.first
user.strict_loading!(false) # => false
user.address.city # => "Tatooine"
user.comments.to_a # => [#<Comment:0x00...]

user.strict_loading!(mode: :n_plus_one_only)
user.address.city # => "Tatooine"
user.comments.to_a # => [#<Comment:0x00...]
user.comments.first.ratings.to_a
=> ActiveRecord::StrictLoadingViolationError



694
695
696
697
698
699
700
701
 
# File 'lib/active_record/core.rb', line 694

def strict_loading!(value = true, mode: :all)
  unless [:all, :n_plus_one_only].include?(mode)
    raise ArgumentError, "The :mode option must be one of [:all, :n_plus_one_only] but #{mode.inspect} was provided."
  end

  @strict_loading_mode = mode
  @strict_loading = value
end

#strict_loading? ⇒ Boolean

Returns true if the record is in strict_loading mode.

Returns:

  • (Boolean) 


661
662
663
 
# File 'lib/active_record/core.rb', line 661

def strict_loading?
  @strict_loading
end

#strict_loading_all? ⇒ Boolean

Returns true if the record uses strict_loading with :all mode enabled.

Returns:

  • (Boolean) 


711
712
713
 
# File 'lib/active_record/core.rb', line 711

def strict_loading_all?
  @strict_loading_mode == :all
end

#strict_loading_n_plus_one_only? ⇒ Boolean

Returns true if the record uses strict_loading with :n_plus_one_only mode enabled.

Returns:

  • (Boolean) 


706
707
708
 
# File 'lib/active_record/core.rb', line 706

def strict_loading_n_plus_one_only?
  @strict_loading_mode == :n_plus_one_only
end