edge badge
Namespace
Methods
#
C
D
E
F
H
I
N
P
R
S
Class Public methods
configurations()

Returns fully resolved configurations hash

# File activerecord/lib/active_record/core.rb, line 51
def self.configurations
  @@configurations
end
configurations=(config)

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 ::configurations to look like this:

{
   'development' => {
      'adapter'  => 'sqlite3',
      'database' => 'db/development.sqlite3'
   },
   'production' => {
      'adapter'  => 'sqlite3',
      'database' => 'db/production.sqlite3'
   }
}
# File activerecord/lib/active_record/core.rb, line 45
def self.configurations=(config)
  @@configurations = ActiveRecord::ConnectionHandling::MergeAndResolveDefaultUrlConfig.new(config).resolve
end
connection_handler()
# File activerecord/lib/active_record/core.rb, line 100
def self.connection_handler
  ActiveRecord::RuntimeRegistry.connection_handler || default_connection_handler
end
connection_handler=(handler)
# File activerecord/lib/active_record/core.rb, line 104
def self.connection_handler=(handler)
  ActiveRecord::RuntimeRegistry.connection_handler = handler
end
disable_implicit_join_references=(value)
# File activerecord/lib/active_record/core.rb, line 90
      def self.disable_implicit_join_references=(value)
        ActiveSupport::Deprecation.warn("          Implicit join references were removed with Rails 4.1.
          Make sure to remove this configuration because it does nothing.
".squish)
      end
new(attributes = nil, options = {})

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')
# File activerecord/lib/active_record/core.rb, line 271
def initialize(attributes = nil, options = {})
  @attributes = self.class._default_attributes.dup

  init_internals
  initialize_internals_callback

  self.class.define_attribute_methods
  # +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, options) if attributes

  yield self if block_given?
  _run_initialize_callbacks
end
Instance Public methods
<=>(other_object)

Allows sort on objects

# File activerecord/lib/active_record/core.rb, line 413
def <=>(other_object)
  if other_object.is_a?(self.class)
    self.to_key <=> other_object.to_key
  else
    super
  end
end
==(comparison_object)

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.

Also aliased as: eql?
# File activerecord/lib/active_record/core.rb, line 381
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
# File activerecord/lib/active_record/core.rb, line 328
    
connection_handler()
# File activerecord/lib/active_record/core.rb, line 432
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).

# File activerecord/lib/active_record/core.rb, line 337
    
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, ... }}
# File activerecord/lib/active_record/core.rb, line 365
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
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.

# File activerecord/lib/active_record/core.rb, line 402
def freeze
  @attributes = @attributes.clone.freeze
  self
end
frozen?()

Returns true if the attributes hash has been frozen.

# File activerecord/lib/active_record/core.rb, line 408
def frozen?
  @attributes.frozen?
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) ]
# File activerecord/lib/active_record/core.rb, line 391
def hash
  if id
    id.hash
  else
    super
  end
end
init_with(coder)

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'
# File activerecord/lib/active_record/core.rb, line 296
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
inspect()

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

# File activerecord/lib/active_record/core.rb, line 437
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)

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

# File activerecord/lib/active_record/core.rb, line 454
def pretty_print(pp)
  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.

# File activerecord/lib/active_record/core.rb, line 428
def readonly!
  @readonly = true
end
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.

# File activerecord/lib/active_record/core.rb, line 423
def readonly?
  @readonly
end
slice(*methods)

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

# File activerecord/lib/active_record/core.rb, line 476
def slice(*methods)
  Hash[methods.map! { |method| [method, public_send(method)] }].with_indifferent_access
end