johnny-five-electron/test/joystick.js

Temporary fork to support Electron (to be deprecated)

var MockFirmata = require("./util/mock-firmata"),
  five = require("../lib/johnny-five.js"),
  sinon = require("sinon"),
  Board = five.Board,
  Joystick = five.Joystick;

function newBoard() {
  var io = new MockFirmata();
  var board = new Board({
    io: io,
    debug: false,
    repl: false
  });

  io.emit("connect");
  io.emit("ready");

  return board;
}

function restore(target) {
  for (var prop in target) {

    if (Array.isArray(target[prop])) {
      continue;
    }

    if (target[prop] != null && typeof target[prop].restore === "function") {
      target[prop].restore();
    }

    if (typeof target[prop] === "object") {
      restore(target[prop]);
    }
  }
}

var instance = [{
  name: "x"
}, {
  name: "y"
}];


exports["Joystick -- Analog"] = {

  setUp: function(done) {
    this.board = newBoard();
    this.clock = sinon.useFakeTimers();
    this.analogRead = sinon.spy(MockFirmata.prototype, "analogRead");
    this.stick = new Joystick({
      pins: ["A0", "A1"],
      board: this.board
    });

    done();
  },

  tearDown: function(done) {
    Board.purge();
    restore(this);
    done();
  },

  shape: function(test) {
    test.expect(instance.length);

    instance.forEach(function(property) {
      test.notEqual(typeof this.stick[property.name], "undefined");
    }, this);

    test.done();
  },

  data: function(test) {
    var x = this.analogRead.args[0][1];
    var y = this.analogRead.args[1][1];
    var spy = sinon.spy();

    test.expect(2);

    this.stick.on("data", spy);

    x(512);
    y(512);

    this.clock.tick(200);

    test.ok(spy.calledOnce);
    test.deepEqual(spy.args[0], [{
      x: 0,
      y: 0
    }]);

    test.done();
  },

  change: function(test) {
    test.expect(10);

    var spy = sinon.spy();
    var x = this.analogRead.args[0][1];
    var y = this.analogRead.args[1][1];

    this.stick.on("change", spy);


    // FIRST -----------------------------------

    x(512);
    this.clock.tick(100);

    y(512);
    this.clock.tick(100);


    x(1023);
    this.clock.tick(100);

    y(1023);
    this.clock.tick(100);

    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, 1);

    // SECOND -----------------------------------

    x(512);
    this.clock.tick(100);

    y(512);
    this.clock.tick(100);


    test.equal(this.stick.x, 0);
    test.equal(this.stick.y, 0);


    // THIRD -----------------------------------

    x(0);
    this.clock.tick(100);

    y(0);
    this.clock.tick(100);


    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, -1);

    // // -----------------------------------

    test.equal(spy.callCount, 4);

    test.deepEqual(spy.args[0], [{
      x: 0,
      y: 0
    }]);

    test.deepEqual(spy.args[1], [{
      x: 1,
      y: 1
    }]);

    test.deepEqual(spy.args[2], [{
      x: 0,
      y: 0
    }]);

    test.done();
  },

  nochange: function(test) {
    test.expect(5);

    var spy = sinon.spy();
    var x = this.analogRead.args[0][1];
    var y = this.analogRead.args[1][1];

    this.stick.on("change", spy);


    // FIRST -----------------------------------

    x(512);
    this.clock.tick(100);

    y(512);
    this.clock.tick(100);

    x(512);
    this.clock.tick(100);

    y(512);
    this.clock.tick(100);

    test.equal(this.stick.x, 0);
    test.equal(this.stick.y, 0);

    // SECOND -----------------------------------

    x(512);
    this.clock.tick(100);

    y(512);
    this.clock.tick(100);

    test.equal(this.stick.x, 0);
    test.equal(this.stick.y, 0);


    test.equal(spy.callCount, 1);

    test.done();
  },

  invertX: function(test) {
    test.expect(4);

    this.analogRead.reset();

    this.stick = new Joystick({
      pins: ["A0", "A1"],
      invertX: true,
      board: this.board
    });

    var x = this.analogRead.args[0][1];
    var y = this.analogRead.args[1][1];

    x(512);
    y(512);

    x(1023);
    y(1023);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, 1);

    x(0);
    y(0);

    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, -1);

    test.done();
  },
  invertY: function(test) {
    test.expect(4);

    this.analogRead.reset();

    this.stick = new Joystick({
      pins: ["A0", "A1"],
      invertY: true,
      board: this.board
    });

    var x = this.analogRead.args[0][1];
    var y = this.analogRead.args[1][1];


    x(512);
    y(512);

    x(1023);
    y(1023);

    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, -1);

    x(0);
    y(0);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, 1);

    test.done();
  },
  invert: function(test) {
    test.expect(4);

    this.analogRead.reset();

    this.stick = new Joystick({
      pins: ["A0", "A1"],
      invert: true,
      board: this.board
    });

    var x = this.analogRead.args[0][1];
    var y = this.analogRead.args[1][1];


    x(512);
    y(512);

    x(1023);
    y(1023);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, -1);

    x(0);
    y(0);

    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, 1);

    test.done();
  }
};

