Spec-Zone.ru › Ruby on Rails 5.0

класс Объект

Родитель:
BasicObject
Включенные модули:

Константы

DEPRECATED_FILES
HashWithIndifferentAccess

Реализует хеш-таблицу, где ключи :foo и "foo" считаются одинаковыми.

rgb = ActiveSupport::HashWithIndifferentAccess.new

rgb[:black] = '#000000'
rgb[:black]  # => '#000000'
rgb['black'] # => '#000000'

rgb['white'] = '#FFFFFF'
rgb[:white]  # => '#FFFFFF'
rgb['white'] # => '#FFFFFF'

Внутренне символы отображаются в строки, когда используются в качестве ключей во всем интерфейсе записи (вызов []=, merge, и т. д.). Это отображение относится к публичному интерфейсу. Например, если:

hash = ActiveSupport::HashWithIndifferentAccess.new(a: 1)

Вам гарантируется, что ключ будет возвращен как строка:

hash.keys # => ["a"]

Технически принимаются и другие типы ключей:

hash = ActiveSupport::HashWithIndifferentAccess.new(a: 1)
hash[0] = 0
hash # => {"a"=>1, 0=>0}

но этот класс предназначен для случаев использования, где ожидаются ключи-строки или символы, и удобно считать их одинаковыми. Например, хеш params в Ruby on Rails.

Обратите внимание, что ядра расширений определяют Hash#with_indifferent_access:

rgb = { black: '#000000', white: '#FFFFFF' }.with_indifferent_access

что может быть полезно.

Чтобы получить доступ к этому классу за пределами Rails, загрузите ядро расширения с помощью:

require "active_support/core_ext/hash/indifferent_access"

что, в свою очередь, загрузит этот файл.

MissingSourceFile

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

acts_like?(duck) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/acts_like.rb, line 7
def acts_like?(duck)
  respond_to? :"acts_like_#{duck}?"
end

Метод-помощник для определения типа объекта. Например, Active Support расширяет Date, чтобы определить метод acts_like_date?, и расширяет Time, чтобы определить acts_like_time?. В результате мы можем выполнить x.acts_like?(:time) и x.acts_like?(:date) для безопасного сравнения типов, так как классам, которые должны вести себя как Time, достаточно определить метод acts_like_time?.

blank?() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/blank.rb, line 14
def blank?
  respond_to?(:empty?) ? !!empty? : !self
end

Объект считается пустым, если он ложный, пустой или строка из пробелов. Например, false, '', ' ', nil, [], и {} являются пустыми.

Это упрощает

!address || address.empty?

до

address.blank?

@return [true, false]

create_fixtures(*fixture_set_names, &block) Показать исходный код
# File railties/lib/rails/test_help.rb, line 24
def create_fixtures(*fixture_set_names, &block)
  FixtureSet.create_fixtures(ActiveSupport::TestCase.fixture_path, fixture_set_names, {}, &block)
end
deep_dup() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/deep_dup.rb, line 13
def deep_dup
  duplicable? ? dup : self
end

Возвращает глубокую копию объекта, если он дублируемый. Если нет, возвращает self.

object = Object.new
dup    = object.deep_dup
dup.instance_variable_set(:@a, 1)

object.instance_variable_defined?(:@a) # => false
dup.instance_variable_defined?(:@a)    # => true
duplicable?() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/duplicable.rb, line 24
def duplicable?
  true
end

Можно ли безопасно продублировать этот объект?

Ложь для объектов методов; истина в противном случае.

html_safe?() Показать исходный код
# File activesupport/lib/active_support/core_ext/string/output_safety.rb, line 123
def html_safe?
  false
end
in?(another_object) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/inclusion.rb, line 10
def in?(another_object)
  another_object.include?(self)
rescue NoMethodError
  raise ArgumentError.new("The parameter passed to #in? must respond to #include?")
end

Возвращает true, если этот объект содержится в аргументе. Аргумент должен быть любым объектом, который отвечает на #include?. Пример использования:

characters = ["Konata", "Kagami", "Tsukasa"]
"Konata".in?(characters) # => true

Это вызовет ArgumentError если аргумент не отвечает на #include?.

instance_values() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/instance_variables.rb, line 12
def instance_values
  Hash[instance_variables.map { |name| [name[1..-1], instance_variable_get(name)] }]
end

Возвращает хеш со строковыми ключами, которые сопоставляют имена переменных экземпляра без «@» с их соответствующими значениями.

class C
  def initialize(x, y)
    @x, @y = x, y
  end
end

C.new(0, 1).instance_values # => {"x" => 0, "y" => 1}
instance_variable_names() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/instance_variables.rb, line 25
def instance_variable_names
  instance_variables.map(&:to_s)
end

Возвращает массив имён переменных экземпляра в виде строк, включая «@».

class C
  def initialize(x, y)
    @x, @y = x, y
  end
end

C.new(0, 1).instance_variable_names # => ["@y", "@x"]
presence() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/blank.rb, line 41
def presence
  self if present?
end

Возвращает приемник, если он присутствует, в противном случае возвращает nil. object.presence эквивалентно

object.present? ? object : nil

Например, что-то вроде

state   = params[:state]   if params[:state].present?
country = params[:country] if params[:country].present?
region  = state || country || 'US'

становится

region = params[:state].presence || params[:country].presence || 'US'

