goroutine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6fcf2f3f6baec6422830dc4ce5ced26ee7d86ab
+  data.tar.gz: b325d312391f8b4379e85c554053a21be817a621
+SHA512:
+  metadata.gz: 07d18c2fdbfa411ef1212f02f19cbee83a797377d5b8145dbebf360fc0cafa5f614639114639965fd2caf25a5c885e2dbbf301b0b3c258066142bc45ae32b653
+  data.tar.gz: 810f327cf6d4b4e95baf28a4de1a8c497a9344303e824c1f00ed361813a463adf1bc3b8f8035a9cccf04c40ab6fe9b2a138f43b640cc3a0acc4b43c18d3e799d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in goroutine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Davide D'Agostino
+
+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,160 @@
+# Goroutine
+
+This is a very simple implementation of `channels` in pure ruby in like [40
+lines](lib/goroutine.rb) of code and with the help of unix `pipes` and `IO.select`
+
+It's composed by two components: `Queue` and `IO.pipe`, the `Queue` can be **buffered**.
+
+This project is in a very **early stage**.
+
+## Usage
+
+![demo](http://fs.daddye.it/qKUU+)
+
+Let's start with some examples:
+
+### GO and Channel
+
+A very basic program could be:
+
+```rb
+chan = Channel.new
+
+go do
+  loop do
+    chan << :hello!
+    sleep 1
+  end
+end
+
+while chan.ready
+  p chan.pop
+end
+```
+
+[go](lib/goroutine/ext.rb) method is nothing more than a `Thread.new {}`, just shorter.
+
+### Select
+
+You can use the `select` method to wait for one or **more** (the latter is
+interesting) channels.
+
+```rb
+channel = Channel.new
+
+go do
+  10.times { |i| channel << i; sleep 1 }
+  channel << :quit
+end
+
+select(channel) do |val|
+  break if val == :quit
+  p val
+end
+```
+
+You can use `break` to stop and exit from a `select` block.
+
+However `select` becomes more interesting when using multiple channels:
+
+```rb
+channels = 5.times.map { Channel.new }
+
+# Simulating a long running worker
+go(0) do |i|
+  while i += 1
+    channels.sample << i
+    sleep 1
+  end
+end
+
+# Reader
+select(channels) do |val, i|
+  puts "<ch:#{i}, message: #{val}>"
+  break if val > 9
+end
+```
+
+The output will be like:
+
+```
+<ch:1, message: 1>
+<ch:2, message: 2>
+<ch:1, message: 3>
+<ch:0, message: 4>
+<ch:4, message: 5>
+<ch:3, message: 6>
+<ch:2, message: 7>
+```
+
+### Buffered Channel
+
+If necessary, you can have a buffered channel:
+
+```rb
+channel = Channel::Buffered.new(5)
+go do
+  10.times { |i| channel << i; sleep 1 }
+  channel << :quit
+end
+
+# Subscribe a "completed" channel
+select(channel) do |val|
+  break if val == :quit
+  p val
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'goroutine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install goroutine
+
+## Inspirations and Mentions
+
+It's worth to mention that if you are looking for a more sophisticated version of `goroutines` you
+should checkout [agent](https://github.com/igrigorik/agent) by [Ilya
+Grigorik](https://www.igvita.com)
+
+Of course, this idea is yet another attempt to model [go
+channels](http://golang.org/doc/effective_go.html#channels)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/goroutine/fork )
+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 a new Pull Request
+
+
+## LICENSE
+
+Copyright (C) 2014 Davide D'Agostino
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/example/chat.rb

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+require 'goroutine'
+
+room = Channel.new
+
+go do
+  room << ['You', STDIN.gets] while true
+end
+
+go('Stan', 'Francine', 'Roger') do |*names|
+  names.each do |who|
+    room << [who, "hello!"]
+    sleep 1
+  end
+  room << ['Klaus', "how are you?"]
+end
+
+select(room) do |(who, text)|
+  puts "\e[01m#{who}\e[0m said:\t#{text}"
+  break if who == 'You'
+end

data/example/file.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'goroutine'
+
+file = File.open(__FILE__) # read myself
+channels = 10.times.map { Channel.new }
+
+# Simulate slow reading
+puts 'Start a slow reading'
+go do
+  while buf = file.read(16)
+    channels.sample << buf
+    sleep 0.5
+  end
+  channels.each { |chan| chan << :exit }
+end
+
+# Do something now
+puts 'Doing something else'
+
+# Okay, now, it's time to read
+puts 'Waiting for lines'
+select(channels) do |line|
+  break if line == :exit
+  print line
+end
+
+file.close

data/example/immediate.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'goroutine'
+
+# Single buffered channel, it's immediate so the publisher will complete before he'll get any
+# subscription (edge case)
+channel = Channel::Buffered.new(5)
+go do
+  10.times { |i| channel << i }
+  channel << :quit
+end
+
+# Subscribe a "completed" channel
+select(channel) do |val|
+  break if val == :quit
+  p val
+end

data/example/multi.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'goroutine'
+
+channels = 5.times.map { Channel.new }
+
+# Simulating a long running worker
+go(0) do |i|
+  while i += 1
+    channels.sample << i
+    sleep 1
+  end
+end
+
+# Reader
+select(channels) do |val, i|
+  puts "<ch:#{i}, message: #{val}>"
+  break if val > 9
+end

data/example/simple.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'goroutine'
+
+chan = Channel.new
+
+go do
+  loop do
+    chan << :hello!
+    sleep 1
+  end
+end
+
+while chan.ready
+  p chan.pop
+end

data/goroutine.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goroutine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goroutine"
+  spec.version       = Goroutine::VERSION
+  spec.authors       = ["Davide D'Agostino"]
+  spec.email         = ["info@daddye.it"]
+  spec.summary       = %q{A simple goroutine model for ruby.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/DAddYE/goroutine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+end

data/lib/goroutine.rb

@@ -0,0 +1,41 @@
+require 'goroutine/version'
+require 'goroutine/channel'
+require 'goroutine/ext'
+
+module Goroutine
+  def initialize(*args)
+    super(*args)
+    @rd, wr = IO.pipe
+    rd, @wr = IO.pipe
+    go do
+      loop do
+        IO.select([rd])
+        rd.read(1)
+        wr.write('.')
+      end
+    end
+  end
+
+  def pop
+    @rd.read(1)
+    super
+  end
+  alias shift pop
+  alias deq pop
+
+  def push(val)
+    @wr.write('.')
+    super(val)
+  end
+  alias << push
+  alias enq push
+
+  def to_io
+    @rd
+  end
+
+  def wait
+    IO.select([self])[0]
+  end
+  alias :ready :wait
+end

data/lib/goroutine/channel.rb

@@ -0,0 +1,7 @@
+class Channel < Queue
+  include Goroutine
+end
+
+class Channel::Buffered < SizedQueue
+  include Goroutine
+end

data/lib/goroutine/ext.rb

@@ -0,0 +1,14 @@
+module Kernel
+  def select(channels, &block)
+    channels = Array(channels)
+    loop do
+      rs, _ = IO.select(channels)
+      rs.each { |ch| block[ch.pop, channels.index(ch)] }
+    end
+  end
+
+  def go(*args, &block)
+    Thread.abort_on_exception = true
+    Thread.new(*args, &block)
+  end
+end

data/lib/goroutine/version.rb

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: goroutine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Davide D'Agostino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: A simple goroutine model for ruby.
+email:
+- info@daddye.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/chat.rb
+- example/file.rb
+- example/immediate.rb
+- example/multi.rb
+- example/simple.rb
+- goroutine.gemspec
+- lib/goroutine.rb
+- lib/goroutine/channel.rb
+- lib/goroutine/ext.rb
+- lib/goroutine/version.rb
+homepage: https://github.com/DAddYE/goroutine
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple goroutine model for ruby.
+test_files: []
+has_rdoc: