Emitter: rename Suspendable -> Emitter and update everything to use o…

…ur Emitter
rwaldron · Jul 6, 2021 · 460179b · 460179b
1 parent 8dc5651
commit 460179b
Show file tree

Hide file tree

Showing 42 changed files with 82 additions and 71 deletions.
diff --git a/lib/accelerometer.js b/lib/accelerometer.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const Expander = require("./expander");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const { constrain, fma, int16, sum, toFixed, RAD_TO_DEG } = require("./fn");
 
 const priv = new Map();

diff --git a/lib/altimeter.js b/lib/altimeter.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const { toFixed } = require("./fn");
 const priv = new Map();
 

diff --git a/lib/animation.js b/lib/animation.js
@@ -1,4 +1,4 @@
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const ease = require("./easing");
 const { cloneDeep, constrain } = require("./fn");
 let temporal;

diff --git a/lib/barometer.js b/lib/barometer.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const { toFixed } = require("./fn");
 
 const Controllers = {

diff --git a/lib/board.js b/lib/board.js
@@ -1,4 +1,4 @@
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const chalk = require("chalk");
 const Collection = require("./mixins/collection");
 const Fn = require("./fn");
@@ -471,11 +471,6 @@ function finalizeAndBroadcast(data, type, io) {
   }
 }
 
-// Inherit event api
-// util.inherits(Board, Emitter);
-
-
-
 /**
  * Pass through methods
  */

diff --git a/lib/button.js b/lib/button.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const Collection = require("./mixins/collection");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const EVS = require("./evshield");
 const Fn = require("./fn");
 

diff --git a/lib/color.js b/lib/color.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const EVS = require("./evshield");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 const priv = new Map();
 

diff --git a/lib/compass.js b/lib/compass.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const {int16, RAD_TO_DEG, TAU} = require("./fn");
 const priv = new Map();
 

