em-ventually 0.0.1 → 0.1.0

data/README.md

@@ -1,5 +1,7 @@
 # EM::Ventually
 
+## Background
+
 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*)
@@ -13,7 +15,9 @@ Take this trivial example. (It's in Minitest, but you can use whatever test suit
 
 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!**
+**EM::Ventually is here to help!**
+
+`EM::Ventually` will take care to start and stop EventMachine, and make sure your tests run serially (unless you don't want them to). It will also prevent your tests from running forever.
 
 Taking the example above you can enqueue a test.
 
@@ -56,10 +60,21 @@ As well, simple returning doesn't always cover your test. You can pass values ba
     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.
+      eventually('test1') { |test| test[val1] } # The secret sauce is if you called
+                                                # `eventually` with a block that takes 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.
+## Usage
+
+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. If you want to use this in all your tests, you can `require 'em-ventually/{minitest,unittest,rspec}'` your appropriate test suite.
+
+There are a couple of global options you can mess with too. `EM::Ventually.every_default=` and `EM::Ventually.total_default=` can both set global `:every` and `:total` times for your tests.
 
+If you don't pass a value to eventually, it will test that your value is true (in the ruby sense). Optionally, you can call `.test` to pass a custom tester.
+
+~~~~~ {ruby}
+    def test_em_with_test
+      eventually(3.5).test{ |v| v < 4 }
+    end
+~~~~~

data/Rakefile

@@ -5,7 +5,7 @@ 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],
+    'rspec-2.6' => [/\n\.\.\.\.F\.\.\.\n/m],
     'test-unit' => [/\n\.\.\.F\.\.\n/m, /test_out_of_order\(TestEMVentually\)/m]
   }
 

data/em-ventually.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   # dependencies
   s.add_runtime_dependency 'eventmachine'
-  s.add_runtime_dependency 'callsite'
+  s.add_runtime_dependency 'callsite',     '~> 0.0.5'
   s.add_development_dependency 'code_stats'
   s.add_development_dependency 'rake',     '~> 0.8.7'
   s.add_development_dependency 'phocus'

data/lib/em-ventually.rb

@@ -1,17 +1,34 @@
 require 'set'
 require 'eventmachine'
 require 'callsite'
-require 'em-ventually/version'
 require 'em-ventually/eventually'
+require 'em-ventually/emify'
 require 'em-ventually/pool'
+require 'em-ventually/version'
 
 module EventMachine
   module Ventually
+    def self.every_default=(value)
+      @every_default = value
+    end
+
+    def self.every_default
+      instance_variable_defined?(:@every_default) ? @every_default : 0.1
+    end
+
+    def self.total_default=(value)
+      @total_default = value
+    end
+
+    def self.total_default
+      instance_variable_defined?(:@total_default) ? @total_default : 1.0
+    end
+
     def _pool
       @_pool ||= Pool.new
     end
 
-    def eventually(expectation = true, opts = nil, &block)
+    def eventually(expectation = nil, opts = nil, &block)
       ancestors = self.class.ancestors.map{|s| s.to_s}
       cls = if ancestors.include?('MiniTest::Unit::TestCase')
         Eventually::MiniTest
@@ -37,7 +54,7 @@ module EventMachine
         Eventually::MiniTest
       elsif ancestors.include?('Test::Unit::TestCase')
         Eventually::TestUnit
-      elsif o.respond_to?(:superclass) && o.superclass.to_s == 'RSpec::Core::ExampleGroup'
+      elsif (o.respond_to?(:name) && o.name.to_s == 'RSpec::Core::ExampleGroup') || (o.respond_to?(:superclass) && o.superclass.to_s == 'RSpec::Core::ExampleGroup')
         Eventually::RSpec
       else
         raise("I know what testsuite i'm in!")

data/lib/em-ventually/emify.rb

@@ -0,0 +1,21 @@
+module EventMachine
+  module Ventually
+    module Emify
+      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
+    end
+  end
+end

data/lib/em-ventually/eventually.rb

@@ -12,13 +12,18 @@ module EventMachine
         @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
+        @total_time = opts && opts[:total] || EventMachine::Ventually.total_default
+        @every_time = opts && opts[:every] || EventMachine::Ventually.every_default
+        @test_blk = expectation.nil? ? proc{|r| r } : proc{|r| expectation == r}
+        EM.add_timer(0.05) { run }
       end
 
-      def assert_equal(got)
-        got == expectation
+      def test(&blk)
+        @test_blk = blk
+      end
+
+      def assert_test(got)
+        @test_blk[got]
       end
 
       def formatted_message(msg)
@@ -26,18 +31,18 @@ module EventMachine
       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}")) }
