amqp-spec 0.3.0 → 0.3.1

data/HISTORY

@@ -57,3 +57,7 @@
 == 0.3.0 / 2010-11-16
 
 * Hooks em_before/em_after implemented
+
+== 0.3.1 / 2010-11-17
+
+* Documentation cleanup

data/README.rdoc

@@ -33,7 +33,7 @@ interactions, but still specify some event-based expectations.
 ==Rspec
 
 There are several ways to use amqp-spec. To use it as a helper, include AMQP::SpecHelper
-in your describe block. You then use either 'amqp' or 'em' methods to wrap your evented
+in your describe block. You then use either #amqp or #em methods to wrap your evented
 test code. Inside the amqp/em block, you must call #done after your expectations. Everything
 works normally otherwise. You can set default_timeout and default_options to avoid manually
 setting AMQP options for each example. However, if you DO supply options to #amqp method
@@ -44,8 +44,9 @@ its nested groups, unconnected example groups DO NOT share defaults. Please note
 this is different from EM-Spec where default_timeout is effectively a global setting.
 
 In order to setup/teardown EM state before/after your examples, you'll need to use
-*em_before{}* and *em_after{}* hooks. These hooks are similar to standard RSpec's
+*em_before* and *em_after* hooks. These hooks are similar to standard RSpec's
 *before/after* hooks but run inside the EM event loop before/after your example block.
+If you are using
 
   require "amqp-spec/rspec"
 
@@ -90,14 +91,14 @@ In order to setup/teardown EM state before/after your examples, you'll need to u
 
 Another option is to include AMQP::Spec in your describe block. This will patch Rspec so
 that all of your examples run inside an amqp block automatically. A word of caution about
-*before{}*/*after{}* hooks in your example groups including AMQP::Spec. Each of these hooks
-will run in its separate EM loop that you'll need to shut down either manually (done) or
+*before*/*after* hooks in your example groups including AMQP::Spec. Each of these hooks
+will run in its separate EM loop that you'll need to shut down either manually (#done) or
 via timeout. Essentially, this means that any EM-related state that you'd like to set up or
 tear down using these hooks will be lost as example itself will run in a different EM loop.
 
 In short, you should avoid using *before/after* if you include AMQP::Spec - instead, use
 *em_before/em_after* hooks that run inside the EM event loop. One more note: you don't need
-to call 'done' inside *em_before/em_after*, otherwise it'll shut down the reactor.
+to call #done inside *em_before/em_after*, otherwise it'll shut down the reactor.
 
 
   describe AMQP do
@@ -132,7 +133,7 @@ to call 'done' inside *em_before/em_after*, otherwise it'll shut down the reacto
   end
 
 Finally, you can include AMQP::EMSpec in your describe block. This will run all the group
-examples inside em block instead of amqp. *before/after* hooks should be finished
+examples inside em block instead of amqp. Non-evented *before/after* hooks should be finished
 with #done, same as when including AMQP::Spec, and same caution about using them applies.
 
   describe AMQP do
@@ -221,11 +222,12 @@ Something like this will do the trick:
 
 ==Limitations
 
-AMQP-Spec can be currently used with Rspec only. I suppose, there is nothing special in
-extending EM-Spec's test unit and bacon support, I just do not have experience dealing with
-these platforms. Another limitation, it uses native Fibers and therefore not compatible with
-Ruby 1.8. Again, it seems possible to rewrite it in 1.8-compatible style, with string evals
-and Fiber backport, but I'd rather leave this work to someone else.
+AMQP-Spec can be currently used with Rspec only. I suppose, it is not that difficult to
+extend EM-Spec's Test::Unit and Bacon support, I just do not have experience doing it.
+
+Another limitation, library uses 1.9 syntax and therefore not compatible with Ruby 1.8.
+Again, it seems possible to rewrite it in 1.8-compatible style, with string evals and
+all such, but I'd rather leave this work to someone else.
 
 Any help improving this library is greatly appreciated...
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/amqp-spec/evented_example.rb

@@ -1,4 +1,4 @@
-require 'fiber' unless Fiber.respond_to?(:current)
+#require 'fiber' unless Fiber.respond_to?(:current)
 
 module AMQP
 
@@ -99,7 +99,8 @@ module AMQP
 
     end # class EventedExample
 
-    # Represents spec running inside AMQP.run loop
+
+    # Represents spec running inside EM.run loop
     class EMExample < EventedExample
 
       # Run @block inside the EM.run event loop
@@ -120,7 +121,8 @@ module AMQP
       end # done
     end # class EMExample < EventedExample
 
-    # Represents spec running inside AMQP.run loop
+
+    # Represents spec running inside AMQP.start loop
     class AMQPExample < EventedExample
 
       # Run @block inside the AMQP.start loop
@@ -149,7 +151,7 @@ module AMQP
       end
 
       # Called from run_event_loop when event loop is finished, before any exceptions
-      # is raised or example returns. We ensure AMQP state cleanup here
+      # is raised or example returns. We ensure AMQP state cleanup here.
       def finish_example
         AMQP.cleanup_state
         super

data/lib/amqp-spec/rspec.rb

@@ -115,6 +115,9 @@ module AMQP
     # force spec to timeout if something goes wrong and EM/AMQP loop hangs for some
     # reason. SpecTimeoutExceededError is raised if it happens.
     #
+    # For compatibility with EM-Spec API, em method accepts either options Hash
+    # or numeric timeout in seconds.
+    #
     def em opts = {}, &block
       if opts.is_a? Hash
         opts[:spec_timeout] ||= self.class.default_timeout

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Arvicco
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 +03:00
+date: 2010-11-17 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,9 +33,24 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: amqp
+  name: bundler
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,7 +61,7 @@ dependencies:
         - 7
         version: 0.6.7
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 description: Simple API for writing asynchronous EventMachine/AMQP specs. Supports RSpec and RSpec2.
 email: arvitallian@gmail.com
 executables: []