chan 0.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfca59accb24a6ffb6cdf1abb6800852694cff43
+  data.tar.gz: 3d83cfa26274fae11c30ca4069dece904acfec1a
+SHA512:
+  metadata.gz: 7d3804f17ef62273f6fd29bab3479e091b4ef7bbb1a548750ae67c16c93565778a72f8b680567976b24a7ec0ce819dcb10a9affae8173e355c3d80a69cb19841
+  data.tar.gz: 4c524ea1a700369e5e911cee292ef9ca12a01fe9722892613b66253fb69a79643eb360ef3e7793fe56e4f1941c1b196435471ad5311226ad9fa27292fe385786

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,31 @@
+language: ruby
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-20mode
+  - jruby-21mode
+  - jruby-head
+  - rbx-2.1.1
+  - rbx-2.2.3
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: rbx-2.1.1
+    - rvm: rbx-2.2.3

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# ChangeLog
+
+## 0.0.0.1 (2015 Jan 30)
+- First release.

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+platforms :rbx do
+	gem 'rubysl'
+end
+
+group :development, :test do
+	gem 'bundler', '>= 1.0'
+	gem 'rake'
+	gem 'rspec'
+	gem 'simplecov'
+	gem 'coveralls', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+- Copyright (c) 2014, T. Yamada
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,31 @@
+# chan
+Bidirectional enumerator (channel) or the chan object like in Golang.
+
+[![Build Status](https://travis-ci.org/cielavenir/ruby-chan.png)](https://travis-ci.org/cielavenir/ruby-chan) [![Code Climate](https://codeclimate.com/github/cielavenir/ruby-chan.png)](https://codeclimate.com/github/cielavenir/ruby-chan) [![Coverage Status](https://coveralls.io/repos/cielavenir/ruby-chan/badge.png)](https://coveralls.io/r/cielavenir/ruby-chan)
+
+## Supported Ruby versions
+* Ruby 1.8.7 or later
+* jruby
+* (Possibly) rubinius / ironruby / macruby / topaz etc
+
+## Binary distribution
+* https://rubygems.org/gems/chan
+
+## Install
+* gem install chan
+
+## Usage
+* Please check spec/chan.spec as an example.
+
+## Contributing to chan
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+Copyright (c) 2015 T. Yamada under Ruby License (2-clause BSDL or Artistic).
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler/gem_tasks'
+require './lib/chan'
+
+### below are copied from jeweler ###
+
+require 'rake'
+# Clean up after gem building
+require 'rake/clean'
+CLEAN.include('pkg/*.gem')
+CLOBBER.include('coverage')
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+	spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+	spec.pattern = 'spec/**/*_spec.rb'
+	spec.rcov = true
+end
+
+task :default => :spec
+
+begin
+	require 'rdoc/task'
+	Rake::RDocTask.new do |rdoc|
+		rdoc.rdoc_dir = 'rdoc'
+		rdoc.title = 'chan '+Chan::VERSION
+		rdoc.main = 'README.md'
+		rdoc.rdoc_files.include('README.*')
+		rdoc.rdoc_files.include('LICENSE.*')
+		rdoc.rdoc_files.include('CHANGELOG.*')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+	end
+rescue Exception #LoadError # Thus rdoc generation is limited to Ruby 1.9.3+...
+#Ruby 1.9.2 gives another Exception. I cannot limit to LoadError...
+end

data/chan.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+require './lib/chan'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chan"
+  spec.version       = Chan::VERSION
+  spec.authors       = ["cielavenir"]
+  spec.email         = ["cielartisan@gmail.com"]
+  spec.description   = "Bidirectional enumerator (channel) or the chan object like in Golang"
+  spec.summary       = "Bidirectional channel like the Golang chan object"
+  spec.homepage      = "http://github.com/cielavenir/chan"
+  spec.license       = "Ruby License (2-clause BSDL or Artistic)"
+
+  spec.files         = `git ls-files`.split($/) + [
+    "LICENSE.txt",
+    "README.md",
+    "CHANGELOG.md",
+  ]
+  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.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/chan.rb

@@ -0,0 +1,116 @@
+# Chan: Bidirectional enumerator (channel) or the chan object like in Golang
+#
+# Copyright (c) 2015, T. Yamada under Ruby License (2-clause BSDL or Artistic).
+#
+# Check LICENSE terms.
+#
+# Note: MIT License is also applicable if that compresses LICENSE file.
+
+class Chan
+	# VERSION string
+	VERSION='0.0.0.1'
+
+	# Channel handler inside block.
+	class Yielder
+		def initialize(parent_to_child,child_to_parent)
+			@parent_to_child=parent_to_child
+			@child_to_parent=child_to_parent
+		end
+		# Loops indefinitely while parent channel is empty.
+		def sync
+			while @parent_to_child.empty?
+				Fiber.yield(true)
+			end
+		end
+		# Stops writing to parent queue.
+		def close
+			@parent_to_child.instance_eval{
+				def push(v)
+					raise RuntimeError.new('Pushing to closed Chan')
+				end
+			}
+		end
+		# Receives an object from parent without modifying the queue.
+		def peek
+			sync
+			@parent_to_child.first
+		end
+		# Receives an object from parent.
+		# aliased to next/succ.
+		def receive
+			sync
+			@parent_to_child.shift
+		end
+		alias_method :next,:receive
+		alias_method :succ,:receive
+		# Sends an object to parent.
+		# aliased to <<.
+		def send(v)
+			@child_to_parent.push(v)
+			Fiber.yield(false)
+		end
+		alias_method :<<,:send
+	end
+
+	# Constructor. you should pass a block like you do in Enumerator.
+	# Actually if you use Enumerator.new{} as external iterator,
+	# you can safely convert it to Chan.new{} in most cases.
+	def initialize(&blk)
+		@f=Fiber.new{|parent_to_child,child_to_parent,blk|
+			ch=Yielder.new(parent_to_child,child_to_parent)
+			blk.call(ch)
+		}
+		@parent_to_child=[]
+		@child_to_parent=[]
+		@f.resume(@parent_to_child,@child_to_parent,blk)
+	end
+
+	# Tells if the channel has next element.
+	# If false, it means end of enumeration or you need to give more object.
+	def next?
+		while @child_to_parent.empty?
+			begin
+				flg=@f.resume
+				if flg&&@parent_to_child.empty?
+					return false
+				end
+			rescue FiberError
+				return false
+			end
+		end
+		true
+	end
+	# Receives an object from child without modifying the queue.
+	def peek
+		raise StopIteration.new('too many read requests') if !next?
+		@child_to_parent.first
+	end
+	# Receives an object from child.
+	# aliased to next/succ.
+	def receive
+		raise StopIteration.new('too many read requests') if !next?
+		@child_to_parent.shift
+	end
+	alias_method :next,:receive
+	alias_method :succ,:receive
+	# Sends an object to child.
+	def send(v)
+		@parent_to_child.push(v)
+	end
+	alias_method :<<,:send
+
+	# Builds an Enumerator using existing Enumerator.
+	def gen_enum(enum)
+		Enumerator.new{|y|
+			begin
+				loop{
+					self<<enum.next
+					y<<self.receive if self.next?
+				} # StopIteration is catched by Kernel#loop
+			rescue RuntimeError
+				# attempted to push to closed Chan
+			end
+			y<<self.receive while self.next?
+		}
+	end
+end

data/spec/chan_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__)+'/spec_helper')
+
+describe "Chan" do
+	specify "skip elements" do
+		ch=Chan.new{|ch|
+			loop{
+				raise if ch.peek!=ch.receive
+				raise if ch.peek!=ch.receive
+				ch<<ch.receive*2
+			}
+		}
+		ch.next?.should be false
+		ch<<1
+		ch.next?.should be false
+		ch<<2
+		ch.next?.should be false
+		ch<<3
+		ch.next?.should be true
+		ch.peek.should eq 6
+		ch.next.should eq 6
+	end
+	specify "gen_enum (chan) with loop" do
+		Chan.new{|ch|
+			loop{
+				ch.receive
+				ch.receive
+				ch<<ch.receive*2
+			}
+		}.gen_enum(Chan.new{|y|
+			a=0
+			b=1
+			y<<a
+			20.times{
+				y<<b
+				a,b=b,a+b
+			}
+		}).take(10).should eq [2, 10, 42, 178, 754, 3194, 13530]
+	end
+	specify "gen_enum (enumerator) without loop" do
+		Chan.new{|ch|
+			#loop{
+				ch.next
+				ch.succ
+				ch.send ch.receive*2
+			#}
+			ch.close
+		}.gen_enum(Enumerator.new{|y|
+			a=0
+			b=1
+			y<<a
+			loop{
+				y<<b
+				a,b=b,a+b
+			}
+		}).take(10).should eq [2]
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rspec'
+RSpec.configure{|config|
+	config.color=true
+}
+
+if !defined?(RUBY_ENGINE)||RUBY_ENGINE=='ruby'
+	require 'simplecov'
+	require 'coveralls'
+	SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+		SimpleCov::Formatter::HTMLFormatter,
+		Coveralls::SimpleCov::Formatter
+	]
+	SimpleCov.start do
+		add_filter 'spec'
+	end
+end
+
+require File.expand_path(File.dirname(__FILE__)+'/../lib/chan')

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: chan
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+platform: ruby
+authors:
+- cielavenir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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'
+description: Bidirectional enumerator (channel) or the chan object like in Golang
+email:
+- cielartisan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chan.gemspec
+- lib/chan.rb
+- spec/chan_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cielavenir/chan
+licenses:
+- Ruby License (2-clause BSDL or Artistic)
+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.14
+signing_key: 
+specification_version: 4
+summary: Bidirectional channel like the Golang chan object
+test_files:
+- spec/chan_spec.rb
+- spec/spec_helper.rb