evented-spec 0.4.0 → 0.4.1

data/spec/evented-spec/adapters/amqp_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe EventedSpec::SpecHelper, "AMQP bindings" do
+  include EventedSpec::SpecHelper
+  default_timeout 0.5
+
+  def amqp_running?
+    EM.reactor_running? && !!AMQP.connection
+  end # em_running?
+
+  let(:method_name) { "amqp" }
+  let(:prefix) { "amqp_" }
+
+  it_should_behave_like "EventedSpec adapter"
+
+  describe EventedSpec::AMQPSpec do
+    include EventedSpec::AMQPSpec
+    it "should run inside of amqp block" do
+      amqp_running?.should be_true
+      done
+    end
+  end
+
+  describe "actual AMQP functionality" do
+    include EventedSpec::SpecHelper
+    default_options AMQP_OPTS if defined? AMQP_OPTS
+
+    def publish_and_consume_once(queue_name="test_sink", data="data")
+      amqp(:spec_timeout => 0.5) do
+        AMQP::Channel.new do |channel, _|
+          exchange = channel.direct(queue_name)
+          queue = channel.queue(queue_name).bind(exchange)
+          queue.subscribe do |hdr, msg|
+            hdr.should be_an AMQP::Header
+            msg.should == data
+            done { queue.unsubscribe; queue.delete }
+          end
+          EM.add_timer(0.2) do
+            exchange.publish data
+          end
+        end
+      end
+    end
+
+    it 'sends data to the queue' do
+      publish_and_consume_once
+    end
+
+    it 'does not hang sending data to the same queue, again' do
+      publish_and_consume_once
+    end
+
+    it 'cleans Thread.current[:mq] after pubsub examples' do
+      Thread.current[:mq].should be_nil
+    end
+  end
+
+end

data/spec/evented-spec/adapters/cool_io_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe EventedSpec::SpecHelper, "Cool.io bindings", :nojruby => true do
+  include EventedSpec::SpecHelper
+  default_timeout 1
+
+  def coolio_running?
+    Coolio::Loop.default.instance_variable_get(:@running)
+  end # coolio_running?
+
+  after(:each) {
+    coolio_running?.should be_false
+  }
+
+  let(:method_name) { "coolio" }
+  let(:prefix) { "coolio_" }
+
+  it_should_behave_like "EventedSpec adapter"
+
+
+  describe EventedSpec::CoolioSpec do
+    include EventedSpec::CoolioSpec
+    it "should run inside of coolio loop" do
+      coolio_running?.should be_true
+      Coolio::Loop.default.has_active_watchers?.should be_true
+      done
+    end
+  end
+
+end

data/spec/evented-spec/adapters/em_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe EventedSpec::SpecHelper, "EventMachine bindings" do
+  include EventedSpec::SpecHelper
+  default_timeout 0.5
+
+  def em_running?
+    EM.reactor_running?
+  end # em_running?
+
+  after(:each) {
+    em_running?.should be_false
+  }
+
+  let(:method_name) { "em" }
+  let(:prefix) { "em_" }
+
+  it_should_behave_like "EventedSpec adapter"
+
+
+  describe EventedSpec::EMSpec do
+    include EventedSpec::EMSpec
+    it "should run inside of em loop" do
+      em_running?.should be_true
+      done
+    end
+  end
+
+end

