multi_enumerator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8056ddfc0ac106027a1f134328cb74b678bb35d
+  data.tar.gz: dd912600f45d8df1c2b7a9a244bf6e98d6b7f0de
+SHA512:
+  metadata.gz: 5c9ccd6aed24204998f2b05889dfce85d55ae044f16a078caa0ccbf4282642e87c9c3a88e9ee0c6b74b08f32855fcb4a4ce3a38595164e1b9ac19dabc4cb70cd
+  data.tar.gz: bb3fd4caec9372d033b6dde9968858cbbf9527a3b8f8c4856beddc2b5bb537105fc3ebac6aee45807b906a985e1b7b1513d68630ef24784c2016d6b16efa334a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.coveralls.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multi_enumerator.gemspec
+gemspec
+
+gem 'coveralls', :require => false
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexander Pavlenko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# MultiEnumerator
+
+Simultaneously process multiple enumerators.
+
+[![Travis CI](https://secure.travis-ci.org/AlexanderPavlenko/multi_enumerator.png)](https://travis-ci.org/AlexanderPavlenko/multi_enumerator)
+[![Coverage Status](https://coveralls.io/repos/AlexanderPavlenko/multi_enumerator/badge.png?branch=master)](https://coveralls.io/r/AlexanderPavlenko/multi_enumerator)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multi_enumerator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_enumerator
+
+## Usage
+
+Main goal of MultiEnumerator is to reduce Array#zip abuse and simplify IO streams handling.
+
+    a = [1, 2, 3].each
+    b = [10, 20].each
+    c = [30].each
+    MultiEnumerator.build([a, b, c]).each do |*slice|
+      puts slice.inspect
+    end
+
+    =>
+    [1, 10, 30]
+    [2, 20, #<StopIteration: iteration reached an end>]
+    [3, #<StopIteration: iteration reached an end>, #<StopIteration: iteration reached an end>]
+
+Instead of getting tons of StopIteration you may wish to specify a replacement.
+
+    a = [1, 2, 3].each
+    b = [10, 20].each
+    c = [30].each
+    MultiEnumerator.build(a, b, c, :ljust_with => nil).each do |*slice|
+      puts slice.inspect
+    end
+
+    =>
+    [1, 10, 30]
+    [2, 20, nil]
+    [3, nil, nil]
+
+By default all enumerators are rewound on before the iterating.
+This may be prevented by passing ```:rewind``` option.
+
+    enum = [1, 2, 3].each
+    enum.next  # skip first elem
+    puts MultiEnumerator.build(enum, :rewind => false).each.to_a.inspect
+
+    =>
+    [2, 3]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/multi_enumerator.rb

@@ -0,0 +1,8 @@
+require 'multi_enumerator/version'
+require 'multi_enumerator/multi_enumerator'
+
+module MultiEnumerator
+  def self.build(*args)
+    MultiEnumerator.new(*args)
+  end
+end

data/lib/multi_enumerator/multi_enumerator.rb

@@ -0,0 +1,45 @@
+class MultiEnumerator::MultiEnumerator < Enumerator
+
+  attr_reader :enums
+
+  # @param [Enumerator, ...] enums List of enumerators
+  # @param [Hash] options
+  # @option options [Boolean] :rewind Indicates whether enumerators should be rewound before traversal. Defaults to the +true+.
+  # @option options [Object] :ljust_with Object for filling tails. Defaults to the corresponding +StopIteration+ exception.
+  def initialize(*args)
+    @options = args.last.is_a?(::Hash) ? args.pop : {}
+    @options[:rewind] = true unless @options.key?(:rewind)
+    @enums = args.flatten.freeze
+  end
+
+  # @yield [a, b, c, ...] items from the corresponding enumerators
+  def each
+    return to_enum(:each) unless block_given?
+
+    @enums.each(&:rewind) if @options[:rewind]
+
+    loop do
+      entry = @enums.map do |enum|
+        begin
+          enum.next
+        rescue => ex
+          ex
+        end
+      end
+
+      break if entry.all?{|item| item.is_a? ::StopIteration }
+
+      if @options.key?(:ljust_with)
+        entry.map!{|item| item.is_a?(::StopIteration) ? @options[:ljust_with] : item }
+      end
+
+      yield *entry
+    end
+
+    self
+  end
+
+  def inspect
+    "#<#{self.class.name}: #{@enums.inspect}>"
+  end
+end

data/lib/multi_enumerator/version.rb

@@ -0,0 +1,3 @@
+module MultiEnumerator
+  VERSION = "0.0.1"
+end

data/multi_enumerator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_enumerator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_enumerator"
+  spec.version       = MultiEnumerator::VERSION
+  spec.authors       = ["AlexanderPavlenko"]
+  spec.email         = ["alerticus@gmail.com"]
+  spec.description   = %q{Simultaneously process multiple enumerators}
+  spec.summary       = %q{MultiEnumerator}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+end

data/spec/multi_enumerator_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe MultiEnumerator do
+
+  it "iterates over given enumerators" do
+    a = [1, 2, 3].each
+    b = [10, 20].each
+    c = [30].each
+    result = MultiEnumerator.build(a, b, c).each.to_a
+    result[0].should == [1, 10, 30]
+    result[1][0..1].should == [2, 20]
+    result[2][0].should == 3
+    result[1][2].class.should == StopIteration
+    result[2][1..2].map(&:class).uniq.should == [StopIteration]
+  end
+
+  it "iterates over given enumerators, filling tails" do
+    a = [1, 2, 3].each
+    b = [10, 20].each
+    c = [30].each
+    result = MultiEnumerator.build([a, b, c], :ljust_with => nil).each.to_a
+    result[0].should == [1, 10, 30]
+    result[1][0..1].should == [2, 20]
+    result[2][0].should == 3
+    result[1][2].should == nil
+    result[2][1..2].uniq.should == [nil]
+  end
+
+  it "respects :rewind option" do
+    enum = [1,2,3].each
+    enum.next
+    result = MultiEnumerator.build(enum, :rewind => false).each.to_a
+    result.should == [2, 3]
+  end
+
+  it "is inspectable" do
+    MultiEnumerator.build([].each).inspect
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'coveralls'
+Coveralls.wear!
+require 'multi_enumerator'
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: multi_enumerator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- AlexanderPavlenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simultaneously process multiple enumerators
+email:
+- alerticus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_enumerator.rb
+- lib/multi_enumerator/multi_enumerator.rb
+- lib/multi_enumerator/version.rb
+- multi_enumerator.gemspec
+- spec/multi_enumerator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: MultiEnumerator
+test_files:
+- spec/multi_enumerator_spec.rb
+- spec/spec_helper.rb