Change isOpen() to a propterty (#899)

Author: reconbot

packages/serialport-util/packages/node-serialport/.travis.yml

@@ -82,7 +82,7 @@ install:
 script:
   # linting no longer works on node 0.10
 - node bin/at-least-node-4.0.js && npm run lint || true
-- npm run docs-diff
+- npm run docs:diff
 - node ./
 - npm test
 

packages/serialport-util/packages/node-serialport/README.md

@@ -52,7 +52,6 @@ For getting started with node-serialport, we recommend you begin with the follow
     * _instance_
         * [`.open([callback])`](#module_serialport--SerialPort+open)
         * [`.update([options], [callback])`](#module_serialport--SerialPort+update)
-        * [`.isOpen()`](#module_serialport--SerialPort+isOpen) ⇒ <code>Boolean</code>
         * [`.write(data, [callback])`](#module_serialport--SerialPort+write)
         * [`.pause()`](#module_serialport--SerialPort+pause)
         * [`.resume()`](#module_serialport--SerialPort+resume)
@@ -299,6 +298,7 @@ Enjoy and do cool things with this code.
 | Name | Type | Description |
 | --- | --- | --- |
 | path | <code>string</code> | The system path or name of the serial port. Read Only. |
+| isOpen | <code>boolean</code> | true if the port is open, false otherwise. Read Only. |
 
 
 -
@@ -351,15 +351,6 @@ Changes the baud rate for an open port. Throws if you provide a bad argument. Em
 | [callback] | <code>[errorCallback](#module_serialport--SerialPort..errorCallback)</code> | Called once the port's baud rate has been changed. If `.update` is called without an callback and there is an error, an error event will be emitted. |
 
 
--
-
-<a name="module_serialport--SerialPort+isOpen"></a>
-
-#### `serialPort.isOpen()` ⇒ <code>Boolean</code>
-Returns `true` if the port is open.
-
-**Kind**: instance method of <code>[SerialPort](#exp_module_serialport--SerialPort)</code>  
-
 -
 
 <a name="module_serialport--SerialPort+write"></a>

packages/serialport-util/packages/node-serialport/lib/serialport.js

@@ -90,6 +90,7 @@ var defaultSetFlags = {
  * @param {module:serialport~errorCallback=} openCallback - Called when a connection has been opened. If this is not provided and an error occurs, it will be emitted on the ports `error` event. The callback will NOT be called if autoOpen is set to false in the openOptions as the open will not be performed.
  * @throws {TypeError} When given invalid arguments a TypeError will be thrown.
  * @property {string} path The system path or name of the serial port. Read Only.
+ * @property {boolean} isOpen true if the port is open, false otherwise. Read Only.
  * @emits module:serialport#open
  * @emits module:serialport#data
  * @emits module:serialport#close
@@ -121,6 +122,12 @@ function SerialPort(path, options, callback) {
     value: path
   });
 
+  Object.defineProperty(this, 'isOpen', {
+    enumerable: true,
+    get: function() {
+      return this.fd !== null && !this.closing;
+    }
+  });
 
   if (!this.path) {
     throw new TypeError('No path specified');
@@ -201,7 +208,7 @@ SerialPort.prototype._error = function(error, callback) {
  * @emits module:serialport#open
  */
 SerialPort.prototype.open = function(callback) {
-  if (this.isOpen()) {
+  if (this.isOpen) {
     return this._error(new Error('Port is already open'), callback);
   }
 
@@ -246,7 +253,7 @@ SerialPort.prototype.open = function(callback) {
  * @param {module:serialport~errorCallback=} [callback] Called once the port's baud rate has been changed. If `.update` is called without an callback and there is an error, an error event will be emitted.
  */
 SerialPort.prototype.update = function(options, callback) {
-  if (!this.isOpen()) {
+  if (!this.isOpen) {
     debug('update attempted, but port is not open');
     return this._error(new Error('Port is not open'), callback);
   }
@@ -262,14 +269,6 @@ SerialPort.prototype.update = function(options, callback) {
   }.bind(this));
 };
 
-/**
- * Returns `true` if the port is open.
- * @return {Boolean}
- */
-SerialPort.prototype.isOpen = function() {
-  return this.fd !== null && !this.closing;
-};
-
 /**
  * Writes data to the given serial port.
  * @param  {(string|array|buffer)} data Accepts a [`Buffer` ](http://nodejs.org/api/buffer.html) object, or a type that is accepted by the `Buffer` constructor (ex. an array of bytes or a string).
@@ -278,7 +277,7 @@ SerialPort.prototype.isOpen = function() {
  * @description Some devices like the Arduino reset when you open a connection to them. In these cases if you immediately write to the device they wont be ready to receive the data. This is often worked around by having the Arduino send a "ready" byte that your node program waits for before writing. You can also often get away with waiting around 400ms.
  */
 SerialPort.prototype.write = function(data, callback) {
-  if (!this.isOpen()) {
+  if (!this.isOpen) {
     debug('write attempted, but port is not open');
     return this._error(new Error('Port is not open'), callback);
   }
@@ -322,7 +321,7 @@ if (process.platform !== 'win32') {
       this.reading = false;
       if (err) {
         if (err.code && err.code === 'EAGAIN') {
-          if (this.isOpen()) {
+          if (this.isOpen) {
             this.serialPoller.start();
           }
         // handle edge case were mac/unix doesn't clearly know the error.
@@ -341,7 +340,7 @@ if (process.platform !== 'win32') {
       this.pool.used -= bytesRequested - bytesRead;
 
       if (bytesRead === 0) {
-        if (this.isOpen()) {
+        if (this.isOpen) {
           this.serialPoller.start();
         }
       } else {
@@ -396,7 +395,7 @@ if (process.platform !== 'win32') {
     }
 
     // No longer open?
-    if (!this.isOpen()) {
+    if (!this.isOpen) {
       return;
     }
 
@@ -454,7 +453,7 @@ SerialPort.prototype.close = function(callback) {
     return this._error(new Error('Port is not open'), callback);
   }
 
-  if (!this.isOpen()) {
+  if (!this.isOpen) {
     debug('close attempted, but port is not open');
     return this._error(new Error('Port is not open'), callback);
   }
@@ -484,7 +483,7 @@ SerialPort.prototype.close = function(callback) {
  * @param  {module:serialport~errorCallback=} callback Called once the flush operation finishes.
  */
 SerialPort.prototype.flush = function(callback) {
-  if (!this.isOpen()) {
+  if (!this.isOpen) {
     debug('flush attempted, but port is not open');
     return this._error(new Error('Port is not open'), callback);
   }
@@ -509,7 +508,7 @@ SerialPort.prototype.flush = function(callback) {
  * @param {module:serialport~errorCallback=} callback Called once the port's flags have been set.
  */
 SerialPort.prototype.set = function(options, callback) {
-  if (!this.isOpen()) {
+  if (!this.isOpen) {
     debug('set attempted, but port is not open');
     return this._error(new Error('Port is not open'), callback);
   }
@@ -554,7 +553,7 @@ function writeAndDrain (data, callback) {
 ```
  */
 SerialPort.prototype.drain = function(callback) {
-  if (!this.isOpen()) {
+  if (!this.isOpen) {
     debug('drain attempted, but port is not open');
     return this._error(new Error('Port is not open'), callback);
   }

packages/serialport-util/packages/node-serialport/package.json

@@ -88,13 +88,12 @@
   "license": "MIT",
   "scripts": {
     "docs": "jsdoc2md -t .docs/README.hbs --partial .docs/sig-name.hbs --partial .docs/sig-link.hbs -r table --separators --name-format lib/* > README.md",
-    "docs-diff": "jsdoc2md -t .docs/README.hbs --partial .docs/sig-name.hbs --partial .docs/sig-link.hbs -r table --separators --name-format lib/* | diff README.md - || (echo 'Docs out of date, run `npm run docs` and commit the new README.md' && false)",
+    "docs:diff": "jsdoc2md -t .docs/README.hbs --partial .docs/sig-name.hbs --partial .docs/sig-link.hbs -r table --separators --name-format lib/* | diff README.md - || (echo 'Docs out of date, run `npm run docs` and commit the new README.md' && false)",
     "install": "node-pre-gyp install --fallback-to-build",
     "rebuild-all": "npm rebuild && node-gyp rebuild",
     "stress": "mocha --no-timeouts test/arduinoTest/stress.js",
     "lint": "eslint *.js lib/**/*.js test/**/*.js bin/**/*.js examples/**/*.js",
     "test": "istanbul cover ./node_modules/mocha/bin/_mocha test/*.js test/arduinoTest/integration.js test/integration-lite.js",
-    "test:unit": "mocha test/*.js test/arduinoTest/integration.js test/integration-lite.js",
     "report-coverage": "cat ./coverage/lcov.info | coveralls",
     "valgrind": "valgrind --leak-check=full --show-possibly-lost=no node --expose-gc --trace-gc node_modules/.bin/grunt test"
   },

packages/serialport-util/packages/node-serialport/test/integration-lite.js

@@ -53,11 +53,11 @@ describe('SerialPort light integration', function() {
       it('can open and close', function(done) {
         var port = new SerialPort(testPort);
         port.on('open', function() {
-          assert.isTrue(port.isOpen());
+          assert.isTrue(port.isOpen);
           port.close();
         });
         port.on('close', function() {
-          assert.isFalse(port.isOpen());
+          assert.isFalse(port.isOpen);
           done();
         });
       });

packages/serialport-util/packages/node-serialport/test/serialport.js

@@ -179,17 +179,75 @@ describe('SerialPort', function() {
         assert.equal(port.path, '/dev/exists');
       });
     });
+
+    describe('.isOpen', function() {
+      it('is a read only property', function(){
+        var port = new SerialPort('/dev/exists', {autoOpen: false});
+        assert.equal(port.isOpen, false);
+        try {
+          port.isOpen = 'foo';
+        } catch(e) {
+          assert.instanceOf(e, TypeError);
+        }
+        assert.equal(port.isOpen, false);
+      });
+
+      it('returns false when the port is created', function(done) {
+        var port = new SerialPort('/dev/exists', { autoOpen: false });
+        assert.isFalse(port.isOpen);
+        done();
+      });
+
+      it('returns false when the port is opening', function(done) {
+        var port = new SerialPort('/dev/exists', { autoOpen: false });
+        sandbox.stub(bindings, 'open', function() {
+          assert.isTrue(port.opening);
+          assert.isFalse(port.isOpen);
+          done();
+        });
+        port.open();
+      });
+
+      it('returns true when the port is open', function(done) {
+        var port = new SerialPort('/dev/exists', function() {
+          assert.isTrue(port.isOpen);
+          done();
+        });
+      });
+
+      it('returns false when the port is closing', function(done) {
+        var port;
+        sandbox.stub(bindings, 'close', function() {
+          assert.isTrue(port.closing);
+          assert.isFalse(port.isOpen);
+          done();
+        });
+        port = new SerialPort('/dev/exists', {}, function() {
+          port.close();
+        });
+      });
+
+      it('returns false when the port is closed', function(done) {
+        var port = new SerialPort('/dev/exists', function() {
+          port.close();
+        });
+        port.on('close', function() {
+          assert.isFalse(port.isOpen);
+          done();
+        });
+      });
+    });
   });
 
   describe('Methods', function() {
     describe('#open', function() {
       it('passes the port to the bindings', function(done) {
         var openSpy = sandbox.spy(bindings, 'open');
         var port = new SerialPort('/dev/exists', { autoOpen: false });
-        assert.isFalse(port.isOpen());
+        assert.isFalse(port.isOpen);
         port.open(function(err) {
           assert.isNull(err);
-          assert.isTrue(port.isOpen());
+          assert.isTrue(port.isOpen);
           assert.isTrue(openSpy.calledWith('/dev/exists'));
           done();
         });
@@ -275,7 +333,7 @@ describe('SerialPort', function() {
       it('emits a close event', function(done) {
         var port = new SerialPort('/dev/exists', function() {
           port.on('close', function() {
-            assert.isFalse(port.isOpen());
+            assert.isFalse(port.isOpen);
             done();
           });
           port.close();
@@ -285,7 +343,7 @@ describe('SerialPort', function() {
       it('has a close callback', function(done) {
         var port = new SerialPort('/dev/exists', function() {
           port.close(function() {
-            assert.isFalse(port.isOpen());
+            assert.isFalse(port.isOpen);
             done();
           });
         });
@@ -341,51 +399,6 @@ describe('SerialPort', function() {
       });
     });
 
-    describe('#isOpen', function() {
-      it('returns false when the port is created', function(done) {
-        var port = new SerialPort('/dev/exists', { autoOpen: false });
-        assert.isFalse(port.isOpen());
-        done();
-      });
-
-      it('returns false when the port is opening', function(done) {
-        var port = new SerialPort('/dev/exists', { autoOpen: false });
-        sandbox.stub(bindings, 'open', function() {
-          assert.isTrue(port.opening);
-          assert.isFalse(port.isOpen());
-          done();
-        });
-        port.open();
-      });
-
-      it('returns true when the port is open', function(done) {
-        var port = new SerialPort('/dev/exists', function() {
-          assert.isTrue(port.isOpen());
-          done();
-        });
-      });
-      it('returns false when the port is closing', function(done) {
-        var port;
-        sandbox.stub(bindings, 'close', function() {
-          assert.isTrue(port.closing);
-          assert.isFalse(port.isOpen());
-          done();
-        });
-        port = new SerialPort('/dev/exists', {}, function() {
-          port.close();
-        });
-      });
-      it('returns false when the port is closed', function(done) {
-        var port = new SerialPort('/dev/exists', function() {
-          port.close();
-        });
-        port.on('close', function() {
-          assert.isFalse(port.isOpen());
-          done();
-        });
-      });
-    });
-
     describe('#write', function() {
       it('errors when the port is not open', function(done) {
         var cb = function() {};
@@ -525,13 +538,13 @@ describe('SerialPort', function() {
   describe('disconnections', function() {
     it('emits a disconnect event and closes the port', function(done) {
       var port = new SerialPort('/dev/exists', function() {
-        assert.isTrue(port.isOpen());
+        assert.isTrue(port.isOpen);
         hardware.disconnect('/dev/exists');
       });
       var spy = sandbox.spy();
       port.on('disconnect', spy);
       port.on('close', function() {
-        assert.isFalse(port.isOpen());
+        assert.isFalse(port.isOpen);
         assert.isTrue(spy.calledOnce);
         done();
       });