keeper 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,5 @@
+--color
+-fs
+-Ilib
+-Ispec
+--require spec_helper

data/.yardopts

@@ -0,0 +1,3 @@
+--title "Keeper"
+--charset UTF-8
+--markup markdown

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "yard", "~> 0.6.0"
+  gem "bluecloth"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.0.9)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    yard (0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rspec (~> 2.1.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kim Burgestrand
+
+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.markdown

@@ -0,0 +1,45 @@
+Keeper!?
+========
+Ever wished you could spawn several threads, each of them waiting for a certain event to happen, without having to do the manual book-keeping of condition variables and mutexes? Now you can!
+
+Keeper is a library that allows multiple threads to wait for incoming events. Have a look at this example code from the docs:
+
+    events = Keeper::Keeper.new
+
+    [:pang, :boom, :pow].each_with_index do |event, i|
+      this_many = i + 1
+      this_many.times do |i|
+        Thread.new do
+          events.wait_for(event)
+          puts "#{event}:#{i}!"
+          events.fire(event == :pang ? :boom : :pow)
+        end
+      end
+      puts "#{this_many} threads waiting for #{event}"
+    end
+
+    print "Pause for effect"
+    3.times { sleep 1 and print "." }
+    puts
+
+    events.fire(:pang)
+    Thread.list.reject { |th| th == Thread.current }.map(&:join)
+    
+And here’s your output:
+
+    1 threads waiting for pang
+    2 threads waiting for boom
+    3 threads waiting for pow
+    Pause for effect...
+    pang:0!
+    boom:0!
+    boom:1!
+    pow:0!
+    pow:2!
+    pow:1!
+
+Ain’t that awesome?! I think it is.
+
+License
+-------
+X11. It means you can use Keeper for whatever you want as long as you ship the license text with it, it’s in LICENSE.txt.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'yard'
+require 'jeweler'
+require 'rspec/core/rake_task'
+require './lib/keeper/version'
+
+Jeweler::Tasks.new do |gem|
+  gem.name     = "keeper"
+  gem.homepage = "http://github.com/Burgestrand/keeper"
+  gem.license  = "X11"
+               
+  gem.summary  = %Q{A thread-safe blocking event pattern for your pleasure.}
+  gem.authors  = ["Kim Burgestrand"]
+  gem.email    = "kim@burgestrand.se"
+  
+  gem.version  = Keeper::Version::STRING
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+YARD::Rake::YardocTask.new
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/keeper.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{keeper}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kim Burgestrand"]
+  s.date = %q{2010-12-11}
+  s.email = %q{kim@burgestrand.se}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "keeper.gemspec",
+    "lib/keeper.rb",
+    "lib/keeper/version.rb",
+    "spec/keeper_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/Burgestrand/keeper}
+  s.licenses = ["X11"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A thread-safe blocking event pattern for your pleasure.}
+  s.test_files = [
+    "spec/keeper_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bluecloth>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bluecloth>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bluecloth>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+  end
+end
+

data/lib/keeper.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+require 'thread'
+require 'keeper/version'
+
+# If you are looking for the documentation you’ll most likely want {Keeper::Keeper}.
+#
+module Keeper
+  # A thread-safe blocking event pattern for your pleasure.
+  #
+  # @example
+  #   events = Keeper::Keeper.new
+  #
+  #   [:pang, :boom, :pow].each_with_index do |event, i|
+  #     this_many = i + 1
+  #     this_many.times do |i|
+  #       Thread.new do
+  #         events.wait_for(event)
+  #         puts "#{event}:#{i}!"
+  #         events.fire(event == :pang ? :boom : :pow)
+  #       end
+  #     end
+  #     puts "#{this_many} threads waiting for #{event}"
+  #   end
+  #
+  #   print "Pause for effect"
+  #   3.times { sleep 1 and print "." }
+  #   puts
+  #
+  #   events.fire(:pang)
+  #   Thread.list.reject { |th| th == Thread.current }.map(&:join)
+  #
+  class Keeper
+    # Create a new {Keeper::Keeper} instance.
+    def initialize
+      @waiting = {}
+      @mootex  = Mutex.new
+    end
+
+    # Fires the given event, waking up the waiting threads.
+    #
+    # @param [Symbol] event
+    # @return [Keeper]
+    def fire(event)
+      @mootex.synchronize do
+        condition = @waiting.delete(event)
+        condition.broadcast unless condition.nil?
+      end
+      self
+    end
+
+    # Waits for the given event to fire.
+    #
+    # @param [Symbol] event
+    # @return [Keeper]
+    def wait_for(event)
+      @mootex.synchronize do
+        (@waiting[event] ||= ConditionVariable.new).wait(@mootex)
+      end
+      self
+    end
+
+    # A list of all events currently being waited for.
+    #
+    # @return [Array<Symbol>]
+    def waiting
+      @mootex.synchronize { @waiting.keys }
+    end
+  end
+end

data/lib/keeper/version.rb

@@ -0,0 +1,18 @@
+module Keeper
+  # Current release version of Keeper
+  #
+  # @see http://semver.org/
+  module Version
+    # Incremented *only* on backwards **incompatible** changes.
+    MAJOR  = 1
+    
+    # Incremented *only* after adding new, backwards compatible functionality.
+    MINOR  = 0
+    
+    # Incremented *only* on backwards compatible bug fixes.
+    PATCH  = 0
+    
+    # String representation of the current version in the form X.Y.Z
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/spec/keeper_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Keeper" do
+  describe "#wait_for" do
+    context "new event" do
+      it "should create the event signaller"
+      it "should register the calling thread as waiting"
+    end
+    
+    context "existing event" do
+      it "should re-use the existing signaller"
+      it "should not affect any other waiting threads"
+      it "should register the the calling thread as waiting"
+    end
+  end
+  
+  describe "#fire" do
+    context "existing event" do
+      it "should release all listeners"
+    end
+    
+    context "non-existing event" do
+      it "should not cause an error"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'keeper'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: keeper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kim Burgestrand
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: 
+email: kim@burgestrand.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rspec
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- keeper.gemspec
+- lib/keeper.rb
+- lib/keeper/version.rb
+- spec/keeper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Burgestrand/keeper
+licenses: 
+- X11
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2286222574126618657
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A thread-safe blocking event pattern for your pleasure.
+test_files: 
+- spec/keeper_spec.rb
+- spec/spec_helper.rb