load custom_matchers globally, and refactor negateIf as a method

Author: alexcjohnson

test/jasmine/assets/custom_matchers.js

@@ -1,10 +1,24 @@
+/*
+ * custom_matchers - to be included in karma.conf.js, so it can
+ * add these matchers to jasmine globally and all suites have access.
+ *
+ * Also adds `.negateIf` which is not a matcher but a conditional `.not`:
+ *
+ *     expect(x).negateIf(condition).toBe(0);
+ *
+ * is equivalent to:
+ *
+ *     if(condition) expect(x).toBe(0);
+ *     else expect(x).not.toBe(0);
+ */
+
 'use strict';
 
 var isNumeric = require('fast-isnumeric');
 var Lib = require('../../../src/lib');
 var deepEqual = require('deep-equal');
 
-module.exports = {
+var matchers = {
     // toEqual except with sparse arrays populated. This arises because:
     //
     //   var x = new Array(2)
@@ -165,3 +179,12 @@ function coercePosition(precision) {
 function arrayToStr(array) {
     return '[ ' + array.join(', ') + ' ]';
 }
+
+beforeAll(function() {
+    jasmine.addMatchers(matchers);
+
+    jasmine.Expectation.prototype.negateIf = function(negate) {
+        if(negate) return this.not;
+        return this;
+    };
+});

test/jasmine/assets/negate_if.js

@@ -99,6 +99,7 @@ var pathToStrictD3 = path.join(__dirname, '..', '..', 'tasks', 'util', 'strict_d
 var pathToMain = path.join(__dirname, '..', '..', 'lib', 'index.js');
 var pathToJQuery = path.join(__dirname, 'assets', 'jquery-1.8.3.min.js');
 var pathToIE9mock = path.join(__dirname, 'assets', 'ie9_mock.js');
+var pathToCustomMatchers = path.join(__dirname, 'assets', 'custom_matchers.js');
 
 
 function func(config) {
@@ -132,8 +133,8 @@ func.defaultConfig = {
 
     // list of files / patterns to load in the browser
     //
-    // N.B. this field is filled below
-    files: [],
+    // N.B. the rest of this field is filled below
+    files: [pathToCustomMatchers],
 
     // list of files / pattern to exclude
     exclude: [],
@@ -220,16 +221,18 @@ func.defaultConfig = {
     }
 };
 
+func.defaultConfig.preprocessors[pathToCustomMatchers] = ['browserify'];
+
 if(isFullSuite) {
     func.defaultConfig.files.push(pathToJQuery);
     func.defaultConfig.preprocessors[testFileGlob] = ['browserify'];
 } else if(isBundleTest) {
     switch(basename(testFileGlob)) {
         case 'requirejs':
-            func.defaultConfig.files = [
+            func.defaultConfig.files.push(
                 constants.pathToRequireJS,
                 constants.pathToRequireJSFixture
-            ];
+            );
             break;
         case 'ie9':
             // load ie9_mock.js before plotly.js+test bundle

test/jasmine/karma.conf.js

@@ -9,7 +9,6 @@ var HOVERMINTIME = require('@src/components/fx').constants.HOVERMINTIME;
 var DBLCLICKDELAY = require('@src/constants/interactions').DBLCLICKDELAY;
 
 var d3 = require('d3');
-var customMatchers = require('../assets/custom_matchers');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var failTest = require('../assets/fail_test');
@@ -561,10 +560,6 @@ describe('annotations autorange', function() {
     var mock;
     var gd;
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     beforeEach(function() {
         gd = createGraphDiv();
         mock = Lib.extendDeep({}, require('@mocks/annotations-autorange.json'));
@@ -908,10 +903,6 @@ describe('annotation effects', function() {
     function arrowDrag() { return gd.querySelector('.annotation-arrow-g>.anndrag'); }
     function textBox() { return gd.querySelector('.annotation-text-g'); }
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     function makePlot(annotations, config) {
         gd = createGraphDiv();
 

test/jasmine/tests/annotations_test.js

@@ -10,7 +10,6 @@ var Axes = require('@src/plots/cartesian/axes');
 
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
-var customMatchers = require('../assets/custom_matchers');
 var failTest = require('../assets/fail_test');
 
 
@@ -577,7 +576,6 @@ describe('Test axes', function() {
 
         beforeEach(function() {
             gd = createGraphDiv();
-            jasmine.addMatchers(customMatchers);
         });
 
         afterEach(destroyGraphDiv);

test/jasmine/tests/axes_test.js

@@ -10,9 +10,7 @@ var Axes = require('@src/plots/cartesian/axes');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var fail = require('../assets/fail_test');
-var customMatchers = require('../assets/custom_matchers');
 var checkTicks = require('../assets/custom_assertions').checkTicks;
-var negateIf = require('../assets/negate_if');
 
 var d3 = require('d3');
 
@@ -154,10 +152,6 @@ describe('Bar.supplyDefaults', function() {
 describe('bar calc / setPositions', function() {
     'use strict';
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     it('should fill in calc pt fields (stack case)', function() {
         var gd = mockBarPlot([{
             y: [2, 1, 2]
@@ -269,10 +263,6 @@ describe('bar calc / setPositions', function() {
 describe('Bar.calc', function() {
     'use strict';
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     it('should guard against invalid base items', function() {
         var gd = mockBarPlot([{
             base: [null, 1, 2],
@@ -328,10 +318,6 @@ describe('Bar.calc', function() {
 describe('Bar.setPositions', function() {
     'use strict';
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     it('should guard against invalid offset items', function() {
         var gd = mockBarPlot([{
             offset: [null, 0, 1],
@@ -768,10 +754,6 @@ describe('A bar plot', function() {
 
     var gd;
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     beforeEach(function() {
         gd = createGraphDiv();
     });
@@ -1205,7 +1187,7 @@ describe('A bar plot', function() {
                 if(!i) return;
                 var bbox = this.getBoundingClientRect();
                 ['left', 'right', 'top', 'bottom', 'width', 'height'].forEach(function(dim) {
-                    negateIf(expect(bbox[dim]), dims.indexOf(dim) === -1)
+                    expect(bbox[dim]).negateIf(dims.indexOf(dim) === -1)
                         .toBeWithin(bbox1[dim], 0.1, msg + ' (' + i + '): ' + dim);
                 });
             });
@@ -1269,10 +1251,6 @@ describe('bar hover', function() {
 
     var gd;
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     afterEach(destroyGraphDiv);
 
     function getPointData(gd) {
@@ -1532,17 +1510,13 @@ function mockBarPlot(dataWithoutTraceType, layout) {
 }
 
 function assertArrayField(calcData, prop, expectation) {
-    // Note that this functions requires to add `customMatchers` to jasmine
-    // matchers; i.e: `jasmine.addMatchers(customMatchers);`.
     var values = Lib.nestedProperty(calcData, prop).get();
     if(!Array.isArray(values)) values = [values];
 
     expect(values).toBeCloseToArray(expectation, undefined, '(field ' + prop + ')');
 }
 
 function assertPointField(calcData, prop, expectation) {
-    // Note that this functions requires to add `customMatchers` to jasmine
-    // matchers; i.e: `jasmine.addMatchers(customMatchers);`.
     var values = [];
 
     calcData.forEach(function(calcTrace) {
@@ -1557,8 +1531,6 @@ function assertPointField(calcData, prop, expectation) {
 }
 
 function assertTraceField(calcData, prop, expectation) {
-    // Note that this functions requires to add `customMatchers` to jasmine
-    // matchers; i.e: `jasmine.addMatchers(customMatchers);`.
     var values = calcData.map(function(calcTrace) {
         return Lib.nestedProperty(calcTrace[0], prop).get();
     });

test/jasmine/tests/bar_test.js

@@ -7,7 +7,6 @@ var smoothFill2D = require('@src/traces/carpet/smooth_fill_2d_array');
 var smoothFill = require('@src/traces/carpet/smooth_fill_array');
 
 var d3 = require('d3');
-var customMatchers = require('../assets/custom_matchers');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var fail = require('../assets/fail_test');
@@ -215,8 +214,6 @@ describe('supplyDefaults visibility check', function() {
 describe('carpet smooth_fill_2d_array', function() {
     var _;
 
-    beforeAll(function() { jasmine.addMatchers(customMatchers); });
-
     it('fills in all points trivially', function() {
         // Given only corners, should just propagate the constant throughout:
         expect(smoothFill2D(
@@ -381,8 +378,6 @@ describe('carpet smooth_fill_2d_array', function() {
 describe('smooth_fill_array', function() {
     var _;
 
-    beforeAll(function() { jasmine.addMatchers(customMatchers); });
-
     it('fills in via linear interplation', function() {
         expect(smoothFill([_, _, 2, 3, _, _, 6, 7, _, _, 10, 11, _]))
         .toBeCloseToArray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]);

test/jasmine/tests/carpet_test.js

@@ -8,7 +8,6 @@ var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var mouseEvent = require('../assets/mouse_event');
 var failTest = require('../assets/fail_test');
-var customMatchers = require('../assets/custom_matchers');
 var selectButton = require('../assets/modebar_button');
 var drag = require('../assets/drag');
 var doubleClick = require('../assets/double_click');
@@ -85,8 +84,6 @@ describe('main plot pan', function() {
 
     it('should respond to pan interactions', function(done) {
 
-        jasmine.addMatchers(customMatchers);
-
         var precision = 5;
 
         var buttonPan = selectButton(modeBar, 'pan2d');
@@ -182,10 +179,6 @@ describe('main plot pan', function() {
 describe('axis zoom/pan and main plot zoom', function() {
     var gd;
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     beforeEach(function() {
         gd = createGraphDiv();
     });

test/jasmine/tests/cartesian_interact_test.js

@@ -8,7 +8,6 @@ var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var mouseEvent = require('../assets/mouse_event');
 var getRectCenter = require('../assets/get_rect_center');
-var customMatchers = require('../assets/custom_matchers');
 
 // cartesian click events events use the hover data
 // from the mousemove events and then simulate
@@ -52,10 +51,6 @@ describe('Test click interactions:', function() {
     var autoRangeX = [-3.011967491973726, 2.1561305597186564],
         autoRangeY = [-0.9910086301469277, 1.389382716298284];
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     beforeEach(function() {
         gd = createGraphDiv();
         mockCopy = Lib.extendDeep({}, mock);

test/jasmine/tests/click_test.js

@@ -9,7 +9,6 @@ var colorScales = require('@src/components/colorscale/scales');
 var fail = require('../assets/fail_test');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
-var customMatchers = require('../assets/custom_matchers');
 var checkTicks = require('../assets/custom_assertions').checkTicks;
 
 
@@ -178,10 +177,6 @@ describe('contour makeColorMap', function() {
 describe('contour calc', function() {
     'use strict';
 
-    beforeAll(function() {
-        jasmine.addMatchers(customMatchers);
-    });
-
     function _calc(opts) {
         var base = { type: 'contour' },
             trace = Lib.extendFlat({}, base, opts),