+        @kill_timer ||= EM.add_timer(@total_time) { stop(formatted_message("Exceeded time#{", expected #{expectation.inspect}" unless expectation.nil?}, 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)
+            process_test(@last_val = @block.call)
           else
             @block[proc { |val|
               @last_val = val
-              process_equality(val)
+              process_test(val)
             }]
           end
         else
@@ -45,8 +50,8 @@ module EventMachine
         end
       end
 
-      def process_equality(val)
-        if assert_equal(val)
+      def process_test(val)
+        if assert_test(val)
           stop
         else
           @count += 1

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

@@ -3,35 +3,31 @@ module EventMachine
     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
+          unless ::MiniTest::Unit::TestCase.public_method_defined?(:_em)
+            ::MiniTest::Unit::TestCase.class_eval <<-EOT, __FILE__, __LINE__ + 1
+            include EM::Ventually::Emify
+            alias_method :__original__send__, :__send__
+            def __send__(*args, &blk)
+              if Callsite.parse(caller.first).method == 'run'
+                _em { __original__send__(*args, &blk) }
+              else
+                __original__send__(*args, &blk)
               end
-            else
-              __original__send__(*args, &blk)
             end
+            EOT
           end
-          EOT
         end
 
         def report(msg)
           @runner.assert false, msg
         end
 
-        def assert_equal(result)
+        def assert_test(result)
           e = expectation
-          if result == expectation
+          if super
+            msg = formatted_message("#{result.inspect} passed")
             @runner.instance_eval do
-              assert_equal result, e
+              assert true, msg
             end
             true
           else

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

@@ -3,41 +3,27 @@ module EventMachine
     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)
+          unless ::RSpec::Core::ExampleGroup.public_method_defined?(:_em)
+            ::RSpec::Core::ExampleGroup.class_eval <<-EOT, __FILE__, __LINE__ + 1
+            include EM::Ventually::Emify
+            alias_method :original_instance_eval, :instance_eval
+            def instance_eval(&block)
+              _em { original_instance_eval(&block) }
             end
+            EOT
           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)
+        def assert_test(result)
           e = expectation
-          if result == expectation
+          if super
+            msg = formatted_message("#{result.inspect} passed")
             @runner.instance_eval do
-              result.should == e
+              1.should == 1
             end
             true
           else

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

@@ -3,35 +3,31 @@ module EventMachine
     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
+          unless ::Test::Unit::TestCase.public_method_defined?(:_em)
+            ::Test::Unit::TestCase.class_eval <<-EOT, __FILE__, __LINE__ + 1
+            include EM::Ventually::Emify
+            alias_method :__original__send__, :__send__
+            def __send__(*args, &blk)
+              if Callsite.parse(caller.first).method == 'run'
+                _em { __original__send__(*args, &blk) }
+              else
+                __original__send__(*args, &blk)
               end
-            else
-              __original__send__(*args, &blk)
             end
+            EOT
           end
-          EOT
         end
 
         def report(msg)
           @runner.assert false, msg
         end
 
-        def assert_equal(result)
+        def assert_test(result)
           e = expectation
-          if result == expectation
+          if super
+            msg = formatted_message("#{result.inspect} passed")
             @runner.instance_eval do
-              assert_equal result, e
+              assert true, msg
             end
             true
           else

data/lib/em-ventually/minitest.rb

@@ -0,0 +1,6 @@
+require 'em-ventually'
+
+MiniTest::Unit::TestCase.class_eval do
+  include EM::Ventually
+end
+  

data/lib/em-ventually/rspec.rb

@@ -0,0 +1,5 @@
+require 'em-ventually'
+
+RSpec::Core::ExampleGroup.class_eval do
+  include EM::Ventually
+end

data/lib/em-ventually/testunit.rb

@@ -0,0 +1,5 @@
+require 'em-ventually'
+
+Test::Unit::TestCase.class_eval do
+  include EM::Ventually
+end

data/lib/em-ventually/version.rb

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

data/test/rspec-2.6/ventually_spec.rb

@@ -1,8 +1,7 @@
 $LOAD_PATH << "#{File.dirname(__FILE__)}/../../lib"
-require 'em-ventually'
+require 'em-ventually/rspec'
 
 describe EM::Ventually do
-  include EM::Ventually
 
   it "should allow a normal test" do
     1.should == 1
@@ -45,4 +44,21 @@ describe EM::Ventually do
       eventually('test2') {|m| m[val] }
     }
   end
+
+  it "should allow longer tests with a specific number of passes" do
+    val = nil
+    count = 0
+    EM.add_timer(3.1) { val = 'done'}
+    eventually('done', :every => 0.5, :total => 3.5) { count +=1; val }
+    eventually(7) { count }
+  end
+
+  it "should allow custom tests" do
+    val = nil
+    count = 0
+    time = Time.new.to_f
+    EM.add_timer(0.5) { val = 'done'}
+    eventually('done') { val }
+    eventually { Time.new.to_f - time }.test{|t| t < 1}
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: em-ventually
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Josh Hull
@@ -15,12 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-07 00:00:00 -07:00
+date: 2011-08-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: eventmachine
   prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,26 +30,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-  name: eventmachine
   type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: callsite
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 21
         segments: 
         - 0
-        version: "0"
-  requirement: *id002
-  name: callsite
+        - 0
+        - 5
+        version: 0.0.5
   type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: code_stats
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -57,12 +60,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
-  name: code_stats
   type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -73,12 +76,12 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
-  requirement: *id004
-  name: rake
   type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: phocus
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -87,12 +90,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
-  name: phocus
   type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: bundler
   prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -103,9 +106,8 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id006
-  name: bundler
   type: :development
+  version_requirements: *id006
 description: Eventually, your tests should pass in EventMachine.
 email: 
 - joshbuddy@gmail.com
@@ -122,11 +124,15 @@ files:
 - Rakefile
 - em-ventually.gemspec
 - lib/em-ventually.rb
+- lib/em-ventually/emify.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/minitest.rb
 - lib/em-ventually/pool.rb
+- lib/em-ventually/rspec.rb
+- lib/em-ventually/testunit.rb
 - lib/em-ventually/version.rb
 - test/minitest-2.0/Gemfile
 - test/minitest-2.0/Rakefile