enumerable.rb 2.5 KB
Newer Older
1 2
require 'active_support/ordered_hash'

3
module Enumerable
4 5 6
  # Ruby 1.8.7 introduces group_by, but the result isn't ordered. Override it.
  remove_method(:group_by) if [].respond_to?(:group_by) && RUBY_VERSION < '1.9'

7 8 9
  # Collect an enumerable into sets, grouped by the result of a block. Useful,
  # for example, for grouping records by date.
  #
P
Pratik Naik 已提交
10
  # Example:
11 12
  #
  #   latest_transcripts.group_by(&:day).each do |day, transcripts| 
13
  #     p "#{day} -> #{transcripts.map(&:class).join(', ')}"
14 15 16 17 18 19 20 21 22
  #   end
  #   "2006-03-01 -> Transcript"
  #   "2006-02-28 -> Transcript"
  #   "2006-02-27 -> Transcript, Transcript"
  #   "2006-02-26 -> Transcript, Transcript"
  #   "2006-02-25 -> Transcript"
  #   "2006-02-24 -> Transcript, Transcript"
  #   "2006-02-23 -> Transcript"
  def group_by
23 24 25 26 27 28 29 30 31 32
    assoc = ActiveSupport::OrderedHash.new

    each do |element|
      key = yield(element)

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

    assoc
36
  end unless [].respond_to?(:group_by)
37 38 39

  # Calculates a sum from the elements. Examples:
  #
40 41
  #  payments.sum { |p| p.price * p.tax_rate }
  #  payments.sum(&:price)
42
  #
43
  # The latter is a shortcut for:
P
Pratik Naik 已提交
44
  #
45
  #  payments.inject { |sum, p| sum + p.price }
46
  #
47
  # It can also calculate the sum without the use of a block.
P
Pratik Naik 已提交
48
  #
49 50 51
  #  [5, 15, 10].sum # => 30
  #  ["foo", "bar"].sum # => "foobar"
  #  [[1, 2], [3, 1, 5]].sum => [1, 2, 3, 1, 5]
52
  #
53
  # The default sum of an empty list is zero. You can override this default:
54
  #
55
  #  [].sum(Payment.new(0)) { |i| i.amount } # => Payment.new(0)
56 57 58
  #
  def sum(identity = 0, &block)
    return identity unless size > 0
J
Jeremy Kemper 已提交
59

60 61 62 63 64
    if block_given?
      map(&block).sum
    else
      inject { |sum, element| sum + element }
    end
65
  end
66

N
Nicholas Seckar 已提交
67 68 69 70 71 72 73 74 75 76 77 78 79
  # 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 ...>, ...}
  # 
  def index_by
    inject({}) do |accum, elem|
      accum[yield(elem)] = elem
      accum
    end
  end
80 81
  
  # Returns true if the collection has more than 1 element. Functionally equivalent to collection.size > 1.
82 83 84
  # Works with a block too ala any?, so people.many? { |p| p.age > 26 } # => returns true if more than 1 person is over 26.
  def many?(&block)
    size = block_given? ? select(&block).size : self.size
85 86
    size > 1
  end
87
end