JasmineScopeCheck

constructor

JasmineScopeCheck()

Option name	Type	Description
settings	[object Object]
[settings.globalObject=window]	[object Object]	The object to watch for modifications.
[settings.expect]	function	The Jasmine expect function, to check if the global scope remained clean.
[settings.whiteList=[]]	Array.<string>, Array.<RegExp>	Object paths as string or regular expression. If properties (and their children) matching a white list entry are changed, it is ignored.
[settings.maxRecursionDepth=4]	number	How deeply the scope check descends into the object graph.
[settings.useDefaultWhiteList=true]	boolean	If true (default), a set of curated default white list rules is used. Otherwise, the white-listing depends solely on the user-provided values.

function JasmineScopeCheck(settings) {
  if (!(this instanceof JasmineScopeCheck)) {
    return new JasmineScopeCheck(settings);
  }

  settings = _.defaults(settings, {
    // Default settings.
    globalObject: window,
    expect: window.expect,
    whiteList: [],
    maxRecursionDepth: 4,
    useDefaultWhiteList: true
  });

  var self = this;

defaultWhiteList

declaration

defaultWhiteList

var defaultWhiteList = [
  // Ignore the recursive reference to the window object.
  'window',
  // Generated by jQuery.
  /jQuery[0-9]+/,
  // Created by PhantomJS:
  'frameElement', 'event', 'scrollY', 'pageYOffset', /frames\..*/, /console\.(profiles|memory)/,
  // Internal jQuery state.
  /\$\.cache\..*/, /\$\.timers\..*/,
  // Jasmine spy stuff.
  /\$(\.\w+)+\.(identity|isSpy|plan|mostRecentCall|argsForCall|calls|andCallThrough|andReturn|andThrow|andCallFake|reset|wasCalled|callCount|baseObj|methodName|originalValue)/,
  // Jasmine globals:
  'cleanup', 'isCommonJS', 'spyOn', 'it', 'xit', 'expect', 'runs', 'waits', 'waitsFor', 'beforeEach', 'afterEach',
  'describe', 'xdescribe', 'readFixtures', 'setFixtures', 'spyOnEvent', 'loadStyleFixtures', 'preloadStyleFixtures',
  'loadJSONFixtures', 'htmlReporter', 'console_reporter', 'preloadFixtures', 'getJSONFixture', 'loadFixtures',
  'appendLoadFixtures', 'appendSetFixtures', 'appendLoadStyleFixtures', 'setStyleFixtures', 'appendSetStyleFixtures',
  'sandbox', /jasmine.*/, 'getJasmineRequireObj', 'fdescribe', 'fit', 'beforeAll', 'pending', 'fail', 'jsApiReporter',
  // Browser stuff:
  'external', 'chrome', 'document', 'location', 'setInterval', 'setTimeout', 'top', 'clearTimeout', 'clearInterval',
  'innerWidth', 'TEMPORARY', 'PERSISTENT', 'addEventListener', 'removeEventListener', 'dispatchEvent',
  // Firefox stuff:
  'mozAnimationStartTime', 'mozPaintCount', 'scrollMaxY'
];

if (settings.useDefaultWhiteList) {
  this.whiteList = defaultWhiteList.concat(settings.whiteList);
} else {
  this.whiteList = settings.whiteList;
}

isWhiteListed

function

isWhiteListed()

Option name	Type	Description
path	Array.<string>	Object path to the property.
property	string	Name of the property.

function isWhiteListed(path, property) {
  var isPropertyWhiteListed = false;
  var fullPath = path.concat([property]).join('.');

  // Consider white-listed if the recursion depth has been reached.
  if (path.length >= settings.maxRecursionDepth) {
    return true;
  }

  _.each(self.whiteList, function (entry) {
    if (typeof entry === 'string') {
      isPropertyWhiteListed = fullPath === entry;
    } else if (entry instanceof RegExp) {
      isPropertyWhiteListed = fullPath.match(entry) !== null;
    } else {
      throw new Error('Only strings and regular expressions may be used as white list rules.');
    }

    // Once the property matches a white list item, we don't have to check any further.
    return !isPropertyWhiteListed;
  });

  return isPropertyWhiteListed;
}

addedProperties

property

this.addedProperties

this.addedProperties = undefined;

changedProperties

property

this.changedProperties

this.changedProperties = undefined;

removedProperties

property

this.removedProperties

this.removedProperties = undefined;

reset

method

this.reset()

this.reset = function () {
  this.addedProperties = [];
  this.changedProperties = [];
  this.removedProperties = [];

  this.globalSnapshot = _.merge({}, settings.globalObject);
};

assertCleanScope

method

this.assertCleanScope()

this.assertCleanScope = function () {
  _.each({
    addedProperties: 'added',
    changedProperties: 'changed',
    removedProperties: 'removed'
  }, function (value, key) {
    settings.expect(self[key].length).toEqual(0,
      'Properties ' + value + ' in global scope: ' + self.addedProperties.join(', '));
  });
};

compareGlobalSnapshotWithReality

method

this.compareGlobalSnapshotWithReality()

this.compareGlobalSnapshotWithReality = function () {
  // Compare the snapshot to the current state of the global object, and track the changes.
  window.DeepDiff.diff(this.globalSnapshot, settings.globalObject, isWhiteListed, {
    push: function (change) {
      var fullPath = change.path.join('.');

      switch (change.kind) {
        case 'N': // Added
        case 'A': // Added to array
          self.addedProperties.push(fullPath);
          break;
        case 'E': // Edited
          self.changedProperties.push(fullPath);
          break;
        case 'D': // Deleted
          self.removedProperties.push(fullPath);
          break;
      }
    }
  });
};

install

method

this.install()

Option name	Type	Description
jasmineBeforeFunc	function	Jasmine's beforeEach() function.
jasmineAfterFunc	function	Jasmine's afterEach() function.

this.install = function (jasmineBeforeFunc, jasmineAfterFunc) {
  jasmineBeforeFunc(function () {
    // Reset the internal state before every spec, so only changes within the spec are detected.
    self.reset();
  });

  jasmineAfterFunc(function () {
    // After each spec, expect to have a clean scope.
    self.compareGlobalSnapshotWithReality();
    self.assertCleanScope();
  });
};

this.reset();
}