websocket-rails 0.3.0 → 0.4.0

data/spec/unit/event_map_spec.rb

@@ -24,7 +24,7 @@ module WebsocketRails
 
 
     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
 
@@ -38,32 +38,24 @@ module WebsocketRails
 
       end
     end
-    
+
     let(:dispatcher) { double('dispatcher').as_null_object }
     subject { EventMap.new(dispatcher) }
     before { define_test_events }
 
     context "EventMap.describe" do
       it "should store the event route block in the global configuration" do
-        WebsocketRails.route_block.should be_present
+        WebsocketRails.config.route_block.should be_present
       end
     end
-    
+
     context "Events in the global namespace" do
-      
+
       it "should store the event in the correct namespace" do
         subject.namespace.actions[:client_connected].should be_present
         subject.namespace.name.should == :global
       end
-      
-      it "should store the instantiated controller in the classes hash" do
-        subject.namespace.controllers[ChatController].class.should == ChatController
-      end
-      
-      it "should set the dispatcher on the instantiated controller" do
-        subject.namespace.controllers[ChatController].instance_variable_get(:@_dispatcher).should == dispatcher
-      end
-      
+
       it "should store the class constant and method name in the events hash" do
         subject.namespace.actions[:client_connected].should == [[ChatController,:new_user]]
       end
@@ -73,25 +65,21 @@ module WebsocketRails
     context "Events in a child namespace" do
 
       before { @namespace = subject.namespace }
-      
+
       it "should store the event in the correct namespaces" do
         @namespace.namespaces[:product].actions[:update].should be_present
         @namespace.namespaces[:complex_product].actions[:simplify].should be_present
       end
-      
+
     end
 
     context "#routes_for" do
-
-      let(:event) { double('event') }
-      
       context "with events in the global namespace" do
-        it "should yield the controller and action name for each route defined for an event" do
-          event.stub(:name).and_return(:client_connected)
-          event.stub(:namespace).and_return([:global])
+        it "should yield the controller class and action name for each route defined for an event" do
+          event = HelperMethods::MockEvent.new(:client_connected, [:global])
 
-          subject.routes_for(event) do |controller,method|
-            controller.class.should == ChatController
+          subject.routes_for(event) do |klass, method|
+            klass.should == ChatController
             method.should == :new_user
           end
         end
@@ -101,8 +89,9 @@ module WebsocketRails
         it "should yield the controller and action name for each route defined with a hash for an event" do
           ProductController.any_instance.should_receive(:action_executed)
           event = HelperMethods::MockEvent.new :update, [:global,:product]
-          
-          subject.routes_for(event) do |controller,method|
+
+          subject.routes_for(event) do |klass, method|
+            controller = klass.new
             controller.action_executed
             controller.class.should == ProductController
             method.should == :update_product
@@ -114,7 +103,8 @@ module WebsocketRails
           ComplexProductController.any_instance.should_receive(:action_executed)
           event = HelperMethods::MockEvent.new :simplify, [:global,:complex_product]
 
-          subject.routes_for(event) do |controller,method|
+          subject.routes_for(event) do |klass, method|
+            controller = klass.new
             controller.action_executed
             controller.class.should == ComplexProductController
             method.should == :simplify

data/spec/unit/event_spec.rb

@@ -96,6 +96,20 @@ module WebsocketRails
       end
     end
 
+    describe "#is_invalid?" do
+      it "returns true if the event name is :invalid_event" do
+        event = Event.new(:invalid_event)
+        event.is_invalid?.should be_true
+      end
+    end
+
+    describe "#is_internal?" do
+      it "returns true if the event is namespaced under websocket_rails" do
+        event = Event.new(:internal_event, :namespace => :websocket_rails)
+        event.is_internal?.should be_true
+      end
+    end
+
     describe "#serialize" do
       context "messages in the global namespace" do
         it "should not add the global namespace to the event name" do

data/spec/unit/logging_spec.rb

@@ -1,38 +1,143 @@
 require 'spec_helper'
 
 module WebsocketRails
-  class ClassWithLogging
-    include Logging
-  end
+  describe Logging do
+
+    class LoggedClass
+      include Logging
+    end
+
+    let(:io) { StringIO.new }
+    let(:object) { LoggedClass.new }
+
+    before do
+      WebsocketRails.config.logger = Logger.new(io)
+    end
+
+    describe "#info" do
+      it "logs the message" do
+        object.info "info logged"
+        io.string.should include("info logged")
+      end
+    end
+
+    describe "#debug" do
+      it "logs the message" do
+        object.debug "debug logged"
+        io.string.should include("debug logged")
+      end
+    end
+
+    describe "log_exception" do
+      let(:exception) { Exception.new('kaputt!').tap { |e| e.set_backtrace(['line 1', 'line 2']) } }
+
+      it "logs the exception message" do
+        object.log_exception(exception)
+        io.string.should include('kaputt!')
+      end
+
+      it "logs the backtrace" do
+        object.log_exception(exception)
+        io.string.should include("line 1")
+        io.string.should include("line 2")
+      end
+    end
+
+    context "logging an event" do
+      before do
+        data = {
+          namespace: :logger,
+          data: {message: "hello"},
+          connection: double('connection')
+        }
+        @event = Event.new(:logged_event, data)
+      end
+
+      describe "#log_event_start" do
+        it "logs the event information" do
+          object.log_event_start(@event)
+          io.string.should include("Started Event:")
+          io.string.should include("logger.logged_event")
+        end
+      end
+
+      describe "#log_event_end" do
+        it "logs the total time the event took to process" do
+          time = 12
+          object.log_event_end(@event, time)
+          io.string.should include("Event #{@event.encoded_name} Finished in #{time.to_f.to_d.to_s} seconds")
+        end
+      end
 
