Module: Enumerable

### Home Classes Methods

### In Files

- lib/active_support/core_ext/enumerable.rb
- lib/active_support/json/encoding.rb

### Methods

- #each_with_object
- #exclude?
- #group_by
- #index_by
- #many?
- #sum

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# Enumerable

### Public Instance Methods

each_with_object(memo) click to toggle source

Iterates over a collection, passing the current element and the `memo` to the block. Handy for building up hashes or reducing collections down to one object. Examples:

    %w(foo bar).each_with_object({}) { |str, hsh| hsh[str] = str.upcase }
    # => {'foo' => 'FOO', 'bar' => 'BAR'}

Note that you can't use immutable objects like numbers, true or false as the memo. You would think the following returns 120, but since the memo is never changed, it does not.

    (1..5).each_with_object(1) { |value, memo| memo *= value } # => 1

    # File lib/active_support/core_ext/enumerable.rb, line 79
    def each_with_object(memo)
      return to_enum :each_with_object, memo unless block_given?
      each do |element|
        yield element, memo
      end
      memo
    end

exclude?(object) click to toggle source

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

    # File lib/active_support/core_ext/enumerable.rb, line 114
    def exclude?(object)
      !include?(object)
    end

group_by() click to toggle source

Collect an enumerable into sets, grouped by the result of a block. Useful, for example, for grouping records by date.

Example:

    latest_transcripts.group_by(&:day).each do |day, transcripts|
      p "#{day} -> #{transcripts.map(&:class).join(', ')}"
    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"

    # File lib/active_support/core_ext/enumerable.rb, line 22
    def group_by
      return to_enum :group_by unless block_given?
      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

index_by() click to toggle source

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

    # File lib/active_support/core_ext/enumerable.rb, line 94
    def index_by
      return to_enum :index_by unless block_given?
      Hash[map { |elem| [yield(elem), elem] }]
    end

many?() click to toggle source

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 lib/active_support/core_ext/enumerable.rb, line 101
    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

sum(identity = 0, &block) click to toggle source

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)

    # File lib/active_support/core_ext/enumerable.rb, line 58
    def sum(identity = 0, &block)
      if block_given?
        map(&block).sum(identity)
      else
        inject(:+) || identity
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.