em-ventually 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+**/Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-ventually.gemspec
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+# EM::Ventually
+
+Your tests will eventually pass. You're not sure when, but you know it'll be quick. This is where EM::Ventually can help you!
+
+Take this trivial example. (It's in Minitest, but you can use whatever test suite you'd like*)
+
+~~~~~ {ruby}
+    def test_em_simple
+      val = nil
+      EM.add_timer(0.5) { val = 'test' }
+    end
+~~~~~
+
+So, you want to test that val is 'test', and as well, you want EM to start on the beginning of your test and shutdown when it's done. The other thing you want is the ability to not let this test run forever, but to shutdown EM and consider it a failure if it doesn't complete.
+
+**Eventually is here to help!**
+
+Taking the example above you can enqueue a test.
+
+~~~~~ {ruby}
+    def test_em_simple
+      val = nil
+      EM.add_timer(0.5) { val = 'test' }
+      eventually('test') { val }
+    end
+~~~~~
+
+This will poll your block every 0.1 seconds to see if the condition is true. After one second, if it's still not true, it will fail. You can mess with both values by passing in `:every` and `:total`. For example:
+
+~~~~~ {ruby}
+    def test_em_simple
+      val = nil
+      EM.add_timer(0.5) { val = 'test' }
+      eventually('test', :every => 0.2, :total => 10) { val } # check every 0.2 seconds
+                                                              # for a total of 10 seconds.
+    end
+~~~~~
+
+You can also parallelize tests if you don't want them to run serially.
+
+~~~~~ {ruby}
+    def test_em_simple
+      val1, val2 = nil, nil
+      EM.add_timer(0.5) { val1 = 'test1' }
+      EM.add_timer(0.5) { val2 = 'test2' }
+      parallel do
+        eventually('test1') { val1 }
+        eventually('test2') { val2 }
+      end
+    end
+~~~~~
+
+As well, simple returning doesn't always cover your test. You can pass values back for equality by doing the following.
+
+~~~~~ {ruby}
+    def test_em_simple
+      val = nil
+      EM.add_timer(0.5) { val = 'test1' }
+      eventually('test1') { |value| value.call(val1) } # The secret sauce is if you called
+                                                       # `eventually` with a parameter or not.
+    end
+~~~~~
+
+Right now, `Test::Unit`, `RSpec` and `MiniTest` are supported. Just do `include EM::Ventually` in your test and you'll get all this for free.
+

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/gem_tasks'
+
+task :default => :test
+
+task :test do
+  matchers = {
+    'minitest-2.0' => [/6 tests, 9 assertions, 1 failures, 0 errors, 0 skips/m],
+    'rspec-2.6' => [/\n\.\.\.\.F\.\n/m],
+    'test-unit' => [/\n\.\.\.F\.\.\n/m, /test_out_of_order\(TestEMVentually\)/m]
+  }
+
+  matchers.each do |type, matcher|
+    STDOUT.sync = true
+    Dir.chdir("./test/#{type}") do
+      print "Testing #{type}#{' ' * (22 - type.size )}"
+      fork {
+        ENV['BUNDLE_GEMFILE'] = File.expand_path("./Gemfile")
+        out = `bundle && bundle exec rake 2>&1`
+        if matcher.all?{|m|out[m]}
+          exit
+        else
+          puts out
+          exit 1
+        end
+      }
+      _, status = Process.wait2
+      puts status.success? ? "PASSED" : "FAILED"
+    end
+  end
+
+
+end
+

