em-ventually 0.1.1 → 0.1.2

data/README.md

@@ -5,11 +5,28 @@
 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*)
+Without em-ventually, testing your EM code requires a lot of boilerplate such as:
 
 ~~~~~ {ruby}
-    def test_em_simple1
-      val = nil
-      EM.add_timer(0.5) { val = 'test' }
+    # Without em-ventually
+    def test_em
+     # Start EM loop.
+     EM.run do
+       # The only two lines you actually care about.
+       val = nil
+       EM.add_timer(0.5) { val = 'test' }
+
+       # Test that work happens in the future.
+       EM.add_periodic_timer(0.1) do
+         if val == 'test'
+           pass      # Increment assertion count.
+           EM.stop   # Manually stop EM loop.
+         end
+       end
+
+       # Guard against infinite loops.
+       EM.add_timer(1) { raise "Potential infinite loop averted!" }
+     end
     end
 ~~~~~
 
@@ -22,17 +39,27 @@ So, you want to test that val is 'test', and as well, you want EM to start on th
 Taking the example above you can enqueue a test.
 
 ~~~~~ {ruby}
-    def test_em_simple2
-      val = nil
+    def test_em
+      val = 'not test'
       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:
+This will poll the block passed to eventually every 0.1 seconds to see if the condition is equal to the argument you passed in to eventually, in this case 'test'. After one second, if it's still not equal, it will fail. If you do not pass in a value for testing, it will evaluate what you return against ruby's notion of truth (not nil and not false). An exmaple:
+
+~~~~~ {ruby}
+    def test_em
+      count = 0
+      EM.add_periodic_timer(0.01) { count += 0.5 }
+      eventually { count >= 3 }
+    end
+~~~~~
+
+As well, you can change both the polling interval as well as the maximum execution time by passing in `:every` and `:total`. Here is an example:
 
 ~~~~~ {ruby}
-    def test_em_simple3
+    def test_em
       val = nil
       EM.add_timer(0.5) { val = 'test' }
       eventually('test', :every => 0.2, :total => 10) { val } # check every 0.2 seconds
@@ -43,7 +70,7 @@ This will poll your block every 0.1 seconds to see if the condition is true. Aft
 You can also parallelize tests if you don't want them to run serially.
 
 ~~~~~ {ruby}
-    def test_em_simple4
+    def test_em
       val1, val2 = nil, nil
       EM.add_timer(0.5) { val1 = 'test1' }
       EM.add_timer(0.5) { val2 = 'test2' }
@@ -54,14 +81,21 @@ You can also parallelize tests if you don't want them to run serially.
     end
 ~~~~~
 
-As well, simple returning doesn't always cover your test. You can pass values back for equality by doing the following.
+Simply returning from your block doesn't always cover your test. Say for instance, you need to do a call against some sort of async client that will return your value in a callback. You can pass values back for equality by doing the following.
 
 ~~~~~ {ruby}
-    def test_em_simple5
-      val = nil
-      EM.add_timer(0.5) { val = 'test1' }
-      eventually('test1') { |with| with[val] } # The secret sauce is if you called
-                                                # `eventually` with a block that takes a parameter or not.
+    class AsyncClient
+      def status(&blk)
+        EM.add_timer(0.5) do
+          blk.call(:ok)
+        end
+      end
+    end
+
+    def test_em
+      client = AsyncClient.new
+      eventually(:ok) { |with| client.status {|status| with[status]} }
+      # The secret sauce is in the arity of the block passed to `eventually`
     end
 ~~~~~
 
