ruby_gothreads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c8fbb30f3494d3bb74b50e70fa3918e494b3ced
+  data.tar.gz: 81909909e24a5b18fc9f43a4b4124a5f8c293dc3
+SHA512:
+  metadata.gz: d77e05748a0fae44aab663b0181c50dad934a40f72e224bc52e21a95c369472a2b0bf78545b1cae3f5c5757a32c752c6aab9a7c8e4252480da92928c108502ea
+  data.tar.gz: fd34fd50afa636a905a9ccdc5434eb64d901bbd23f3c391e8253a8cfc65da1ea24916d1e9f81c48bbe3ac116e9c7af5bbcccb4e97d27d451a8035eebc84a7019

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at zhuochun@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zhuochun
+
+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,27 @@
+# RubyGo
+
+Syntax sugars (`go`, `chan`, `select`) around Ruby threads and queues, emulating Golang Goroutines.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_go'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_go
+
+## Usage
+
+Refer to examples in `example/`.
+
+## License
+
+MIT 2016 @ [Zhuochun](https://github.com/zhuochun).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_go"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/fibonacci.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "ruby_go"
+
+include RubyGo
+
+nums_chan = chan(8)
+
+wg = []
+
+wg << go do
+  x, y = 1, 1
+
+  4.times do
+    sleep 0.2
+    nums_chan << "1 - #{y}"
+    x, y = y, x + y
+  end
+end
+
+wg << go do
+  x, y = 1, 1
+
+  4.times do
+    sleep 0.8
+    nums_chan << "2 - #{y}"
+    x, y = y, x + y
+  end
+end
+
+8.times do
+  p nums_chan.pop
+end
+
+wg.map(&:join)

data/example/schedular.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "logger"
+require "ruby_go"
+
+include RubyGo
+
+LOGGER = Logger.new(STDOUT)
+LOGGER.level = Logger::INFO
+
+ExitException = Class.new(StandardError)
+
+Task = Struct.new(:name, :result)
+
+NUM_WORKERS = 5
+NUM_TASKS = 25
+
+task_chan = chan(NUM_WORKERS)
+done_chan = chan(NUM_WORKERS)
+exit_chan = chan(NUM_WORKERS)
+
+def worker(worker_id, task_chan, done_chan, exit_chan)
+  -> do
+    LOGGER.info "Worker #{worker_id} Started"
+
+    begin
+      loop do
+        select({
+          task_chan => ->(task) do
+            LOGGER.info "[#{worker_id}] Start #{task.name}"
+            task.result = rand()
+            sleep task.result
+            done_chan << task
+            LOGGER.info "[#{worker_id}] Finished #{task.name}"
+          end,
+          exit_chan => ->(_) { raise ExitException },
+        })
+      end
+    rescue ExitException
+    end
+
+    LOGGER.info "Worker #{worker_id} Ended"
+  end
+end
+
+wg = NUM_WORKERS.times.map do |i|
+  go(&worker(i, task_chan, done_chan, exit_chan))
+end
+
+wg << go do
+  LOGGER.info "Producer Started"
+  NUM_TASKS.times { |i| task_chan << Task.new("Task #{i}") }
+  LOGGER.info "Producer Ended"
+end
+
+wg << go do
+  LOGGER.info "Consumer Started"
+  NUM_TASKS.times do
+    task = done_chan.pop
+    LOGGER.info "Consumer Read #{task.name}, Result #{task.result}"
+  end
+  LOGGER.info "Consumer Ended"
+
+  LOGGER.info "Consumer Signal Exit Start"
+  NUM_WORKERS.times { exit_chan << true }
+  LOGGER.info "Consumer Signal End Start"
+end
+
+wg.map(&:join)

data/example/timeout.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "ruby_go"
+
+include RubyGo
+
+c = chan()
+timeout = RubyGo::Timeout.new(5)
+
+p Time.now()
+
+go do
+  sleep 20
+  c << true
+end
+
+select({
+  c => ->(result) { p "Result: #{result}" },
+  timeout => ->(_) { p "Timeout" }
+})
+
+p Time.now()

data/example/timeout_2.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "logger"
+require "ruby_go"
+
+include RubyGo
+
+LOGGER = Logger.new(STDOUT)
+LOGGER.level = Logger::INFO
+
+class Task
+  include RubyGo
+
+  def initialize(name)
+    @name = name
+  end
+
+  def do
+    sleep_sec = rand() * 30
+    timeout_sec = rand() * 30
+
+    c = chan()
+    t = RubyGo::Timeout.new(timeout_sec)
+
+    go do
+      sleep sleep_sec
+      c << true
+    end
+
+    select({
+      c => ->(result) do
+        correct = sleep_sec <= timeout_sec
+        LOGGER.info "[#{@name}][#{correct}] RESULT: #{sleep_sec}, Timeout: #{timeout_sec}"
+      end,
+      t => ->(_) do
+        correct = timeout_sec <= sleep_sec
+        LOGGER.info "[#{@name}][#{correct}] timeout: #{timeout_sec}, Sleep: #{sleep_sec}"
+      end
+    })
+  end
+end
+
+LOGGER.info "Starting"
+
+wg = 100.times.map do |i|
+  go { Task.new("Task #{i}").do }
+end
+
+wg.map(&:join)
+
+LOGGER.info "Finished"

data/lib/ruby_go.rb

@@ -0,0 +1,41 @@
+require "thread"
+
+require "ruby_go/version"
+require "ruby_go/timeout"
+
+module RubyGo
+  # go starts a thread
+  def go(&block)
+    Thread.new(&block)
+  end
+
+  # chan creates a size channel with default size 1
+  def chan(len = 1)
+    SizedQueue.new(len)
+  end
+
+  # select receives a { chan => action } map, and blocked til a chan to execute
+  def select(chans)
+    chan_method = ->(_) {}
+    value = nil
+
+    selected = false
+    loop do
+      sleep 0.01 # to prevent busy loop
+
+      chans.each do |c, cm|
+        begin
+          value = c.pop(true)
+          chan_method = cm
+          selected = true
+          break
+        rescue ThreadError
+        end
+      end
+
+      break if selected
+    end
+
+    chan_method.call(value)
+  end
+end

data/lib/ruby_go/timeout.rb

@@ -0,0 +1,24 @@
+class RubyGo::Timeout
+  attr_reader :timeout_at
+
+  def initialize(seconds)
+    @mutex = Mutex.new
+    @timeout = false
+    @timeout_at = Time.now() + seconds
+  end
+
+  def pop(non_block = true)
+    return true if @timeout
+
+    @mutex.synchronize do
+      diff = @timeout_at - Time.now()
+      @timeout = true if diff <= 0
+    end
+
+    if @timeout
+      true
+    else
+      raise ThreadError
+    end
+  end
+end

data/lib/ruby_go/version.rb

@@ -0,0 +1,3 @@
+module RubyGo
+  VERSION = "0.1.0"
+end

data/ruby_go.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_go/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_gothreads"
+  spec.version       = RubyGo::VERSION
+  spec.authors       = ["Zhuochun"]
+  spec.email         = ["zhuochun@hotmail.com"]
+
+  spec.summary       = %q{Syntax sugars around Ruby threads like Goroutines}
+  spec.description   = %q{Syntax sugars (`go`, `chan`, `select`) around Ruby threads and queues, emulating Golang Goroutines}
+  spec.homepage      = "https://github.com/zhuochun"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ruby_gothreads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zhuochun
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Syntax sugars (`go`, `chan`, `select`) around Ruby threads and queues, emulating Golang Goroutines
+email:
+- zhuochun@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/fibonacci.rb
+- example/schedular.rb
+- example/timeout.rb
+- example/timeout_2.rb
+- lib/ruby_go.rb
+- lib/ruby_go/timeout.rb
+- lib/ruby_go/version.rb
+- ruby_go.gemspec
+homepage: https://github.com/zhuochun
+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.6.4
+signing_key:
+specification_version: 4
+summary: Syntax sugars around Ruby threads like Goroutines
+test_files: []