data/em-ventually.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-ventually/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-ventually"
+  s.version     = EventMachine::Ventually::VERSION
+  s.authors     = ["Josh Hull"]
+  s.email       = ["joshbuddy@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Eventually, your tests should pass in EventMachine}
+  s.description = %q{Eventually, your tests should pass in EventMachine.}
+
+  s.rubyforge_project = "em-ventually"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # dependencies
+  s.add_runtime_dependency 'eventmachine'
+  s.add_runtime_dependency 'callsite'
+  s.add_development_dependency 'code_stats'
+  s.add_development_dependency 'rake',     '~> 0.8.7'
+  s.add_development_dependency 'phocus'
+  s.add_development_dependency 'bundler',  '~> 1.0.0'
+end

data/lib/em-ventually.rb

@@ -0,0 +1,48 @@
+require 'set'
+require 'eventmachine'
+require 'callsite'
+require 'em-ventually/version'
+require 'em-ventually/eventually'
+require 'em-ventually/pool'
+
+module EventMachine
+  module Ventually
+    def _pool
+      @_pool ||= Pool.new
+    end
+
+    def eventually(expectation = true, opts = nil, &block)
+      ancestors = self.class.ancestors.map{|s| s.to_s}
+      cls = if ancestors.include?('MiniTest::Unit::TestCase')
+        Eventually::MiniTest
+      elsif ancestors.include?('Test::Unit::TestCase')
+        Eventually::TestUnit
+      elsif self.class.to_s[/^RSpec::Core/]
+        Eventually::RSpec
+      else
+        nil
+      end
+      cls.new(_pool, self, Callsite.parse(caller.first), expectation, opts, block)
+    end
+
+    def parallel(&blk)
+      _pool.in_parallel do
+        instance_eval(&blk)
+      end
+    end
+
+    def self.included(o)
+      ancestors = o.ancestors.map{|s| s.to_s}
+      cls = if ancestors.include?('MiniTest::Unit::TestCase')
+        Eventually::MiniTest
+      elsif ancestors.include?('Test::Unit::TestCase')
+        Eventually::TestUnit
+      elsif o.respond_to?(:superclass) && o.superclass.to_s == 'RSpec::Core::ExampleGroup'
+        Eventually::RSpec
+      else
+        raise("I know what testsuite i'm in!")
+      end
+      cls.inject
+    end
+  end
+end

data/lib/em-ventually/eventually.rb

@@ -0,0 +1,71 @@
+module EventMachine
+  module Ventually
+    class Eventually
+
+      autoload :MiniTest, 'em-ventually/eventually/minitest'
+      autoload :RSpec,    'em-ventually/eventually/rspec'
+      autoload :TestUnit, 'em-ventually/eventually/testunit'
+
+      attr_reader :expectation
+
+      def initialize(pool, runner, caller, expectation, opts, block)
+        @pool, @runner, @caller, @expectation, @opts, @block = pool, runner, caller, expectation, opts, block
+        @count = 0
+        @pool.push self
+        @total_time = opts && opts[:total] || 1
+        @every_time = opts && opts[:every] || 0.1
+        run
+      end
+
+      def assert_equal(got)
+        got == expectation
+      end
+
+      def formatted_message(msg)
+        "#{msg} (#{@caller.filename}:#{@caller.line})"
+      end
+
+      def kill_timer
+        @kill_timer ||= EM.add_timer(@total_time) { stop(formatted_message("Exceeded time, expected #{expectation.inspect}, last value was #{@last_val.inspect}")) }
+      end
+
+      def run
+        if @pool.should_run?(self)
+          kill_timer
+          if @block.arity != 1
+            process_equality(@last_val = @block.call)
+          else
+            @block[proc { |val|
+              @last_val = val
+              process_equality(val)
+            }]
+          end
+        else
+          EM.add_timer(@every_time) { run }
+        end
+      end
+
+      def process_equality(val)
+        if assert_equal(val)
+          stop
+        else
+          @count += 1
+          EM.add_timer(@every_time) { run }
+        end
+      end
+
+      def stop(msg = nil)
+        EM.cancel_timer @kill_timer
+        @pool.complete(self)
+        report(msg) if msg
+        if @pool.empty? && EM.reactor_running?
+          EM.stop
+        end
+      end
+
+      def report(msg)
+        STDERR << "Msg: #{msg}\n"
+      end
+    end
+  end
+end

data/lib/em-ventually/eventually/minitest.rb

@@ -0,0 +1,44 @@
+module EventMachine
+  module Ventually
+    class Eventually
+      class MiniTest < Eventually
+        def self.inject
+          ::MiniTest::Unit::TestCase.class_eval <<-EOT, __FILE__, __LINE__ + 1
+          alias_method :__original__send__, :__send__
+          def __send__(*args, &blk)
+            if Callsite.parse(caller.first).method == 'run'
+              result = nil
+              EM.run do 
+                begin
+                  result = __original__send__(*args, &blk)
+                ensure
+                  EM.stop if (!instance_variable_defined?(:@_pool) || @_pool.nil? || @_pool.empty?) && EM.reactor_running?
+                end
+                result
+              end
+            else
+              __original__send__(*args, &blk)
+            end
+          end
+          EOT
+        end
+
+        def report(msg)
+          @runner.assert false, msg
+        end
+
+        def assert_equal(result)
+          e = expectation
+          if result == expectation
+            @runner.instance_eval do
+              assert_equal result, e
+            end
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/em-ventually/eventually/rspec.rb

@@ -0,0 +1,50 @@
+module EventMachine
+  module Ventually
+    class Eventually
+      class RSpec < Eventually
+        def self.inject
+          ::RSpec::Core::ExampleGroup.class_eval <<-EOT, __FILE__, __LINE__ + 1
+          alias_method :original_instance_eval, :instance_eval
+          def instance_eval(&block)
+            _em do
+              original_instance_eval(&block)
+            end
+          end
+
+          def _em
+            result = nil
+            if EM.reactor_running?
+              result = yield
+            else
+              EM.run do
+                begin
+                  result = yield
+                ensure
+                  EM.stop if (!instance_variable_defined?(:@_pool) || @_pool.nil? || @_pool.empty?) && EM.reactor_running?
+                end
+              end
+            end
+            result
+          end
+          EOT
+        end
+
+        def report(msg)
+          ::RSpec::Expectations.fail_with(msg)
+        end
+
+        def assert_equal(result)
+          e = expectation
+          if result == expectation
+            @runner.instance_eval do
+              result.should == e
+            end
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/em-ventually/eventually/testunit.rb

@@ -0,0 +1,44 @@
+module EventMachine
+  module Ventually
+    class Eventually
+      class TestUnit < Eventually
+        def self.inject
+          ::Test::Unit::TestCase.class_eval <<-EOT, __FILE__, __LINE__ + 1
+          alias_method :__original__send__, :__send__
+          def __send__(*args, &blk)
+            if Callsite.parse(caller.first).method == 'run'
+              result = nil
+              EM.run do 
+                begin
+                  result = __original__send__(*args, &blk)
+                ensure
+                  EM.stop if (!instance_variable_defined?(:@_pool) || @_pool.nil? || @_pool.empty?) && EM.reactor_running?
+                end
+                result
+              end
+            else
+              __original__send__(*args, &blk)
+            end
+          end
+          EOT
+        end
+
+        def report(msg)
+          @runner.assert false, msg
+        end
+
+        def assert_equal(result)
+          e = expectation
+          if result == expectation
+            @runner.instance_eval do
+              assert_equal result, e
+            end
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/em-ventually/pool.rb

@@ -0,0 +1,44 @@
+module EventMachine
+  module Ventually
+    class Pool
+      def initialize
+        @store = []
+      end
+
+      def should_run?(eventually)
+        case @store.first
+        when Array
+          @store.first.include?(eventually)
+        else
+          @store.first == eventually
+        end
+      end
+
+      def in_parallel
+        @store.push []
+        yield
+      end
+
+      def push(e)
+        if @store.last.is_a?(Array)
+          @store.last.push(e)
+        else
+          @store.push(e)
+        end
+      end
+
+      def complete(e)
+        if @store.first.is_a?(Array)
+          @store.first.delete(e)
+          @store.shift if @store.last.empty?
+        else
+          @store.delete(e)
+        end
+      end
+
+      def empty?
+        @store.empty?
+      end
+    end
+  end
+end

data/lib/em-ventually/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module Ventually
+    VERSION = "0.0.1"
+  end
+end

data/test/minitest-2.0/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'minitest', '~> 2.0.0'
+gem 'eventmachine'
+gem 'rake', '0.8.7'
+gem 'phocus'
+gem 'callsite'

data/test/minitest-2.0/Rakefile

@@ -0,0 +1,9 @@
+task :default => :test
+
+desc "Run tests"
+task :test do
+  $: << File.expand_path("#{File.dirname(__FILE__)}/../../lib")
+  require 'em-ventually'
+  require './helper'
+  Dir['./*.rb'].each { |test| require test }
+end

data/test/minitest-2.0/helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'phocus'

data/test/minitest-2.0/test_ventually.rb

@@ -0,0 +1,45 @@
+class TestMounting < MiniTest::Unit::TestCase
+  include EM::Ventually
+
+  def test_simple
+    assert_equal 1, 1
+  end
+
+  def test_em_simple
+    val = nil
+    EM.add_timer(0.5) { val = 'test' }
+    eventually('test') { val }
+  end
+
+  def test_em_passing
+    val = nil
+    EM.add_timer(0.5) { val = 'test' }
+    eventually('test') {|m| m[val] }
+  end
+
+  def test_multiple
+    val = nil
+    EM.add_timer(0.3) { val = 'test' }
+    EM.add_timer(0.8) { val = 'test2' }
+    eventually('test') {|m| m[val] }
+    eventually('test2') {|m| m[val] }
+  end
+
+  def test_out_of_order # this should fail
+    val = nil
+    EM.add_timer(0.3) { val = 'test2' }
+    EM.add_timer(0.8) { val = 'test' }
+    eventually('test') {|m| m[val] }
+    eventually('test2') {|m| m[val] }
+  end
+
+  def test_out_of_order_with_parallel
+    val = nil
+    EM.add_timer(0.3) { val = 'test2' }
+    EM.add_timer(0.8) { val = 'test' }
+    parallel {
+      eventually('test') {|m| m[val] }
+      eventually('test2') {|m| m[val] }
+    }
+  end
+end

data/test/rspec-2.6/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rspec', '~> 2.6.0'
+gem 'eventmachine'
+gem 'rake', '0.8.7'
+gem 'callsite'

data/test/rspec-2.6/Rakefile

@@ -0,0 +1,6 @@
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) { |spec|
+  spec.pattern = "*_spec.rb"
+}

