Spec-Zone.ru › Ruby on Rails 6.0

модуль ActiveRecord::Core

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

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

Возвращает полностью разрешённый объект ActiveRecord::DatabaseConfigurations

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

Содержит конфигурацию базы данных — как обычно хранится в config/database.yml — в виде объекта ActiveRecord::DatabaseConfigurations.

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

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

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

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

#<ActiveRecord::DatabaseConfigurations:0x00007fd1acbdf800 @configurations=[
  #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10 @env_name="development",
    @spec_name="primary", @config={"adapter"=>"sqlite3", "database"=>"db/development.sqlite3"}>,
  #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbdea90 @env_name="production",
    @spec_name="primary", @config={"adapter"=>"mysql2", "database"=>"db/production.sqlite3"}>
]>
connection_handler() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 135
def self.connection_handler
  Thread.current.thread_variable_get("ar_connection_handler") || default_connection_handler
end
connection_handler=(handler) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 139
def self.connection_handler=(handler)
  Thread.current.thread_variable_set("ar_connection_handler", handler)
end
new(attributes = nil) { |self| ... } Показать исходный код
# File activerecord/lib/active_record/core.rb, line 319
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

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

Пример:

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

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

<=>(other_object) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 471
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 438
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 387
    

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

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

encode_with(coder) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 423
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 459
def freeze
  @attributes = @attributes.clone.freeze
  self
end

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

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

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

hash() Показать исходный код
# File activerecord/lib/active_record/core.rb, line 448
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, &block) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 346
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

Инициализирует пустой объект модели из 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 503
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

Возвращает содержимое записи в виде отформатированной строки.

pretty_print(pp) Показать исходный код
# File activerecord/lib/active_record/core.rb, line 528
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

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

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

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

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

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

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

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

END_OF_DOCUMENT_MARKER

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

Spec-Zone.ru

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