From d2ce46cc42dced5647fc930b55ab56c2f38258b1 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 10 Jun 2012 14:23:03 +0100 Subject: [PATCH 01/15] [#152,timeline][xs]: handle null or undefined dates properly. --- src/view.timeline.js | 3 +++ test/view.timeline.test.js | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/view.timeline.js b/src/view.timeline.js index 5c0da584..5c24b300 100644 --- a/src/view.timeline.js +++ b/src/view.timeline.js @@ -103,6 +103,9 @@ my.Timeline = Backbone.View.extend({ }, _parseDate: function(date) { + if (!date) { + return null; + } var out = date.trim(); out = out.replace(/(\d)th/g, '$1'); out = out.replace(/(\d)st/g, '$1'); diff --git a/test/view.timeline.test.js b/test/view.timeline.test.js index 8746b0bb..eef8b759 100644 --- a/test/view.timeline.test.js +++ b/test/view.timeline.test.js @@ -59,7 +59,8 @@ test('_parseDate', function () { [ 'August 1st 1914', '1914-08-01T00:00:00.000Z' ], [ '1914-08-01', '1914-08-01T00:00:00.000Z' ], [ '1914-08-01T08:00', '1914-08-01T08:00:00.000Z' ], - [ 'afdaf afdaf', null ] + [ 'afdaf afdaf', null ], + [ null, null ] ]; _.each(testData, function(item) { var out = view._parseDate(item[0]); From 80d3576a6cfef22ee878abf022e2f6a51640a32c Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 10 Jun 2012 15:15:57 +0100 Subject: [PATCH 02/15] [view/timeline][s]: workarounds so that timeline can be init-ed automatically if created with a dom element. * This means you don't have to do view.trigger('view:show') after creating if the view element already in the dom. * Verite Timeline is a bit problematic in that it cannot be passed a dom element but insists on being passed an id it looks up. --- dist/recline.js | 22 ++++++++++++++++++---- src/view.timeline.js | 19 +++++++++++++++---- 2 files changed, 33 insertions(+), 8 deletions(-) diff --git a/dist/recline.js b/dist/recline.js index aad9bb33..ec2acbc6 100644 --- a/dist/recline.js +++ b/dist/recline.js @@ -2755,12 +2755,17 @@ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { + +// ## Timeline +// +// Timeline view using http://timeline.verite.co/ my.Timeline = Backbone.View.extend({ tagName: 'div', - className: 'recline-timeline', template: ' \ -
\ +
\ +
\ +
\ ', // These are the default (case-insensitive) names of field that are used if found. @@ -2775,6 +2780,7 @@ my.Timeline = Backbone.View.extend({ this.timeline = new VMM.Timeline(); this._timelineIsInitialized = false; this.bind('view:show', function() { + // only call _initTimeline once view in DOM as Timeline uses $ internally to look up element if (self._timelineIsInitialized === false) { self._initTimeline(); } @@ -2794,6 +2800,11 @@ my.Timeline = Backbone.View.extend({ this.state = new recline.Model.ObjectState(stateData); this._setupTemporalField(); this.render(); + // can only call _initTimeline once view in DOM as Timeline uses $ + // internally to look up element + if ($(this.elementId).length > 0) { + this._initTimeline(); + } }, render: function() { @@ -2803,9 +2814,9 @@ my.Timeline = Backbone.View.extend({ }, _initTimeline: function() { + var $timeline = this.el.find(this.elementId); // set width explicitly o/w timeline goes wider that screen for some reason - this.el.find(this.elementId).width(this.el.parent().width()); - // only call _initTimeline once view in DOM as Timeline uses $ internally to look up element + $timeline.width(this.el.parent().width()); var config = {}; var data = this._timelineJSON(); this.timeline.init(data, this.elementId, config); @@ -2854,6 +2865,9 @@ my.Timeline = Backbone.View.extend({ }, _parseDate: function(date) { + if (!date) { + return null; + } var out = date.trim(); out = out.replace(/(\d)th/g, '$1'); out = out.replace(/(\d)st/g, '$1'); diff --git a/src/view.timeline.js b/src/view.timeline.js index 5c24b300..86a4b486 100644 --- a/src/view.timeline.js +++ b/src/view.timeline.js @@ -4,12 +4,17 @@ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { + +// ## Timeline +// +// Timeline view using http://timeline.verite.co/ my.Timeline = Backbone.View.extend({ tagName: 'div', - className: 'recline-timeline', template: ' \ -
\ +
\ +
\ +
\ ', // These are the default (case-insensitive) names of field that are used if found. @@ -24,6 +29,7 @@ my.Timeline = Backbone.View.extend({ this.timeline = new VMM.Timeline(); this._timelineIsInitialized = false; this.bind('view:show', function() { + // only call _initTimeline once view in DOM as Timeline uses $ internally to look up element if (self._timelineIsInitialized === false) { self._initTimeline(); } @@ -43,6 +49,11 @@ my.Timeline = Backbone.View.extend({ this.state = new recline.Model.ObjectState(stateData); this._setupTemporalField(); this.render(); + // can only call _initTimeline once view in DOM as Timeline uses $ + // internally to look up element + if ($(this.elementId).length > 0) { + this._initTimeline(); + } }, render: function() { @@ -52,9 +63,9 @@ my.Timeline = Backbone.View.extend({ }, _initTimeline: function() { + var $timeline = this.el.find(this.elementId); // set width explicitly o/w timeline goes wider that screen for some reason - this.el.find(this.elementId).width(this.el.parent().width()); - // only call _initTimeline once view in DOM as Timeline uses $ internally to look up element + $timeline.width(this.el.parent().width()); var config = {}; var data = this._timelineJSON(); this.timeline.init(data, this.elementId, config); From 399172b8f417d314d8d7f938a9648caf73b60821 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 10 Jun 2012 21:08:29 +0100 Subject: [PATCH 03/15] [timeline,tweaks][xs]: tweak setting of timeline width to be more robust in different circumstances. --- dist/recline.js | 5 ++++- src/view.timeline.js | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/dist/recline.js b/dist/recline.js index ec2acbc6..25b2f5ee 100644 --- a/dist/recline.js +++ b/dist/recline.js @@ -2816,7 +2816,10 @@ my.Timeline = Backbone.View.extend({ _initTimeline: function() { var $timeline = this.el.find(this.elementId); // set width explicitly o/w timeline goes wider that screen for some reason - $timeline.width(this.el.parent().width()); + var width = Math.max(this.el.width(), this.el.find('.recline-timeline').width()); + if (width) { + $timeline.width(width); + } var config = {}; var data = this._timelineJSON(); this.timeline.init(data, this.elementId, config); diff --git a/src/view.timeline.js b/src/view.timeline.js index 86a4b486..0ae0f0c4 100644 --- a/src/view.timeline.js +++ b/src/view.timeline.js @@ -65,7 +65,10 @@ my.Timeline = Backbone.View.extend({ _initTimeline: function() { var $timeline = this.el.find(this.elementId); // set width explicitly o/w timeline goes wider that screen for some reason - $timeline.width(this.el.parent().width()); + var width = Math.max(this.el.width(), this.el.find('.recline-timeline').width()); + if (width) { + $timeline.width(width); + } var config = {}; var data = this._timelineJSON(); this.timeline.init(data, this.elementId, config); From 7b07a9558bb27026b8dff1c172b82df6626b61e8 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Mon, 11 Jun 2012 12:46:10 +0100 Subject: [PATCH 04/15] [timeline][s]: make it easy to customize timeline info in client apps by providing convertRecord method. --- dist/recline.js | 41 ++++++++++++++++++++++++++++++----------- src/view.timeline.js | 41 ++++++++++++++++++++++++++++++----------- 2 files changed, 60 insertions(+), 22 deletions(-) diff --git a/dist/recline.js b/dist/recline.js index 25b2f5ee..b0d1ca64 100644 --- a/dist/recline.js +++ b/dist/recline.js @@ -2755,6 +2755,8 @@ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { +// turn off unnecessary logging from VMM Timeline +VMM.debug = false; // ## Timeline // @@ -2833,6 +2835,30 @@ my.Timeline = Backbone.View.extend({ } }, + // Convert record to JSON for timeline + // + // Designed to be overridden in client apps + convertRecord: function(record, fields) { + return this._convertRecord(record, fields); + }, + + // Internal method to generate a Timeline formatted entry + _convertRecord: function(record, fields) { + var start = this._parseDate(record.get(this.state.get('startField'))); + var end = this._parseDate(record.get(this.state.get('endField'))); + if (start) { + var tlEntry = { + "startDate": start, + "endDate": end, + "headline": String(record.get('title') || ''), + "text": record.get('description') || record.summary() + }; + return tlEntry; + } else { + return null; + } + }, + _timelineJSON: function() { var self = this; var out = { @@ -2843,17 +2869,10 @@ my.Timeline = Backbone.View.extend({ ] } }; - this.model.currentRecords.each(function(doc) { - var start = self._parseDate(doc.get(self.state.get('startField'))); - var end = self._parseDate(doc.get(self.state.get('endField'))); - if (start) { - var tlEntry = { - "startDate": start, - "endDate": end, - "headline": String(doc.get('title') || ''), - "text": doc.summary() - }; - out.timeline.date.push(tlEntry); + this.model.currentRecords.each(function(record) { + var newEntry = self.convertRecord(record, self.fields); + if (newEntry) { + out.timeline.date.push(newEntry); } }); // if no entries create a placeholder entry to prevent Timeline crashing with error diff --git a/src/view.timeline.js b/src/view.timeline.js index 0ae0f0c4..74be3a0b 100644 --- a/src/view.timeline.js +++ b/src/view.timeline.js @@ -4,6 +4,8 @@ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { +// turn off unnecessary logging from VMM Timeline +VMM.debug = false; // ## Timeline // @@ -82,6 +84,30 @@ my.Timeline = Backbone.View.extend({ } }, + // Convert record to JSON for timeline + // + // Designed to be overridden in client apps + convertRecord: function(record, fields) { + return this._convertRecord(record, fields); + }, + + // Internal method to generate a Timeline formatted entry + _convertRecord: function(record, fields) { + var start = this._parseDate(record.get(this.state.get('startField'))); + var end = this._parseDate(record.get(this.state.get('endField'))); + if (start) { + var tlEntry = { + "startDate": start, + "endDate": end, + "headline": String(record.get('title') || ''), + "text": record.get('description') || record.summary() + }; + return tlEntry; + } else { + return null; + } + }, + _timelineJSON: function() { var self = this; var out = { @@ -92,17 +118,10 @@ my.Timeline = Backbone.View.extend({ ] } }; - this.model.currentRecords.each(function(doc) { - var start = self._parseDate(doc.get(self.state.get('startField'))); - var end = self._parseDate(doc.get(self.state.get('endField'))); - if (start) { - var tlEntry = { - "startDate": start, - "endDate": end, - "headline": String(doc.get('title') || ''), - "text": doc.summary() - }; - out.timeline.date.push(tlEntry); + this.model.currentRecords.each(function(record) { + var newEntry = self.convertRecord(record, self.fields); + if (newEntry) { + out.timeline.date.push(newEntry); } }); // if no entries create a placeholder entry to prevent Timeline crashing with error From 20d7683223f0dd86b163bb31f47111924ad07085 Mon Sep 17 00:00:00 2001 From: amercader Date: Mon, 11 Jun 2012 13:47:41 +0100 Subject: [PATCH 05/15] [#130,view/slickgrid] Sort documents on SlickGrid view --- src/view.slickgrid.js | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/src/view.slickgrid.js b/src/view.slickgrid.js index 1b0e69ac..1f49b6ee 100644 --- a/src/view.slickgrid.js +++ b/src/view.slickgrid.js @@ -135,35 +135,23 @@ my.SlickGrid = Backbone.View.extend({ this.grid = new Slick.Grid(this.el, data, visibleColumns, options); // Column sorting - var gridSorter = function(field, ascending, grid, data){ - - data.sort(function(a, b){ - var result = - a[field] > b[field] ? 1 : - a[field] < b[field] ? -1 : - 0 - ; - return ascending ? result : -result; - }); - - grid.setData(data); - grid.updateRowCount(); - grid.render(); - } - var sortInfo = this.state.get('columnsSort'); - if (sortInfo){ - var sortAsc = !(sortInfo['direction'] == 'desc'); - gridSorter(sortInfo.column, sortAsc, self.grid, data); + if (sortInfo.column){ + var sortAsc = !(sortInfo.order == 'desc'); this.grid.setSortColumn(sortInfo.column, sortAsc); } this.grid.onSort.subscribe(function(e, args){ - gridSorter(args.sortCol.field,args.sortAsc,self.grid,data); + var order = (args.sortAsc) ? 'asc':'desc'; self.state.set({columnsSort:{ - column:args.sortCol, - direction: (args.sortAsc) ? 'asc':'desc' + column:args.sortCol.field, + order: order }}); + + var sort = [{}]; + sort[0][args.sortCol.field] = {order: order}; + self.model.query({sort: sort}); + }); this.grid.onColumnsReordered.subscribe(function(e, args){ From 75cd2fb94d7309725968718b88decb829a996531 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Mon, 11 Jun 2012 21:58:13 +0100 Subject: [PATCH 06/15] [#141,view/map][s]: support for all of elasticsearch geo_point / location objects - fixes #141. * [lon, lat] * "lat,lon" * Bonus (non-ES): "(lat,lon)" Also (accidentally included): * upgrade to qunit 1.5.0 (much better stack traces!) --- src/view.map.js | 77 +- test/qunit/qunit.css | 15 +- test/qunit/qunit.js | 1733 +++++++++++++++++++++++---------------- test/view.graph.test.js | 1 + test/view.map.test.js | 30 +- 5 files changed, 1100 insertions(+), 756 deletions(-) diff --git a/src/view.map.js b/src/view.map.js index 624ef29d..006887f4 100644 --- a/src/view.map.js +++ b/src/view.map.js @@ -227,38 +227,55 @@ my.Map = Backbone.View.extend({ // Private: Return a GeoJSON geomtry extracted from the record fields // _getGeometryFromRecord: function(doc){ - if (this._geomReady()){ - if (this.state.get('geomField')){ - var value = doc.get(this.state.get('geomField')); - if (typeof(value) === 'string'){ - // We *may* have a GeoJSON string representation - try { - value = $.parseJSON(value); - } catch(e) { - } - } - if (value && value.lat) { - // not yet geojson so convert - value = { - "type": "Point", - "coordinates": [value.lon || value.lng, value.lat] - }; - } - // We now assume that contents of the field are a valid GeoJSON object - return value; - } else if (this.state.get('lonField') && this.state.get('latField')){ - // We'll create a GeoJSON like point object from the two lat/lon fields - var lon = doc.get(this.state.get('lonField')); - var lat = doc.get(this.state.get('latField')); - if (!isNaN(parseFloat(lon)) && !isNaN(parseFloat(lat))) { - return { - type: 'Point', - coordinates: [lon,lat] - }; - } + if (this.state.get('geomField')){ + var value = doc.get(this.state.get('geomField')); + if (typeof(value) === 'string'){ + // We *may* have a GeoJSON string representation + try { + value = $.parseJSON(value); + } catch(e) {} + } + + if (typeof(value) === 'string') { + value = value.replace('(', '').replace(')', ''); + var parts = value.split(','); + var lat = parseFloat(parts[0]); + var lon = parseFloat(parts[1]); + if (!isNaN(lon) && !isNaN(parseFloat(lat))) { + return { + "type": "Point", + "coordinates": [lon, lat] + }; + } else { + return null; + } + } else if (value && value.slice) { + // [ lon, lat ] + return { + "type": "Point", + "coordinates": [value[0], value[1]] + }; + } else if (value && value.lat) { + // of form { lat: ..., lon: ...} + return { + "type": "Point", + "coordinates": [value.lon || value.lng, value.lat] + }; + } + // We o/w assume that contents of the field are a valid GeoJSON object + return value; + } else if (this.state.get('lonField') && this.state.get('latField')){ + // We'll create a GeoJSON like point object from the two lat/lon fields + var lon = doc.get(this.state.get('lonField')); + var lat = doc.get(this.state.get('latField')); + if (!isNaN(parseFloat(lon)) && !isNaN(parseFloat(lat))) { + return { + type: 'Point', + coordinates: [lon,lat] + }; } - return null; } + return null; }, // Private: Check if there is a field with GeoJSON geometries or alternatively, diff --git a/test/qunit/qunit.css b/test/qunit/qunit.css index b3c6db52..23235ec8 100644 --- a/test/qunit/qunit.css +++ b/test/qunit/qunit.css @@ -1,9 +1,9 @@ /** - * QUnit - A JavaScript Unit Testing Framework + * QUnit v1.6.0 - A JavaScript Unit Testing Framework * * http://docs.jquery.com/QUnit * - * Copyright (c) 2011 John Resig, Jörn Zaefferer + * Copyright (c) 2012 John Resig, Jörn Zaefferer * Dual licensed under the MIT (MIT-LICENSE.txt) * or GPL (GPL-LICENSE.txt) licenses. */ @@ -54,6 +54,11 @@ color: #fff; } +#qunit-header label { + display: inline-block; + padding-left: 0.5em; +} + #qunit-banner { height: 5px; } @@ -186,6 +191,7 @@ color: #710909; background-color: #fff; border-left: 26px solid #EE5757; + white-space: pre; } #qunit-tests > li:last-child { @@ -215,6 +221,9 @@ border-bottom: 1px solid white; } +#qunit-testresult .module-name { + font-weight: bold; +} /** Fixture */ @@ -222,4 +231,6 @@ position: absolute; top: -10000px; left: -10000px; + width: 1000px; + height: 1000px; } diff --git a/test/qunit/qunit.js b/test/qunit/qunit.js index e00cca90..2c277fab 100644 --- a/test/qunit/qunit.js +++ b/test/qunit/qunit.js @@ -1,145 +1,180 @@ /** - * QUnit - A JavaScript Unit Testing Framework + * QUnit v1.6.0 - A JavaScript Unit Testing Framework * * http://docs.jquery.com/QUnit * - * Copyright (c) 2011 John Resig, Jörn Zaefferer + * Copyright (c) 2012 John Resig, Jörn Zaefferer * Dual licensed under the MIT (MIT-LICENSE.txt) * or GPL (GPL-LICENSE.txt) licenses. */ -(function(window) { +(function( window ) { -var defined = { +var QUnit, + config, + testId = 0, + toString = Object.prototype.toString, + hasOwn = Object.prototype.hasOwnProperty, + defined = { setTimeout: typeof window.setTimeout !== "undefined", sessionStorage: (function() { + var x = "qunit-test-string"; try { - return !!sessionStorage.getItem; - } catch(e){ + sessionStorage.setItem( x, x ); + sessionStorage.removeItem( x ); + return true; + } catch( e ) { return false; } - })() + }()) }; -var testId = 0; - -var Test = function(name, testName, expected, testEnvironmentArg, async, callback) { +function Test( name, testName, expected, async, callback ) { this.name = name; this.testName = testName; this.expected = expected; - this.testEnvironmentArg = testEnvironmentArg; this.async = async; this.callback = callback; this.assertions = []; -}; +} + Test.prototype = { init: function() { - var tests = id("qunit-tests"); - if (tests) { - var b = document.createElement("strong"); - b.innerHTML = "Running " + this.name; - var li = document.createElement("li"); - li.appendChild( b ); - li.className = "running"; - li.id = this.id = "test-output" + testId++; + var b, li, + tests = id( "qunit-tests" ); + + if ( tests ) { + b = document.createElement( "strong" ); + b.innerHTML = "Running " + this.name; + + li = document.createElement( "li" ); + li.appendChild( b ); + li.className = "running"; + li.id = this.id = "qunit-test-output" + testId++; + tests.appendChild( li ); } }, setup: function() { - if (this.module != config.previousModule) { + if ( this.module !== config.previousModule ) { if ( config.previousModule ) { - QUnit.moduleDone( { + runLoggingCallbacks( "moduleDone", QUnit, { name: config.previousModule, failed: config.moduleStats.bad, passed: config.moduleStats.all - config.moduleStats.bad, total: config.moduleStats.all - } ); + }); } config.previousModule = this.module; config.moduleStats = { all: 0, bad: 0 }; - QUnit.moduleStart( { + runLoggingCallbacks( "moduleStart", QUnit, { name: this.module - } ); + }); + } else if ( config.autorun ) { + runLoggingCallbacks( "moduleStart", QUnit, { + name: this.module + }); } config.current = this; + this.testEnvironment = extend({ setup: function() {}, teardown: function() {} - }, this.moduleTestEnvironment); - if (this.testEnvironmentArg) { - extend(this.testEnvironment, this.testEnvironmentArg); - } + }, this.moduleTestEnvironment ); - QUnit.testStart( { - name: this.testName - } ); + runLoggingCallbacks( "testStart", QUnit, { + name: this.testName, + module: this.module + }); // allow utility functions to access the current test environment // TODO why?? QUnit.current_testEnvironment = this.testEnvironment; + if ( !config.pollution ) { + saveGlobal(); + } + if ( config.notrycatch ) { + this.testEnvironment.setup.call( this.testEnvironment ); + return; + } try { - if ( !config.pollution ) { - saveGlobal(); - } - - this.testEnvironment.setup.call(this.testEnvironment); - } catch(e) { - QUnit.ok( false, "Setup failed on " + this.testName + ": " + e.message ); + this.testEnvironment.setup.call( this.testEnvironment ); + } catch( e ) { + QUnit.pushFailure( "Setup failed on " + this.testName + ": " + e.message, extractStacktrace( e, 1 ) ); } }, run: function() { + config.current = this; + + var running = id( "qunit-testresult" ); + + if ( running ) { + running.innerHTML = "Running:
" + this.name; + } + if ( this.async ) { QUnit.stop(); } if ( config.notrycatch ) { - this.callback.call(this.testEnvironment); + this.callback.call( this.testEnvironment ); return; } + try { - this.callback.call(this.testEnvironment); - } catch(e) { - fail("Test " + this.testName + " died, exception and test follows", e, this.callback); - QUnit.ok( false, "Died on test #" + (this.assertions.length + 1) + ": " + e.message + " - " + QUnit.jsDump.parse(e) ); + this.callback.call( this.testEnvironment ); + } catch( e ) { + QUnit.pushFailure( "Died on test #" + (this.assertions.length + 1) + ": " + e.message, extractStacktrace( e, 1 ) ); // else next test will carry the responsibility saveGlobal(); // Restart the tests if they're blocking if ( config.blocking ) { - start(); + QUnit.start(); } } }, teardown: function() { - try { - this.testEnvironment.teardown.call(this.testEnvironment); - checkPollution(); - } catch(e) { - QUnit.ok( false, "Teardown failed on " + this.testName + ": " + e.message ); + config.current = this; + if ( config.notrycatch ) { + this.testEnvironment.teardown.call( this.testEnvironment ); + return; + } else { + try { + this.testEnvironment.teardown.call( this.testEnvironment ); + } catch( e ) { + QUnit.pushFailure( "Teardown failed on " + this.testName + ": " + e.message, extractStacktrace( e, 1 ) ); + } } + checkPollution(); }, finish: function() { - if ( this.expected && this.expected != this.assertions.length ) { - QUnit.ok( false, "Expected " + this.expected + " assertions, but " + this.assertions.length + " were run" ); + config.current = this; + if ( this.expected != null && this.expected != this.assertions.length ) { + QUnit.pushFailure( "Expected " + this.expected + " assertions, but " + this.assertions.length + " were run", this.stack ); + } else if ( this.expected == null && !this.assertions.length ) { + QUnit.pushFailure( "Expected at least one assertion, but none were run - call expect(0) to accept zero assertions.", this.stack ); } - var good = 0, bad = 0, - tests = id("qunit-tests"); + var assertion, a, b, i, li, ol, + good = 0, + bad = 0, + tests = id( "qunit-tests" ); config.stats.all += this.assertions.length; config.moduleStats.all += this.assertions.length; if ( tests ) { - var ol = document.createElement("ol"); + ol = document.createElement( "ol" ); - for ( var i = 0; i < this.assertions.length; i++ ) { - var assertion = this.assertions[i]; + for ( i = 0; i < this.assertions.length; i++ ) { + assertion = this.assertions[i]; - var li = document.createElement("li"); + li = document.createElement( "li" ); li.className = assertion.result ? "pass" : "fail"; - li.innerHTML = assertion.message || (assertion.result ? "okay" : "failed"); + li.innerHTML = assertion.message || ( assertion.result ? "okay" : "failed" ); ol.appendChild( li ); if ( assertion.result ) { @@ -153,23 +188,25 @@ Test.prototype = { // store result when possible if ( QUnit.config.reorder && defined.sessionStorage ) { - if (bad) { - sessionStorage.setItem("qunit-" + this.module + "-" + this.testName, bad); + if ( bad ) { + sessionStorage.setItem( "qunit-test-" + this.module + "-" + this.testName, bad ); } else { - sessionStorage.removeItem("qunit-" + this.module + "-" + this.testName); + sessionStorage.removeItem( "qunit-test-" + this.module + "-" + this.testName ); } } - if (bad == 0) { + if ( bad === 0 ) { ol.style.display = "none"; } - var b = document.createElement("strong"); + // `b` initialized at top of scope + b = document.createElement( "strong" ); b.innerHTML = this.name + " (" + bad + ", " + good + ", " + this.assertions.length + ")"; - var a = document.createElement("a"); + // `a` initialized at top of scope + a = document.createElement( "a" ); a.innerHTML = "Rerun"; - a.href = QUnit.url({ filter: getText([b]).replace(/\([^)]+\)$/, "").replace(/(^\s*|\s*$)/g, "") }); + a.href = QUnit.url({ filter: getText([b]).replace( /\([^)]+\)$/, "" ).replace( /(^\s*|\s*$)/g, "" ) }); addEvent(b, "click", function() { var next = b.nextSibling.nextSibling, @@ -177,17 +214,20 @@ Test.prototype = { next.style.display = display === "none" ? "block" : "none"; }); - addEvent(b, "dblclick", function(e) { + addEvent(b, "dblclick", function( e ) { var target = e && e.target ? e.target : window.event.srcElement; if ( target.nodeName.toLowerCase() == "span" || target.nodeName.toLowerCase() == "b" ) { target = target.parentNode; } if ( window.location && target.nodeName.toLowerCase() === "strong" ) { - window.location = QUnit.url({ filter: getText([target]).replace(/\([^)]+\)$/, "").replace(/(^\s*|\s*$)/g, "") }); + window.location = QUnit.url({ + filter: getText([target]).replace( /\([^)]+\)$/, "" ).replace( /(^\s*|\s*$)/g, "" ) + }); } }); - var li = id(this.id); + // `li` initialized at top of scope + li = id( this.id ); li.className = bad ? "fail" : "pass"; li.removeChild( li.firstChild ); li.appendChild( b ); @@ -195,7 +235,7 @@ Test.prototype = { li.appendChild( ol ); } else { - for ( var i = 0; i < this.assertions.length; i++ ) { + for ( i = 0; i < this.assertions.length; i++ ) { if ( !this.assertions[i].result ) { bad++; config.stats.bad++; @@ -204,22 +244,21 @@ Test.prototype = { } } - try { - QUnit.reset(); - } catch(e) { - fail("reset() failed, following Test " + this.testName + ", exception and reset fn follows", e, QUnit.reset); - } - - QUnit.testDone( { + runLoggingCallbacks( "testDone", QUnit, { name: this.testName, + module: this.module, failed: bad, passed: this.assertions.length - bad, total: this.assertions.length - } ); + }); + + QUnit.reset(); }, queue: function() { - var test = this; + var bad, + test = this; + synchronize(function() { test.init(); }); @@ -238,233 +277,268 @@ Test.prototype = { test.finish(); }); } + + // `bad` initialized at top of scope // defer when previous test run passed, if storage is available - var bad = QUnit.config.reorder && defined.sessionStorage && +sessionStorage.getItem("qunit-" + this.module + "-" + this.testName); - if (bad) { + bad = QUnit.config.reorder && defined.sessionStorage && + +sessionStorage.getItem( "qunit-test-" + this.module + "-" + this.testName ); + + if ( bad ) { run(); } else { - synchronize(run); - }; + synchronize( run, true ); + } } - }; -var QUnit = { +// `QUnit` initialized at top of scope +QUnit = { // call on start of module test to prepend name to all tests - module: function(name, testEnvironment) { + module: function( name, testEnvironment ) { config.currentModule = name; config.currentModuleTestEnviroment = testEnvironment; }, - asyncTest: function(testName, expected, callback) { - if ( arguments.length === 2 ) { - callback = expected; - expected = 0; - } - - QUnit.test(testName, expected, callback, true); - }, - - test: function(testName, expected, callback, async) { - var name = '' + testName + '', testEnvironmentArg; - + asyncTest: function( testName, expected, callback ) { if ( arguments.length === 2 ) { callback = expected; expected = null; } - // is 2nd argument a testEnvironment? - if ( expected && typeof expected === 'object') { - testEnvironmentArg = expected; + + QUnit.test( testName, expected, callback, true ); + }, + + test: function( testName, expected, callback, async ) { + var test, + name = "" + escapeInnerText( testName ) + ""; + + if ( arguments.length === 2 ) { + callback = expected; expected = null; } if ( config.currentModule ) { - name = '' + config.currentModule + ": " + name; + name = "" + config.currentModule + ": " + name; } if ( !validTest(config.currentModule + ": " + testName) ) { return; } - var test = new Test(name, testName, expected, testEnvironmentArg, async, callback); + test = new Test( name, testName, expected, async, callback ); test.module = config.currentModule; test.moduleTestEnvironment = config.currentModuleTestEnviroment; + test.stack = sourceFromStacktrace( 2 ); test.queue(); }, - /** - * Specify the number of expected assertions to gurantee that failed test (no assertions are run at all) don't slip through. - */ - expect: function(asserts) { + // Specify the number of expected assertions to gurantee that failed test (no assertions are run at all) don't slip through. + expect: function( asserts ) { config.current.expected = asserts; }, - /** - * Asserts true. - * @example ok( "asdfasdf".length > 5, "There must be at least 5 chars" ); - */ - ok: function(a, msg) { - a = !!a; - var details = { - result: a, - message: msg - }; - msg = escapeHtml(msg); - QUnit.log(details); + // Asserts true. + // @example ok( "asdfasdf".length > 5, "There must be at least 5 chars" ); + ok: function( result, msg ) { + if ( !config.current ) { + throw new Error( "ok() assertion outside test context, was " + sourceFromStacktrace(2) ); + } + result = !!result; + + var source, + details = { + result: result, + message: msg + }; + + msg = escapeInnerText( msg || (result ? "okay" : "failed" ) ); + msg = "" + msg + ""; + + if ( !result ) { + source = sourceFromStacktrace( 2 ); + if ( source ) { + details.source = source; + msg += "
Source: 
" + escapeInnerText( source ) + "
"; + } + } + runLoggingCallbacks( "log", QUnit, details ); config.current.assertions.push({ - result: a, + result: result, message: msg }); }, - /** - * Checks that the first two arguments are equal, with an optional message. - * Prints out both actual and expected values. - * - * Prefered to ok( actual == expected, message ) - * - * @example equal( format("Received {0} bytes.", 2), "Received 2 bytes." ); - * - * @param Object actual - * @param Object expected - * @param String message (optional) - */ - equal: function(actual, expected, message) { - QUnit.push(expected == actual, actual, expected, message); + // Checks that the first two arguments are equal, with an optional message. Prints out both actual and expected values. + // @example equal( format( "Received {0} bytes.", 2), "Received 2 bytes." ); + equal: function( actual, expected, message ) { + QUnit.push( expected == actual, actual, expected, message ); }, - notEqual: function(actual, expected, message) { - QUnit.push(expected != actual, actual, expected, message); + notEqual: function( actual, expected, message ) { + QUnit.push( expected != actual, actual, expected, message ); }, - deepEqual: function(actual, expected, message) { - QUnit.push(QUnit.equiv(actual, expected), actual, expected, message); + deepEqual: function( actual, expected, message ) { + QUnit.push( QUnit.equiv(actual, expected), actual, expected, message ); }, - notDeepEqual: function(actual, expected, message) { - QUnit.push(!QUnit.equiv(actual, expected), actual, expected, message); + notDeepEqual: function( actual, expected, message ) { + QUnit.push( !QUnit.equiv(actual, expected), actual, expected, message ); }, - strictEqual: function(actual, expected, message) { - QUnit.push(expected === actual, actual, expected, message); + strictEqual: function( actual, expected, message ) { + QUnit.push( expected === actual, actual, expected, message ); }, - notStrictEqual: function(actual, expected, message) { - QUnit.push(expected !== actual, actual, expected, message); + notStrictEqual: function( actual, expected, message ) { + QUnit.push( expected !== actual, actual, expected, message ); }, - raises: function(block, expected, message) { - var actual, ok = false; + raises: function( block, expected, message ) { + var actual, + ok = false; - if (typeof expected === 'string') { + if ( typeof expected === "string" ) { message = expected; expected = null; } try { - block(); + block.call( config.current.testEnvironment ); } catch (e) { actual = e; } - if (actual) { + if ( actual ) { // we don't want to validate thrown error - if (!expected) { + if ( !expected ) { ok = true; // expected is a regexp - } else if (QUnit.objectType(expected) === "regexp") { - ok = expected.test(actual); + } else if ( QUnit.objectType( expected ) === "regexp" ) { + ok = expected.test( actual ); // expected is a constructor - } else if (actual instanceof expected) { + } else if ( actual instanceof expected ) { ok = true; // expected is a validation function which returns true is validation passed - } else if (expected.call({}, actual) === true) { + } else if ( expected.call( {}, actual ) === true ) { ok = true; } } - QUnit.ok(ok, message); + QUnit.ok( ok, message ); }, - start: function() { - config.semaphore--; - if (config.semaphore > 0) { - // don't start until equal number of stop-calls + start: function( count ) { + config.semaphore -= count || 1; + // don't start until equal number of stop-calls + if ( config.semaphore > 0 ) { return; } - if (config.semaphore < 0) { - // ignore if start is called more often then stop + // ignore if start is called more often then stop + if ( config.semaphore < 0 ) { config.semaphore = 0; } // A slight delay, to avoid any current callbacks if ( defined.setTimeout ) { window.setTimeout(function() { + if ( config.semaphore > 0 ) { + return; + } if ( config.timeout ) { - clearTimeout(config.timeout); + clearTimeout( config.timeout ); } config.blocking = false; - process(); + process( true ); }, 13); } else { config.blocking = false; - process(); + process( true ); } }, - stop: function(timeout) { - config.semaphore++; + stop: function( count ) { + config.semaphore += count || 1; config.blocking = true; - if ( timeout && defined.setTimeout ) { - clearTimeout(config.timeout); + if ( config.testTimeout && defined.setTimeout ) { + clearTimeout( config.timeout ); config.timeout = window.setTimeout(function() { QUnit.ok( false, "Test timed out" ); + config.semaphore = 1; QUnit.start(); - }, timeout); + }, config.testTimeout ); } } }; -// Backwards compatibility, deprecated -QUnit.equals = QUnit.equal; -QUnit.same = QUnit.deepEqual; +// We want access to the constructor's prototype +(function() { + function F() {} + F.prototype = QUnit; + QUnit = new F(); + // Make F QUnit's constructor so that we can add to the prototype later + QUnit.constructor = F; +}()); + +// deprecated; still export them to window to provide clear error messages +// next step: remove entirely +QUnit.equals = function() { + QUnit.push( false, false, false, "QUnit.equals has been deprecated since 2009 (e88049a0), use QUnit.equal instead" ); +}; +QUnit.same = function() { + QUnit.push( false, false, false, "QUnit.same has been deprecated since 2009 (e88049a0), use QUnit.deepEqual instead" ); +}; // Maintain internal state -var config = { +// `config` initialized at top of scope +config = { // The queue of tests to run queue: [], // block until document ready blocking: true, + // when enabled, show only failing tests + // gets persisted through sessionStorage and can be changed in UI via checkbox + hidepassed: false, + // by default, run previously failed tests first // very useful in combination with "Hide passed tests" checked reorder: true, - noglobals: false, - notrycatch: false + // by default, modify document.title when suite is done + altertitle: true, + + urlConfig: [ "noglobals", "notrycatch" ], + + // logging callback queues + begin: [], + done: [], + log: [], + testStart: [], + testDone: [], + moduleStart: [], + moduleDone: [] }; // Load paramaters (function() { - var location = window.location || { search: "", protocol: "file:" }, + var i, + location = window.location || { search: "", protocol: "file:" }, params = location.search.slice( 1 ).split( "&" ), length = params.length, urlParams = {}, current; if ( params[ 0 ] ) { - for ( var i = 0; i < length; i++ ) { + for ( i = 0; i < length; i++ ) { current = params[ i ].split( "=" ); current[ 0 ] = decodeURIComponent( current[ 0 ] ); // allow just a key to turn on a flag, e.g., test.html?noglobals current[ 1 ] = current[ 1 ] ? decodeURIComponent( current[ 1 ] ) : true; urlParams[ current[ 0 ] ] = current[ 1 ]; - if ( current[ 0 ] in config ) { - config[ current[ 0 ] ] = current[ 1 ]; - } } } @@ -472,29 +546,26 @@ var config = { config.filter = urlParams.filter; // Figure out if we're running the tests from a server or not - QUnit.isLocal = !!(location.protocol === 'file:'); -})(); + QUnit.isLocal = location.protocol === "file:"; +}()); -// Expose the API as global variables, unless an 'exports' -// object exists, in that case we assume we're in CommonJS -if ( typeof exports === "undefined" || typeof require === "undefined" ) { - extend(window, QUnit); +// Expose the API as global variables, unless an 'exports' object exists, +// in that case we assume we're in CommonJS - export everything at the end +if ( typeof exports === "undefined" ) { + extend( window, QUnit ); window.QUnit = QUnit; -} else { - extend(exports, QUnit); - exports.QUnit = QUnit; } // define these after exposing globals to keep them in these QUnit namespace only -extend(QUnit, { +extend( QUnit, { config: config, // Initialize the configuration options init: function() { - extend(config, { + extend( config, { stats: { all: 0, bad: 0 }, moduleStats: { all: 0, bad: 0 }, - started: +new Date, + started: +new Date(), updateRate: 1000, blocking: false, autostart: true, @@ -504,9 +575,21 @@ extend(QUnit, { semaphore: 0 }); - var tests = id( "qunit-tests" ), - banner = id( "qunit-banner" ), - result = id( "qunit-testresult" ); + var tests, banner, result, + qunit = id( "qunit" ); + + if ( qunit ) { + qunit.innerHTML = + "

" + escapeInnerText( document.title ) + "

" + + "

" + + "
" + + "

" + + "
    "; + } + + tests = id( "qunit-tests" ); + banner = id( "qunit-banner" ); + result = id( "qunit-testresult" ); if ( tests ) { tests.innerHTML = ""; @@ -525,43 +608,36 @@ extend(QUnit, { result.id = "qunit-testresult"; result.className = "result"; tests.parentNode.insertBefore( result, tests ); - result.innerHTML = 'Running...
     '; + result.innerHTML = "Running...
     "; } }, - /** - * Resets the test setup. Useful for tests that modify the DOM. - * - * If jQuery is available, uses jQuery's html(), otherwise just innerHTML. - */ + // Resets the test setup. Useful for tests that modify the DOM. + // If jQuery is available, uses jQuery's html(), otherwise just innerHTML. reset: function() { + var fixture; + if ( window.jQuery ) { jQuery( "#qunit-fixture" ).html( config.fixture ); } else { - var main = id( 'qunit-fixture' ); - if ( main ) { - main.innerHTML = config.fixture; + fixture = id( "qunit-fixture" ); + if ( fixture ) { + fixture.innerHTML = config.fixture; } } }, - /** - * Trigger an event on an element. - * - * @example triggerEvent( document.body, "click" ); - * - * @param DOMElement elem - * @param String type - */ + // Trigger an event on an element. + // @example triggerEvent( document.body, "click" ); triggerEvent: function( elem, type, event ) { if ( document.createEvent ) { - event = document.createEvent("MouseEvents"); + event = document.createEvent( "MouseEvents" ); event.initMouseEvent(type, true, true, elem.ownerDocument.defaultView, 0, 0, 0, 0, 0, false, false, false, false, 0, null); - elem.dispatchEvent( event ); + elem.dispatchEvent( event ); } else if ( elem.fireEvent ) { - elem.fireEvent("on"+type); + elem.fireEvent( "on" + type ); } }, @@ -571,66 +647,74 @@ extend(QUnit, { }, objectType: function( obj ) { - if (typeof obj === "undefined") { + if ( typeof obj === "undefined" ) { return "undefined"; - // consider: typeof null === object } - if (obj === null) { + if ( obj === null ) { return "null"; } - var type = Object.prototype.toString.call( obj ) - .match(/^\[object\s(.*)\]$/)[1] || ''; + var type = toString.call( obj ).match(/^\[object\s(.*)\]$/)[1] || ""; - switch (type) { - case 'Number': - if (isNaN(obj)) { - return "nan"; - } else { - return "number"; - } - case 'String': - case 'Boolean': - case 'Array': - case 'Date': - case 'RegExp': - case 'Function': - return type.toLowerCase(); + switch ( type ) { + case "Number": + if ( isNaN(obj) ) { + return "nan"; + } + return "number"; + case "String": + case "Boolean": + case "Array": + case "Date": + case "RegExp": + case "Function": + return type.toLowerCase(); } - if (typeof obj === "object") { - return "object"; + if ( typeof obj === "object" ) { + return "object"; } return undefined; }, - push: function(result, actual, expected, message) { - var details = { - result: result, - message: message, - actual: actual, - expected: expected - }; - - message = escapeHtml(message) || (result ? "okay" : "failed"); - message = '' + message + ""; - expected = escapeHtml(QUnit.jsDump.parse(expected)); - actual = escapeHtml(QUnit.jsDump.parse(actual)); - var output = message + ''; - if (actual != expected) { - output += ''; - output += ''; + push: function( result, actual, expected, message ) { + if ( !config.current ) { + throw new Error( "assertion outside test context, was " + sourceFromStacktrace() ); } - if (!result) { - var source = sourceFromStacktrace(); - if (source) { - details.source = source; - output += ''; + + var output, source, + details = { + result: result, + message: message, + actual: actual, + expected: expected + }; + + message = escapeInnerText( message ) || ( result ? "okay" : "failed" ); + message = "" + message + ""; + output = message; + + if ( !result ) { + expected = escapeInnerText( QUnit.jsDump.parse(expected) ); + actual = escapeInnerText( QUnit.jsDump.parse(actual) ); + output += "
    Expected: 
    ' + expected + '
    Result: 
    ' + actual + '
    Diff: 
    ' + QUnit.diff(expected, actual) +'
    Source: 
    ' + escapeHtml(source) + '
    "; + + if ( actual != expected ) { + output += ""; + output += ""; } - } - output += "
    Expected: 
    " + expected + "
    Result: 
    " + actual + "
    Diff: 
    " + QUnit.diff( expected, actual ) + "
    "; - QUnit.log(details); + source = sourceFromStacktrace(); + + if ( source ) { + details.source = source; + output += "Source: 
    " + escapeInnerText( source ) + "
    "; + } + + output += ""; + } + + runLoggingCallbacks( "log", QUnit, details ); config.current.assertions.push({ result: !!result, @@ -638,57 +722,106 @@ extend(QUnit, { }); }, + pushFailure: function( message, source ) { + var output, + details = { + result: false, + message: message + }; + + message = escapeInnerText(message ) || "error"; + message = "" + message + ""; + output = message; + + if ( source ) { + details.source = source; + output += "
    Source: 
    " + escapeInnerText( source ) + "
    "; + } + + runLoggingCallbacks( "log", QUnit, details ); + + config.current.assertions.push({ + result: false, + message: output + }); + }, + url: function( params ) { params = extend( extend( {}, QUnit.urlParams ), params ); - var querystring = "?", - key; + var key, + querystring = "?"; + for ( key in params ) { + if ( !hasOwn.call( params, key ) ) { + continue; + } querystring += encodeURIComponent( key ) + "=" + encodeURIComponent( params[ key ] ) + "&"; } return window.location.pathname + querystring.slice( 0, -1 ); }, + extend: extend, + id: id, + addEvent: addEvent +}); + +// QUnit.constructor is set to the empty F() above so that we can add to it's prototype later +// Doing this allows us to tell if the following methods have been overwritten on the actual +// QUnit object, which is a deprecated way of using the callbacks. +extend( QUnit.constructor.prototype, { // Logging callbacks; all receive a single argument with the listed properties // run test/logs.html for any related changes - begin: function() {}, + begin: registerLoggingCallback( "begin" ), // done: { failed, passed, total, runtime } - done: function() {}, + done: registerLoggingCallback( "done" ), // log: { result, actual, expected, message } - log: function() {}, + log: registerLoggingCallback( "log" ), // testStart: { name } - testStart: function() {}, + testStart: registerLoggingCallback( "testStart" ), // testDone: { name, failed, passed, total } - testDone: function() {}, + testDone: registerLoggingCallback( "testDone" ), // moduleStart: { name } - moduleStart: function() {}, + moduleStart: registerLoggingCallback( "moduleStart" ), // moduleDone: { name, failed, passed, total } - moduleDone: function() {} + moduleDone: registerLoggingCallback( "moduleDone" ) }); if ( typeof document === "undefined" || document.readyState === "complete" ) { config.autorun = true; } -addEvent(window, "load", function() { - QUnit.begin({}); +QUnit.load = function() { + runLoggingCallbacks( "begin", QUnit, {} ); // Initialize the config, saving the execution queue - var oldconfig = extend({}, config); + var banner, filter, i, label, len, main, ol, toolbar, userAgent, val, + urlConfigHtml = "", + oldconfig = extend( {}, config ); + QUnit.init(); extend(config, oldconfig); config.blocking = false; - var userAgent = id("qunit-userAgent"); + len = config.urlConfig.length; + + for ( i = 0; i < len; i++ ) { + val = config.urlConfig[i]; + config[val] = QUnit.urlParams[val]; + urlConfigHtml += ""; + } + + // `userAgent` initialized at top of scope + userAgent = id( "qunit-userAgent" ); if ( userAgent ) { userAgent.innerHTML = navigator.userAgent; } - var banner = id("qunit-header"); + + // `banner` initialized at top of scope + banner = id( "qunit-header" ); if ( banner ) { - banner.innerHTML = ' ' + banner.innerHTML + ' ' + - '' + - ''; + banner.innerHTML = "" + banner.innerHTML + " " + urlConfigHtml; addEvent( banner, "change", function( event ) { var params = {}; params[ event.target.name ] = event.target.checked ? true : undefined; @@ -696,111 +829,150 @@ addEvent(window, "load", function() { }); } - var toolbar = id("qunit-testrunner-toolbar"); + // `toolbar` initialized at top of scope + toolbar = id( "qunit-testrunner-toolbar" ); if ( toolbar ) { - var filter = document.createElement("input"); + // `filter` initialized at top of scope + filter = document.createElement( "input" ); filter.type = "checkbox"; filter.id = "qunit-filter-pass"; + addEvent( filter, "click", function() { - var ol = document.getElementById("qunit-tests"); + var tmp, + ol = document.getElementById( "qunit-tests" ); + if ( filter.checked ) { ol.className = ol.className + " hidepass"; } else { - var tmp = " " + ol.className.replace( /[\n\t\r]/g, " " ) + " "; - ol.className = tmp.replace(/ hidepass /, " "); + tmp = " " + ol.className.replace( /[\n\t\r]/g, " " ) + " "; + ol.className = tmp.replace( / hidepass /, " " ); } if ( defined.sessionStorage ) { if (filter.checked) { - sessionStorage.setItem("qunit-filter-passed-tests", "true"); + sessionStorage.setItem( "qunit-filter-passed-tests", "true" ); } else { - sessionStorage.removeItem("qunit-filter-passed-tests"); + sessionStorage.removeItem( "qunit-filter-passed-tests" ); } } }); - if ( defined.sessionStorage && sessionStorage.getItem("qunit-filter-passed-tests") ) { + + if ( config.hidepassed || defined.sessionStorage && sessionStorage.getItem( "qunit-filter-passed-tests" ) ) { filter.checked = true; - var ol = document.getElementById("qunit-tests"); + // `ol` initialized at top of scope + ol = document.getElementById( "qunit-tests" ); ol.className = ol.className + " hidepass"; } toolbar.appendChild( filter ); - var label = document.createElement("label"); - label.setAttribute("for", "qunit-filter-pass"); + // `label` initialized at top of scope + label = document.createElement( "label" ); + label.setAttribute( "for", "qunit-filter-pass" ); label.innerHTML = "Hide passed tests"; toolbar.appendChild( label ); } - var main = id('qunit-fixture'); + // `main` initialized at top of scope + main = id( "qunit-fixture" ); if ( main ) { config.fixture = main.innerHTML; } - if (config.autostart) { + if ( config.autostart ) { QUnit.start(); } -}); +}; + +addEvent( window, "load", QUnit.load ); + +// addEvent(window, "error" ) gives us a useless event object +window.onerror = function( message, file, line ) { + if ( QUnit.config.current ) { + QUnit.pushFailure( message, file + ":" + line ); + } else { + QUnit.test( "global failure", function() { + QUnit.pushFailure( message, file + ":" + line ); + }); + } +}; function done() { config.autorun = true; // Log the last module results if ( config.currentModule ) { - QUnit.moduleDone( { + runLoggingCallbacks( "moduleDone", QUnit, { name: config.currentModule, failed: config.moduleStats.bad, passed: config.moduleStats.all - config.moduleStats.bad, total: config.moduleStats.all - } ); + }); } - var banner = id("qunit-banner"), - tests = id("qunit-tests"), - runtime = +new Date - config.started, + var i, key, + banner = id( "qunit-banner" ), + tests = id( "qunit-tests" ), + runtime = +new Date() - config.started, passed = config.stats.all - config.stats.bad, html = [ - 'Tests completed in ', + "Tests completed in ", runtime, - ' milliseconds.
    ', - '', + " milliseconds.
    ", + "", passed, - ' tests of ', + " tests of ", config.stats.all, - ' passed, ', + " passed, ", config.stats.bad, - ' failed.' - ].join(''); + "     failed." + ].join( "" ); if ( banner ) { - banner.className = (config.stats.bad ? "qunit-fail" : "qunit-pass"); + banner.className = ( config.stats.bad ? "qunit-fail" : "qunit-pass" ); } if ( tests ) { id( "qunit-testresult" ).innerHTML = html; } - if ( typeof document !== "undefined" && document.title ) { + if ( config.altertitle && typeof document !== "undefined" && document.title ) { // show ✖ for good, ✔ for bad suite result in title // use escape sequences in case file gets loaded with non-utf-8-charset - document.title = (config.stats.bad ? "\u2716" : "\u2714") + " " + document.title; + document.title = [ + ( config.stats.bad ? "\u2716" : "\u2714" ), + document.title.replace( /^[\u2714\u2716] /i, "" ) + ].join( " " ); } - QUnit.done( { + // clear own sessionStorage items if all tests passed + if ( config.reorder && defined.sessionStorage && config.stats.bad === 0 ) { + // `key` & `i` initialized at top of scope + for ( i = 0; i < sessionStorage.length; i++ ) { + key = sessionStorage.key( i++ ); + if ( key.indexOf( "qunit-test-" ) === 0 ) { + sessionStorage.removeItem( key ); + } + } + } + + runLoggingCallbacks( "done", QUnit, { failed: config.stats.bad, passed: passed, total: config.stats.all, runtime: runtime - } ); + }); } function validTest( name ) { - var filter = config.filter, + var not, + filter = config.filter, run = false; if ( !filter ) { return true; } - var not = filter.charAt( 0 ) === "!"; + not = filter.charAt( 0 ) === "!"; + if ( not ) { filter = filter.slice( 1 ); } @@ -816,32 +988,51 @@ function validTest( name ) { return run; } -// so far supports only Firefox, Chrome and Opera (buggy) -// could be extended in the future to use something like https://github.com/csnover/TraceKit -function sourceFromStacktrace() { +// so far supports only Firefox, Chrome and Opera (buggy), Safari (for real exceptions) +// Later Safari and IE10 are supposed to support error.stack as well +// See also https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error/Stack +function extractStacktrace( e, offset ) { + offset = offset || 3; + + var stack; + + if ( e.stacktrace ) { + // Opera + return e.stacktrace.split( "\n" )[ offset + 3 ]; + } else if ( e.stack ) { + // Firefox, Chrome + stack = e.stack.split( "\n" ); + if (/^error$/i.test( stack[0] ) ) { + stack.shift(); + } + return stack[ offset ]; + } else if ( e.sourceURL ) { + // Safari, PhantomJS + // hopefully one day Safari provides actual stacktraces + // exclude useless self-reference for generated Error objects + if ( /qunit.js$/.test( e.sourceURL ) ) { + return; + } + // for actual exceptions, this is useful + return e.sourceURL + ":" + e.line; + } +} +function sourceFromStacktrace( offset ) { try { throw new Error(); } catch ( e ) { - if (e.stacktrace) { - // Opera - return e.stacktrace.split("\n")[6]; - } else if (e.stack) { - // Firefox, Chrome - return e.stack.split("\n")[4]; - } + return extractStacktrace( e, offset ); } } -function escapeHtml(s) { - if (!s) { +function escapeInnerText( s ) { + if ( !s ) { return ""; } s = s + ""; - return s.replace(/[\&"<>\\]/g, function(s) { - switch(s) { + return s.replace( /[\&<>]/g, function( s ) { + switch( s ) { case "&": return "&"; - case "\\": return "\\\\"; - case '"': return '\"'; case "<": return "<"; case ">": return ">"; default: return s; @@ -849,28 +1040,33 @@ function escapeHtml(s) { }); } -function synchronize( callback ) { +function synchronize( callback, last ) { config.queue.push( callback ); if ( config.autorun && !config.blocking ) { - process(); + process( last ); } } -function process() { - var start = (new Date()).getTime(); +function process( last ) { + function next() { + process( last ); + } + var start = new Date().getTime(); + config.depth = config.depth ? config.depth + 1 : 1; while ( config.queue.length && !config.blocking ) { - if ( config.updateRate <= 0 || (((new Date()).getTime() - start) < config.updateRate) ) { + if ( !defined.setTimeout || config.updateRate <= 0 || ( ( new Date().getTime() - start ) < config.updateRate ) ) { config.queue.shift()(); } else { - window.setTimeout( process, 13 ); + window.setTimeout( next, 13 ); break; } } - if (!config.blocking && !config.queue.length) { - done(); - } + config.depth--; + if ( last && !config.blocking && !config.queue.length && config.depth === 0 ) { + done(); + } } function saveGlobal() { @@ -878,33 +1074,42 @@ function saveGlobal() { if ( config.noglobals ) { for ( var key in window ) { + // in Opera sometimes DOM element ids show up here, ignore them + if ( !hasOwn.call( window, key ) || /^qunit-test-output/.test( key ) ) { + continue; + } config.pollution.push( key ); } } } function checkPollution( name ) { - var old = config.pollution; + var newGlobals, + deletedGlobals, + old = config.pollution; + saveGlobal(); - var newGlobals = diff( config.pollution, old ); + newGlobals = diff( config.pollution, old ); if ( newGlobals.length > 0 ) { - ok( false, "Introduced global variable(s): " + newGlobals.join(", ") ); + QUnit.pushFailure( "Introduced global variable(s): " + newGlobals.join(", ") ); } - var deletedGlobals = diff( old, config.pollution ); + deletedGlobals = diff( old, config.pollution ); if ( deletedGlobals.length > 0 ) { - ok( false, "Deleted global variable(s): " + deletedGlobals.join(", ") ); + QUnit.pushFailure( "Deleted global variable(s): " + deletedGlobals.join(", ") ); } } // returns a new Array with the elements that are in a but not in b function diff( a, b ) { - var result = a.slice(); - for ( var i = 0; i < result.length; i++ ) { - for ( var j = 0; j < b.length; j++ ) { + var i, j, + result = a.slice(); + + for ( i = 0; i < result.length; i++ ) { + for ( j = 0; j < b.length; j++ ) { if ( result[i] === b[j] ) { - result.splice(i, 1); + result.splice( i, 1 ); i--; break; } @@ -913,30 +1118,21 @@ function diff( a, b ) { return result; } -function fail(message, exception, callback) { - if ( typeof console !== "undefined" && console.error && console.warn ) { - console.error(message); - console.error(exception); - console.warn(callback.toString()); - - } else if ( window.opera && opera.postError ) { - opera.postError(message, exception, callback.toString); - } -} - -function extend(a, b) { +function extend( a, b ) { for ( var prop in b ) { - if ( b[prop] === undefined ) { - delete a[prop]; - } else { - a[prop] = b[prop]; + if ( b[ prop ] === undefined ) { + delete a[ prop ]; + + // Avoid "Member not found" error in IE8 caused by setting window.constructor + } else if ( prop !== "constructor" || a !== window ) { + a[ prop ] = b[ prop ]; } } return a; } -function addEvent(elem, type, fn) { +function addEvent( elem, type, fn ) { if ( elem.addEventListener ) { elem.addEventListener( type, fn, false ); } else if ( elem.attachEvent ) { @@ -946,181 +1142,220 @@ function addEvent(elem, type, fn) { } } -function id(name) { - return !!(typeof document !== "undefined" && document && document.getElementById) && +function id( name ) { + return !!( typeof document !== "undefined" && document && document.getElementById ) && document.getElementById( name ); } +function registerLoggingCallback( key ) { + return function( callback ) { + config[key].push( callback ); + }; +} + +// Supports deprecated method of completely overwriting logging callbacks +function runLoggingCallbacks( key, scope, args ) { + //debugger; + var i, callbacks; + if ( QUnit.hasOwnProperty( key ) ) { + QUnit[ key ].call(scope, args ); + } else { + callbacks = config[ key ]; + for ( i = 0; i < callbacks.length; i++ ) { + callbacks[ i ].call( scope, args ); + } + } +} + // Test for equality any JavaScript type. -// Discussions and reference: http://philrathe.com/articles/equiv -// Test suites: http://philrathe.com/tests/equiv // Author: Philippe Rathé -QUnit.equiv = function () { +QUnit.equiv = (function() { - var innerEquiv; // the real equiv function - var callers = []; // stack to decide between skip/abort functions - var parents = []; // stack to avoiding loops from circular referencing + // Call the o related callback with the given arguments. + function bindCallbacks( o, callbacks, args ) { + var prop = QUnit.objectType( o ); + if ( prop ) { + if ( QUnit.objectType( callbacks[ prop ] ) === "function" ) { + return callbacks[ prop ].apply( callbacks, args ); + } else { + return callbacks[ prop ]; // or undefined + } + } + } - // Call the o related callback with the given arguments. - function bindCallbacks(o, callbacks, args) { - var prop = QUnit.objectType(o); - if (prop) { - if (QUnit.objectType(callbacks[prop]) === "function") { - return callbacks[prop].apply(callbacks, args); - } else { - return callbacks[prop]; // or undefined - } - } - } + // the real equiv function + var innerEquiv, + // stack to decide between skip/abort functions + callers = [], + // stack to avoiding loops from circular referencing + parents = [], - var callbacks = function () { + getProto = Object.getPrototypeOf || function ( obj ) { + return obj.__proto__; + }, + callbacks = (function () { - // for string, boolean, number and null - function useStrictEquality(b, a) { - if (b instanceof a.constructor || a instanceof b.constructor) { - // to catch short annotaion VS 'new' annotation of a declaration - // e.g. var i = 1; - // var j = new Number(1); - return a == b; - } else { - return a === b; - } - } + // for string, boolean, number and null + function useStrictEquality( b, a ) { + if ( b instanceof a.constructor || a instanceof b.constructor ) { + // to catch short annotaion VS 'new' annotation of a + // declaration + // e.g. var i = 1; + // var j = new Number(1); + return a == b; + } else { + return a === b; + } + } - return { - "string": useStrictEquality, - "boolean": useStrictEquality, - "number": useStrictEquality, - "null": useStrictEquality, - "undefined": useStrictEquality, + return { + "string": useStrictEquality, + "boolean": useStrictEquality, + "number": useStrictEquality, + "null": useStrictEquality, + "undefined": useStrictEquality, - "nan": function (b) { - return isNaN(b); - }, + "nan": function( b ) { + return isNaN( b ); + }, - "date": function (b, a) { - return QUnit.objectType(b) === "date" && a.valueOf() === b.valueOf(); - }, + "date": function( b, a ) { + return QUnit.objectType( b ) === "date" && a.valueOf() === b.valueOf(); + }, - "regexp": function (b, a) { - return QUnit.objectType(b) === "regexp" && - a.source === b.source && // the regex itself - a.global === b.global && // and its modifers (gmi) ... - a.ignoreCase === b.ignoreCase && - a.multiline === b.multiline; - }, + "regexp": function( b, a ) { + return QUnit.objectType( b ) === "regexp" && + // the regex itself + a.source === b.source && + // and its modifers + a.global === b.global && + // (gmi) ... + a.ignoreCase === b.ignoreCase && + a.multiline === b.multiline; + }, - // - skip when the property is a method of an instance (OOP) - // - abort otherwise, - // initial === would have catch identical references anyway - "function": function () { - var caller = callers[callers.length - 1]; - return caller !== Object && - typeof caller !== "undefined"; - }, + // - skip when the property is a method of an instance (OOP) + // - abort otherwise, + // initial === would have catch identical references anyway + "function": function() { + var caller = callers[callers.length - 1]; + return caller !== Object && typeof caller !== "undefined"; + }, - "array": function (b, a) { - var i, j, loop; - var len; + "array": function( b, a ) { + var i, j, len, loop; - // b could be an object literal here - if ( ! (QUnit.objectType(b) === "array")) { - return false; - } + // b could be an object literal here + if ( QUnit.objectType( b ) !== "array" ) { + return false; + } - len = a.length; - if (len !== b.length) { // safe and faster - return false; - } + len = a.length; + if ( len !== b.length ) { + // safe and faster + return false; + } - //track reference to avoid circular references - parents.push(a); - for (i = 0; i < len; i++) { - loop = false; - for(j=0;j= 0) { - type = "array"; - } else { - type = typeof obj; - } - return type; - }, - separator:function() { - return this.multiline ? this.HTML ? '
    ' : '\n' : this.HTML ? ' ' : ' '; - }, - indent:function( extra ) {// extra can be a number, shortcut for increasing-calling-decreasing - if ( !this.multiline ) - return ''; - var chr = this.indentChar; - if ( this.HTML ) - chr = chr.replace(/\t/g,' ').replace(/ /g,' '); - return Array( this._depth_ + (extra||0) ).join(chr); - }, - up:function( a ) { - this._depth_ += a || 1; - }, - down:function( a ) { - this._depth_ -= a || 1; - }, - setParser:function( name, parser ) { - this.parsers[name] = parser; - }, - // The next 3 are exposed so you can use them - quote:quote, - literal:literal, - join:join, - // - _depth_: 1, - // This is the list of parsers, to modify them, use jsDump.setParser - parsers:{ - window: '[Window]', - document: '[Document]', - error:'[ERROR]', //when no parser is found, shouldn't happen - unknown: '[Unknown]', - 'null':'null', - 'undefined':'undefined', - 'function':function( fn ) { - var ret = 'function', - name = 'name' in fn ? fn.name : (reName.exec(fn)||[])[1];//functions never have name in IE - if ( name ) - ret += ' ' + name; - ret += '('; - - ret = [ ret, QUnit.jsDump.parse( fn, 'functionArgs' ), '){'].join(''); - return join( ret, QUnit.jsDump.parse(fn,'functionCode'), '}' ); - }, - array: array, - nodelist: array, - arguments: array, - object:function( map ) { - var ret = [ ]; - QUnit.jsDump.up(); - for ( var key in map ) - ret.push( QUnit.jsDump.parse(key,'key') + ': ' + QUnit.jsDump.parse(map[key]) ); - QUnit.jsDump.down(); - return join( '{', ret, '}' ); - }, - node:function( node ) { - var open = QUnit.jsDump.HTML ? '<' : '<', - close = QUnit.jsDump.HTML ? '>' : '>'; - - var tag = node.nodeName.toLowerCase(), - ret = open + tag; - - for ( var a in QUnit.jsDump.DOMAttrs ) { - var val = node[QUnit.jsDump.DOMAttrs[a]]; - if ( val ) - ret += ' ' + a + '=' + QUnit.jsDump.parse( val, 'attribute' ); + if ( inStack != -1 ) { + return "recursion(" + (inStack - stack.length) + ")"; } - return ret + close + open + '/' + tag + close; + //else + if ( type == "function" ) { + stack.push( obj ); + res = parser.call( this, obj, stack ); + stack.pop(); + return res; + } + // else + return ( type == "string" ) ? parser : this.parsers.error; }, - functionArgs:function( fn ) {//function calls it internally, it's the arguments part of the function - var l = fn.length; - if ( !l ) return ''; + typeOf: function( obj ) { + var type; + if ( obj === null ) { + type = "null"; + } else if ( typeof obj === "undefined" ) { + type = "undefined"; + } else if ( QUnit.is( "RegExp", obj) ) { + type = "regexp"; + } else if ( QUnit.is( "Date", obj) ) { + type = "date"; + } else if ( QUnit.is( "Function", obj) ) { + type = "function"; + } else if ( typeof obj.setInterval !== undefined && typeof obj.document !== "undefined" && typeof obj.nodeType === "undefined" ) { + type = "window"; + } else if ( obj.nodeType === 9 ) { + type = "document"; + } else if ( obj.nodeType ) { + type = "node"; + } else if ( + // native arrays + toString.call( obj ) === "[object Array]" || + // NodeList objects + ( typeof obj.length === "number" && typeof obj.item !== "undefined" && ( obj.length ? obj.item(0) === obj[0] : ( obj.item( 0 ) === null && typeof obj[0] === "undefined" ) ) ) + ) { + type = "array"; + } else { + type = typeof obj; + } + return type; + }, + separator: function() { + return this.multiline ? this.HTML ? "
    " : "\n" : this.HTML ? " " : " "; + }, + indent: function( extra ) {// extra can be a number, shortcut for increasing-calling-decreasing + if ( !this.multiline ) { + return ""; + } + var chr = this.indentChar; + if ( this.HTML ) { + chr = chr.replace( /\t/g, " " ).replace( / /g, " " ); + } + return new Array( this._depth_ + (extra||0) ).join(chr); + }, + up: function( a ) { + this._depth_ += a || 1; + }, + down: function( a ) { + this._depth_ -= a || 1; + }, + setParser: function( name, parser ) { + this.parsers[name] = parser; + }, + // The next 3 are exposed so you can use them + quote: quote, + literal: literal, + join: join, + // + _depth_: 1, + // This is the list of parsers, to modify them, use jsDump.setParser + parsers: { + window: "[Window]", + document: "[Document]", + error: "[ERROR]", //when no parser is found, shouldn"t happen + unknown: "[Unknown]", + "null": "null", + "undefined": "undefined", + "function": function( fn ) { + var ret = "function", + name = "name" in fn ? fn.name : (reName.exec(fn) || [])[1];//functions never have name in IE - var args = Array(l); - while ( l-- ) - args[l] = String.fromCharCode(97+l);//97 is 'a' - return ' ' + args.join(', ') + ' '; + if ( name ) { + ret += " " + name; + } + ret += "( "; + + ret = [ ret, QUnit.jsDump.parse( fn, "functionArgs" ), "){" ].join( "" ); + return join( ret, QUnit.jsDump.parse(fn,"functionCode" ), "}" ); + }, + array: array, + nodelist: array, + "arguments": array, + object: function( map, stack ) { + var ret = [ ], keys, key, val, i; + QUnit.jsDump.up(); + if ( Object.keys ) { + keys = Object.keys( map ); + } else { + keys = []; + for ( key in map ) { + keys.push( key ); + } + } + keys.sort(); + for ( i = 0; i < keys.length; i++ ) { + key = keys[ i ]; + val = map[ key ]; + ret.push( QUnit.jsDump.parse( key, "key" ) + ": " + QUnit.jsDump.parse( val, undefined, stack ) ); + } + QUnit.jsDump.down(); + return join( "{", ret, "}" ); + }, + node: function( node ) { + var a, val, + open = QUnit.jsDump.HTML ? "<" : "<", + close = QUnit.jsDump.HTML ? ">" : ">", + tag = node.nodeName.toLowerCase(), + ret = open + tag; + + for ( a in QUnit.jsDump.DOMAttrs ) { + val = node[ QUnit.jsDump.DOMAttrs[a] ]; + if ( val ) { + ret += " " + a + "=" + QUnit.jsDump.parse( val, "attribute" ); + } + } + return ret + close + open + "/" + tag + close; + }, + functionArgs: function( fn ) {//function calls it internally, it's the arguments part of the function + var args, + l = fn.length; + + if ( !l ) { + return ""; + } + + args = new Array(l); + while ( l-- ) { + args[l] = String.fromCharCode(97+l);//97 is 'a' + } + return " " + args.join( ", " ) + " "; + }, + key: quote, //object calls it internally, the key part of an item in a map + functionCode: "[code]", //function calls it internally, it's the content of the function + attribute: quote, //node calls it internally, it's an html attribute value + string: quote, + date: quote, + regexp: literal, //regex + number: literal, + "boolean": literal }, - key:quote, //object calls it internally, the key part of an item in a map - functionCode:'[code]', //function calls it internally, it's the content of the function - attribute:quote, //node calls it internally, it's an html attribute value - string:quote, - date:quote, - regexp:literal, //regex - number:literal, - 'boolean':literal - }, - DOMAttrs:{//attributes to dump from nodes, name=>realName - id:'id', - name:'name', - 'class':'className' - }, - HTML:false,//if true, entities are escaped ( <, >, \t, space and \n ) - indentChar:' ',//indentation unit - multiline:true //if true, items in a collection, are separated by a \n, else just a space. - }; + DOMAttrs: { + //attributes to dump from nodes, name=>realName + id: "id", + name: "name", + "class": "className" + }, + HTML: false,//if true, entities are escaped ( <, >, \t, space and \n ) + indentChar: " ",//indentation unit + multiline: true //if true, items in a collection, are separated by a \n, else just a space. + }; return jsDump; -})(); +}()); // from Sizzle.js function getText( elems ) { - var ret = "", elem; + var i, elem, + ret = ""; - for ( var i = 0; elems[i]; i++ ) { + for ( i = 0; elems[i]; i++ ) { elem = elems[i]; // Get the text from text nodes and CDATA nodes @@ -1306,7 +1585,22 @@ function getText( elems ) { } return ret; -}; +} + +// from jquery.js +function inArray( elem, array ) { + if ( array.indexOf ) { + return array.indexOf( elem ); + } + + for ( var i = 0, length = array.length; i < length; i++ ) { + if ( array[ i ] === elem ) { + return i; + } + } + + return -1; +} /* * Javascript Diff Algorithm @@ -1320,67 +1614,75 @@ function getText( elems ) { * * Usage: QUnit.diff(expected, actual) * - * QUnit.diff("the quick brown fox jumped over", "the quick fox jumps over") == "the quick brown fox jumped jumps over" + * QUnit.diff( "the quick brown fox jumped over", "the quick fox jumps over" ) == "the quick brown fox jumped jumps over" */ QUnit.diff = (function() { - function diff(o, n){ - var ns = new Object(); - var os = new Object(); + function diff( o, n ) { + var i, + ns = {}, + os = {}; - for (var i = 0; i < n.length; i++) { - if (ns[n[i]] == null) - ns[n[i]] = { - rows: new Array(), + for ( i = 0; i < n.length; i++ ) { + if ( ns[ n[i] ] == null ) { + ns[ n[i] ] = { + rows: [], o: null }; - ns[n[i]].rows.push(i); + } + ns[ n[i] ].rows.push( i ); } - for (var i = 0; i < o.length; i++) { - if (os[o[i]] == null) - os[o[i]] = { - rows: new Array(), + for ( i = 0; i < o.length; i++ ) { + if ( os[ o[i] ] == null ) { + os[ o[i] ] = { + rows: [], n: null }; - os[o[i]].rows.push(i); + } + os[ o[i] ].rows.push( i ); } - for (var i in ns) { - if (ns[i].rows.length == 1 && typeof(os[i]) != "undefined" && os[i].rows.length == 1) { - n[ns[i].rows[0]] = { - text: n[ns[i].rows[0]], + for ( i in ns ) { + if ( !hasOwn.call( ns, i ) ) { + continue; + } + if ( ns[i].rows.length == 1 && typeof os[i] != "undefined" && os[i].rows.length == 1 ) { + n[ ns[i].rows[0] ] = { + text: n[ ns[i].rows[0] ], row: os[i].rows[0] }; - o[os[i].rows[0]] = { - text: o[os[i].rows[0]], + o[ os[i].rows[0] ] = { + text: o[ os[i].rows[0] ], row: ns[i].rows[0] }; } } - for (var i = 0; i < n.length - 1; i++) { - if (n[i].text != null && n[i + 1].text == null && n[i].row + 1 < o.length && o[n[i].row + 1].text == null && - n[i + 1] == o[n[i].row + 1]) { - n[i + 1] = { - text: n[i + 1], + for ( i = 0; i < n.length - 1; i++ ) { + if ( n[i].text != null && n[ i + 1 ].text == null && n[i].row + 1 < o.length && o[ n[i].row + 1 ].text == null && + n[ i + 1 ] == o[ n[i].row + 1 ] ) { + + n[ i + 1 ] = { + text: n[ i + 1 ], row: n[i].row + 1 }; - o[n[i].row + 1] = { - text: o[n[i].row + 1], + o[ n[i].row + 1 ] = { + text: o[ n[i].row + 1 ], row: i + 1 }; } } - for (var i = n.length - 1; i > 0; i--) { - if (n[i].text != null && n[i - 1].text == null && n[i].row > 0 && o[n[i].row - 1].text == null && - n[i - 1] == o[n[i].row - 1]) { - n[i - 1] = { - text: n[i - 1], + for ( i = n.length - 1; i > 0; i-- ) { + if ( n[i].text != null && n[ i - 1 ].text == null && n[i].row > 0 && o[ n[i].row - 1 ].text == null && + n[ i - 1 ] == o[ n[i].row - 1 ]) { + + n[ i - 1 ] = { + text: n[ i - 1 ], row: n[i].row - 1 }; - o[n[i].row - 1] = { - text: o[n[i].row - 1], + o[ n[i].row - 1 ] = { + text: o[ n[i].row - 1 ], row: i - 1 }; } @@ -1392,49 +1694,52 @@ QUnit.diff = (function() { }; } - return function(o, n){ - o = o.replace(/\s+$/, ''); - n = n.replace(/\s+$/, ''); - var out = diff(o == "" ? [] : o.split(/\s+/), n == "" ? [] : n.split(/\s+/)); + return function( o, n ) { + o = o.replace( /\s+$/, "" ); + n = n.replace( /\s+$/, "" ); - var str = ""; + var i, pre, + str = "", + out = diff( o === "" ? [] : o.split(/\s+/), n === "" ? [] : n.split(/\s+/) ), + oSpace = o.match(/\s+/g), + nSpace = n.match(/\s+/g); - var oSpace = o.match(/\s+/g); - if (oSpace == null) { - oSpace = [" "]; + if ( oSpace == null ) { + oSpace = [ " " ]; } else { - oSpace.push(" "); - } - var nSpace = n.match(/\s+/g); - if (nSpace == null) { - nSpace = [" "]; - } - else { - nSpace.push(" "); + oSpace.push( " " ); } - if (out.n.length == 0) { - for (var i = 0; i < out.o.length; i++) { - str += '' + out.o[i] + oSpace[i] + ""; + if ( nSpace == null ) { + nSpace = [ " " ]; + } + else { + nSpace.push( " " ); + } + + if ( out.n.length === 0 ) { + for ( i = 0; i < out.o.length; i++ ) { + str += "" + out.o[i] + oSpace[i] + ""; } } else { - if (out.n[0].text == null) { - for (n = 0; n < out.o.length && out.o[n].text == null; n++) { - str += '' + out.o[n] + oSpace[n] + ""; + if ( out.n[0].text == null ) { + for ( n = 0; n < out.o.length && out.o[n].text == null; n++ ) { + str += "" + out.o[n] + oSpace[n] + ""; } } - for (var i = 0; i < out.n.length; i++) { + for ( i = 0; i < out.n.length; i++ ) { if (out.n[i].text == null) { - str += '' + out.n[i] + nSpace[i] + ""; + str += "" + out.n[i] + nSpace[i] + ""; } else { - var pre = ""; + // `pre` initialized at top of scope + pre = ""; - for (n = out.n[i].row + 1; n < out.o.length && out.o[n].text == null; n++) { - pre += '' + out.o[n] + oSpace[n] + ""; + for ( n = out.n[i].row + 1; n < out.o.length && out.o[n].text == null; n++ ) { + pre += "" + out.o[n] + oSpace[n] + ""; } str += " " + out.n[i].text + nSpace[i] + pre; } @@ -1443,6 +1748,12 @@ QUnit.diff = (function() { return str; }; -})(); +}()); -})(this); +// for CommonJS enviroments, export everything +if ( typeof exports !== "undefined" ) { + extend(exports, QUnit); +} + +// get at whatever the global object is, like window in browsers +}( (function() {return this;}.call()) )); diff --git a/test/view.graph.test.js b/test/view.graph.test.js index 13c48efc..d7de87c5 100644 --- a/test/view.graph.test.js +++ b/test/view.graph.test.js @@ -38,6 +38,7 @@ test('initialize', function () { }); test('dates in graph view', function () { + expect(0); var dataset = Fixture.getDataset(); var view = new recline.View.Graph({ model: dataset, diff --git a/test/view.map.test.js b/test/view.map.test.js index f5d26406..638ff2c9 100644 --- a/test/view.map.test.js +++ b/test/view.map.test.js @@ -105,21 +105,25 @@ test('GeoJSON geom field', function () { view.remove(); }); -test('geom field non-GeoJSON', function () { - var data = [{ - location: { lon: 47, lat: 53}, - title: 'abc' - }]; - var dataset = recline.Backend.Memory.createDataset(data); +test('_getGeometryFromRecord non-GeoJSON', function () { + var test = [ + [{ lon: 47, lat: 53}, [47,53]], + ["53.3,47.32", [47.32, 53.3]], + ["53.3, 47.32", [47.32, 53.3]], + ["(53.3,47.32)", [47.32, 53.3]], + [[53.3,47.32], [53.3, 47.32]] + ]; var view = new recline.View.Map({ - model: dataset + model: recline.Backend.Memory.createDataset([{a: 1}]), + state: { + geomField: 'location' + } + }); + _.each(test, function(item) { + var record = new recline.Model.Record({location: item[0]}); + var out = view._getGeometryFromRecord(record); + deepEqual(out.coordinates, item[1]); }); - - //Fire query, otherwise the map won't be initialized - dataset.query(); - - // Check that all features were created - equal(_getFeaturesCount(view.features), 1); }); test('Popup', function () { From b6eb375624f8b5f4d8037046ad4a90ecf25cd0e1 Mon Sep 17 00:00:00 2001 From: amercader Date: Tue, 12 Jun 2012 13:22:39 +0100 Subject: [PATCH 07/15] [#130,view/slickgrid] Don't store sort info on state, as it is stored on the query --- src/view.slickgrid.js | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/view.slickgrid.js b/src/view.slickgrid.js index 1f49b6ee..0c506760 100644 --- a/src/view.slickgrid.js +++ b/src/view.slickgrid.js @@ -135,23 +135,18 @@ my.SlickGrid = Backbone.View.extend({ this.grid = new Slick.Grid(this.el, data, visibleColumns, options); // Column sorting - var sortInfo = this.state.get('columnsSort'); - if (sortInfo.column){ - var sortAsc = !(sortInfo.order == 'desc'); - this.grid.setSortColumn(sortInfo.column, sortAsc); + var sortInfo = this.model.queryState.get('sort'); + if (sortInfo){ + var column = _.keys(sortInfo[0])[0]; + var sortAsc = !(sortInfo[0][column].order == 'desc'); + this.grid.setSortColumn(column, sortAsc); } this.grid.onSort.subscribe(function(e, args){ var order = (args.sortAsc) ? 'asc':'desc'; - self.state.set({columnsSort:{ - column:args.sortCol.field, - order: order - }}); - var sort = [{}]; sort[0][args.sortCol.field] = {order: order}; self.model.query({sort: sort}); - }); this.grid.onColumnsReordered.subscribe(function(e, args){ From 8fe04ddd4fd6045314e04bff13f4c6ca169d0edf Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 15 Jun 2012 10:51:13 +0100 Subject: [PATCH 08/15] [#111,filter/geo][m]: geo filter support - filter editor working though not sure actual query is working (!). * Extensive refactoring of Model.Query and View.FilterEditor to do this cleanly (geo_distance and term treated similarly now) --- src/backend/memory.js | 11 +++-- src/model.js | 49 ++++++++++++++++++- src/widget.filtereditor.js | 83 ++++++++++++++++++++------------ test/model.test.js | 27 +++++++++++ test/widget.filtereditor.test.js | 25 ++++++++++ 5 files changed, 160 insertions(+), 35 deletions(-) diff --git a/src/backend/memory.js b/src/backend/memory.js index daf78dbf..39c11e9c 100644 --- a/src/backend/memory.js +++ b/src/backend/memory.js @@ -90,10 +90,13 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; // in place filtering this._applyFilters = function(results, queryObj) { _.each(queryObj.filters, function(filter) { - results = _.filter(results, function(doc) { - var fieldId = _.keys(filter.term)[0]; - return (doc[fieldId] == filter.term[fieldId]); - }); + // if a term filter ... + if (filter.term) { + results = _.filter(results, function(doc) { + var fieldId = _.keys(filter.term)[0]; + return (doc[fieldId] == filter.term[fieldId]); + }); + } }); return results; }; diff --git a/src/model.js b/src/model.js index 2628903e..0d9b3975 100644 --- a/src/model.js +++ b/src/model.js @@ -393,7 +393,7 @@ my.FieldList = Backbone.Collection.extend({ // may just pass this straight through e.g. for an SQL backend this could be // the full SQL query // -// * filters: dict of ElasticSearch filters. These will be and-ed together for +// * filters: array of ElasticSearch filters. These will be and-ed together for // execution. // // **Examples** @@ -417,6 +417,37 @@ my.Query = Backbone.Model.extend({ filters: [] }; }, + _filterTemplates: { + term: { + '{{fieldId}}': '' + }, + geo_distance: { + distance: '10km', + '{{fieldId}}': { + lon: 0, + lat: 0 + } + } + }, + // ### addFilter + // + // Add a new filter (appended to the list of filters) with default + // value. To set value for the filter use updateFilter. + // + // @param type type of this filter e.g. term, geo_distance etc + // @param fieldId the field to add this filter on + addFilter: function(type, fieldId) { + var tmpl = JSON.stringify(this._filterTemplates[type]); + var filters = this.get('filters'); + var filter = {}; + filter[type] = JSON.parse(Mustache.render(tmpl, {type: type, fieldId: fieldId})); + filter[type]._type = type; + filter[type]._field = fieldId; + filters.push(filter); + this.trigger('change:filters:new-blank'); + }, + updateFilter: function(index, value) { + }, // #### addTermFilter // // Set (update or add) a terms filter to filters @@ -436,6 +467,22 @@ my.Query = Backbone.Model.extend({ this.trigger('change:filters:new-blank'); } }, + addGeoDistanceFilter: function(field) { + var filters = this.get('filters'); + var filter = { + geo_distance: { + distance: '10km', + } + }; + filter.geo_distance[field] = { + 'lon': 0, + 'lat': 0 + }; + filters.push(filter); + this.set({filters: filters}); + // adding a new blank filter and do not want to trigger a new query + this.trigger('change:filters:new-blank'); + }, // ### removeFilter // // Remove a filter from filters at index filterIndex diff --git a/src/widget.filtereditor.js b/src/widget.filtereditor.js index a53a8b69..56962891 100644 --- a/src/widget.filtereditor.js +++ b/src/widget.filtereditor.js @@ -15,7 +15,8 @@ my.FilterEditor = Backbone.View.extend({
    \ \ \ \ \ - × \ - \ - \ - {{/termFilters}} \ - {{#termFilters.length}} \ + {{#filters}} \ + {{{filterRender}}} \ + {{/filters}} \ + {{#filters.length}} \ \ - {{/termFilters.length}} \ + {{/filters.length}} \ \ \ ', + filterTemplates: { + term: ' \ +
    \ + \ +
    \ + \ + × \ +
    \ +
    \ + ', + geo_distance: ' \ +
    \ + \ + × \ +
    \ + \ + \ + \ +
    \ +
    \ + ' + }, events: { 'click .js-remove-filter': 'onRemoveFilter', 'click .js-add-filter': 'onAddFilterShow', @@ -51,30 +68,28 @@ my.FilterEditor = Backbone.View.extend({ initialize: function() { this.el = $(this.el); _.bindAll(this, 'render'); + this.model.fields.bind('all', this.render); this.model.queryState.bind('change', this.render); this.model.queryState.bind('change:filters:new-blank', this.render); this.render(); }, render: function() { + var self = this; var tmplData = $.extend(true, {}, this.model.queryState.toJSON()); // we will use idx in list as there id ... tmplData.filters = _.map(tmplData.filters, function(filter, idx) { filter.id = idx; return filter; }); - tmplData.termFilters = _.filter(tmplData.filters, function(filter) { - return filter.term !== undefined; - }); - tmplData.termFilters = _.map(tmplData.termFilters, function(filter) { - var fieldId = _.keys(filter.term)[0]; - return { - id: filter.id, - fieldId: fieldId, - label: fieldId, - value: filter.term[fieldId] - }; - }); tmplData.fields = this.model.fields.toJSON(); + tmplData.filterRender = function() { + var filterType = _.keys(this)[0]; + var _data = this[filterType]; + _data.id = this.id; + _data._type = filterType; + _data._value = _data[_data._field]; + return Mustache.render(self.filterTemplates[filterType], _data); + }; var out = Mustache.render(this.template, tmplData); this.el.html(out); }, @@ -90,9 +105,7 @@ my.FilterEditor = Backbone.View.extend({ $target.hide(); var filterType = $target.find('select.filterType').val(); var field = $target.find('select.fields').val(); - if (filterType === 'term') { - this.model.queryState.addTermFilter(field); - } + this.model.queryState.addFilter(filterType, field); // trigger render explicitly as queryState change will not be triggered (as blank value for filter) this.render(); }, @@ -109,10 +122,20 @@ my.FilterEditor = Backbone.View.extend({ var $form = $(e.target); _.each($form.find('input'), function(input) { var $input = $(input); - var filterIndex = parseInt($input.attr('data-filter-id')); - var value = $input.val(); + var filterType = $input.attr('data-filter-type'); var fieldId = $input.attr('data-filter-field'); - filters[filterIndex].term[fieldId] = value; + var filterIndex = parseInt($input.attr('data-filter-id')); + var name = $input.attr('name'); + var value = $input.val(); + if (filterType === 'term') { + filters[filterIndex].term[fieldId] = value; + } else if (filterType === 'geo_distance') { + if (name === 'distance') { + filters[filterIndex].geo_distance.distance = parseInt(value); + } else { + filters[filterIndex].geo_distance[fieldId][name] = parseFloat(value); + } + } }); self.model.queryState.set({filters: filters}); self.model.queryState.trigger('change'); diff --git a/test/model.test.js b/test/model.test.js index 0433be74..05508888 100644 --- a/test/model.test.js +++ b/test/model.test.js @@ -150,6 +150,33 @@ test('Query', function () { }); test('Query.addFilter', function () { + var query = new recline.Model.Query(); + query.addFilter('term', 'xyz'); + var exp = { + term: { + xyz: '', + _field: 'xyz', + _type: 'term' + } + }; + deepEqual(exp, query.get('filters')[0]); + + query.addFilter('geo_distance', 'xyz'); + var exp = { + geo_distance: { + distance: '10km', + xyz: { + lon: 0, + lat: 0 + }, + _field: 'xyz', + _type: 'geo_distance' + } + }; + deepEqual(exp, query.get('filters')[1]); +}); + +test('Query.addTermFilter', function () { var query = new recline.Model.Query(); query.addTermFilter('xyz', 'this-value'); deepEqual({term: {xyz: 'this-value'}}, query.get('filters')[0]); diff --git a/test/widget.filtereditor.test.js b/test/widget.filtereditor.test.js index 627db158..f991918a 100644 --- a/test/widget.filtereditor.test.js +++ b/test/widget.filtereditor.test.js @@ -39,3 +39,28 @@ test('basics', function () { view.remove(); }); +test('geo_distance', function () { + var dataset = Fixture.getDataset(); + var view = new recline.View.FilterEditor({ + model: dataset + }); + $('.fixtures').append(view.el); + + var $addForm = view.el.find('form.js-add'); + // submit the form + $addForm.find('select.filterType').val('geo_distance'); + $addForm.find('select.fields').val('lon'); + $addForm.submit(); + + // now check we have new filter + $editForm = view.el.find('form.js-edit'); + equal($editForm.find('.filter-geo_distance').length, 1) + deepEqual(_.keys(dataset.queryState.attributes.filters[0].geo_distance), ['distance', 'lon', '_type', '_field']); + + // now set filter value and apply + $editForm.find('input[name="lat"]').val(10); + $editForm.submit(); + equal(dataset.queryState.attributes.filters[0].geo_distance.lon.lat, 10); + + view.remove(); +}); From 617d3440f03204bf92c179dd964e8ce49563048d Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 15 Jun 2012 22:32:18 +0100 Subject: [PATCH 09/15] [#154, backend/elasticsearch][s]: backend errors now reported up the stack (implement deferred reject when call to backend fails). --- src/backend/elasticsearch.js | 6 ++++++ test/backend/elasticsearch.test.js | 4 +++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/backend/elasticsearch.js b/src/backend/elasticsearch.js index bcab5d95..bee8d9ba 100644 --- a/src/backend/elasticsearch.js +++ b/src/backend/elasticsearch.js @@ -213,6 +213,12 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {}; results.hits.facets = results.facets; } dfd.resolve(results.hits); + }).fail(function(errorObj) { + var out = { + title: 'Failed: ' + errorObj.status + ' code', + message: errorObj.responseText + }; + dfd.reject(out); }); return dfd.promise(); }; diff --git a/test/backend/elasticsearch.test.js b/test/backend/elasticsearch.test.js index 0c08607f..91affe18 100644 --- a/test/backend/elasticsearch.test.js +++ b/test/backend/elasticsearch.test.js @@ -128,6 +128,7 @@ test("query", function() { return { done: function(callback) { callback(sample_data); + return this; }, fail: function() { } @@ -224,10 +225,11 @@ test("query", function() { return { done: function(callback) { callback(sample_data); + return this; }, fail: function() { } - } + }; } }); From f14dcdcaafb7a1b92c7aca1a0777b88b7354524c Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 16 Jun 2012 13:04:03 +0100 Subject: [PATCH 10/15] [#154,model/query][m]: refactor to new filter structure (see ticket) updating FilterEditor widget and backends. * ElasticSearch changes represents a significant refactor and now support filters and query via constant_score (did not support this before!) --- src/backend/elasticsearch.js | 59 ++++++++++++++++++------------ src/backend/memory.js | 5 +-- src/model.js | 32 ++++++++-------- src/widget.filtereditor.js | 31 +++++++--------- test/backend/elasticsearch.test.js | 54 ++++++++++++++++++--------- test/backend/memory.test.js | 4 +- test/model.test.js | 30 +++++++-------- test/widget.filtereditor.test.js | 9 +++-- 8 files changed, 124 insertions(+), 100 deletions(-) diff --git a/src/backend/elasticsearch.js b/src/backend/elasticsearch.js index bee8d9ba..ea18ff39 100644 --- a/src/backend/elasticsearch.js +++ b/src/backend/elasticsearch.js @@ -87,44 +87,57 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {}; }; this._normalizeQuery = function(queryObj) { - var out = queryObj && queryObj.toJSON ? queryObj.toJSON() : _.extend({}, queryObj); - if (out.q !== undefined && out.q.trim() === '') { - delete out.q; - } - if (!out.q) { - out.query = { + var self = this; + var queryInfo = (queryObj && queryObj.toJSON) ? queryObj.toJSON() : _.extend({}, queryObj); + var out = { + constant_score: { + query: {} + } + }; + if (!queryInfo.q) { + out.constant_score.query = { match_all: {} }; } else { - out.query = { + out.constant_score.query = { query_string: { - query: out.q + query: queryInfo.q } }; - delete out.q; } - // now do filters (note the *plural*) - if (out.filters && out.filters.length) { - if (!out.filter) { - out.filter = {}; - } - if (!out.filter.and) { - out.filter.and = []; - } - out.filter.and = out.filter.and.concat(out.filters); - } - if (out.filters !== undefined) { - delete out.filters; + if (queryInfo.filters && queryInfo.filters.length) { + out.constant_score.filter = { + and: [] + }; + _.each(queryInfo.filters, function(filter) { + out.constant_score.filter.and.push(self._convertFilter(filter)); + }); } return out; - }; + }, + + this._convertFilter = function(filter) { + var out = {}; + out[filter.type] = {} + if (filter.type === 'term') { + out.term[filter.field] = filter.term; + } else if (filter.type === 'geo_point') { + out.geo_point[filter.field] = filter.point; + out.geo_point[filter.distance] = filter.distance; + } + return out; + }, // ### query // // @return deferred supporting promise API this.query = function(queryObj) { + var esQuery = (queryObj && queryObj.toJSON) ? queryObj.toJSON() : _.extend({}, queryObj); var queryNormalized = this._normalizeQuery(queryObj); - var data = {source: JSON.stringify(queryNormalized)}; + delete esQuery.q; + delete esQuery.filters; + esQuery.query = queryNormalized; + var data = {source: JSON.stringify(esQuery)}; var url = this.endpoint + '/_search'; var jqxhr = recline.Backend.makeRequest({ url: url, diff --git a/src/backend/memory.js b/src/backend/memory.js index 39c11e9c..960396fc 100644 --- a/src/backend/memory.js +++ b/src/backend/memory.js @@ -91,10 +91,9 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; this._applyFilters = function(results, queryObj) { _.each(queryObj.filters, function(filter) { // if a term filter ... - if (filter.term) { + if (filter.type === 'term') { results = _.filter(results, function(doc) { - var fieldId = _.keys(filter.term)[0]; - return (doc[fieldId] == filter.term[fieldId]); + return (doc[filter.field] == filter.term); }); } }); diff --git a/src/model.js b/src/model.js index 0d9b3975..74031b3f 100644 --- a/src/model.js +++ b/src/model.js @@ -411,39 +411,39 @@ my.Query = Backbone.Model.extend({ return { size: 100, from: 0, + q: '', facets: {}, - // - // , filter: {} filters: [] }; }, _filterTemplates: { term: { - '{{fieldId}}': '' + type: 'term', + field: '', + term: '' }, geo_distance: { distance: '10km', - '{{fieldId}}': { + point: { lon: 0, lat: 0 } } - }, + }, // ### addFilter // - // Add a new filter (appended to the list of filters) with default - // value. To set value for the filter use updateFilter. + // Add a new filter (appended to the list of filters) // - // @param type type of this filter e.g. term, geo_distance etc - // @param fieldId the field to add this filter on - addFilter: function(type, fieldId) { - var tmpl = JSON.stringify(this._filterTemplates[type]); + // @param filter an object specifying the filter - see _filterTemplates for examples. If only type is provided will generate a filter by cloning _filterTemplates + addFilter: function(filter) { + // crude deep copy + var ourfilter = JSON.parse(JSON.stringify(filter)); + // not full specified so use template and over-write + if (_.keys(filter).length <= 2) { + ourfilter = _.extend(this._filterTemplates[filter.type], ourfilter); + } var filters = this.get('filters'); - var filter = {}; - filter[type] = JSON.parse(Mustache.render(tmpl, {type: type, fieldId: fieldId})); - filter[type]._type = type; - filter[type]._field = fieldId; - filters.push(filter); + filters.push(ourfilter); this.trigger('change:filters:new-blank'); }, updateFilter: function(index, value) { diff --git a/src/widget.filtereditor.js b/src/widget.filtereditor.js index 56962891..3fa58010 100644 --- a/src/widget.filtereditor.js +++ b/src/widget.filtereditor.js @@ -39,22 +39,22 @@ my.FilterEditor = Backbone.View.extend({ ', filterTemplates: { term: ' \ -
    \ - \ +
    \ + \
    \ - \ + \ × \
    \
    \ ', geo_distance: ' \ -
    \ - \ +
    \ + \ × \
    \ - \ - \ - \ + \ + \ + \
    \
    \ ' @@ -83,12 +83,7 @@ my.FilterEditor = Backbone.View.extend({ }); tmplData.fields = this.model.fields.toJSON(); tmplData.filterRender = function() { - var filterType = _.keys(this)[0]; - var _data = this[filterType]; - _data.id = this.id; - _data._type = filterType; - _data._value = _data[_data._field]; - return Mustache.render(self.filterTemplates[filterType], _data); + return Mustache.render(self.filterTemplates[this.type], this); }; var out = Mustache.render(this.template, tmplData); this.el.html(out); @@ -105,7 +100,7 @@ my.FilterEditor = Backbone.View.extend({ $target.hide(); var filterType = $target.find('select.filterType').val(); var field = $target.find('select.fields').val(); - this.model.queryState.addFilter(filterType, field); + this.model.queryState.addFilter({type: filterType, field: field}); // trigger render explicitly as queryState change will not be triggered (as blank value for filter) this.render(); }, @@ -128,12 +123,12 @@ my.FilterEditor = Backbone.View.extend({ var name = $input.attr('name'); var value = $input.val(); if (filterType === 'term') { - filters[filterIndex].term[fieldId] = value; + filters[filterIndex].term = value; } else if (filterType === 'geo_distance') { if (name === 'distance') { - filters[filterIndex].geo_distance.distance = parseInt(value); + filters[filterIndex].distance = parseInt(value); } else { - filters[filterIndex].geo_distance[fieldId][name] = parseFloat(value); + filters[filterIndex].point[name] = parseFloat(value); } } }); diff --git a/test/backend/elasticsearch.test.js b/test/backend/elasticsearch.test.js index 91affe18..7dfeb8ff 100644 --- a/test/backend/elasticsearch.test.js +++ b/test/backend/elasticsearch.test.js @@ -3,32 +3,52 @@ module("Backend ElasticSearch - Wrapper"); test("queryNormalize", function() { var backend = new recline.Backend.ElasticSearch.Wrapper(); + var in_ = new recline.Model.Query(); var out = backend._normalizeQuery(in_); - equal(out.size, 100); + var exp = { + constant_score: { + query: { + match_all: {} + } + } + }; + deepEqual(out, exp); var in_ = new recline.Model.Query(); in_.set({q: ''}); var out = backend._normalizeQuery(in_); - equal(out.q, undefined); - deepEqual(out.query.match_all, {}); - - var in_ = new recline.Model.Query().toJSON(); - in_.q = ''; - var out = backend._normalizeQuery(in_); - equal(out.q, undefined); - deepEqual(out.query.match_all, {}); - - var in_ = new recline.Model.Query().toJSON(); - in_.q = 'abc'; - var out = backend._normalizeQuery(in_); - equal(out.query.query_string.query, 'abc'); + deepEqual(out, exp); var in_ = new recline.Model.Query(); - in_.addTermFilter('xyz', 'XXX'); - in_ = in_.toJSON(); + in_.attributes.q = 'abc'; var out = backend._normalizeQuery(in_); - deepEqual(out.filter.and[0], {term: { xyz: 'XXX'}}); + equal(out.constant_score.query.query_string.query, 'abc'); + + var in_ = new recline.Model.Query(); + in_.addFilter({ + type: 'term', + field: 'xyz', + term: 'XXX' + }); + var out = backend._normalizeQuery(in_); + var exp = { + constant_score: { + query: { + match_all: {} + }, + filter: { + and: [ + { + term: { + xyz: 'XXX' + } + } + ] + } + } + }; + deepEqual(out, exp); }); var mapping_data = { diff --git a/test/backend/memory.test.js b/test/backend/memory.test.js index ed76f668..b9c2f75a 100644 --- a/test/backend/memory.test.js +++ b/test/backend/memory.test.js @@ -60,7 +60,7 @@ test('query string', function () { test('filters', function () { var data = _wrapData(); var query = new recline.Model.Query(); - query.addTermFilter('country', 'UK'); + query.addFilter({type: 'term', field: 'country', term: 'UK'}); var out = data.query(query.toJSON()); equal(out.total, 3); deepEqual(_.pluck(out.records, 'country'), ['UK', 'UK', 'UK']); @@ -198,7 +198,7 @@ test('query string', function () { test('filters', function () { var dataset = makeBackendDataset(); - dataset.queryState.addTermFilter('country', 'UK'); + dataset.queryState.addFilter({type: 'term', field: 'country', term: 'UK'}); dataset.query().then(function() { equal(dataset.currentRecords.length, 3); deepEqual(dataset.currentRecords.pluck('country'), ['UK', 'UK', 'UK']); diff --git a/test/model.test.js b/test/model.test.js index 05508888..0c1fe167 100644 --- a/test/model.test.js +++ b/test/model.test.js @@ -151,27 +151,23 @@ test('Query', function () { test('Query.addFilter', function () { var query = new recline.Model.Query(); - query.addFilter('term', 'xyz'); + query.addFilter({type: 'term', field: 'xyz'}); var exp = { - term: { - xyz: '', - _field: 'xyz', - _type: 'term' - } + field: 'xyz', + type: 'term', + term: '' }; - deepEqual(exp, query.get('filters')[0]); + deepEqual(query.get('filters')[0], exp); - query.addFilter('geo_distance', 'xyz'); + query.addFilter({type: 'geo_distance', field: 'xyz'}); var exp = { - geo_distance: { - distance: '10km', - xyz: { - lon: 0, - lat: 0 - }, - _field: 'xyz', - _type: 'geo_distance' - } + distance: '10km', + point: { + lon: 0, + lat: 0 + }, + field: 'xyz', + type: 'geo_distance' }; deepEqual(exp, query.get('filters')[1]); }); diff --git a/test/widget.filtereditor.test.js b/test/widget.filtereditor.test.js index f991918a..36f16e40 100644 --- a/test/widget.filtereditor.test.js +++ b/test/widget.filtereditor.test.js @@ -21,12 +21,12 @@ test('basics', function () { ok(!$addForm.is(":visible")); $editForm = view.el.find('form.js-edit'); equal($editForm.find('.filter-term').length, 1) - equal(_.keys(dataset.queryState.attributes.filters[0].term)[0], 'country'); + equal(dataset.queryState.attributes.filters[0].field, 'country'); // now set filter value and apply $editForm.find('input').val('UK'); $editForm.submit(); - equal(dataset.queryState.attributes.filters[0].term.country, 'UK'); + equal(dataset.queryState.attributes.filters[0].term, 'UK'); equal(dataset.currentRecords.length, 3); // now remove filter @@ -55,12 +55,13 @@ test('geo_distance', function () { // now check we have new filter $editForm = view.el.find('form.js-edit'); equal($editForm.find('.filter-geo_distance').length, 1) - deepEqual(_.keys(dataset.queryState.attributes.filters[0].geo_distance), ['distance', 'lon', '_type', '_field']); + deepEqual(_.keys(dataset.queryState.attributes.filters[0]), ['distance', + 'point', 'type', 'field']); // now set filter value and apply $editForm.find('input[name="lat"]').val(10); $editForm.submit(); - equal(dataset.queryState.attributes.filters[0].geo_distance.lon.lat, 10); + equal(dataset.queryState.attributes.filters[0].point.lat, 10); view.remove(); }); From 36911aef14099a0e97969db3c7eec8e3c1f58d3b Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 16 Jun 2012 13:17:10 +0100 Subject: [PATCH 11/15] [#130,test,bugfix][xs]: slickgrid tests were still testing sort order even though removed in b6eb375624f8b5f4d8037046ad4a90ecf25cd0e1. --- test/view.slickgrid.test.js | 4 ---- 1 file changed, 4 deletions(-) diff --git a/test/view.slickgrid.test.js b/test/view.slickgrid.test.js index 94d4d9d7..d0df3c3d 100644 --- a/test/view.slickgrid.test.js +++ b/test/view.slickgrid.test.js @@ -29,7 +29,6 @@ test('state', function () { state: { hiddenColumns:['x','lat','title'], columnsOrder:['lon','id','z','date', 'y', 'country'], - columnsSort:{column:'country',direction:'desc'}, columnsWidth:[ {column:'id',width: 250} ] @@ -52,9 +51,6 @@ test('state', function () { // Column order deepEqual(_.pluck(headers,'title'),view.state.get('columnsOrder')); - // Column sorting - equal($(view.grid.getCellNode(0,view.grid.getColumnIndex('country'))).text(),'US'); - // Column width equal($('.slick-header-column[title="id"]').width(),250); From d17775e39d07100e11d22b628f7edf047e5c647d Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 16 Jun 2012 13:39:15 +0100 Subject: [PATCH 12/15] [backend/memory,bugfix][s]: corrected sort for memory backend so works correctly on string fields. --- src/backend/memory.js | 5 ++++- test/backend/memory.test.js | 16 ++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/src/backend/memory.js b/src/backend/memory.js index 960396fc..fea90eb9 100644 --- a/src/backend/memory.js +++ b/src/backend/memory.js @@ -74,8 +74,11 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; var fieldName = _.keys(sortObj)[0]; results = _.sortBy(results, function(doc) { var _out = doc[fieldName]; - return (sortObj[fieldName].order == 'asc') ? _out : -1*_out; + return _out; }); + if (sortObj[fieldName].order == 'desc') { + results.reverse(); + } }); var total = results.length; var facets = this.computeFacets(results, queryObj); diff --git a/test/backend/memory.test.js b/test/backend/memory.test.js index b9c2f75a..535aeb61 100644 --- a/test/backend/memory.test.js +++ b/test/backend/memory.test.js @@ -44,6 +44,22 @@ test('query sort', function () { }; var out = data.query(queryObj); equal(out.records[0].x, 6); + + var queryObj = { + sort: [ + {'country': {order: 'desc'}} + ] + }; + var out = data.query(queryObj); + equal(out.records[0].country, 'US'); + + var queryObj = { + sort: [ + {'country': {order: 'asc'}} + ] + }; + var out = data.query(queryObj); + equal(out.records[0].country, 'DE'); }); test('query string', function () { From 8ff885759fcc2a5c4f9c487ee37d03da8f3cfc0e Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 16 Jun 2012 16:31:45 +0100 Subject: [PATCH 13/15] [#111,backend/elasticsearch][s]: geo distance filter now working - hurrah!. --- src/backend/elasticsearch.js | 6 +++--- test/backend/elasticsearch.test.js | 25 +++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/src/backend/elasticsearch.js b/src/backend/elasticsearch.js index ea18ff39..4667f4cc 100644 --- a/src/backend/elasticsearch.js +++ b/src/backend/elasticsearch.js @@ -121,9 +121,9 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {}; out[filter.type] = {} if (filter.type === 'term') { out.term[filter.field] = filter.term; - } else if (filter.type === 'geo_point') { - out.geo_point[filter.field] = filter.point; - out.geo_point[filter.distance] = filter.distance; + } else if (filter.type === 'geo_distance') { + out.geo_distance[filter.field] = filter.point; + out.geo_distance.distance = filter.distance; } return out; }, diff --git a/test/backend/elasticsearch.test.js b/test/backend/elasticsearch.test.js index 7dfeb8ff..9170b5cb 100644 --- a/test/backend/elasticsearch.test.js +++ b/test/backend/elasticsearch.test.js @@ -49,6 +49,31 @@ test("queryNormalize", function() { } }; deepEqual(out, exp); + + var in_ = new recline.Model.Query(); + in_.addFilter({ + type: 'geo_distance', + field: 'xyz' + }); + var out = backend._normalizeQuery(in_); + var exp = { + constant_score: { + query: { + match_all: {} + }, + filter: { + and: [ + { + geo_distance: { + distance: '10km', + 'xyz': { lon: 0, lat: 0 } + } + } + ] + } + } + }; + deepEqual(out, exp); }); var mapping_data = { From 81167e39fe6079b4d94e1d496ce46357cd106ed8 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 16 Jun 2012 16:46:34 +0100 Subject: [PATCH 14/15] [#154,filtereditor][s]: refactor how we lay out the filters in order to group inputs for a given filter together more. * Model.Query: use distance_unit for geo_distance filter. --- src/model.js | 3 ++- src/widget.filtereditor.js | 37 ++++++++++++++++++++++--------------- 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/src/model.js b/src/model.js index 74031b3f..3bf80a6b 100644 --- a/src/model.js +++ b/src/model.js @@ -423,7 +423,8 @@ my.Query = Backbone.Model.extend({ term: '' }, geo_distance: { - distance: '10km', + distance: 10, + distance_unit: 'km', point: { lon: 0, lat: 0 diff --git a/src/widget.filtereditor.js b/src/widget.filtereditor.js index 3fa58010..4ae2eafd 100644 --- a/src/widget.filtereditor.js +++ b/src/widget.filtereditor.js @@ -39,23 +39,30 @@ my.FilterEditor = Backbone.View.extend({ ', filterTemplates: { term: ' \ -
    \ - \ -
    \ - \ - × \ -
    \ +
    \ +
    \ + \ + {{field}} {{type}} \ + × \ + \ + \ +
    \
    \ ', geo_distance: ' \ -
    \ - \ - × \ -
    \ - \ - \ - \ -
    \ +
    \ +
    \ + \ + {{field}} {{type}} \ + × \ + \ + \ + \ + \ + \ + \ + \ +
    \
    \ ' }, @@ -126,7 +133,7 @@ my.FilterEditor = Backbone.View.extend({ filters[filterIndex].term = value; } else if (filterType === 'geo_distance') { if (name === 'distance') { - filters[filterIndex].distance = parseInt(value); + filters[filterIndex].distance = parseFloat(value); } else { filters[filterIndex].point[name] = parseFloat(value); } From 262bb95376d946178d584be3f47bd99a5fa43517 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 16 Jun 2012 17:03:53 +0100 Subject: [PATCH 15/15] [backend/elasticsearch][xs]: auto lower case terms in term filters as ES needs them to be lowercase. --- src/backend/elasticsearch.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/backend/elasticsearch.js b/src/backend/elasticsearch.js index 4667f4cc..0ed05723 100644 --- a/src/backend/elasticsearch.js +++ b/src/backend/elasticsearch.js @@ -120,7 +120,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {}; var out = {}; out[filter.type] = {} if (filter.type === 'term') { - out.term[filter.field] = filter.term; + out.term[filter.field] = filter.term.toLowerCase(); } else if (filter.type === 'geo_distance') { out.geo_distance[filter.field] = filter.point; out.geo_distance.distance = filter.distance;