websocket-rails 0.3.0 → 0.4.0

data/spec/integration/connection_manager_spec.rb

@@ -9,7 +9,7 @@ module WebsocketRails
     end
 
     def define_test_events
-      WebsocketRails.route_block = nil
+      WebsocketRails.config.route_block = nil
       WebsocketRails::EventMap.describe do
         subscribe :client_connected, :to => ChatController, :with_method => :new_user
         subscribe :change_username, :to => ChatController, :with_method => :change_username
@@ -99,6 +99,13 @@ module WebsocketRails
             @server.call( env )
             socket.on_close
           end
+
+          it "should unsubscribe from channels" do
+            channel = WebsocketRails[:test_chan]
+            @server.call( env )
+            channel.should_receive(:unsubscribe).with(socket)
+            socket.on_close
+          end
         end
       end
     end

data/spec/spec_helper.rb

@@ -34,21 +34,8 @@ RSpec.configure do |config|
   # rspec-rails.
   config.infer_base_class_for_anonymous_controllers = false
 
-end
-
-def silence_output
-  @orig_stderr = $stderr
-  @orig_stdout = $stdout
-
-  # redirect stderr and stdout to /dev/null
-  $stderr = File.new('/dev/null', 'w')
-  $stdout = File.new('/dev/null', 'w')
-end
+  config.before(:each) do
+    WebsocketRails.config.logger = Logger.new(StringIO.new)
+  end
 
-# Replace stdout and stderr so anything else is output correctly.
-def enable_output
-  $stderr = @orig_stderr
-  $stdout = @orig_stdout
-  @orig_stderr = nil
-  @orig_stdout = nil
 end

data/spec/spec_helpers/matchers/route_matchers_spec.rb

@@ -19,9 +19,8 @@ describe 'Route Matchers' do
 
   end
 
-
   def define_route_test_events
-    WebsocketRails.route_block = nil
+    WebsocketRails.config.route_block = nil
     WebsocketRails::EventMap.describe do
 
       namespace :product do
@@ -106,13 +105,5 @@ describe 'Route Matchers' do
       matcher.should produce_as_description 'be routed only to target route_spec_product#update_product'
     end
 
-
   end
-
-
-
-
-
-
-
-end
+end

data/spec/spec_helpers/matchers/trigger_matchers_spec.rb

@@ -20,7 +20,7 @@ describe 'Trigger Matchers' do
   end
 
   def define_test_events
-    WebsocketRails.route_block = nil
+    WebsocketRails.config.route_block = nil
     WebsocketRails::EventMap.describe do
 
       namespace :product do
@@ -32,16 +32,6 @@ describe 'Trigger Matchers' do
 
   before { define_test_events }
 
-  around(:each) do |example|
-    EM.run do
-      example.run
-    end
-  end
-
-  after(:each) do
-    EM.stop
-  end
-
   # 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
@@ -254,4 +244,4 @@ describe 'Trigger Matchers' do
   end
 
 
-end
+end

data/spec/unit/channel_manager_spec.rb

@@ -25,5 +25,13 @@ module WebsocketRails
       end
     end
 
+    describe "unsubscribe" do
+      it "should unsubscribe connection from all channels" do
+        subject[:awesome_channel].should_receive(:unsubscribe).with(:some_connection)
+        subject[:awesome_channel]
+        subject.unsubscribe(:some_connection)
+      end
+    end
+
   end
 end

data/spec/unit/channel_spec.rb

@@ -21,6 +21,19 @@ module WebsocketRails
       end
     end
 
+    describe "#unsubscribe" do
+      it "should remove connection from subscriber pool" do
+        subject.subscribe connection
+        subject.unsubscribe connection
+        subject.subscribers.include?(connection).should be_false
+      end
+
+      it "should do nothing if connection is not subscribed to channel" do
+        subject.unsubscribe connection
+        subject.subscribers.include?(connection).should be_false
+      end
+    end
+
     describe "#trigger" do
       it "should create a new event and trigger it on all subscribers" do
         event = double('event').as_null_object
@@ -37,8 +50,9 @@ module WebsocketRails
 
     describe "#trigger_event" do
       it "should forward the event to the subscribers" do
-        subject.should_receive(:send_data).with('event')
-        subject.trigger_event 'event'
+        event = double('event').as_null_object
+        subject.should_receive(:send_data).with(event)
+        subject.trigger_event event
       end
     end
 

data/spec/unit/connection_adapters_spec.rb

@@ -1,31 +1,31 @@
 require 'spec_helper'
 
 module WebsocketRails
-  
+
   class ConnectionAdapters::Test < ConnectionAdapters::Base
     def self.accepts?(env)
       true
     end
   end
