hkroger-websocket-rails 0.7.1

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'simplecov'
+SimpleCov.start if ENV["COVERAGE"]
+
+require File.expand_path("../../spec/dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'thin'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'websocket-rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+require 'websocket_rails/spec_helpers'
+require 'rspec-matchers-matchers'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.include WebsocketRails::HelperMethods
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  config.before(:each) do
+    WebsocketRails.config.logger = Logger.new(StringIO.new)
+  end
+
+end

data/spec/spec_helpers/matchers/route_matchers_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe 'Route Matchers' do
+
+  class RouteSpecProductController < WebsocketRails::BaseController
+
+    def update_product
+    end
+
+    def delete_product
+    end
+
+  end
+
+  class RouteSpecWarehouseController < WebsocketRails::BaseController
+
+    def remove_product
+    end
+
+  end
+
+  def define_route_test_events
+    WebsocketRails.config.route_block = nil
+    WebsocketRails::EventMap.describe do
+
+      namespace :product do
+        subscribe :update, :to => RouteSpecProductController, :with_method => :update_product
+        subscribe :delete, :to => RouteSpecProductController, :with_method => :delete_product
+        subscribe :delete, :to => RouteSpecWarehouseController, :with_method => :remove_product
+      end
+    end
+  end
+
+  before { define_route_test_events }
+
+  describe 'be_routed_to' do
+
+    it 'should return true when the event is routed only to the specified controller' do
+     create_event('product.update', nil).should be_routed_to 'route_spec_product#update_product'
+    end
+
+    it 'should return true when the event is routed also to the specified controller' do
+     create_event('product.delete', nil).should be_routed_to 'route_spec_product#delete_product'
+    end
+
+    it 'should return false when the event is not routed to the specified controller' do
+      create_event('product.update', nil).should_not be_routed_to 'route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct failure message' do
+      event = create_event('route_spec_product.update', nil)
+      matcher = be_routed_to 'route_spec_product#delete_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected event update to be routed to target route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct negative failure message' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected event update not to be routed to target route_spec_product#update_product'
+    end
+
+    it 'should produce the correct description' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_description 'be routed to target route_spec_product#update_product'
+    end
+
+  end
+
+  describe 'be_routed_only_to' do
+
+    it 'should return true when the event is routed only to the specified controller' do
+     create_event('product.update', nil).should be_routed_only_to 'route_spec_product#update_product'
+    end
+
+    it 'should return false when the event is routed also to the specified controller' do
+     create_event('product.delete', nil).should_not be_routed_only_to 'route_spec_product#delete_product'
+    end
+
+    it 'should return false when the event is not routed to the specified controller' do
+      create_event('product.update', nil).should_not be_routed_only_to 'route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct failure message' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_only_to 'route_spec_product#delete_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected event update to be routed only to target route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct negative failure message' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_only_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected event update not to be routed only to target route_spec_product#update_product'
+    end
+
+    it 'should produce the correct description' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_only_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_description 'be routed only to target route_spec_product#update_product'
+    end
+
+  end
+end

data/spec/spec_helpers/matchers/trigger_matchers_spec.rb

@@ -0,0 +1,247 @@
+require 'spec_helper'
+
+describe 'Trigger Matchers' do
+
+  class TriggerSpecProductController < WebsocketRails::BaseController
+
+    # a method that does not trigger messages
+    def update_product
+    end
+
+    def delete_product
+      data = message[:data] ? 'Return Data' : nil
+      if message[:confirm_delete]
+        trigger_success(data)
+      else
+        trigger_failure(data)
+      end
+    end
+
+  end
+
+  def define_test_events
+    WebsocketRails.config.route_block = nil
+    WebsocketRails::EventMap.describe do
+
+      namespace :product do
+        subscribe :update, :to => TriggerSpecProductController, :with_method => :update_product
+        subscribe :delete, :to => TriggerSpecProductController, :with_method => :delete_product
+      end
+    end
+  end
+
+  before { define_test_events }
+
+  # as we have have 16 possible combinations of trigger messages and data matching pattern (data|no_data, success|failure,
+  # no_checking|checking_with_any|checking_with_nil|checking_with_exact_data) plus the case of no message at all
+  # for EACH of the matchers, resulting in a total 51 cases, we will not extensively test all cases for all matchers
+  # but we just make sure that coverage is 100%
+
+  describe 'trigger_message' do
+
+    it 'should return false when the event does not trigger any message' do
+      create_event('product.update', nil).dispatch.should_not trigger_message
+    end
+
+    it 'should produce the correct failure message when no trigger is generated' do
+      event = create_event('product.update', nil).dispatch
+      matcher = trigger_message
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.update to trigger message, instead it did not trigger any message'
+    end
+
+    it 'should return true when the message is a failure' do
+      create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should trigger_message
+    end
+
+    it 'should return true when the message is a success' do
+      create_event('product.delete', {confirm_delete: true, data: false}).dispatch.should trigger_message
+    end
+
+    context 'when a message is triggered with no data' do
+
+      it 'should return true when no check is done' do
+        create_event('product.delete', {confirm_delete: true, data: false}).dispatch.should trigger_message
+      end
+
+      it 'should produce the correct negative failure message when no check on data is done' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message'
+      end
+
+      it 'should return true when explicitly checking no data' do
+        create_event('product.delete', {confirm_delete: false, data: false}).dispatch.should trigger_message :nil
+      end
+
+      it 'should produce the correct negative failure message when explicitly checking no data' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message :nil
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message with no data'
+      end
+
+      it 'should return false when checking for some data' do
+        create_event('product.delete', {confirm_delete: true, data: false}).dispatch.should_not trigger_message :any
+      end
+
+      it 'should return the correct failure message when checking for some data' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message :any
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with some data, instead it triggered message with no data'
+      end
+
+      it 'should return false when checking for specific data' do
+        create_event('product.delete', {confirm_delete: false, data: false}).dispatch.should_not trigger_message 'Expected Data'
+      end
+
+      it 'should return the correct failure message when checking for specific data' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message 'Expected Data'
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with data Expected Data, instead it triggered message with no data'
+      end
+
+    end
+
+    context 'when a message is triggered with some data' do
+
+      it 'should return true when no check is done' do
+        create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_message
+      end
+
+      it 'should return false when explicitly checking no data' do
+        create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should_not trigger_message :nil
+      end
+
+      it 'should produce the correct failure message when explicitly checking for no data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message :nil
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with no data, instead it triggered message with data Return Data'
+      end
+
+      it 'should return true when checking for some data' do
+        create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_message :any
+      end
+
+      it 'should produce the correct negative failure message when checking for some data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message :any
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message with some data'
+      end
+
+      it 'should return false when checking for specific data with wrong data' do
+        create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should_not trigger_message 'Wrong Data'
+      end
+
+      it 'should produce the correct failure message when checking for specific data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message 'Wrong Data'
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with data Wrong Data, instead it triggered message with data Return Data'
+      end
+
+      it 'should return true when checking for specific data with correct data' do
+        create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_message 'Return Data'
+      end
+
+      it 'should produce the correct negative failure message when checking for specific data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message 'Return Data'
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message with data Return Data'
+      end
+
+    end
+
+    it 'should produce the correct description' do
+      event = create_event('product.update', nil)
+      matcher = trigger_message 'Return Data'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_description 'trigger message with data Return Data'
+    end
+
+
+  end
+
+  describe 'trigger_success_message' do
+
+    it 'should return false when the method does not trigger any message' do
+      create_event('product.update', nil).dispatch.should_not trigger_success_message
+    end
+
+    it 'should produce the correct failure message when the method does not trigger any message' do
+      event = create_event('product.update', nil).dispatch
+      matcher = trigger_success_message 'Return Data'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.update to trigger success message with data Return Data, instead it did not trigger any message'
+    end
+
+    it 'should return true when the method triggers a success message' do
+      create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_success_message
+    end
+
+    it 'should produce the correct negative failure message when the method triggers a success message' do
+      event = create_event('product.delete', {confirm_delete: true, data: true}).dispatch
+      matcher = trigger_success_message :any
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger success message with some data'
+    end
+
+    it 'should return false when the method triggers a failure message' do
+      create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should_not trigger_success_message
+    end
+
+    it 'should produce the correct failure message when the method triggers a failure message' do
+      event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+      matcher = trigger_success_message
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.delete to trigger success message, instead it triggered a failure message with data Return Data'
+    end
+
+  end
+
+  describe 'trigger_failure_message' do
+
+    it 'should return false when the method does not trigger any message' do
+      create_event('product.update', nil).dispatch.should_not trigger_failure_message
+    end
+
+    it 'should produce the correct failure message when the method does not trigger any message' do
+      event = create_event('product.update', nil).dispatch
+      matcher = trigger_failure_message 'Return Data'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.update to trigger failure message with data Return Data, instead it did not trigger any message'
+    end
+
+    it 'should return false when the method triggers a success message' do
+      create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should_not trigger_failure_message
+    end
+
+    it 'should produce the correct failure message when the method triggers a success message' do
+      event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+      matcher = trigger_failure_message :any
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.delete to trigger failure message with some data, instead it triggered a success message with no data'
+    end
+
+
+    it 'should return true when the method triggers a failure message' do
+      create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should trigger_failure_message
+    end
+
+    it 'should produce the correct negative failure message when the method triggers a failure message' do
+      event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+      matcher = trigger_failure_message
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger failure message'
+    end
+
+  end
+
+
+end

data/spec/spec_helpers/spec_helper_event_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module WebsocketRails
+
+  describe SpecHelperEvent do
+
+    before do
+      @dispatcher = double(:dispatcher)
+      Dispatcher.stub(:new).and_return @dispatcher
+      @event = SpecHelperEvent.new('my_event', data: 'my_data')
+    end
+
+    describe 'initialize' do
+
+      it 'should initialize the name and namespace of the event' do
+        @event.namespace.should == [:global]
+        @event.name.should == :my_event
+      end
+
+      it 'should initialize the data of the event' do
+        @event.data.should == 'my_data'
+      end
+
+      it 'should set the event to not triggered' do
+        @event.should_not be_triggered
+      end
+
+    end
+
+    describe 'trigger' do
+
+      it 'should set the triggered variable to true' do
+        @event.trigger
+        @event.should be_triggered
+      end
+
+    end
+
+    describe 'dispatch' do
+
+      it 'should invoke dispatch on the dispatcher object' do
+        @dispatcher.should_receive(:dispatch).with(@event)
+        @event.dispatch
+      end
+
+      it 'should return itself to be able to chain matchers' do
+        @dispatcher.stub(:dispatch)
+        @event.dispatch.should == @event
+      end
+
+    end
+
+  end
+
+end
+
+describe 'create_event' do
+
+  it 'should create a SpecHelperEvent with the correct parameters' do
+    event = create_event('my_event','my_data')
+    event.should be_a WebsocketRails::SpecHelperEvent
+    event.name.should == :my_event
+    event.data.should == 'my_data'
+  end
+
+end