data/test/rspec-2.6/helper.rb

@@ -0,0 +1 @@
+require 'minitest/autorun'

data/test/rspec-2.6/ventually_spec.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../../lib"
+require 'em-ventually'
+
+describe EM::Ventually do
+  include EM::Ventually
+
+  it "should allow a normal test" do
+    1.should == 1
+  end
+
+  it "should allow a simple em test" do
+    val = nil
+    EM.add_timer(0.5) { val = 'test' }
+    eventually('test') { val }
+  end
+
+  it "should allow an em test with value passing" do
+    val = nil
+    EM.add_timer(0.5) { val = 'test' }
+    eventually('test') {|m| m[val] }
+  end
+
+  it "should allow multiple eventuallys" do
+    val = nil
+    EM.add_timer(0.3) { val = 'test' }
+    EM.add_timer(0.8) { val = 'test2' }
+    eventually('test') {|m| m[val] }
+    eventually('test2') {|m| m[val] }
+  end
+
+  it "should fail when out of order" do
+    val = nil
+    EM.add_timer(0.3) { val = 'test2' }
+    EM.add_timer(0.8) { val = 'test' }
+    eventually('test') {|m| m[val] }
+    eventually('test2') {|m| m[val] }
+  end
+
+  it "should succeed when out of order using parallel" do
+    val = nil
+    EM.add_timer(0.3) { val = 'test2' }
+    EM.add_timer(0.8) { val = 'test' }
+    parallel {
+      eventually('test') {|m| m[val] }
+      eventually('test2') {|m| m[val] }
+    }
+  end
+end