diff --git a/lib/evshield.js b/lib/evshield.js
@@ -1,4 +1,4 @@
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 let shared;
 
 class Bank {

diff --git a/lib/expander.js b/lib/expander.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const sleep = require("./sleep");
 const Fn = require("./fn");
 const priv = new Map();

diff --git a/lib/gps.js b/lib/gps.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Pin = require("./pin");
 const {toFixed} = require("./fn");
 const priv = new Map();

diff --git a/lib/gyro.js b/lib/gyro.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 
 const sum = Fn.sum;

diff --git a/lib/hygrometer.js b/lib/hygrometer.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 const priv = new Map();
 

diff --git a/lib/joystick.js b/lib/joystick.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const { constrain, fscale } = require("./fn");
 const priv = new Map();
 const axes = ["x", "y"];

diff --git a/lib/keypad.js b/lib/keypad.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 const { scale, toFixed, uint16 } = Fn;
 const priv = new Map();

diff --git a/lib/light.js b/lib/light.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const EVS = require("./evshield");
-const Suspendable = require("./mixins/suspendable");
+const Withinable = require("./mixins/withinable");
 const { uint16, toFixed, scale } = require("./fn");
 const priv = new Map();
 
@@ -436,7 +436,7 @@ Controllers.ALSPT19 = Controllers["ALS-PT19"] = Controllers.DEFAULT;
  *
  */
 
-class Light extends Suspendable {
+class Light extends Withinable {
   constructor(options) {
     super();
 

diff --git a/lib/mixins/collection.js b/lib/mixins/collection.js
@@ -1,4 +1,5 @@
-const Emitter = require("events");
+const EventEmitter = require("events");
+const Emitter = require("./emitter");
 
 /**
  * Collection
@@ -203,8 +204,6 @@ Collection.Emitter = class extends Collection {
   constructor(numsOrObjects) {
     super(numsOrObjects);
 
-    // Emitter.call(this);
-
     // If the Collection.Emitter was created
     // with a Shared Properties object, then
     // we should abide by the freq or period
@@ -282,6 +281,7 @@ Collection.Emitter = class extends Collection {
 
 Object.assign(
   Collection.Emitter.prototype,
+  EventEmitter.prototype,
   Emitter.prototype
 );
 

diff --git a/lib/mixins/suspendable.js → lib/mixins/emitter.js b/lib/mixins/suspendable.js → lib/mixins/emitter.js
@@ -1,16 +1,14 @@
-const Withinable = require("./withinable");
+const EventEmitter = require("events");
 const wm = new WeakMap();
 
-class Suspendable extends Withinable {
+class Emitter extends EventEmitter {
   pause() {
-
     wm.set(this, {
       ...this._events
     });
 
     this._events = { __proto__: null };
   }
-
   resume() {
     const events = wm.get(this);
     if (events) {
@@ -23,4 +21,9 @@ class Suspendable extends Withinable {
   }
 }
 
-module.exports = Suspendable;
+Object.assign(
+  Emitter.prototype,
+  EventEmitter.prototype
+);
+
+module.exports = Emitter;
diff --git a/lib/mixins/withinable.js b/lib/mixins/withinable.js
@@ -1,4 +1,4 @@
-const Emitter = require("events");
+const Emitter = require("./emitter");
 
 class Withinable extends Emitter {
   constructor() {

diff --git a/lib/motion.js b/lib/motion.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const Collection = require("./mixins/collection");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const priv = new Map();
 
 

diff --git a/lib/motor.js b/lib/motor.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const Collection = require("./mixins/collection");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const EVS = require("./evshield");
 const Expander = require("./expander.js");
 const Fn = require("./fn");

diff --git a/lib/orientation.js b/lib/orientation.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const priv = new Map();
 
 const Controllers = {

diff --git a/lib/pin.js b/lib/pin.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Collection = require("./mixins/collection");
 
 const priv = new Map();

diff --git a/lib/proximity.js b/lib/proximity.js
@@ -2,7 +2,7 @@ const Board = require("./board");
 const Collection = require("./mixins/collection");
 const EVS = require("./evshield");
 const Fn = require("./fn");
-const Suspendable = require("./mixins/suspendable");
+const Withinable = require("./mixins/withinable");
 const Pins = Board.Pins;
 
 const toFixed = Fn.toFixed;
@@ -427,7 +427,7 @@ Controllers.DEFAULT = Controllers["GP2Y0A21YK"];
  *
  */
 
-class Proximity extends Suspendable {
+class Proximity extends Withinable {
   constructor(options) {
     super();
 

diff --git a/lib/reflectancearray.js b/lib/reflectancearray.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 const Led = require("./led");
 const Sensor = require("./sensor");

diff --git a/lib/repl.js b/lib/repl.js
@@ -1,4 +1,4 @@
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const repl = require("repl");
 const priv = new Map();
 

diff --git a/lib/sensor.js b/lib/sensor.js
@@ -1,7 +1,7 @@
 const Board = require("./board");
-const Collection = require("./mixins/collection");
 const Fn = require("./fn");
-const Suspendable = require("./mixins/suspendable");
+const Collection = require("./mixins/collection");
+const Withinable = require("./mixins/withinable");
 
 // Sensor instance private data
 const priv = new Map();
@@ -28,7 +28,7 @@ function median(input) {
  * @param {Object} options Options: pin, freq, range
  */
 
-class Sensor extends Suspendable {
+class Sensor extends Withinable {
   constructor(options) {
 
     super();

diff --git a/lib/servo.js b/lib/servo.js
@@ -1,8 +1,8 @@
 const Board = require("./board");
 const Pins = Board.Pins;
 const Expander = require("./expander");
-const Emitter = require("events");
 const Collection = require("./mixins/collection");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 const Animation = require("./animation");
 

diff --git a/lib/sip.js b/lib/sip.js
@@ -1,5 +1,5 @@
 const Board = require("./board");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 const priv = new Map();
 const activeDrivers = new Map();

diff --git a/lib/switch.js b/lib/switch.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
 const Collection = require("./mixins/collection");
-const Emitter = require("events");
+const Emitter = require("./mixins/emitter");
 const Fn = require("./fn");
 
 /**

diff --git a/lib/thermometer.js b/lib/thermometer.js
@@ -1,6 +1,6 @@
 const Board = require("./board");
-const Emitter = require("events");
-const Suspendable = require("./mixins/suspendable");
+const EventEmitter = require("events");
+const Emitter = require("./mixins/emitter");
 const {
   toFixed,
   POW_2_16,
@@ -283,7 +283,7 @@ Drivers.get = (board, driverName, options) => {
   const key = `${driverName}_${options.pin}`;
 
   if (!drivers[key]) {
-    driver = new Emitter();
+    driver = new EventEmitter();
     Object.defineProperties(driver, Drivers[driverName]);
     driver.initialize(board, options);
     drivers[key] = driver;
@@ -880,7 +880,7 @@ Controllers.DEFAULT = Controllers.ANALOG;
 
 var priv = new Map();
 
-class Thermometer extends Suspendable {
+class Thermometer extends Emitter {
   constructor(options) {
     super();
 

diff --git a/test/.jshintrc b/test/.jshintrc
@@ -90,7 +90,7 @@
     "ShiftRegisters": true,
     "Sonar": true,
     "Stepper": true,
-    "Suspendable": true,
+    "Emitter": true,
     "Switch": true,
     "temporal": true,
     "Thermometer": true,

diff --git a/test/common/bootstrap.js b/test/common/bootstrap.js
@@ -3,11 +3,11 @@
 global.IS_TEST_MODE = true;
 
 // Built-ins
-global.Emitter = require("events");
+global.EventEmitter = require("events");
 
 // Internal
 global.Collection = require("../../lib/mixins/collection");
-global.Suspendable = require("../../lib/mixins/suspendable");
+global.Emitter = require("../../lib/mixins/emitter");
 global.Withinable = require("../../lib/mixins/withinable");
 global.five = require("../../lib/johnny-five");
 global.EVS = require("../../lib/evshield");