123456789_123456789_123456789_123456789_123456789_

Module: ActiveRecord::Core

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Base, ActiveRecord::InternalMetadata, ActiveRecord::SchemaMigration
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Defined in: activerecord/lib/active_record/core.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

  • #<=>(other_object)

    Allows sort on objects.

  • #==(comparison_object) (also: #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.

  • #clone

    Identical to Ruby’s clone method.

  • #connection_handler
  • #dup

    Duped objects have no id assigned and are treated as new records.

  • #encode_with(coder)

    Populate coder with attributes about this record that should be serialized.

  • #eql?(comparison_object)

    Alias for #==.

  • #freeze

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

  • #hash

    Delegates to id in order to allow two records of the same type and id to work with something like:

  • #init_with(coder) {|_self| ... }

    Initialize an empty model object from coder.

  • #initialize(attributes = nil) {|_self| ... }

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

  • #inspect

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

  • #pretty_print(pp)

    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!

    Marks this record as read only.

  • #slice(*methods)

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

DSL Calls

included

[ GitHub ]


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'activerecord/lib/active_record/core.rb', line 11

included do
  ##
  # :singleton-method:
  #
  # Accepts a logger conforming to the interface of Log4r which is then
  # passed on to any new database connections made and which can be
  # retrieved on both a class and instance level by calling logger.
  mattr_accessor :logger, instance_writer: false

  ##
  # :singleton-method:
  #
  # Specifies if the methods calling database queries should be logged below
  # their relevant queries. Defaults to false.
  mattr_accessor :verbose_query_logs, instance_writer: false, default: false

  ##
  # Contains the database configuration - as is typically stored in config/database.yml -
  # as a Hash.
  #
  # For example, the following database.yml...
  #
  #   development:
  #     adapter: sqlite3
  #     database: db/development.sqlite3
  #
  #   production:
  #     adapter: sqlite3
  #     database: db/production.sqlite3
  #
  # ...would result in ActiveRecord::Base.configurations to look like this:
  #
  #   {
  #      'development' => {
  #         'adapter'  => 'sqlite3',
  #         'database' => 'db/development.sqlite3'
  #      },
  #      'production' => {
  #         'adapter'  => 'sqlite3',
  #         'database' => 'db/production.sqlite3'
  #      }
  #   }
  def self.configurations=(config)
    @@configurations = ActiveRecord::ConnectionHandling::MergeAndResolveDefaultUrlConfig.new(config).resolve
  end
  self.configurations = {}

  # Returns fully resolved configurations hash
  def self.configurations
    @@configurations
  end

  ##
  # :singleton-method:
  # Determines whether to use Time.utc (using :utc) or Time.local (using :local) when pulling
  # dates and times from the database. This is set to :utc by default.
  mattr_accessor :default_timezone, instance_writer: false, default: :utc

  ##
  # :singleton-method:
  # Specifies the format to use when dumping the database schema with Rails'
  # Rakefile. If :sql, the schema is dumped as (potentially database-
  # specific) SQL statements. If :ruby, the schema is dumped as an
  # ActiveRecord::Schema file which can be loaded into any database that
  # supports migrations. Use :ruby if you want to have different database
  # adapters for, e.g., your development and test environments.
  mattr_accessor :schema_format, instance_writer: false, default: :ruby

  ##
  # :singleton-method:
  # Specifies if an error should be raised if the query has an order being
  # ignored when doing batch queries. Useful in applications where the
  # scope being ignored is error-worthy, rather than a warning.
  mattr_accessor :error_on_ignored_order, instance_writer: false, default: false

  # :singleton-method:
  # Specify the behavior for unsafe raw query methods. Values are as follows
  #   deprecated - Warnings are logged when unsafe raw SQL is passed to
  #                query methods.
  #   disabled   - Unsafe raw SQL passed to query methods results in
  #                UnknownAttributeReference exception.
  mattr_accessor :allow_unsafe_raw_sql, instance_writer: false, default: :deprecated

  ##
  # :singleton-method:
  # Specify whether or not to use timestamps for migration versions
  mattr_accessor :timestamped_migrations, instance_writer: false, default: true

  ##
  # :singleton-method:
  # Specify whether schema dump should happen at the end of the
  # db:migrate rake task. This is true by default, which is useful for the
  # development environment. This should ideally be false in the production
  # environment where dumping schema is rarely needed.
  mattr_accessor :dump_schema_after_migration, instance_writer: false, default: true

  ##
  # :singleton-method:
  # Specifies which database schemas to dump when calling db:structure:dump.
  # If the value is :schema_search_path (the default), any schemas listed in
  # schema_search_path are dumped. Use :all to dump all schemas regardless
  # of schema_search_path, or a string of comma separated schemas for a
  # custom list.
  mattr_accessor :dump_schemas, instance_writer: false, default: :schema_search_path

  ##
  # :singleton-method:
  # Specify a threshold for the size of query result sets. If the number of
  # records in the set exceeds the threshold, a warning is logged. This can
  # be used to identify queries which load thousands of records and
  # potentially cause memory bloat.
  mattr_accessor :warn_on_records_fetched_greater_than, instance_writer: false

  mattr_accessor :maintain_test_schema, instance_accessor: false

  mattr_accessor :belongs_to_required_by_default, instance_accessor: false

  ##
  # :singleton-method:
  # Application configurable boolean that instructs the YAML Coder to use
  # an unsafe load if set to true.
  mattr_accessor :use_yaml_unsafe_load, instance_writer: false, default: false

  # Application configurable array that provides additional permitted classes
  # to Psych safe_load in the YAML Coder
  mattr_accessor :yaml_column_permitted_classes, instance_writer: false, default: []

  class_attribute :default_connection_handler, instance_writer: false

  def self.connection_handler
    ActiveRecord::RuntimeRegistry.connection_handler || default_connection_handler
  end

  def self.connection_handler=(handler)
    ActiveRecord::RuntimeRegistry.connection_handler = handler
  end

  self.default_connection_handler = ConnectionAdapters::ConnectionHandler.new
