coroutines 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6075ff02c811ae434bd45a95c49d4e55dbef28a7
-  data.tar.gz: 6533a5e7ab42de553f513c93fee0622fb081f755
+  metadata.gz: a2fa7ac85ca8235cd32795dc01769e4203155e3b
+  data.tar.gz: a3e56d66919ec36730231a369c0ec776732f760c
 SHA512:
-  metadata.gz: ff68457b130b88bebee3f5df84e3f6cd97b6e7fbef3b9fff7c0b58acf353052abcb4e0a2e976ab02613e7e14f1471ea01f6ab3f7f2a90550a08d62569c520981
-  data.tar.gz: 30b78a1aa708333c17b6d366255d286cdc65252f96deb1debb6748ce09345ed8d144fe9adf8d10f031897b0b4681f345f2f76b586d7f4901259942e7fc65a1e5
+  metadata.gz: 4e26d6f223b0e3f0f6e7336ddedaafcaf38e973c36e805de019ce6c0ad3b22577ab5e5df82bad0f45914a9212ff1749f33e17817d627fd6e13c204e9901761ae
+  data.tar.gz: 155ccb30cdd1c8c96b0a132994c5a2dd1e660ba030c0a1cd8850ec77778923461a6b54d60026eb5e08b61106246edede58ab6988a00902a3b7fa46b2a73a0247

data/README.rdoc

@@ -1,4 +1,4 @@
-= Coroutines
+= Coroutines for Ruby
 A library for creating and composing producer/transformer/consumer coroutines.
 Producers are already provided by Ruby's built-in Enumerator class; this
 library provides Transformer and Consumer classes that work analogously. In
@@ -6,6 +6,10 @@ particular, they are also based on Fiber and not on threads (as in some other
 producer/consumer libraries). Also provides a module Sink, which is analogous
 to Enumerable, and Enumerable/Transformer/Sink composition.
 
+rdoc API docs:: http://nome.github.io/coroutines
+source code:: https://github.com/nome/coroutines
+bug tracker:: https://github.com/nome/coroutines/issues
+
 == Installing
    gem install coroutines
 
@@ -44,6 +48,27 @@ basic library API. Of course, a counter could just as easily be implemented
 using a closure; the advantage of a consumer is that the implementation could
 involve arbitrary control structures with multiple calls to await.
 
+Often, a consumer can be rewritten using an enumerator. In the above example,
+we could also write
+
+   def counter(start, values)
+     result = start
+     values.each { |x| result += x }
+     "Final value: #{result}"
+   end
+
+   values = [10, 1000, 100000] # could be an enumerator fetching values lazily
+   counter(10, values)
+
+Depending on the context, either solution may be more readable. But there's one
+thing you can do with consumers but not with enumerators: Lazily feeding the
+same values to more than one function. With enumerators, iteration is driven
+from the consuming side; with consumers, it is driven by the producing side.
+Distributing a stream to many consumers (or, more generally, sinks) can be done
+using Sink::Multicast.  See the {Apache log parsing
+example}[https://github.com/nome/coroutines/blob/master/examples/parse_apache.rb]
+for a practical application of multicasting.
+
 A simple transformer:
 
    require 'coroutines'
@@ -164,7 +189,7 @@ where a Proc object in a pipeline is interpreted as if it were an argument to En
    (1..9).lazy.filter_map{|x| x.to_s if x.even? }.out_connect("")
 
 Apart from saving a few keystrokes (d'oh...), this has a the advantage that all
-elements of a pipeline are lazy _by default_. When using map, filter and
+elements of a pipeline are lazy _by_default_. When using map, filter and
 friends, forgetting to drop a "lazy" in the right place causes this part of the
 pipeline to become strict (but of course it may still produce the intended
 results!). This type of bug can be hard to catch - unless you're always
@@ -200,9 +225,10 @@ Proc::              define Proc#to_trans, Proc#<= and Proc#>=
 Symbol::            define Symbol#to_trans, Symbol#<= and Symbol#>=
 
 == Contributing
-1. Fork it {on Github}[https://github.com/nome/coroutines]
-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
+1. {Fork it on Github}[https://github.com/nome/coroutines/fork]
+2. Create your feature branch (<code>git checkout -b my-new-feature</code>)
+3. Commit your changes (<code>git commit -am 'Add some feature'</code>)
+4. Make sure unit tests pass (<code>gem install --development coroutines; ruby tests/suite.rb</code>)
+5. Push to the branch (<code>git push origin my-new-feature</code>)
+6. Create new Pull Request
 

data/lib/coroutines/base.rb

@@ -6,7 +6,6 @@ require 'lazy_enumerator' unless defined? Enumerator::Lazy
 #
 # A Consumer can be created by the following methods:
 # * Object#consum_for
-# * Object#consumer
 # * Consumer.new
 # * Transformer#out_connect
 #

data/tests/suite.rb

@@ -1,4 +1,9 @@
-require 'test_sink'
-require 'test_enumerable'
-require 'test_coroutines'
-require 'test_operators'
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir  = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "tests")
+
+$LOAD_PATH.unshift(lib_dir)
+
+require 'test/unit'
+
+exit Test::Unit::AutoRunner.run(true, test_dir)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coroutines
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Knut Franke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lazy_enumerator
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |
   A library for creating and composing producer/transformer/consumer coroutines.
   Producers are already provided by Ruby's built-in Enumerator class; this
@@ -43,11 +57,13 @@ files:
 - lib/coroutines/operators.rb
 - lib/coroutines/sink.rb
 - tests/suite.rb
-homepage: https://github.com/nome/coroutines
+homepage: http://nome.github.io/coroutines
 licenses:
 - Ruby
 - BSD-2-Clause
-metadata: {}
+metadata:
+  issue_tracker: https://github.com/nome/coroutines/issues
+  source_code: https://github.com/nome/coroutines
 post_install_message: 
 rdoc_options: []
 require_paths: