Module: Enumerable

Defined in:
activesupport/lib/active_support/json/encoding.rb,
activesupport/lib/active_support/core_ext/enumerable.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) as_json(options = nil)

:nodoc:



202
 
# File 'activesupport/lib/active_support/json/encoding.rb', line 202

def as_json(options = nil) to_a end

- (Object) each_with_object(memo, &block) 



78
79
80
81
82
83
 
# File 'activesupport/lib/active_support/core_ext/enumerable.rb', line 78

def each_with_object(memo, &block)
  each do |element|
    block.call(element, memo)
  end
  memo
end

- (Boolean) exclude?(object)

The negative of the Enumerable#include?. Returns true if the collection does not include the object.

Returns:

  • (Boolean) 


107
108
109
 
# File 'activesupport/lib/active_support/core_ext/enumerable.rb', line 107

def exclude?(object)
  !include?(object)
end

- (Object) group_by 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'activesupport/lib/active_support/core_ext/enumerable.rb', line 22

def group_by
  assoc = ActiveSupport::OrderedHash.new

  each do |element|
    key = yield(element)

    if assoc.has_key?(key)
      assoc[key] << element
    else
      assoc[key] = [element]
    end
  end

  assoc
end

- (Object) index_by

Convert an enumerable to a hash. Examples:

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 ...>, ...}


92
93
94
95
96
97
 
# File 'activesupport/lib/active_support/core_ext/enumerable.rb', line 92

def index_by
  inject({}) do |accum, elem|
    accum[yield(elem)] = elem
    accum
  end
end

- (Boolean) many?(&block)

Returns true if the collection has more than 1 element. Functionally equivalent to collection.size > 1. Works with a block too ala any?, so people.many? { |p| p.age > 26 } # => returns true if more than 1 person is over 26.

Returns:

  • (Boolean) 


101
102
103
104
 
# File 'activesupport/lib/active_support/core_ext/enumerable.rb', line 101

def many?(&block)
  size = block_given? ? select(&block).size : self.size
  size > 1
end

- (Object) sum(identity = 0, &block)

Calculates a sum from the elements. Examples:

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)


57
58
59
60
61
62
63
 
# File 'activesupport/lib/active_support/core_ext/enumerable.rb', line 57

def sum(identity = 0, &block)
  if block_given?
    map(&block).sum(identity)
  else
    inject { |sum, element| sum + element } || identity
  end
end