data/test/test-unit/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'eventmachine'
+gem 'rake', '0.8.7'
+gem 'phocus'
+gem 'callsite'

data/test/test-unit/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+desc "Run basic tests"
+Rake::TestTask.new("test") { |t|
+  t.pattern = File.expand_path("#{File.dirname(__FILE__)}/test_*.rb")
+  t.verbose = true
+  t.warning = true
+  t.libs = [File.expand_path("#{File.dirname(__FILE__)}/../../lib")]
+}
+
+task :default => :test

data/test/test-unit/helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'phocus'

data/test/test-unit/test_ventually.rb

@@ -0,0 +1,48 @@
+require 'em-ventually'
+require 'test/unit'
+
+class TestEMVentually < Test::Unit::TestCase
+  include EM::Ventually
+
+  def test_simple
+    assert_equal 1, 1
+  end
+
+  def test_em_simple
+    val = nil
+    EM.add_timer(0.5) { val = 'test' }
+    eventually('test') { val }
+  end
+
+  def test_em_passing
+    val = nil
+    EM.add_timer(0.5) { val = 'test' }
+    eventually('test') {|m| m[val] }
+  end
+
+  def test_multiple
+    val = nil
+    EM.add_timer(0.3) { val = 'test' }
+    EM.add_timer(0.8) { val = 'test2' }
+    eventually('test') {|m| m[val] }
+    eventually('test2') {|m| m[val] }
+  end
+
+  def test_out_of_order # this should fail
+    val = nil
+    EM.add_timer(0.3) { val = 'test2' }
+    EM.add_timer(0.8) { val = 'test' }
+    eventually('test') {|m| m[val] }
+    eventually('test2') {|m| m[val] }
+  end
+
+  def test_out_of_order_with_parallel
+    val = nil
+    EM.add_timer(0.3) { val = 'test2' }
+    EM.add_timer(0.8) { val = 'test' }
+    parallel {
+      eventually('test') {|m| m[val] }
+      eventually('test2') {|m| m[val] }
+    }
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: em-ventually
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  name: eventmachine
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  name: callsite
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  name: code_stats
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  requirement: *id004
+  name: rake
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  name: phocus
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id006
+  name: bundler
+  type: :development
+description: Eventually, your tests should pass in EventMachine.
+email: 
+- joshbuddy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- em-ventually.gemspec
+- lib/em-ventually.rb
+- lib/em-ventually/eventually.rb
+- lib/em-ventually/eventually/minitest.rb
+- lib/em-ventually/eventually/rspec.rb
+- lib/em-ventually/eventually/testunit.rb
+- lib/em-ventually/pool.rb
+- lib/em-ventually/version.rb
+- test/minitest-2.0/Gemfile
+- test/minitest-2.0/Rakefile
+- test/minitest-2.0/helper.rb
+- test/minitest-2.0/test_ventually.rb
+- test/rspec-2.6/Gemfile
+- test/rspec-2.6/Rakefile
+- test/rspec-2.6/helper.rb
+- test/rspec-2.6/ventually_spec.rb
+- test/test-unit/Gemfile
+- test/test-unit/Rakefile
+- test/test-unit/helper.rb
+- test/test-unit/test_ventually.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: em-ventually
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Eventually, your tests should pass in EventMachine
+test_files: 
+- test/minitest-2.0/Gemfile
+- test/minitest-2.0/Rakefile
+- test/minitest-2.0/helper.rb
+- test/minitest-2.0/test_ventually.rb
+- test/rspec-2.6/Gemfile
+- test/rspec-2.6/Rakefile
+- test/rspec-2.6/helper.rb
+- test/rspec-2.6/ventually_spec.rb
+- test/test-unit/Gemfile
+- test/test-unit/Rakefile
+- test/test-unit/helper.rb
+- test/test-unit/test_ventually.rb