dc/spec/helpers/spec-helper.js

A multi-dimensional charting library built to work natively with crossfilter and rendered using d3.js

/* global parseTranslate */
/* eslint "no-unused-vars": 0 */

/*exported appendChartID, coordsFromTranslate, makeDate, cleanDateRange, flushAllD3Transitions */
/*exported simulateChartBrushing, simulateChart2DBrushing */

beforeEach(function () {
    jasmine.clock().install();

    // If we're using browserify bundle, pull d3 and crossfilter out of it,
    // so that tests don't have to deal with this incidental complexity.
    if (typeof d3 === 'undefined') { d3 = dc.d3; }
    if (typeof crossfilter === 'undefined') { crossfilter = dc.crossfilter; }
    d3.select('body').append('div').attr('id', 'test-content');
});

afterEach(function () {
    dc.deregisterAllCharts();
    dc.renderlet(null);
    d3.selectAll('#test-content').remove();
    jasmine.clock().uninstall();
});

function appendChartID (id) {
    return d3.select('#test-content').append('div').attr('id', id);
}

function coordsFromTranslate (translationString) {
    var result = parseTranslate(translationString);
    expect(result).not.toBeNull();
    return {x: +result[1], y: +result[2]};
}

// use UTC dates because these tests will be run in many time zones
function makeDate (year, month, day) {
    if (typeof year === 'string' || arguments.length !== 3) {
        throw new Error('makeDate takes year, month, day');
    }
    return new Date(Date.UTC(year, month, day, 0, 0, 0, 0));
}

// the invisible non-array members that we add in dc.filter cause the objects
// to be non-equal (correctly, but with no good diagnostics) in the eyes of Jasmine.
function cleanDateRange (range) {
    return [range[0], range[1]];
}

// http://stackoverflow.com/questions/20068497/d3-transition-in-unit-testing
function flushAllD3Transitions () {
    d3.timerFlush();
}

// Simulate a dummy event - just enough for the handler to get fooled
var simulateChartBrushing = function (chart, domainSelection) {
    // D3v4 needs scaled coordinates for the event
    var scaledSelection = domainSelection.map(function (coord) {
        return chart.x()(coord);
    });

    d3.event = {
        sourceEvent: true,
        selection: scaledSelection
    };

    try {
        chart._brushing();
    } finally {
        d3.event = null;
    }
};

// Simulate a dummy event - just enough for the handler to get fooled
var simulateChart2DBrushing = function (chart, domainSelection) {
    // D3v4 needs scaled coordinates for the event
    var scaledSelection = domainSelection.map(function (point) {
        return point.map(function (coord, i) {
            var scale = i === 0 ? chart.x() : chart.y();
            return scale(coord);
        });
    });

    d3.event = {
        sourceEvent: true,
        selection: scaledSelection
    };

    try {
        chart._brushing();
    } finally {
        d3.event = null;
    }
};