-  
+
   describe ConnectionAdapters do
-    
+
     context ".register" do
       it "should store a reference to the adapter in the adapters array" do
         ConnectionAdapters.register( ConnectionAdapters::Test )
         ConnectionAdapters.adapters.include?( ConnectionAdapters::Test ).should be_true
       end
     end
-    
+
     context ".establish_connection" do
       it "should return the correct connection adapter instance" do
         adapter = ConnectionAdapters.establish_connection( mock_request, double('Dispatcher').as_null_object )
         adapter.class.should == ConnectionAdapters::Test
       end
     end
-    
+
   end
-    
+
   module ConnectionAdapters
     describe Base do
       let(:dispatcher) { double('Dispatcher').as_null_object }
@@ -33,12 +33,16 @@ module WebsocketRails
       let(:event) { double('Event').as_null_object }
       before  { Event.stub(:new_from_json).and_return(event) }
       subject { Base.new( mock_request, dispatcher ) }
-      
-      context "new adapters" do
-        it "should register themselves in the adapters array when inherited" do
+
+      context "new adapter" do
+        it "should register itself in the adapters array when inherited" do
           adapter = Class.new( ConnectionAdapters::Base )
           ConnectionAdapters.adapters.include?( adapter ).should be_true
         end
+
+        it "should create a new DataStore::Connection instance" do
+          subject.data_store.should be_a DataStore::Connection
+        end
       end
 
       describe "#on_open" do
@@ -82,13 +86,13 @@ module WebsocketRails
           subject.on_error("test_data")
         end
       end
-      
+
       describe "#send" do
         it "should raise a NotImplementedError exception" do
           expect { subject.send :message }.to raise_exception( NotImplementedError )
         end
       end
-      
+
       describe "#enqueue" do
         it "should add the event to the queue" do
           subject.enqueue 'event'
@@ -125,6 +129,23 @@ module WebsocketRails
           subject.flush
         end
       end
+
+      describe "#close_connection" do
+        before do
+          @connection_manager = double('connection_manager').as_null_object
+          subject.stub_chain(:dispatcher, :connection_manager).and_return(@connection_manager)
+        end
+
+        it "calls delegates to the conection manager" do
+          @connection_manager.should_receive(:close_connection).with(subject)
+          subject.__send__(:close_connection)
+        end
+
+        it "deletes it's data_store" do
+          subject.data_store.should_receive(:destroy!)
+          subject.__send__(:close_connection)
+        end
+      end
     end
   end
 end

data/spec/unit/controller_factory_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+module WebsocketRails
+  describe ControllerFactory do
+
+    class TestController < BaseController
+      attr_reader :_dispatcher, :_event
+
+      def initialize_session
+        true
+      end
+    end
+
+    let(:dispatcher) { double('dispatcher') }
+    let(:connection) { double('connection') }
+    let(:event) { double('event') }
+
+    subject { ControllerFactory.new(dispatcher) }
+
+    before do
+      connection.stub(:id).and_return(1)
+      event.stub(:connection).and_return(connection)
+    end
+
+    it "stores a reference to the dispatcher" do
+      subject.dispatcher.should == dispatcher
+    end
+
+    it "maintains a hash of controller data stores" do
+      subject.controller_stores.should be_a Hash
+    end
+
+    describe "#new_for_event" do
+      it "creates and returns a new controller instance" do
+        controller = subject.new_for_event(event, TestController)
+        controller.class.should == TestController
+      end
+
+      it "initializes the controller with the correct data_store" do
+        store = double('data_store')
+        subject.controller_stores[TestController] = store
+        controller = subject.new_for_event(event, TestController)
+        controller.controller_store.should == store
+      end
+
+      it "initializes the controller with the correct event" do
+        controller = subject.new_for_event(event, TestController)
+        controller.event.should == event
+      end
+
+      it "initializes the controller with the correct dispatcher" do
+        controller = subject.new_for_event(event, TestController)
+        controller._dispatcher.should == dispatcher
+      end
+
+      it "calls #initialize_session on the controller only once" do
+        TestController.any_instance.should_receive(:initialize_session).once
+        3.times { subject.new_for_event(event, TestController) }
+      end
+    end
+
+  end
+end

data/spec/unit/data_store_spec.rb

@@ -1,39 +1,106 @@
 require 'spec_helper'
 
 module WebsocketRails