data/spec/{failing_rspec_spec.rb → integration/failing_rspec_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'Following 9 examples should all be failing:' do
+describe 'Following 9 examples should all be failing:', :deliberately_failing => true do
   describe EventMachine, " when running failing examples" do
     include EventedSpec::EMSpec
 

data/spec/spec_helper.rb

@@ -1,32 +1,41 @@
-$LOAD_PATH << "." unless $LOAD_PATH.include? "." # moronic 1.9.2 breaks things bad
+#$LOAD_PATH << "." unless $LOAD_PATH.include? "." # moronic 1.9.2 breaks things bad
 
 require 'bundler'
 Bundler.setup
 Bundler.require :default, :test
 
 require 'yaml'
-require 'evented-spec/rspec'
-require 'shared_examples'
+require 'evented-spec'
+require 'evented-spec/adapters/adapter_seg'
 
-require 'amqp'
-require 'cool.io'
 
-def rspec2?
-  defined?(RSpec)
+require 'amqp'
+begin
+  require 'cool.io'
+rescue LoadError => e
+  if RUBY_PLATFORM =~ /java/
+    puts "Cool.io is unavailable for jruby"
+  else
+    # cause unknown, reraise
+    raise e
+  end
 end
 
 # Done is defined as noop to help share examples between evented and non-evented specs
 def done
 end
 
-RSPEC       = rspec2? ? RSpec : Spec
+RSpec.configure do |c|
+  c.filter_run_excluding :nojruby => true if RUBY_PLATFORM =~ /java/
+  c.filter_run_excluding :deliberately_failing => true if ENV["EXCLUDE_DELIBERATELY_FAILING_SPECS"]
+end
 
 amqp_config = File.dirname(__FILE__) + '/amqp.yml'
 
 AMQP_OPTS   = unless File.exists? amqp_config
                 {:user  => 'guest',
                  :pass  => 'guest',
-                 :host  => '10.211.55.2',
+                 :host  => 'localhost',
                  :vhost => '/'}
               else
                 class Hash

data/tasks/spec.rake

@@ -1,11 +1,16 @@
 desc 'Alias to spec:spec'
-task :spec => 'spec:spec'
+task :spec => 'spec:all'
 
 namespace :spec do
   require 'rspec/core/rake_task'
 
   desc "Run all specs"
-  RSpec::Core::RakeTask.new(:spec){|task|}
+  RSpec::Core::RakeTask.new(:all){|task|}
+
+  desc "Run all non-failing specs (for CI)"
+  RSpec::Core::RakeTask.new(:ci) do |task|
+    ENV["EXCLUDE_DELIBERATELY_FAILING_SPECS"] = "1"
+  end
 
   desc "Run specs with RCov"
   RSpec::Core::RakeTask.new(:rcov) do |t|

metadata

@@ -2,7 +2,7 @@
 name: evented-spec
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Arvicco
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 -05:00
+date: 2011-04-29 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,9 +31,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.8.0.pre
+        version: 0.8.0.rc1
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -56,8 +56,19 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         version: 4.2.7
-  type: :runtime
+  type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: Simple API for writing asynchronous EventMachine and AMQP specs. Runs legacy EM-Spec based examples. Supports RSpec and RSpec2.
 email: arvitallian@gmail.com
 executables: []
@@ -70,26 +81,34 @@ extra_rdoc_files:
 - README.textile
 files: 
 - lib/amqp-spec.rb
-- lib/evented-spec/amqp.rb
+- lib/evented-spec/amqp_spec.rb
+- lib/evented-spec/coolio_spec.rb
+- lib/evented-spec/em_spec.rb
 - lib/evented-spec/evented_example/amqp_example.rb
 - lib/evented-spec/evented_example/coolio_example.rb
 - lib/evented-spec/evented_example/em_example.rb
 - lib/evented-spec/evented_example.rb
-- lib/evented-spec/rspec.rb
+- lib/evented-spec/ext/amqp.rb
+- lib/evented-spec/ext/coolio.rb
+- lib/evented-spec/spec_helper/amqp_helpers.rb
+- lib/evented-spec/spec_helper/coolio_helpers.rb
+- lib/evented-spec/spec_helper/event_machine_helpers.rb
+- lib/evented-spec/spec_helper.rb
 - lib/evented-spec/util.rb
 - lib/evented-spec/version.rb
 - lib/evented-spec.rb
-- spec/cool_io_spec.rb
-- spec/em_defaults_spec.rb
+- spec/amqp.yml
 - spec/em_hooks_spec.rb
-- spec/em_metadata_spec.rb
-- spec/failing_rspec_spec.rb
-- spec/rspec_amqp_spec.rb
-- spec/rspec_em_spec.rb
-- spec/shared_examples.rb
+- spec/evented-spec/adapters/adapter_seg.rb
+- spec/evented-spec/adapters/amqp_spec.rb
+- spec/evented-spec/adapters/cool_io_spec.rb
+- spec/evented-spec/adapters/em_spec.rb
+- spec/evented-spec/defaults_options_spec.rb
+- spec/evented-spec/evented_spec_metadata_spec.rb
+- spec/evented-spec/util_spec.rb
+- spec/integration/failing_rspec_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/util_spec.rb
 - tasks/common.rake
 - tasks/doc.rake
 - tasks/gem.rake
@@ -130,20 +149,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: evented-spec
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple API for writing asynchronous EventMachine/AMQP specs. Supports RSpec and RSpec2.
 test_files: 
-- spec/cool_io_spec.rb
-- spec/em_defaults_spec.rb
+- spec/amqp.yml
 - spec/em_hooks_spec.rb
-- spec/em_metadata_spec.rb
-- spec/failing_rspec_spec.rb
-- spec/rspec_amqp_spec.rb
-- spec/rspec_em_spec.rb
-- spec/shared_examples.rb
+- spec/evented-spec/adapters/adapter_seg.rb
+- spec/evented-spec/adapters/amqp_spec.rb
+- spec/evented-spec/adapters/cool_io_spec.rb
+- spec/evented-spec/adapters/em_spec.rb
+- spec/evented-spec/defaults_options_spec.rb
+- spec/evented-spec/evented_spec_metadata_spec.rb
+- spec/evented-spec/util_spec.rb
+- spec/integration/failing_rspec_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/util_spec.rb

data/lib/evented-spec/rspec.rb

@@ -1,267 +0,0 @@
-require 'evented-spec/amqp'
-require 'evented-spec/evented_example'
-require 'evented-spec/util'
-
-# You can include one of the following modules into your example groups:
-# EventedSpec::SpecHelper,
-# EventedSpec::AMQPSpec,
-# EventedSpec::EMSpec.
-#
-# EventedSpec::SpecHelper module defines #ampq and #em methods that can be safely used inside
-# your specs (examples) to test code running inside AMQP.start or EM.run loop
-# respectively. Each example is running in a separate event loop,you can control
-# for timeouts either with :spec_timeout option given to #amqp/#em method or setting
-# a default timeout using default_timeout(timeout) macro inside describe/context block.
-#
-# If you include EventedSpec::Spec module into your example group, each example of this group
-# will run inside AMQP.start loop without the need to explicitly call 'amqp'. In order to
-# provide options to AMQP loop, default_options({opts}) macro is defined.
-#
-# Including EventedSpec::EMSpec module into your example group, each example of this group will
-# run inside EM.run loop without the need to explicitly call 'em'.
-#
-# In order to stop AMQP/EM loop, you should call 'done' AFTER you are sure that your
-# example is finished and your expectations executed. For example if you are using
-# subscribe block that tests expectations on messages, 'done' should be probably called
-# at the end of this block.
-#
-module EventedSpec
-
-  # EventedSpec::SpecHelper module defines #ampq and #em methods that can be safely used inside
-  # your specs (examples) to test code running inside AMQP.start or EM.run loop
-  # respectively. Each example is running in a separate event loop, you can control
-  # for timeouts either with :spec_timeout option given to #amqp/#em/#coolio method or setting
-  # a default timeout using default_timeout(timeout) macro inside describe/context block.
-  module SpecHelper
-    # Error which shows in RSpec log when example does not call #done inside
-    # of event loop.
-    SpecTimeoutExceededError = Class.new(RuntimeError)
-
-    # Class methods (macros) for any example groups that includes SpecHelper.
-    # You can use these methods as macros inside describe/context block.
-    module GroupMethods
-      # Returns evented-spec related metadata for particular example group.
-      # Metadata is cloned from parent to children, so that children inherit
-      # all the options and hooks set in parent example groups
-      #
-      # @return [Hash] hash with example group metadata
-      def evented_spec_metadata
-        if @evented_spec_metadata
-          @evented_spec_metadata
-        else
-          @evented_spec_metadata = superclass.evented_spec_metadata rescue {}
-          @evented_spec_metadata = EventedSpec::Util.deep_clone(@evented_spec_metadata)
-        end
-      end # evented_spec_metadata
-
-      # Sets/retrieves default timeout for running evented specs for this
-      # example group and its nested groups.
-      #
-      # @param [Float] desired timeout for the example group
-      # @return [Float]
-      def default_timeout(spec_timeout = nil)
-        if spec_timeout
-          default_options[:spec_timeout] = spec_timeout
-        else
-          default_options[:spec_timeout] || self.superclass.default_timeout
-        end
-      end
-
-      # Sets/retrieves default AMQP.start options for this example group
-      # and its nested groups.
-      #
-      # @param [Hash] context-specific options for helper methods like #amqp, #em, #coolio
-      # @return [Hash]
-      def default_options(opts = nil)
-        evented_spec_metadata[:default_options] ||= {}
-        if opts
-          evented_spec_metadata[:default_options].merge!(opts)
-        else
-          evented_spec_metadata[:default_options]
-        end
-      end
-
-      # Adds before hook that will run inside EM event loop before example starts.
-      #
-      # @param [Symbol] scope for hook (only :each is supported currently)
-      # @yield hook block
-      def em_before(scope = :each, &block)
-        raise ArgumentError, "em_before only supports :each scope" unless :each == scope
-        em_hooks[:em_before] << block
-      end
-
-      # Adds after hook that will run inside EM event loop after example finishes.
-      #
-      # @param [Symbol] scope for hook (only :each is supported currently)
-      # @yield hook block
-      def em_after(scope = :each, &block)
-        raise ArgumentError, "em_after only supports :each scope" unless :each == scope
-        em_hooks[:em_after].unshift block
-      end
-
-      # Adds before hook that will run inside AMQP connection (AMQP.start loop)
-      # before example starts
-      #
-      # @param [Symbol] scope for hook (only :each is supported currently)
-      # @yield hook block
-      def amqp_before(scope = :each, &block)
-        raise ArgumentError, "amqp_before only supports :each scope" unless :each == scope
-        em_hooks[:amqp_before] << block
-      end
-
-      # Adds after hook that will run inside AMQP connection (AMQP.start loop)
-      # after example finishes
-      #
-      # @param [Symbol] scope for hook (only :each is supported currently)
-      # @yield hook block
-      def amqp_after(scope = :each, &block)
-        raise ArgumentError, "amqp_after only supports :each scope" unless :each == scope
-        em_hooks[:amqp_after].unshift block
-      end
-
-      # Collection of evented hooks for current example group
-      #
-      # @return [Hash] hash with hooks
-      def em_hooks
-        evented_spec_metadata[:em_hooks] ||= {
-          :em_before   => [],
-          :em_after    => [],
-          :amqp_before => [],
-          :amqp_after  => []
-        }
-      end
-    end
-
-    def self.included(example_group)
-      unless example_group.respond_to? :default_timeout
-        example_group.extend GroupMethods
-      end
-    end
-
-    # Retrieves default options passed in from enclosing example groups
-    #
-    # @return [Hash] default option for currently running example
-    def default_options
-      @em_default_options ||= self.class.default_options.dup rescue {}
-    end
-
-    # Yields to a given block inside EM.run and AMQP.start loops.
-    #
-    # @param [Hash] options for amqp connection initialization
-    # @option opts [String] :user ('guest') Username as defined by the AMQP server.
-    # @option opts [String] :pass ('guest') Password as defined by the AMQP server.
-    # @option opts [String] :vhost ('/') Virtual host as defined by the AMQP server.
-    # @option opts [Numeric] :timeout (nil) *Connection* timeout, measured in seconds.
-    # @option opts [Boolean] :logging (false) Toggle the extremely verbose AMQP logging.
-    # @option opts [Numeric] :spec_timeout (nil) Amount of time before spec is stopped by timeout
-    # @yield block to execute after amqp connects
-    def amqp(opts = {}, &block)
-      opts = default_options.merge opts
-      @evented_example = AMQPExample.new(opts, self, &block)
-      @evented_example.run
-    end
-
-    # Yields to block inside EM loop, :spec_timeout option (in seconds) is used to
-    # force spec to timeout if something goes wrong and EM/AMQP loop hangs for some
-    # reason.
-    #
-    # For compatibility with EM-Spec API, em method accepts either options Hash
-    # or numeric timeout in seconds.
-    #
-    # @param [Hash] options for eventmachine
-    # @param opts [Numeric] :spec_timeout (nil) Amount of time before spec is stopped by timeout
-    # @yield block to execute after eventmachine loop starts
-    def em(opts = {}, &block)
-      opts = default_options.merge(opts.is_a?(Hash) ? opts : { :spec_timeout =>  opts })
-      @evented_example = EMExample.new(opts, self, &block)
-      @evented_example.run
-    end
-
-    # Yields to block inside cool.io loop, :spec_timeout option (in seconds) is used to
-    # force spec to timeout if something goes wrong and EM/AMQP loop hangs for some
-    # reason.
-    #
-    # @param [Hash] options for cool.io
-    # @param opts [Numeric] :spec_timeout (nil) Amount of time before spec is stopped by timeout
-    # @yield block to execute after cool.io loop starts
-    def coolio(opts = {}, &block)
-      opts = default_options.merge opts
-      @evented_example = CoolioExample.new(opts, self, &block)
-      @evented_example.run
-    end
-
-    # Breaks the event loop and finishes the spec. This should be called after
-    # you are reasonably sure that your expectations succeeded.
-    # Done yields to any given block first, then stops EM event loop.
-    # For amqp specs, stops AMQP and cleans up AMQP state.
-    #
-    # You may pass delay (in seconds) to done. If you do so, please keep in mind
-    # that your (default or explicit) spec timeout may fire before your delayed done
-    # callback is due, leading to SpecTimeoutExceededError
-    #
-    # @param [Float] Delay before event loop is stopped
-    def done(*args, &block)
-      @evented_example.done *args, &block if @evented_example
-    end
-
-    # Manually sets timeout for currently running example. If spec doesn't call
-    # #done before timeout, it is marked as failed on timeout.
-    #
-    # @param [Float] Delay before event loop is stopped with error
-    def timeout(*args)
-      @evented_example.timeout *args if @evented_example
-    end
-
-  end # module SpecHelper
-
-  # If you include EventedSpec::AMQPSpec module into your example group, each example of this group
-  # will run inside AMQP.start loop without the need to explicitly call 'amqp'. In order
-  # to provide options to AMQP loop, default_options class method is defined. Remember,
-  # when using EventedSpec::Specs, you'll have a single set of AMQP.start options for all your
-  # examples.
-  #
-  module AMQPSpec
-    def self.included(example_group)
-      example_group.send(:include, SpecHelper)
-      example_group.extend(ClassMethods)
-    end
-
-    # @private
-    module ClassMethods
-      def it(*args, &block)
-        if block
-          new_block = Proc.new {|example_group_instance| (example_group_instance || self).instance_eval { amqp(&block) } }
-          super(*args, &new_block)
-        else
-          # pending example
-          super
-        end
-      end # it
-    end # ClassMethods
-  end # AMQPSpec
-
-  # Including EventedSpec::EMSpec module into your example group, each example of this group
-  # will run inside EM.run loop without the need to explicitly call 'em'.
-  #
-  module EMSpec
-    def self.included(example_group)
-      example_group.send(:include, SpecHelper)
-      example_group.extend ClassMethods
-    end
-
-    # @private
-    module ClassMethods
-      def it(*args, &block)
-        if block
-          # Shared example groups seem to pass example group instance
-          # to the actual example block
-          new_block = Proc.new {|example_group_instance| (example_group_instance || self).instance_eval { em(&block) } }
-          super(*args, &new_block)
-        else
-          # pending example
-          super
-        end
-      end # it
-    end # ClassMethods
-  end # EMSpec
-end # EventedSpec