exports["Joystick -- ESPLORA"] = {

  setUp: function(done) {
    this.board = newBoard();
    this.clock = sinon.useFakeTimers();
    this.analogRead = sinon.spy(MockFirmata.prototype, "analogRead");
    this.stick = new Joystick({
      controller: "ESPLORA",
      board: this.board
    });

    done();
  },

  tearDown: function(done) {
    Board.purge();
    restore(this);
    done();
  },

  shape: function(test) {
    test.expect(instance.length);

    instance.forEach(function(property) {
      test.notEqual(typeof this.stick[property.name], "undefined");
    }, this);

    test.done();
  },

  data: function(test) {
    test.expect(2);

    var spy = sinon.spy();

    this.stick.on("data", spy);

    var x = this.analogRead.args[0][1];

    // This is REQUIRED for y to exist
    x(512);

    this.clock.tick(10);

    var y = this.analogRead.args[1][1];

    y(512);

    this.clock.tick(10);

    test.equal(spy.callCount, 1);

    test.deepEqual(spy.args[0], [{
      x: 0,
      y: 0
    }]);

    test.done();
  },

  change: function(test) {
    test.expect(10);

    var spy = sinon.spy();

    this.stick.on("change", spy);


    // FIRST -----------------------------------

    var x = this.analogRead.args[0][1];

    // This is REQUIRED for y to exist
    x(512);

    this.clock.tick(10);

    var y = this.analogRead.args[1][1];

    y(512);

    this.clock.tick(10);

    x = this.analogRead.args[2][1];

    // This is REQUIRED for y to exist
    x(0);

    this.clock.tick(10);

    y = this.analogRead.args[3][1];

    y(0);

    this.clock.tick(10);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, -1);

    // SECOND -----------------------------------

    x = this.analogRead.args[4][1];

    // This is REQUIRED for y to exist
    x(512);

    this.clock.tick(10);

    y = this.analogRead.args[5][1];

    y(512);

    this.clock.tick(10);

    test.equal(this.stick.x, 0);
    test.equal(this.stick.y, 0);

    // THIRD -----------------------------------

    x = this.analogRead.args[6][1];

    // This is REQUIRED for y to exist
    x(0);

    this.clock.tick(10);

    y = this.analogRead.args[7][1];

    y(0);

    this.clock.tick(10);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, -1);

    // -----------------------------------

    test.equal(spy.callCount, 4);

    test.deepEqual(spy.args[0], [{
      x: 0,
      y: 0
    }]);

    test.deepEqual(spy.args[1], [{
      x: -1,
      y: -1
    }]);

    test.deepEqual(spy.args[2], [{
      x: 0,
      y: 0
    }]);


    test.done();
  },

  nochange: function(test) {
    test.expect(5);

    var spy = sinon.spy();

    this.stick.on("change", spy);

    var x = this.analogRead.args[0][1];

    // This is REQUIRED for y to exist
    x(512);

    this.clock.tick(10);

    var y = this.analogRead.args[1][1];

    y(512);

    this.clock.tick(10);

    // FIRST -----------------------------------

    x = this.analogRead.args[2][1];

    x(512);

    this.clock.tick(10);

    y = this.analogRead.args[3][1];

    y(512);

    this.clock.tick(10);

    test.equal(this.stick.x, 0);
    test.equal(this.stick.y, 0);

    // SECOND -----------------------------------

    x = this.analogRead.args[4][1];

    x(512);

    this.clock.tick(10);

    y = this.analogRead.args[5][1];

    y(512);

    this.clock.tick(10);


    test.equal(this.stick.x, 0);
    test.equal(this.stick.y, 0);


    test.equal(spy.callCount, 1);

    test.done();
  },

  invertX: function(test) {
    test.expect(4);

    this.analogRead.reset();

    this.stick = new Joystick({
      controller: "ESPLORA",
      invertX: true,
      board: this.board
    });

    var x = this.analogRead.args[0][1];

    x(512);

    this.clock.tick(10);

    var y = this.analogRead.args[1][1];

    y(512);

    this.clock.tick(10);

    x = this.analogRead.args[2][1];

    x(1023);

    this.clock.tick(10);

    y = this.analogRead.args[3][1];

    y(1023);

    this.clock.tick(10);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, 1);


    x(0);

    this.clock.tick(10);

    y(0);

    this.clock.tick(10);

    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, -1);

    test.done();
  },
  invertY: function(test) {
    test.expect(4);

    this.analogRead.reset();

    this.stick = new Joystick({
      controller: "ESPLORA",
      invertY: true,
      board: this.board
    });

    var x = this.analogRead.args[0][1];

    x(512);

    this.clock.tick(10);

    var y = this.analogRead.args[1][1];

    y(512);

    this.clock.tick(10);

    x = this.analogRead.args[2][1];

    x(1023);

    this.clock.tick(10);

    y = this.analogRead.args[3][1];

    y(1023);

    this.clock.tick(10);


    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, -1);

    x(0);

    this.clock.tick(10);

    y(0);

    this.clock.tick(10);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, 1);

    test.done();
  },
  invert: function(test) {
    test.expect(4);

    this.analogRead.reset();

    this.stick = new Joystick({
      controller: "ESPLORA",
      invert: true,
      board: this.board
    });

    var x = this.analogRead.args[0][1];

    x(512);

    this.clock.tick(10);

    var y = this.analogRead.args[1][1];

    y(512);

    this.clock.tick(10);

    x = this.analogRead.args[2][1];

    x(1023);

    this.clock.tick(10);

    y = this.analogRead.args[3][1];

    y(1023);

    this.clock.tick(10);

    test.equal(this.stick.x, -1);
    test.equal(this.stick.y, -1);

    x(0);

    this.clock.tick(10);

    y(0);

    this.clock.tick(10);

    test.equal(this.stick.x, 1);
    test.equal(this.stick.y, 1);

    test.done();
  }
};