going 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d65446460582cc05ff1e4b2a7f2dd75fa8e2de02
+  data.tar.gz: d3bef60cf07e6f7142194c3a524aa7451e8fc46a
+SHA512:
+  metadata.gz: e7ada7d6cfc7e6bbf816e546f84c1c5b42f0901d4d8ac6740dd13219c8c73ebecb7d30eaba45f4a08ff4e194edd12f3856253cb267200983d55a649b1eeb510f
+  data.tar.gz: 5b353932fcd9107fddd2edde8fbcf2b950dbd5cc798100ccb1b4fbd7e2f58acf9ba2b6e6179665082232b46f0b55bc12ea6ed1949badffc501c97926a92d9ef9

data/.gitignore

@@ -0,0 +1,15 @@
+/bin/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.2.7
+  - rbx-2.2.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Justin Ridgewell
+
+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 @@
+# Going [![Build Status](https://travis-ci.org/jridgewell/Going.svg)](https://travis-ci.org/jridgewell/Going)
+
+Go for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'going'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install going
+
+## Usage
+
+Brings Go's Channel and Goroutines to Ruby.
+
+```ruby
+require 'going'
+# Require 'going/kernel' to get the unnamespaced `go` function
+# require 'going/kernel'
+
+class ConcurrentSieve
+  def generator
+    ch = Going::Channel.new
+    Going.go do
+      i = 1
+      loop { ch.push(i += 1) }
+    end
+    ch
+  end
+
+  def filter(prime, from)
+    ch = Going::Channel.new
+    Going.go do
+      loop do
+        i = from.receive
+        ch.push(i) if i % prime != 0
+      end
+    end
+    ch
+  end
+
+  def initialize(n)
+    ch = generator
+    n.times do
+      prime = ch.receive
+      puts prime
+      ch = filter(prime, ch)
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/jridgewell/going/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

data/Rakefile

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

data/going.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'going/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "going"
+  spec.version       = Going::VERSION
+  spec.authors       = ["Justin Ridgewell"]
+  spec.email         = ["justin@ridgewell.name"]
+  spec.summary       = %q{Go for Ruby}
+  spec.homepage      = "https://github.com/jridgewell/going"
+  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", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/going/channel.rb

@@ -0,0 +1,141 @@
+require 'going'
+
+module Going
+  #
+  # This class represents message channels of specified capacity.
+  # The push operation may be blocked if the capacity is full.
+  # The pop operation may be blocked if no messages have been sent.
+  #
+  class Channel
+    extend Forwardable
+
+    #
+    # Creates a fixed-length channel with a capacity of +capacity+.
+    #
+    def initialize(capacity = 0)
+      fail ArgumentError, 'channel capacity must be 0 or greater' unless capacity >= 0
+      @capacity = capacity
+      @closed = false
+      @mutex = Mutex.new
+      @push_semaphore = ConditionVariable.new
+      @pop_semaphore = ConditionVariable.new
+
+      yield self if block_given?
+    end
+
+    #
+    # Returns the capacity of the channel.
+    #
+    attr_reader :capacity
+
+    #
+    # Returns whether or not the channel is closed.
+    #
+    def closed?
+      @closed
+    end
+
+    #
+    # Closes the channel. Any data in the buffer may still be retrieved.
+    #
+    def close
+      synchronize do
+        return false if closed?
+        @messages = messages.first(capacity)
+        broadcast_close
+        @closed = true
+      end
+    end
+
+    #
+    # Pushes +obj+ to the channel. If the channel is already full, waits
+    # until a thread pops from it.
+    #
+    def push(obj)
+      synchronize do
+        fail 'cannot push to a closed channel' if closed?
+        messages.push obj
+        signal_push
+        wait_for_pop if messages.length > capacity
+        check_for_close
+        self
+      end
+    end
+
+    #
+    # Alias of push
+    #
+    alias_method :<<, :push
+    alias_method :yield, :push
+
+    #
+    # Receives data from the channel. If the channel is already empty,
+    # waits until a thread pushes to it.
+    #
+    def pop
+      synchronize do
+        return if closed?
+        wait_for_push if messages.empty?
+        signal_pop
+        check_for_close
+        messages.shift
+      end
+    end
+
+    #
+    # Alias of pop
+    #
+    alias_method :receive, :pop
+    alias_method :next, :pop
+
+    #
+    # Delegate size, length, and empty? to the messages queue
+    #
+    def_delegators :messages, :size, :empty?
+
+    #
+    # Alias of size
+    #
+    alias_method :length, :size
+
+    def inspect
+      inspection = [:capacity, :messages].map do |attr|
+        "#{attr}: #{send(attr).inspect}"
+      end
+      "#<#{self.class} #{inspection.join(', ')}>"
+    end
+
+    private
+
+    def_delegators :@mutex, :synchronize
+
+    def messages
+      @messages ||= []
+    end
+
+    def signal_pop
+      @push_semaphore.signal
+    end
+
+    def wait_for_pop
+      @push_semaphore.wait(@mutex)
+    end
+
+    def signal_push
+      @pop_semaphore.signal
+    end
+
+    def wait_for_push
+      @pop_semaphore.wait(@mutex)
+    end
+
+    def broadcast_close
+      @push_semaphore.broadcast
+      @pop_semaphore.broadcast
+    end
+
+    def check_for_close
+      throw :close if closed?
+    end
+  end
+end

data/lib/going/kernel.rb

@@ -0,0 +1,7 @@
+require 'going'
+
+module Kernel
+  def go(*args, &blk)
+    Going.go(*args, &blk)
+  end
+end

data/lib/going/version.rb

@@ -0,0 +1,3 @@
+module Going
+  VERSION = '0.0.3'
+end

data/lib/going.rb

@@ -0,0 +1,12 @@
+require 'thread'
+require 'going/channel'
+require 'going/version'
+
+module Going
+  #
+  # Creates an async thread to run the block
+  #
+  def self.go(*args, &blk)
+    Thread.new(*args, &blk)
+  end
+end

data/spec/going/channel_spec.rb

@@ -0,0 +1,214 @@
+describe Going::Channel do
+  subject(:channel) { Going::Channel.new }
+  def elapsed_time(original_time)
+    (Time.now - original_time)
+  end
+
+  describe '.new' do
+    it 'defaults capacity to 0' do
+      expect(channel.capacity).to eq(0)
+    end
+
+    it 'throws error if capacity is less than 0' do
+      expect { Going::Channel.new(-1) }.to raise_error
+    end
+
+    it 'is not closed' do
+      expect(channel).not_to be_closed
+    end
+
+    it 'yields itself if block given' do
+      yielded = nil
+      channel = Going::Channel.new { |y| yielded = y }
+      expect(yielded).to be(channel)
+    end
+  end
+
+  describe '#capacity' do
+    it 'returns capacity of channel' do
+      channel = Going::Channel.new(5)
+      expect(channel.capacity).to eq(5)
+    end
+  end
+
+  describe '#close' do
+    it 'closes channel' do
+      channel.close
+      expect(channel).to be_closed
+    end
+
+    it 'returns true after closing channel' do
+      expect(channel.close).to be(true)
+    end
+
+    it 'returns false if channel already closed' do
+      channel.close
+      expect(channel.close).to be(false)
+    end
+
+    it 'will wake a blocked push' do
+      Going.go do
+        sleep 0.1
+        channel.close
+      end
+      expect { channel.push 1 }.to throw_symbol(:close)
+    end
+
+    it 'will wake a blocked push' do
+      Going.go do
+        sleep 0.1
+        channel.close
+      end
+      expect { channel.receive }.to throw_symbol(:close)
+    end
+
+    it 'will reject all but the first #capacity pushes' do
+      channel = Going::Channel.new 2
+      Going.go do
+        sleep 0.1
+        channel.close
+      end
+      catch :close do
+        3.times { |i| channel.push i }
+      end
+      expect(channel.size).to eq(2)
+    end
+  end
+
+  describe '#push' do
+    subject(:channel) { Going::Channel.new 1 }
+
+    it 'is aliased as #<<' do
+      expect(channel.method(:<<)).to eq(channel.method(:push))
+    end
+
+    it 'is aliased as #yield' do
+      expect(channel.method(:yield)).to eq(channel.method(:push))
+    end
+
+    it 'raises error if channel is closed' do
+      channel.close
+      expect { channel.push 1 }.to raise_error
+    end
+
+    it 'will not block if channel is under capacity' do
+      now = Time.now
+      channel.push 1
+      expect(elapsed_time(now)).to be < 0.2
+    end
+
+    it 'will block if channel is over capacity' do
+      channel.push 1
+      Going.go do
+        sleep 0.25
+        channel.receive
+      end
+      now = Time.now
+      channel.push 1
+      expect(elapsed_time(now)).to be > 0.2
+    end
+
+    it 'will push messages in order' do
+      channel.push 1
+      Going.go do
+        channel.push 2
+      end
+      Going.go do
+        sleep 0.05
+        channel.push 3
+      end
+      sleep 0.1
+      1.upto(3).each do |i|
+        expect(channel.receive).to eq(i)
+      end
+    end
+
+    it 'returns the channel' do
+      expect(channel.push(1)).to be(channel)
+    end
+  end
+
+  describe '#pop' do
+    subject(:channel) { Going::Channel.new 1 }
+
+    it 'is aliased as #receive' do
+      expect(channel.method(:receive)).to eq(channel.method(:pop))
+    end
+
+    it 'is aliased as #next' do
+      expect(channel.method(:next)).to eq(channel.method(:pop))
+    end
+
+    it 'returns the next message' do
+      channel.push 1
+      expect(channel.receive).to eq(1)
+    end
+
+    it 'will not block if channel is not empty' do
+      channel.push 1
+      now = Time.now
+      channel.receive
+      expect(elapsed_time(now)).to be < 0.2
+    end
+
+    it 'will block if channel is empty' do
+      Going.go do
+        sleep 0.25
+        channel.push 1
+      end
+      now = Time.now
+      channel.receive
+      expect(elapsed_time(now)).to be > 0.2
+    end
+
+    it 'returns nil if closed' do
+      channel.close
+      expect(channel.receive).to be_nil
+    end
+
+    it 'does not block if closed' do
+      channel.close
+      now = Time.now
+      channel.receive
+      expect(elapsed_time(now)).to be < 0.2
+    end
+  end
+
+  describe '#size' do
+    it 'is aliased as #length' do
+      expect(channel.method(:length)).to eq(channel.method(:size))
+    end
+
+    it 'returns the number of messages in channel' do
+      channel = Going::Channel.new 2
+      expect(channel.size).to eq(0)
+      channel.push 1
+      expect(channel.size).to eq(1)
+      channel.push 1
+      expect(channel.size).to eq(2)
+      channel.receive
+      expect(channel.size).to eq(1)
+      channel.receive
+      expect(channel.size).to eq(0)
+    end
+  end
+
+  describe '#empty?' do
+    it 'returns true when no messages in channel' do
+      expect(channel).to be_empty
+    end
+
+    context 'when capacity is greater than 0' do
+      subject(:channel) { Going::Channel.new 1 }
+
+      it 'returns true when messages in channel' do
+        expect(channel).to be_empty
+      end
+
+      it 'returns false when messages in channel' do
+        channel.push 1
+        expect(channel).not_to be_empty
+      end
+    end
+  end
+end

data/spec/going/kernel_spec.rb

@@ -0,0 +1,18 @@
+require 'going/kernel'
+
+describe Kernel do
+  it 'defines #go function' do
+    expect(method(:go)).not_to be(nil)
+  end
+
+  it 'delegates to Going.go' do
+    expect(Going).to receive(:go)
+    go
+  end
+
+  it "returns Going.go's return value" do
+    thread = double
+    expect(Going).to receive(:go) { thread }
+    expect(go).to be(thread)
+  end
+end

data/spec/going_spec.rb

@@ -0,0 +1,28 @@
+describe Going do
+  describe '.go' do
+    it 'creates new thread' do
+      expect(Thread).to receive(:new)
+      Going.go
+    end
+
+    it 'passes args to block' do
+      args = nil
+      Going.go(1, 2, 3) { |*a| args = a }.join
+      expect(args).to eq([1, 2, 3])
+    end
+
+    it 'passes block to thread' do
+      block = proc {}
+      expect(Thread).to receive(:new) do |&blk|
+        expect(blk).to be(block)
+      end
+      Going.go(&block)
+    end
+
+    it 'returns thread' do
+      thread = double
+      expect(Thread).to receive(:new) { thread }
+      expect(Going.go).to be(thread)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'going'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: going
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Justin Ridgewell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-22 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- justin@ridgewell.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- going.gemspec
+- lib/going.rb
+- lib/going/channel.rb
+- lib/going/kernel.rb
+- lib/going/version.rb
+- spec/going/channel_spec.rb
+- spec/going/kernel_spec.rb
+- spec/going_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jridgewell/going
+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: Go for Ruby
+test_files:
+- spec/going/channel_spec.rb
+- spec/going/kernel_spec.rb
+- spec/going_spec.rb
+- spec/spec_helper.rb