@return [Объект]

presence_in(another_object) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/inclusion.rb, line 24
def presence_in(another_object)
  self.in?(another_object) ? self : nil
end

Возвращает приемник, если он включён в аргумент, в противном случае возвращает nil. Аргумент должен быть любым объектом, который отвечает на #include?. Пример использования:

params[:bucket_type].presence_in %w( project calendar )

Это вызовет ArgumentError если аргумент не отвечает на #include?.

@return [Объект]

present?() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/blank.rb, line 21
def present?
  !blank?
end

Объект присутствует, если он не пустой.

@return [true, false]

to_param() Показать исходный код
# File activesupport/lib/active_support/core_ext/object/to_query.rb, line 5
def to_param
  to_s
end

Псевдоним to_s.

to_query(key) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/to_query.rb, line 11
def to_query(key)
  "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
end

Преобразует объект в строку, подходящую для использования в строке запроса URL, используя заданный key в качестве имени параметра.

try(*a, &b) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/try.rb, line 91
  

Вызывает публичный метод, имя которого передается в качестве первого аргумента, как и public_send, за исключением того, что если приемник не отвечает на него, вызов возвращает nil вместо поднятия исключения.

Этот метод предназначен для написания

@person.try(:name)

вместо

@person.name if @person

try вызовы могут быть объединены:

@person.try(:spouse).try(:name)

вместо

@person.spouse.name if @person && @person.spouse

try также вернёт nil если приемник не отвечает на метод:

@person.try(:non_existing_method) # => nil

вместо

@person.non_existing_method if @person.respond_to?(:non_existing_method) # => nil

try вернёт nil при вызове на nil независимо от того, отвечает ли он на метод:

nil.try(:to_i) # => nil, rather than 0

Аргументы и блоки передаются методу при вызове:

@posts.try(:each_slice, 2) do |a, b|
  ...
end

Количество аргументов в сигнатуре должно совпадать. Если объект отвечает на метод, вызов выполняется, и ArgumentError всё ещё генерируется в случае несовпадения аргументов.

Если try вызывается без аргументов, он передаёт приемник в предоставленный блок, если он не nil:

@person.try do |p|
  ...
end

Также можно вызвать try с блоком без аргументов, и блок будет обработан с помощью instance_eval:

@person.try { upcase.truncate(50) }

Обратите также внимание, что try определён на Object. Поэтому он не будет работать с экземплярами классов, которые не имеют Object среди своих предков, например, с прямыми подклассами BasicObject.

try!(*a, &b) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/try.rb, line 103

То же, что и try, но генерирует исключение NoMethodError если приемник не nil и не реализует вызванный метод.

"a".try!(:upcase) # => "A"
nil.try!(:upcase) # => nil
123.try!(:upcase) # => NoMethodError: undefined method `upcase' for 123:Integer
unescape(str, escaped = /%[a-fA-F\d]{2}/) Показать исходный код
# File activesupport/lib/active_support/core_ext/uri.rb, line 8
def unescape(str, escaped = /%[a-fA-F\d]{2}/)
  # TODO: Are we actually sure that ASCII == UTF-8?
  # YK: My initial experiments say yes, but let's be sure please
  enc = str.encoding
  enc = Encoding::UTF_8 if enc == Encoding::US_ASCII
  str.gsub(escaped) { |match| [match[1, 2].hex].pack('C') }.force_encoding(enc)
end
END_OF_DOCUMENT_MARKER
with_options(options, &block) Показать исходный код
# File activesupport/lib/active_support/core_ext/object/with_options.rb, line 65
def with_options(options, &block)
  option_merger = ActiveSupport::OptionMerger.new(self, options)
  block.arity.zero? ? option_merger.instance_eval(&block) : block.call(option_merger)
end

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

Без with_options, этот код содержит дублирование:

class Account < ActiveRecord::Base
  has_many :customers, dependent: :destroy
  has_many :products,  dependent: :destroy
  has_many :invoices,  dependent: :destroy
  has_many :expenses,  dependent: :destroy
end

Используя with_options, мы можем устранить дублирование:

class Account < ActiveRecord::Base
  with_options dependent: :destroy do |assoc|
    assoc.has_many :customers
    assoc.has_many :products
    assoc.has_many :invoices
    assoc.has_many :expenses
  end
end

Он также может использоваться с явным получателем:

I18n.with_options locale: user.locale, scope: 'newsletter' do |i18n|
  subject i18n.t :subject
  body    i18n.t :body, user_name: user.name
end

Когда вы не передаёте явного получателя, весь блок выполняется в контексте слияния опций:

class Account < ActiveRecord::Base
  with_options dependent: :destroy do
    has_many :customers
    has_many :products
    has_many :invoices
    has_many :expenses
  end
end

with_options также может быть вложенным, поскольку вызов передаётся его получателю.

ПРИМЕЧАНИЕ: Каждый уровень вложенности будет объединять унаследованные значения по умолчанию в дополнение к собственным.

class Post < ActiveRecord::Base
  with_options if: :persisted?, length: { minimum: 50 } do
    validates :content, if: -> { content.present? }
  end
end

Код эквивалентен:

validates :content, length: { minimum: 50 }, if: -> { content.present? }

Следовательно, унаследованное значение по умолчанию для ключа `if` игнорируется.

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

Spec-Zone.ru

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