em-minitest-spec 1.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-06-11
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/em/minitest/spec.rb
+test/test_em_minitest_spec.rb

data/README.txt

@@ -0,0 +1,75 @@
+= em_minitest_spec
+
+* https://github.com/phiggins/em-minitest-spec
+
+== DESCRIPTION:
+
+Utility to allow easy integration of MiniTest::Spec and Eventmachine.
+
+== FEATURES/PROBLEMS:
+
+* Allows specs to run inside an EM reactor.
+* Opt-in: this library does not automatically change how MiniTest::Spec works without your permission.
+* before/after blocks and setup/teardown methods are not run in the reactor, and so cannot contain code that requires an EM reactor.
+
+== SYNOPSIS:
+
+  # Get the gem version on 1.9.x
+  gem 'minitest'
+  require 'minitest/autorun'
+  require 'em/minitest/spec'
+
+  describe MyEventmachineSpec do
+    describe "these specs will run normally" do
+      it "tests things" do
+        puts "foo"
+      end
+
+      # ...
+    end
+
+    describe "these specs will run inside an EM reactor" do
+      include EM::MiniTest::Spec
+
+      it "runs this inside EM.run" do
+        puts EM.reactor_running? # true
+      end
+
+      # ...
+    end
+  end
+
+== REQUIREMENTS:
+
+* Eventmachine: no specific version, although 1.0.0.beta.3 was tested with.
+* MiniTest: 2.2.2 was the current version as of writing this, so probably
+  that or newer.
+
+== INSTALL:
+
+* gem install em-minitest-spec
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Pete Higgins
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :git
+
+Hoe.spec 'em-minitest-spec' do
+  developer('pete higgins', 'pete@peterhiggins.org')
+
+  extra_deps << ["eventmachine"]
+  extra_dev_deps << ["minitest", "~> 2.2"]
+
+  self.testlib = :minitest
+  self.test_prelude = 'gem "minitest"'
+end
+
+# vim: syntax=ruby

data/lib/em/minitest/spec.rb

@@ -0,0 +1,98 @@
+require 'eventmachine'
+require 'minitest/spec'
+
+module EM # :nodoc:
+  module MiniTest # :nodoc:
+    module Spec # :nodoc
+      VERSION = '1.1.0' # :nodoc:
+
+      ##
+      # +wait+ indicates that the spec is not expected to be completed when
+      # the block is finished running. A call to +done+ is required when using
+      # +wait+.
+      #
+      #   # setup my spec to use EM::MiniTest::Spec
+      #   describe MyClass do
+      #     include EM::MiniTest::Spec
+      #
+      #     # The call to defer will return immediately, so the spec code
+      #     # needs to keep running until callback is called.
+      #     it "does some async things" do
+      #       defer_me = lambda do
+      #         # some async stuff
+      #       end
+      #
+      #       callback = lambda do
+      #         done!
+      #       end
+      #
+      #       EM.defer defer_me, callback
+      #
+      #       wait!
+      #     end
+      def wait
+        @wait = true
+      end
+      alias wait! wait
+
+      ##
+      # Indicates that an async spec is finished. See +wait+ for example usage.
+      def done
+        EM.cancel_timer(@timeout)
+        EM.stop
+      end
+      alias done! done
+
+      ##
+      # A helper method for the use case of waiting for some operation to
+      # complete that is not necessarily under the control of the spec code.
+      #
+      #   # These are exactly equivalent
+      #   it "waits with the helper" do
+      #     wait_for do
+      #       assert true
+      #     end
+      #   end
+      #
+      #   it "waits manually" do
+      #     EM.next_tick do
+      #       assert true
+      #       done!
+      #     end
+      #
+      #     wait!
+      #   end
+      def wait_for
+        EM.next_tick do
+          yield
+          done!
+        end
+
+        wait!
+      end
+
+      def self.included base # :nodoc:
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods # :nodoc:
+        def it *args, &block # :nodoc:
+          return super unless block_given?
+
+          super do
+            @wait = false
+
+            EM.run do
+              @timeout = EM.add_timer(0.1) do
+                flunk "test timed out!"
+              end
+
+              instance_eval(&block)
+              done! unless @wait
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_em_minitest_spec.rb

@@ -0,0 +1,86 @@
+gem 'minitest'
+require 'minitest/autorun'
+require "em/minitest/spec"
+
+class TestEmMinitestSpec < MiniTest::Unit::TestCase
+  def setup
+    @spec = describe "EM::MiniTest::Spec" do
+      include EM::MiniTest::Spec
+
+      it "runs vanilla specs" do
+        assert true
+      end
+
+      it "runs specs inside reactor" do
+        assert EM.reactor_running?
+      end
+
+      it "allows pending specs"
+
+      it "allows manual reactor control" do
+        EM.next_tick do
+          done!
+        end
+
+        wait!
+      end
+
+      it "has a manual control helper" do
+        wait_for do
+          pass
+        end
+
+        EM.add_timer(0.1) { flunk }
+      end
+
+      it "flunks long running specs" do
+        wait!
+      end
+    end
+  end
+
+  def run_test name
+    test_name = name.tr(' ', '_')
+    test = @spec.instance_methods.detect {|m| m =~ /test_[0-9]+_#{test_name}/ }
+
+    raise "no spec found matching: #{name}" unless test
+
+    @spec.new(test).run(MiniTest::Unit.new)
+  end
+
+  def assert_passes name
+    assert_equal '.', run_test(name)
+  end
+
+  def assert_skips name
+    assert_equal 'S', run_test(name)
+  end
+
+  def assert_fails name
+    assert_equal 'F', run_test(name)
+  end
+
+  def test_runs_regular_specs
+    assert_passes "runs vanilla specs"
+  end
+
+  def test_runs_specs_in_em_reactor
+    assert_passes "runs specs inside reactor"
+  end
+
+  def test_skips_specs_with_no_block
+    assert_skips "allows pending specs"
+  end
+
+  def test_allows_manual_event_loop_control
+    assert_passes "allows manual reactor control"
+  end
+
+  def test_wait_for
+    assert_passes "has a manual control helper"
+  end
+
+  def test_timeout
+    assert_fails "flunks long running specs"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: em-minitest-spec
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.1.0
+platform: ruby
+authors: 
+- pete higgins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.2"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.9.4
+  type: :development
+  version_requirements: *id003
+description: Utility to allow easy integration of MiniTest::Spec and Eventmachine.
+email: 
+- pete@peterhiggins.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/em/minitest/spec.rb
+- test/test_em_minitest_spec.rb
+- .gemtest
+homepage: https://github.com/phiggins/em-minitest-spec
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: em-minitest-spec
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: Utility to allow easy integration of MiniTest::Spec and Eventmachine.
+test_files: 
+- test/test_em_minitest_spec.rb