end

Instance Attribute Details

#frozen?Boolean (readonly)

Returns true if the attributes hash has been frozen.

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 458

def frozen?
  @attributes.frozen?
end

#readonly?Boolean (readonly)

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.

[ GitHub ]

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

def readonly?
  @readonly
end

Instance Method Details

#<=>(other_object)

Allows sort on objects

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 463

def <=>(other_object)
  if other_object.is_a?(self.class)
    to_key <=> other_object.to_key
  else
    super
  end
end

#==(comparison_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.

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 431

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

#clone

Identical to Ruby’s clone method. This is a “shallow” copy. Be warned that your attributes are not copied. That means that modifying attributes of the clone will modify the original, since they will both point to the same attributes hash. If you need a copy of your attributes hash, please use the #dup method.

user = User.first
new_user = user.clone
user.name               # => "Bob"
new_user.name = "Joe"
user.name               # => "Joe"

user.object_id == new_user.object_id            # => false
user.name.object_id == new_user.name.object_id  # => true

user.name.object_id == user.dup.name.object_id  # => false
[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 364

rdoc_method :method: clone

#connection_handler

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 482

def connection_handler
  self.class.connection_handler
end

#dup

Duped objects have no id assigned and are treated as new records. Note that this is a “shallow” copy as it copies the object’s attributes only, not its associations. The extent of a “deep” copy is application specific and is therefore left to the application to implement according to its need. The dup method does not preserve the timestamps (created|updated)_(at|on).

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 381

rdoc_method :method: dup

#encode_with(coder)

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, ... }}
[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 416

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

#eql?(comparison_object)

Alias for #==.

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 437

alias :eql? :==

#freeze

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

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 452

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

#hash

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

  
# File 'activerecord/lib/active_record/core.rb', line 441

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

#init_with(coder) {|_self| ... }

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'

Yields:

  • (_self)

Yield Parameters:

  • _self (Core)

    the object that the method was called on

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 345

def init_with(coder)
  coder = LegacyYamlAdapter.convert(self.class, coder)
  @attributes = self.class.yaml_encoder.decode(coder)

  init_internals

  @new_record = coder["new_record"]

  self.class.define_attribute_methods

  yield self if block_given?

  _run_find_callbacks
  _run_initialize_callbacks

  self
end

#initialize(attributes = nil) {|_self| ... }

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:

  • _self (Core)

    the object that the method was called on

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 318

def initialize(attributes = nil)
  self.class.define_attribute_methods
  @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

#inspect

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

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 487

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)
        "#{name}: #{attribute_for_inspect(name)}"
      end
    end.compact.join(", ")
  else
    "not initialized"
  end

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

#pretty_print(pp)

Takes a PP and prettily prints this record to it, allowing you to get a nice result from pp record when pp is required.

[ GitHub ]

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

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!

Marks this record as read only.

[ GitHub ]

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

def readonly!
  @readonly = true
end

#slice(*methods)

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

[ GitHub ]

  
# File 'activerecord/lib/active_record/core.rb', line 528

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