-  describe ClassWithLogging do
+      describe "#log_event" do
+        it "logs the start of the event" do
+          object.should_receive(:log_event_start).with(@event)
+          object.log_event(@event) { true }
+        end
 
-    describe "#log" do
-      context "when log_level = :warn" do
+        it "logs the end of the event" do
+          Time.stub(:now).and_return(1)
+          object.should_receive(:log_event_end).with(@event, 0)
+          object.log_event(@event) { true }
+        end
+
+        it "executes the block" do
+          executed = false
+          object.log_event(@event) { executed = true }
+          executed.should == true
+        end
+
+        it "logs any exceptions" do
+          exception = Exception.new("ouch")
+          object.should_receive(:log_exception).with(exception)
+          expect {
+            object.log_event(@event) { raise exception }
+          }.to raise_exception(exception)
+        end
+      end
+    end
+
+    describe "#log_event?" do
+      context "with an internal event" do
         before do
-          WebsocketRails.setup do |config|
-            config.log_level = :warn
+          @event = Event.new(:internal, :namespace => :websocket_rails)
+        end
+
+        context "when WebsocketRails.config.log_internal_events? is false" do
+          it "returns false" do
+            WebsocketRails.config.log_internal_events = false
+            object.log_event?(@event).should == false
           end
         end
 
-        it "should not print to the console" do
-          subject.should_not_receive(:puts).with("test message")
-          subject.log "test message"
+        context "when WebsocketRails.config.log_internal_events? is true" do
+          it "returns true" do
+            WebsocketRails.config.log_internal_events = true
+            object.log_event?(@event).should == true
+          end
         end
       end
 
-      context "log_level = :debug" do
+      context "with an external event" do
         before do
-          WebsocketRails.setup do |config|
-            config.log_level = :debug
+          @event = Event.new(:external)
+        end
+
+        context "when WebsocketRails.config.log_internal_events? is false" do
+          it "returns true" do
+            WebsocketRails.config.log_internal_events = false
+            object.log_event?(@event).should == true
           end
         end
 
-        it "should print to the console if log_level is :debug" do
-          subject.should_receive(:puts).with("test message")
-          subject.log "test message"
+        context "when WebsocketRails.config.log_internal_events? is true" do
+          it "returns true" do
+            WebsocketRails.config.log_internal_events = true
+            object.log_event?(@event).should == true
+          end
         end
       end
     end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -200,10 +200,12 @@ files:
 - lib/websocket_rails/base_controller.rb
 - lib/websocket_rails/channel.rb
 - lib/websocket_rails/channel_manager.rb
+- lib/websocket_rails/configuration.rb
 - lib/websocket_rails/connection_adapters/http.rb
 - lib/websocket_rails/connection_adapters/web_socket.rb
 - lib/websocket_rails/connection_adapters.rb
 - lib/websocket_rails/connection_manager.rb
+- lib/websocket_rails/controller_factory.rb
 - lib/websocket_rails/data_store.rb
 - lib/websocket_rails/dispatcher.rb
 - lib/websocket_rails/engine.rb
@@ -282,6 +284,7 @@ files:
 - spec/unit/connection_adapters/web_socket_spec.rb
 - spec/unit/connection_adapters_spec.rb
 - spec/unit/connection_manager_spec.rb
+- spec/unit/controller_factory_spec.rb
 - spec/unit/data_store_spec.rb
 - spec/unit/dispatcher_spec.rb
 - spec/unit/event_map_spec.rb
@@ -297,7 +300,9 @@ files:
 - CHANGELOG.md
 homepage: http://danknox.github.com/websocket-rails/
 licenses: []
-post_install_message: 
+post_install_message: ! "  Welcome to WebsocketRails v0.4.0!\n\n  There have been
+  a few significant changes in the public\n  API, so if you are upgrading please be
+  sure to read the\n  CHANGELOG located at:\n\n  http://github.com/DanKnox/websocket-rails/CHANGELOG.md\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -309,7 +314,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3143824869554570755
+      hash: 500969557461387914
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -318,10 +323,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3143824869554570755
+      hash: 500969557461387914
 requirements: []
 rubyforge_project: websocket-rails
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Plug and play websocket support for ruby on rails. Includes event router