Spec-Zone.ru › Ruby on Rails 7.0

модуль Enumerable

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

compact_blank() Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 218
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 152
def exclude?(object)
  !include?(object)
end

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

excluding(*elements) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 166
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}
Также алиас: without
in_order_of(key, series) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 230
def in_order_of(key, series)
  index_by(&key).values_at(*series).compact
end

Возвращает новый Array с порядком, заданным в series, основанным на key объектов в исходном перечислителе.

[ Person.find(5), Person.find(3), Person.find(1) ].in_order_of(:id, [ 1, 5, 3 ])
# => [ Person.find(1), Person.find(5), Person.find(3) ]

Если series содержат ключи, у которых нет соответствующего элемента в Enumerable, они игнорируются. Если Enumerable имеет дополнительные элементы, которые не указаны в series, они не включаются в результат.

including(*elements) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 146
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 86
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 109
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 127
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 если перечислитель содержит более 1 элемента. Функционально эквивалентно enum.to_a.size > 1. Может вызываться с блоком, поэтому people.many? { |p| p.age > 26 } возвращает true если больше одного человека старше 26 лет.

maximum(key) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 35
def maximum(key)
  map(&key).max
end

Вычисляет максимальное значение из выделенных элементов.

payments = [Payment.new(5), Payment.new(15), Payment.new(10)]
payments.maximum(:price) # => 15
minimum(key) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 27
def minimum(key)
  map(&key).min
end

Вычисляет минимальное значение из выделенных элементов.

payments = [Payment.new(5), Payment.new(15), Payment.new(10)]
payments.minimum(:price) # => 5
pick(*keys) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 195
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 179
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"]]
sole() Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 240
def sole
  case count
  when 1   then return first # rubocop:disable Style/RedundantReturn
  when 0   then raise SoleItemExpectedError, "no item found"
  when 2.. then raise SoleItemExpectedError, "multiple items found"
  end
end

Возвращает единственный элемент в перечисляемом. Если элементов нет или их больше одного, генерирует Enumerable::SoleItemExpectedError.

["x"].sole          # => "x"
Set.new.sole        # => Enumerable::SoleItemExpectedError: no item found
{ a: 1, b: 2 }.sole # => Enumerable::SoleItemExpectedError: multiple items found
sum(identity = nil, &block) Показать исходный код
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 57
  def sum(identity = nil, &block)
    if identity
      _original_sum_with_required_identity(identity, &block)
    elsif block_given?
      map(&block).sum
    # we check `first(1) == []` to check if we have an
    # empty Enumerable; checking `empty?` would return
    # true for `[nil]`, which we want to deprecate to
    # keep consistent with Ruby
    elsif first.is_a?(Numeric) || first(1) == []
      identity ||= 0
      _original_sum_with_required_identity(identity, &block)
    else
      ActiveSupport::Deprecation.warn(<<-MSG.squish)
        Rails 7.0 has deprecated Enumerable.sum in favor of Ruby's native implementation available since 2.4.
        Sum of non-numeric elements requires an initial argument.
      MSG
      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)
Псевдоним для: excluding

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

Spec-Zone.ru

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