Spec-Zone.ru › Ruby on Rails 5.2

модуль ActiveRecord::Core

Публичные методы класса

configurations() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 59
def self.configurations
  @@configurations
end

Возвращает полностью разрешённый хэш конфигураций

configurations=(config) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 53
def self.configurations=(config)
  @@configurations = ActiveRecord::ConnectionHandling::MergeAndResolveDefaultUrlConfig.new(config).resolve
end

Содержит конфигурацию базы данных — как обычно хранится в файле config/database.yml — в виде хэша.

Например, следующий файл database.yml…

development:
  adapter: sqlite3
  database: db/development.sqlite3

production:
  adapter: sqlite3
  database: db/production.sqlite3

…приведёт к тому, что ::configurations будет выглядеть так:

{
   'development' => {
      'adapter'  => 'sqlite3',
      'database' => 'db/development.sqlite3'
   },
   'production' => {
      'adapter'  => 'sqlite3',
      'database' => 'db/production.sqlite3'
   }
}
connection_handler() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 130
def self.connection_handler
  ActiveRecord::RuntimeRegistry.connection_handler || default_connection_handler
end
connection_handler=(handler) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 134
def self.connection_handler=(handler)
  ActiveRecord::RuntimeRegistry.connection_handler = handler
end
new(attributes = nil) { |self| ... } Показать исходный код
# File activerecord/lib/active_record/core.rb, line 307
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

Новые объекты могут быть созданы либо пустыми (без параметров), либо с предварительно заданными атрибутами, но ещё не сохранёнными (передав хэш с именами ключей, соответствующими именам столбцов связанной таблицы). В обоих случаях допустимые ключи атрибутов определяются именами столбцов связанной таблицы — поэтому у вас не может быть атрибутов, которые не являются частью столбцов таблицы.

Пример:

# Instantiates a single new object
User.new(first_name: 'Jamie')

Публичные методы экземпляров

<=>(other_object) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 452
def <=>(other_object)
  if other_object.is_a?(self.class)
    to_key <=> other_object.to_key
  else
    super
  end
end

Разрешает сортировку по объектам

Вызывает метод суперкласса
==(comparison_object) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 420
def ==(comparison_object)
  super ||
    comparison_object.instance_of?(self.class) &&
    !id.nil? &&
    comparison_object.id == id
end

Возвращает true, если comparison_object — это тот же самый объект, или comparison_object имеет тот же тип и self имеет ID, который равен comparison_object.id.

Обратите внимание, что новые записи по определению отличаются от любых других записей, если только другая запись не является самим получателем. Кроме того, если вы получаете существующие записи с помощью select и опускаете ID, вы сами за себя отвечаете, этот предикат вернёт false.

Также обратите внимание, что уничтожение записи сохраняет её ID в экземпляре модели, поэтому удалённые модели всё ещё сравнимы.

Вызывает метод суперкласса
Также алиас: eql?
clone() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 369
    

Идентично методу clone в Ruby. Это «поверхностная» копия. Будьте осторожны, ваши атрибуты не копируются. Это означает, что изменение атрибутов копии изменит оригинал, поскольку оба будут указывать на один и тот же хеш атрибутов. Если вам нужна копия вашего хеша атрибутов, используйте метод dup.

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
connection_handler() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 471
def connection_handler
  self.class.connection_handler
end
dup() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 378
    

Дублированные объекты не имеют назначенного ID и обрабатываются как новые записи. Обратите внимание, что это «поверхностная» копия, так как она копирует только атрибуты объекта, а не его ассоциации. Область «глубокой» копии зависит от приложения, поэтому её реализация предоставляется приложению в соответствии с его потребностями. Метод dup не сохраняет отметки времени (created|updated)_(at|on).

encode_with(coder) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 405
def encode_with(coder)
  self.class.yaml_encoder.encode(@attributes, coder)
  coder["new_record"] = new_record?
  coder["active_record_yaml_version"] = 2
end

Заполнить coder атрибутами этой записи, которые должны быть сериализованы. Структура coder в этом методе гарантированно соответствует структуре coder, переданной методу init_with.

Пример:

class Post < ActiveRecord::Base
end
coder = {}
Post.new.encode_with(coder)
coder # => {"attributes" => {"id" => nil, ... }}
eql?(comparison_object)
Алиас для: ==
freeze() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 441
def freeze
  @attributes = @attributes.clone.freeze
  self
end

Клонирует и замораживает хеш атрибутов, так что ассоциации всё ещё доступны, даже для удалённых записей, но клонированные модели не будут заморожены.

frozen?() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 447
def frozen?
  @attributes.frozen?
end

Возвращает true , если хеш атрибутов был заморожен.

hash() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 430
def hash
  if id
    self.class.hash ^ id.hash
  else
    super
  end
end

Делегирует вызов методу id, чтобы две записи одного типа и с одним ID работали со следующим:

[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
Вызывает метод суперкласса
init_with(coder) { |self| ... } Показать исходный код
# File activerecord/lib/active_record/core.rb, line 334
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

Инициализирует пустой объект модели из coder. coder должно быть результатом предыдущего кодирования модели Active Record с использованием 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'
inspect() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 476
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) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 494
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

Принимает PP и красиво выводит эту запись в него, позволяя получить хороший результат из pp record при необходимости pp.

Вызывает метод суперкласса
readonly!() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 467
def readonly!
  @readonly = true
end

Помечает эту запись как только для чтения.

readonly?() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 462
def readonly?
  @readonly
end

Возвращает true, если запись только для чтения. Записи, загруженные через объединения с атрибутами-придатками, будут помечены как только для чтения, так как их нельзя сохранить.

slice(*methods) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 517
def slice(*methods)
  Hash[methods.flatten.map! { |method| [method, public_send(method)] }].with_indifferent_access
end

Возвращает хеш заданных методов с их именами в качестве ключей и возвращаемыми значениями в качестве значений.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API