module Enumerable
Public Instance Methods
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 113 def exclude?(object) !include?(object) end
The negative of the Enumerable#include?
. Returns true
if the collection does not include the object.
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 127 def excluding(*elements) elements.flatten!(1) reject { |element| elements.include?(element) } end
Returns a copy of the enumerable excluding the specified elements.
["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}
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 107 def including(*elements) to_a.including(*elements) end
Returns a new array that includes the passed elements.
[ 1, 2, 3 ].including(4, 5) # => [ 1, 2, 3, 4, 5 ] ["David", "Rafael"].including %w[ Aaron Todd ] # => ["David", "Rafael", "Aaron", "Todd"]
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 54 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
Convert an enumerable to a hash keying it by the block return value.
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 ...>, ...}
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 70 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
Convert an enumerable to a hash keying it with the enumerable items and with the values returned in the block.
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?" }
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 88 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
Returns true
if the enumerable has more than 1 element. Functionally equivalent to enum.to_a.size > 1
. Can be called with a block too, much like any?, so people.many? { |p| p.age
> 26 }
returns true
if more than one person is over 26.
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 144 def pluck(*keys) if keys.many? map { |element| keys.map { |key| element[key] } } else map { |element| element[keys.first] } end end
Convert an enumerable to an array based on the given key.
[{ 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"]]
# 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
Calculates a sum from the elements.
payments.sum { |p| p.price * p.tax_rate } payments.sum(&:price)
The latter is a shortcut for:
payments.inject(0) { |sum, p| sum + p.price }
It can also calculate the sum without the use of a block.
[5, 15, 10].sum # => 30 ['foo', 'bar'].sum # => "foobar" [[1, 2], [3, 1, 5]].sum # => [1, 2, 3, 1, 5]
The default sum of an empty list is zero. You can override this default:
[].sum(Payment.new(0)) { |i| i.amount } # => Payment.new(0)
# File activesupport/lib/active_support/core_ext/enumerable.rb, line 133 def without(*elements) excluding(*elements) end
Alias for excluding.
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.