-  describe DataStore do
-    let(:attribute) {"example_attribute"}
-    let(:value)     {1}
-
-    before(:each) do
-      @base = double('base_controller')
-      @base.stub(:client_id).and_return(1)
-      @data_store = DataStore.new(@base)
-    end
-    
-    it "loads up" do
-      @data_store.present?.should be_true
-    end
+  module DataStore
+    describe Base do
+      it "extends Hash" do
+        subject.should be_a Hash
+      end
+
+      it "allows indifferent access" do
+        subject['key'] = true
+        subject[:key].should == true
+      end
+
+      describe "#instances" do
+        before do
+          Base.clear_all_instances
+          @connection = double('connection')
+          @controller = double('controller')
+        end
+
+        it "keeps track of all instantiated instances" do
+          store_one = Base.new
+          store_two = Base.new
 
-    describe "#[]" do
-      context "with an undefined attribute" do
-        it "returns nil" do
-          @data_store[attribute].should be_nil
+          store_one.instances.count.should == 2
+          store_two.instances.count.should == 2
+        end
+
+        it "separates instances based on class name" do
+          2.times { Connection.new(@connection) }
+          4.times { Controller.new(@controller) }
+
+          Connection.new(@connection).instances.count.should == 3
+          Controller.new(@controller).instances.count.should == 5
         end
       end
 
-      context "with a defined attribute" do
-        it "returns its value" do
-          @data_store[attribute] = value
-          @data_store[attribute].should == value
+      describe "#destroy!" do
+        before do
+          Base.clear_all_instances
+          @store = Base.new
+          @other = Base.new
+        end
+
+        it "removes itself from the instances collection" do
+          @other.instances.count.should == 2
+          @store.destroy!
+          @other.instances.count.should == 1
+        end
+      end
+
+      describe "#collect_all" do
+        before do
+          Base.clear_all_instances
+          @store_one = Base.new
+          @store_two = Base.new
+
+          @store_one[:secret] = 'token_one'
+          @store_two[:secret] = 'token_two'
+        end
+
+        context "called without a block" do
+          it "returns an array of values for the specified key from all store instances" do
+            secrets = @store_one.collect_all(:secret)
+            secrets.should == ['token_one', 'token_two']
+          end
+        end
+
+        context "called with a block" do
+          it "yields each value to the block" do
+            @store_one.collect_all(:secret) do |item|
+              item.should be_in ['token_one', 'token_two']
+            end
+          end
         end
       end
     end
 
-    describe "#[]=" do
-      it "returns the value" do
-        (@data_store[attribute]=value).should == value
+    describe Connection do
+      before do
+        @connection = double('connection')
+        @connection.stub(:client_id).and_return(1)
+      end
+
+      let(:subject) { DataStore::Connection.new(@connection) }
+
+      it "stores a reference to it's connection" do
+        subject.connection.should == @connection
+      end
+    end
+
+    describe Controller do
+      before do
+        @controller = double('controller')
+      end
+
+      let(:subject) { DataStore::Controller.new(@controller) }
+
+      it "stores a reference to it's controller" do
+        subject.controller.should == @controller
       end
     end
   end
+
 end

data/spec/unit/dispatcher_spec.rb

@@ -4,7 +4,7 @@ require 'support/mock_web_socket'
 module WebsocketRails
 
   class EventTarget
-    attr_reader :_event, :test_method
+    attr_reader :_event, :_dispatcher, :test_method
 
     def execute_observers(event_name)
       true
@@ -13,7 +13,7 @@ module WebsocketRails
 
   describe Dispatcher do
 
-    let(:event) { double('Event') }
+    let(:event) { double('Event').as_null_object }
     let(:connection) { MockWebSocket.new }
     let(:connection_manager) { double('connection_manager').as_null_object }
     subject { Dispatcher.new(connection_manager) }
@@ -43,27 +43,22 @@ module WebsocketRails
       end
     end
 
-    context "dispatching a message for an event" do
+    context "dispatching an event" do
       before do
-        @target = EventTarget.new
-        EventMap.any_instance.stub(:routes_for).with(any_args).and_yield( @target, :test_method )
+        EventMap.any_instance.stub(:routes_for).with(any_args).and_yield(EventTarget, :test_method)
         event.stub(:name).and_return(:test_method)
         event.stub(:data).and_return(:some_message)
         event.stub(:connection).and_return(connection)
         event.stub(:is_channel?).and_return(false)
         event.stub(:is_invalid?).and_return(false)
+        event.stub(:is_internal?).and_return(false)
       end
 
       it "should execute the correct method on the target class" do
-        @target.should_receive(:test_method)
+        EventTarget.any_instance.should_receive(:test_method)
         subject.dispatch(event)
       end
 
-      it "should set the _event instance variable on the target object" do
-        subject.dispatch(event)
-        @target._event.should == event
-      end
-
       context "channel events" do
         it "should forward the data to the correct channel" do
           event = Event.new 'test', :data => 'data', :channel => :awesome_channel