Spec-Zone.ru › Ruby on Rails 6.1

модуль Enumerable

Общедоступные методы экземпляров

compact_blank() Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 191
def compact_blank
  reject(&:blank?)
end

Возвращает новый Array без пустых элементов. Использует Object#blank? для определения пустого элемента.

[1, "", nil, 2, " ", [], {}, false, true].compact_blank
# =>  [1, 2, true]

Set.new([nil, "", 1, 2])
# => [2, 1] (or [1, 2])

При вызове для Hash, возвращает новый Hash без пустых значений.

{ a: "", b: 1, c: nil, d: [], e: false, f: true }.compact_blank
#=> { b: 1, f: true }
exclude?(object) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 121
def exclude?(object)
  !include?(object)
end

Отрицание Enumerable#include?. Возвращает true если коллекция не содержит объект.

excluding(*elements) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 135
def excluding(*elements)
  elements.flatten!(1)
  reject { |element| elements.include?(element) }
end

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

["David", "Rafael", "Aaron", "Todd"].excluding "Aaron", "Todd"
# => ["David", "Rafael"]

["David", "Rafael", "Aaron", "Todd"].excluding %w[ Aaron Todd ]
# => ["David", "Rafael"]

{foo: 1, bar: 2, baz: 3}.excluding :bar
# => {foo: 1, baz: 3}
including(*elements) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 115
def including(*elements)
  to_a.including(*elements)
end

Возвращает новый массив, включающий переданные элементы.

[ 1, 2, 3 ].including(4, 5)
# => [ 1, 2, 3, 4, 5 ]

["David", "Rafael"].including %w[ Aaron Todd ]
# => ["David", "Rafael", "Aaron", "Todd"]
index_by() { |elem| ... } Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 55
def index_by
  if block_given?
    result = {}
    each { |elem| result[yield(elem)] = elem }
    result
  else
    to_enum(:index_by) { size if respond_to?(:size) }
  end
end

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

people.index_by(&:login)
# => { "nextangle" => <Person ...>, "chade-" => <Person ...>, ...}

people.index_by { |person| "#{person.first_name} #{person.last_name}" }
# => { "Chade- Fowlersburg-e" => <Person ...>, "David Heinemeier Hansson" => <Person ...>, ...}
index_with(default = INDEX_WITH_DEFAULT) { |elem| ... } Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 78
def index_with(default = INDEX_WITH_DEFAULT)
  if block_given?
    result = {}
    each { |elem| result[elem] = yield(elem) }
    result
  elsif default != INDEX_WITH_DEFAULT
    result = {}
    each { |elem| result[elem] = default }
    result
  else
    to_enum(:index_with) { size if respond_to?(:size) }
  end
end

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

post = Post.new(title: "hey there", body: "what's up?")

%i( title body ).index_with { |attr_name| post.public_send(attr_name) }
# => { title: "hey there", body: "what's up?" }

Если вместо блока передается аргумент, он будет использоваться в качестве значения для всех элементов:

%i( created_at updated_at ).index_with(Time.now)
# => { created_at: 2020-03-09 22:31:47, updated_at: 2020-03-09 22:31:47 }
many?() { |element| ... } Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 96
def many?
  cnt = 0
  if block_given?
    any? do |element|
      cnt += 1 if yield element
      cnt > 1
    end
  else
    any? { (cnt += 1) > 1 }
  end
end

Возвращает true, если перечисляемый объект содержит более одного элемента. Функционально эквивалентно enum.to_a.size > 1. Может быть вызвано с блоком, например, people.many? { |p| p.age > 26 } возвращает true, если более одного человека старше 26 лет.

pick(*keys) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 168
def pick(*keys)
  return if none?

  if keys.many?
    keys.map { |key| first[key] }
  else
    first[keys.first]
  end
end

Извлекает указанный ключ из первого элемента в перечисляемом объекте.

[{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pick(:name)
# => "David"

[{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pick(:id, :name)
# => [1, "David"]
pluck(*keys) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 152
def pluck(*keys)
  if keys.many?
    map { |element| keys.map { |key| element[key] } }
  else
    key = keys.first
    map { |element| element[key] }
  end
end

Извлекает указанный ключ из каждого элемента в перечисляемом объекте.

[{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pluck(:name)
# => ["David", "Rafael", "Aaron"]

[{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pluck(:id, :name)
# => [[1, "David"], [2, "Rafael"]]
sum(identity = nil, &block) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 37
def sum(identity = nil, &block)
  if identity
    _original_sum_with_required_identity(identity, &block)
  elsif block_given?
    map(&block).sum(identity)
  else
    inject(:+) || 0
  end
end

Вычисляет сумму элементов.

payments.sum { |p| p.price * p.tax_rate }
payments.sum(&:price)

Последнее – сокращение для:

payments.inject(0) { |sum, p| sum + p.price }

Также может вычислять сумму без использования блока.

[5, 15, 10].sum # => 30
['foo', 'bar'].sum # => "foobar"
[[1, 2], [3, 1, 5]].sum # => [1, 2, 3, 1, 5]

По умолчанию сумма пустого списка равна нулю. Вы можете изменить это значение:

[].sum(Payment.new(0)) { |i| i.amount } # => Payment.new(0)
without(*elements) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 141
def without(*elements)
  excluding(*elements)
end

Псевдоним для excluding.

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

Spec-Zone.ru

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