NAME

Rubyish::Enumerable - Enumerable (module)

NAME

Rubyish::Enumerable - The Enumerable implementation

SYNOPSIS

    use MyEnumerableClass;
    use Rubyish::Enumerable;

    # you define "each"...
    def each {... }

    # and get these methods for free:
    # all, any, to_a

DESCRIPTION

This module exports several methods that can be defined in terms of "each". When you define your classes and you want it behave as enumerables, simply say use Rubyish::Enumerable. And define each method. Then you will get the following intance methods for free.

all([ $block ])

Return true if all items in the enumerable object makes $block returns true. For example:

  $collection->all(sub {
    my ($i) = @_;
    $i > 3;
  });

Will test if all items in the $collection are greater then 3. If $block is not given, then it simply test if all items in the collection are considered to be true value.

See also List::MoreUtils and Quantum::Superpositions for the concept and alternative implementation of the all function.

any([ $block ])

Similar to all function, but returns ture if any item in the enumerable object is true, or let $block returns true.

See also List::MoreUtils and Quantum::Superpositions for the concept and alternative implementation of the any function.

to_a

Convert the enumerable object to an array.

SEE ALSO

Rubyish::Arry

AUTHOR

Kang-min Liu <gugod@gugod.org>, shelling shelling@cpan.org

LICENCE AND COPYRIGHT

Copyright (c) 2008,2009, Kang-min Liu <gugod@gugod.org>.

This is free software, licensed under:

    The MIT (X11) License

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.