@@ -74,7 +108,7 @@ There are a couple of global options you can mess with too. `EM::Ventually.every
 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_test6
+    def test_em
       count = 0
       EM.add_periodic_timer(0.01) { count += 0.5 }
       eventually { count }.test{ |v| v >= 3 }
@@ -84,9 +118,18 @@ If you don't pass a value to eventually, it will test that your value is true (i
 of course, you're gonna be writing so many of these we've aliased it to make your tests stylish and classy.
 
 ~~~~~ {ruby}
-    def test_em_with_test6
+    def test_em
       count = 0
       EM.add_periodic_timer(0.01) { count += 0.5 }
       ly { count }.test{ |v| v >= 3 }
     end
 ~~~~~
+
+If you want to manually manage stopping and starting EM within a test, you can call `manually_stop_em!` within your test. An example:
+
+~~~~~ {ruby}
+    def test_em
+      manually_stop_em!
+      EM.add_timer(0.5) { assert "Hey!"; EM.stop }
+    end
+~~~~~

data/Rakefile

@@ -1,45 +1,60 @@
 require 'bundler/gem_tasks'
 
 task :default => :test
+task :test => [:'test:readme', :'test:suites']
 
-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]
-  }
+namespace :test do
+  task :suites do
+    matchers = {
+      'minitest-2.0' => [/6 tests, 9 assertions, 1 failures, 0 errors/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"
+    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
 
-  # test README.md
-  require 'minitest/autorun'
-  require 'eventmachine'
-  $LOAD_PATH << 'lib'
-  require 'em-ventually'
-  class ReadmeTest < MiniTest::Unit::TestCase
-    include EM::Ventually
-
+  task :readme do
+    # test README.md
+    puts "Testing README.md"
+    STDOUT.sync = true
     readme = File.read('./README.md')
-    readme.scan(/~~~~~ \{ruby\}\n(.*?)~~~~~/m).each do |block|
-      class_eval(block.join)
+    passes = readme.scan(/~~~~~ \{ruby\}\n(.*?)~~~~~/m).map do |block|
+      fork {
+        require 'minitest/autorun'
+        require 'eventmachine'
+        $LOAD_PATH << 'lib'
+        STDOUT.reopen('/dev/null')
+        require 'em-ventually'
+        code = block.join
+        cls = Class.new(MiniTest::Unit::TestCase)
+        cls.class_eval "include EM::Ventually" unless code[/# Without em-ventually/]
+        cls.class_eval(code)
+        cls
+      }
+      _, status = Process.wait2
+      print status.success? ? '.' : 'F'
+      status.success? ? :pass : :fail
     end
+    puts
+    pass_count = passes.inject(0){|m, s| m += (s == :pass ? 1 : 0)}
+    raise "README tests failed" unless pass_count == passes.size
   end
-end
-
+end

data/lib/em-ventually.rb

@@ -43,6 +43,10 @@ module EventMachine
     end
     alias_method :ly, :eventually
 
+    def manually_stop_em!
+      @_manually_stop_em = true
+    end
+
     def parallel(&blk)
       _pool.in_parallel do
         instance_eval(&blk)

data/lib/em-ventually/emify.rb

@@ -10,7 +10,9 @@ module EventMachine
             begin
               result = yield
             ensure
-              EM.stop if (!instance_variable_defined?(:@_pool) || @_pool.nil? || @_pool.empty?) && EM.reactor_running?
+              unless instance_variable_defined?(:@_manually_stop_em) && @_manually_stop_em
+                EM.stop if (!instance_variable_defined?(:@_pool) || @_pool.nil? || @_pool.empty?) && EM.reactor_running?
+              end
             end
           end
         end

data/lib/em-ventually/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   module Ventually
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: em-ventually
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Josh Hull
@@ -15,13 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-08 00:00:00 -07:00
+date: 2011-08-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: eventmachine
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +29,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id001
+  name: eventmachine
   type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: callsite
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,12 +45,12 @@ dependencies:
         - 0
         - 5
         version: 0.0.5
+  requirement: *id002
+  name: callsite
   type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: code_stats
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +59,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id003
+  name: code_stats
   type: :development
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,12 +75,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
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,12 +89,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id005
+  name: phocus
   type: :development
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -106,12 +105,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  requirement: *id006
+  name: bundler
   type: :development
-  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -122,8 +121,9 @@ dependencies:
         - 0
         - 0
         version: 2.0.0
+  requirement: *id007
+  name: minitest
   type: :development
-  version_requirements: *id007
 description: Eventually, your tests should pass in EventMachine.
 email: 
 - joshbuddy@gmail.com