Complete SerialDataSource documentation and tests.

danielwippermann · Feb 15, 2014 · 7fd8982 · 7fd8982
1 parent e1edc2f
commit 7fd8982
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 4 deletions.
diff --git a/src/serial-data-source.js b/src/serial-data-source.js
@@ -18,10 +18,19 @@ var optionKeys = [
 
 
 
-var SerialDataSource = DataSource.extend({
+var SerialDataSource = DataSource.extend(/** @lends SerialDataSource# */ {
 
+    /**
+     * The path to the serial port.
+     */
     path: null,
 
+    /**
+     * Creates a new SerialDataSource.
+     *
+     * @constructs
+     * @augments DataSource
+     */
     constructor: function(options) {
         DataSource.call(this, options);
 
@@ -40,7 +49,9 @@ var SerialDataSource = DataSource.extend({
 
         var connection = new SerialConnection(options);
 
-        return connection.connect();
+        return connection.connect().then(function() {
+            return connection;
+        });
     }
 
 });

diff --git a/test/specs/serial-data-source.spec.js b/test/specs/serial-data-source.spec.js
@@ -3,7 +3,16 @@
 
 
 
-var SerialDataSource = require('./resol-vbus').SerialDataSource;
+var Q = require('q');
+
+
+var vbus = require('./resol-vbus');
+var testUtils = require('./test-utils');
+
+
+
+var SerialConnection = vbus.SerialConnection;
+var SerialDataSource = vbus.SerialDataSource;
 
 
 
@@ -15,9 +24,44 @@ describe('SerialDataSource', function() {
             expect(SerialDataSource).to.be.a('function');
         });
 
+        it('should have reasonable defaults', function() {
+            var ds = new SerialDataSource();
+
+            expect(ds)
+                .to.have.a.property('path')
+                    .that.equal(null);
+        });
+
     });
 
-    xit('should perform tests...', function() {
+    describe('#connectLive', function() {
+
+        it('should be a method', function() {
+            expect(SerialDataSource.prototype)
+                .to.have.a.property('connectLive')
+                    .that.is.a('function');
+        });
+
+        it('should work correctly', function(done) {
+            var originalConnect = SerialConnection.prototype.connect;
+
+            SerialConnection.prototype.connect = function() {
+                return Q(null);
+            };
+
+            var ds = new SerialDataSource();
+
+            testUtils.performAsyncTest(done, function() {
+                return Q.fcall(function() {
+                    return ds.connectLive();
+                }).then(function(connection) {
+                    expect(connection)
+                        .to.be.instanceOf(SerialConnection);
+                }).finally(function() {
+                    SerialConnection.prototype.connect = originalConnect;
+                });
+            });
+        });
 
     });