hammerjs/tests/unit/gestures.js

A javascript library for multi-touch gestures

var el = document.getElementById('toucharea');

// force showing touches
Hammer.plugins.showTouches(true);

// simulate touches
var simulator = new FakeTouches(el);
if (simulator_type) {
  simulator.setTouchType(simulator_type);
}

// hammer
var hammertime = new Hammer(el);


// all events
var all_events = ["touch", "release", "hold", "tap", "doubletap",
  "dragstart", "drag", "dragend", "dragleft", "dragright",
  "dragup", "dragdown", "swipe", "swipeleft", "swiperight",
  "swipeup", "swipedown", "transformstart", "transform",
  "transformend", "rotate", "pinch", "pinchin", "pinchout"];

// keep track of what events are triggered
var triggered_events = {};
hammertime.on(all_events.join(" "), function (ev) {
  triggered_events[ev.type] = ev;
});


/**
 * test gestures
 * when an event has an *, then it is allowed to be triggered multiple times
 */
var gesture_tests = {
  'Hold': 'touch hold release',
  'Tap': 'touch tap release',
  'DoubleTap': 'touch tap doubletap release',
  'DragRight': 'touch drag dragstart dragright dragend release',
  'SwipeRight': 'touch drag dragstart dragright dragend swipe swiperight release',
  'Rotate': 'touch transform transformstart transformend rotate release',
  'PinchIn': 'touch transform transformstart transformend pinch pinchin release',
  'PinchOut': 'touch transform transformstart transformend pinch pinchout release'
};

for (var gesture in gesture_tests) {
  if (gesture_tests.hasOwnProperty(gesture)) {
    (function (gesture) {
      if (gesture_tests[gesture].match(/transform/) && !simulator.has_multitouch) {
        return;
      }

      asyncTest(gesture, function () {
        testGesture(gesture, gesture_tests[gesture], function (success, msg) {
          ok(success, msg);
          start();
        });
      });
    })(gesture);
  }
}


/**
 * test gestures
 * @param   {String}    gesture
 * @param   {String}    expect_events
 * @param   {Function}  callback
 */
function testGesture(gesture, expect_events, callback) {
  // reset triggered events
  triggered_events = {};

  // trigger the gesture simulator
  simulator.triggerGesture(gesture, function () {
    var expect = expect_events.split(" ");
    var events = Object.keys(triggered_events);

    _.each(triggered_events, function (ev, name) {
      testEventData(name, ev);
    });

    // trigger callback with true/false is all the events are triggered
    // if also any other events are triggered it is false
    var success = (events.length === expect.length);

    // error msg
    var msg = gesture + " detected";
    if (!success) {
      msg = gesture + " error. Events triggered: " + events.join(" ");
    }

    // maybe something happens after the end, so wait a moment
    callback(success, msg);
  });
}


/**
 * test if event data contains wright values
 * @param   {String}    name
 * @param   {Object}    ev
 */
function testEventData(name, ev) {
  // types match
  ok(ev.type == name, 'ev.type');

  // has gesture object
  ok(_.isObject(ev.gesture), 'ev.gesture');

  // EVENT_START|MOVE|END|TOUCH|RELEASE
  ok(ev.gesture.eventType, 'ev.gesture.eventType');

  ok(_.isNumber(ev.gesture.angle), 'ev.gesture.angle');
  ok(_.isNumber(ev.gesture.interimAngle), 'ev.gesture.interimAngle');
  
  if(ev.gesture.eventType == Hammer.EVENT_TOUCH || ev.gesture.eventType == Hammer.EVENT_RELEASE) {
    ok(_.isNumber(ev.gesture.changedLength), 'ev.gesture.changedLength');
  }

  ok(_.isObject(ev.gesture.center), 'ev.gesture.center');
  ok(_.isNumber(ev.gesture.deltaTime), 'ev.gesture.deltatime');
  ok(_.isNumber(ev.gesture.deltaX), 'ev.gesture.deltaX');
  ok(_.isNumber(ev.gesture.deltaY), 'ev.gesture.deltaY');
  ok(_.isNumber(ev.gesture.distance), 'ev.gesture.distance');

  // direction
  ok(ev.gesture.direction, 'ev.gesture.direction');
  ok(ev.gesture.interimDirection, 'ev.gesture.interimDirection');
  var dir = ev.type.match(/up|down|left|right/);
  if (dir) {
    ok(ev.gesture.direction === dir[0]);
    ok(ev.gesture.interimDirection === dir[0]);
  }

  // pointerType
  ok(ev.gesture.pointerType, 'ev.gesture.pointerType');
  var pointer_type = 'touch';
  if (simulator.touch_type == FakeTouches.POINTER_MOUSE_EVENTS ||
    simulator.touch_type == FakeTouches.MOUSE_EVENTS) {
    pointer_type = 'mouse';
  }
  ok(ev.gesture.pointerType == pointer_type, 'not matching pointertype: ' + ev.gesture.eventType + ':' + ev.gesture.pointerType + ':' + pointer_type);

  ok(_.isFunction(ev.gesture.preventDefault), 'ev.gesture.preventDefault');
  ok(_.isNumber(ev.gesture.rotation), 'ev.gesture.rotation');
  ok(_.isNumber(ev.gesture.scale), 'ev.gesture.scale');
  ok(_.isObject(ev.gesture.srcEvent), 'ev.gesture.srcEvent');
  ok(_.isElement(ev.gesture.srcEvent.target), 'ev.gesture.srcEvent.target');
  ok(_.isObject(ev.gesture.startEvent), 'ev.gesture.startEvent');
  ok(_.isFunction(ev.gesture.stopDetect), 'ev.gesture.stopDetect');
  ok(_.isFunction(ev.gesture.stopPropagation), 'ev.gesture.stopPropagation');
  ok(_.isElement(ev.gesture.target), 'ev.gesture.target');
  ok(_.isNumber(ev.gesture.timeStamp), 'ev.gesture.timeStamp');
  ok(_.isArray(ev.gesture.touches), 'ev.gesture.touches');
  ok(ev.gesture.touches.length >= 1, 'ev.gesture.touches');
  ok(_.isNumber(ev.gesture.velocityX), 'ev.gesture.velocityX');
  ok(_.isNumber(ev.gesture.velocityY), 'ev.gesture.velocityY');
}