Building on Backbone, Recline supplies components and structure to data-heavy applications by providing a - set of models (Dataset, Document/Row, Field) and views (Grid, Map, Graph + set of models (Dataset, Record/Row, Field) and views (Grid, Map, Graph etc).
There are two main model objects:
Backends connect Dataset and Documents to data from a +
Backends connect Dataset and Records to data from a specific 'Backend' data source. They provide methods for loading and saving - Datasets and individuals Documents as well as for bulk loading via a query API + Datasets and individuals Records as well as for bulk loading via a query API and doing bulk transforms on the backend.
A template Base class can be found in the - Backend base module of the source docs. It documents both the relevant + Backend base module of the source docs. It records both the relevant methods a Backend must have and (optionally) provides a base 'class' for inheritance. You can also find detailed examples of backend implementations in the source documentation below.
diff --git a/src/backend/base.js b/src/backend/base.js index 2758f51e..1948de6e 100644 --- a/src/backend/base.js +++ b/src/backend/base.js @@ -29,14 +29,14 @@ this.recline.Backend.Base = function() { // ### sync // // An implementation of Backbone.sync that will be used to override - // Backbone.sync on operations for Datasets and Documents which are using this backend. + // Backbone.sync on operations for Datasets and Records which are using this backend. // // For read-only implementations you will need only to implement read method // for Dataset models (and even this can be a null operation). The read method // should return relevant metadata for the Dataset. We do not require read support - // for Documents because they are loaded in bulk by the query method. + // for Records because they are loaded in bulk by the query method. // - // For backends supporting write operations you must implement update and delete support for Document objects. + // For backends supporting write operations you must implement update and delete support for Record objects. // // All code paths should return an object conforming to the jquery promise API. this.sync = function(method, model, options) { @@ -44,8 +44,8 @@ this.recline.Backend.Base = function() { // ### query // - // Query the backend for documents returning them in bulk. This method will - // be used by the Dataset.query method to search the backend for documents, + // Query the backend for records returning them in bulk. This method will + // be used by the Dataset.query method to search the backend for records, // retrieving the results in bulk. // // @param {recline.model.Dataset} model: Dataset model. @@ -71,11 +71,11 @@ this.recline.Backend.Base = function() { //
// {
// total: // (required) total number of results (can be null)
- // hits: [ // (required) one entry for each result document
+ // hits: [ // (required) one entry for each result record
// {
- // _score: // (optional) match score for document
- // _type: // (optional) document type
- // _source: // (required) document/row object
+ // _score: // (optional) match score for record
+ // _type: // (optional) record type
+ // _source: // (required) record/row object
// }
// ],
// facets: { // (optional)
diff --git a/src/backend/elasticsearch.js b/src/backend/elasticsearch.js
index a73d4140..bcab5d95 100644
--- a/src/backend/elasticsearch.js
+++ b/src/backend/elasticsearch.js
@@ -39,7 +39,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
// ### get
//
- // Get document corresponding to specified id
+ // Get record corresponding to specified id
//
// @return promise compatible deferred object.
this.get = function(id) {
@@ -52,7 +52,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
// ### upsert
//
- // create / update a document to ElasticSearch backend
+ // create / update a record to ElasticSearch backend
//
// @param {Object} doc an object to insert to the index.
// @return deferred supporting promise API
@@ -72,7 +72,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
// ### delete
//
- // Delete a document from the ElasticSearch backend.
+ // Delete a record from the ElasticSearch backend.
//
// @param {Object} id id of object to delete
// @return deferred supporting promise API
@@ -154,7 +154,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
// Backbone sync implementation for this backend.
//
// URL of ElasticSearch endpoint to use must be specified on the dataset
- // (and on a Document via its dataset attribute) by the dataset having a
+ // (and on a Record via its dataset attribute) by the dataset having a
// url attribute.
this.sync = function(method, model, options) {
if (model.__type__ == 'Dataset') {
@@ -180,15 +180,15 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
dfd.reject(arguments);
});
return dfd.promise();
- } else if (model.__type__ == 'Document') {
+ } else if (model.__type__ == 'Record') {
return es.get(model.dataset.id);
}
} else if (method === 'update') {
- if (model.__type__ == 'Document') {
+ if (model.__type__ == 'Record') {
return es.upsert(model.toJSON());
}
} else if (method === 'delete') {
- if (model.__type__ == 'Document') {
+ if (model.__type__ == 'Record') {
return es.delete(model.id);
}
}
diff --git a/src/backend/memory.js b/src/backend/memory.js
index f7fa8afb..60ef7811 100644
--- a/src/backend/memory.js
+++ b/src/backend/memory.js
@@ -7,7 +7,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
//
// Convenience function to create a simple 'in-memory' dataset in one step.
//
- // @param data: list of hashes for each document/row in the data ({key:
+ // @param data: list of hashes for each record/row in the data ({key:
// value, key: value})
// @param fields: (optional) list of field hashes (each hash defining a hash
// as per recline.Model.Field). If fields not specified they will be taken
@@ -76,7 +76,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
results = results.slice(start, start+numRows);
return {
total: total,
- documents: results,
+ records: results,
facets: facets
};
};
@@ -118,7 +118,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
return results;
};
- this.computeFacets = function(documents, queryObj) {
+ this.computeFacets = function(records, queryObj) {
var facetResults = {};
if (!queryObj.facets) {
return facetResults;
@@ -129,7 +129,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
facetResults[facetId].termsall = {};
});
// faceting
- _.each(documents, function(doc) {
+ _.each(records, function(doc) {
_.each(queryObj.facets, function(query, facetId) {
var fieldId = query.terms.field;
var val = doc[fieldId];
@@ -172,13 +172,13 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
}
return dfd.promise();
} else if (method === 'update') {
- if (model.__type__ == 'Document') {
+ if (model.__type__ == 'Record') {
model.dataset._dataCache.update(model.toJSON());
dfd.resolve(model);
}
return dfd.promise();
} else if (method === 'delete') {
- if (model.__type__ == 'Document') {
+ if (model.__type__ == 'Record') {
model.dataset._dataCache.delete(model.toJSON());
dfd.resolve(model);
}
@@ -191,7 +191,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
this.query = function(model, queryObj) {
var dfd = $.Deferred();
var results = model._dataCache.query(queryObj);
- var hits = _.map(results.documents, function(row) {
+ var hits = _.map(results.records, function(row) {
return { _source: row };
});
var out = {
diff --git a/src/model.js b/src/model.js
index a32e5521..99ef250f 100644
--- a/src/model.js
+++ b/src/model.js
@@ -12,11 +12,11 @@ this.recline.Model = this.recline.Model || {};
// fields on this Dataset (this can be set explicitly, or, will be set by
// Dataset.fetch() or Dataset.query()
//
-// @property {DocumentList} currentDocuments: a `DocumentList` containing the
-// Documents we have currently loaded for viewing (updated by calling query
+// @property {RecordList} currentRecords: a `RecordList` containing the
+// Records we have currently loaded for viewing (updated by calling query
// method)
//
-// @property {number} docCount: total number of documents in this dataset
+// @property {number} docCount: total number of records in this dataset
//
// @property {Backend} backend: the Backend (instance) for this Dataset.
//
@@ -48,7 +48,7 @@ my.Dataset = Backbone.Model.extend({
this.backend = this._backendFromString(backend);
}
this.fields = new my.FieldList();
- this.currentDocuments = new my.DocumentList();
+ this.currentRecords = new my.RecordList();
this.facets = new my.FacetList();
this.docCount = null;
this.queryState = new my.Query();
@@ -58,12 +58,12 @@ my.Dataset = Backbone.Model.extend({
// ### query
//
- // AJAX method with promise API to get documents from the backend.
+ // AJAX method with promise API to get records from the backend.
//
// It will query based on current query state (given by this.queryState)
// updated by queryObj (if provided).
//
- // Resulting DocumentList are used to reset this.currentDocuments and are
+ // Resulting RecordList are used to reset this.currentRecords and are
// also returned.
query: function(queryObj) {
var self = this;
@@ -73,12 +73,12 @@ my.Dataset = Backbone.Model.extend({
this.backend.query(this, actualQuery).done(function(queryResult) {
self.docCount = queryResult.total;
var docs = _.map(queryResult.hits, function(hit) {
- var _doc = new my.Document(hit._source);
+ var _doc = new my.Record(hit._source);
_doc.backend = self.backend;
_doc.dataset = self;
return _doc;
});
- self.currentDocuments.reset(docs);
+ self.currentRecords.reset(docs);
if (queryResult.facets) {
var facets = _.map(queryResult.facets, function(facetResult, facetId) {
facetResult.id = facetId;
@@ -87,7 +87,7 @@ my.Dataset = Backbone.Model.extend({
self.facets.reset(facets);
}
self.trigger('query:done');
- dfd.resolve(self.currentDocuments);
+ dfd.resolve(self.currentRecords);
})
.fail(function(arguments) {
self.trigger('query:fail', arguments);
@@ -176,11 +176,11 @@ my.Dataset.restore = function(state) {
return dataset;
};
-// ## A Document (aka Row)
+// ## A Record (aka Row)
//
// A single entry or row in the dataset
-my.Document = Backbone.Model.extend({
- __type__: 'Document',
+my.Record = Backbone.Model.extend({
+ __type__: 'Record',
initialize: function() {
_.bindAll(this, 'getFieldValue');
},
@@ -188,7 +188,7 @@ my.Document = Backbone.Model.extend({
// ### getFieldValue
//
// For the provided Field get the corresponding rendered computed data value
- // for this document.
+ // for this record.
getFieldValue: function(field) {
var val = this.get(field.id);
if (field.deriver) {
@@ -211,17 +211,17 @@ my.Document = Backbone.Model.extend({
}
});
-// ## A Backbone collection of Documents
-my.DocumentList = Backbone.Collection.extend({
- __type__: 'DocumentList',
- model: my.Document
+// ## A Backbone collection of Records
+my.RecordList = Backbone.Collection.extend({
+ __type__: 'RecordList',
+ model: my.Record
});
// ## A Field (aka Column) on a Dataset
//
// Following (Backbone) attributes as standard:
//
-// * id: a unique identifer for this field- usually this should match the key in the documents hash
+// * id: a unique identifer for this field- usually this should match the key in the records hash
// * label: (optional: defaults to id) the visible label used for this field
// * type: (optional: defaults to string) the type of the data in this field. Should be a string as per type names defined by ElasticSearch - see Types list on
// var row = new GridRow({
-// model: dataset-document,
+// model: dataset-record,
// el: dom-element,
// fields: mydatasets.fields // a FieldList object
// });
diff --git a/src/view-map.js b/src/view-map.js
index 8e622a0a..f0a75ae8 100644
--- a/src/view-map.js
+++ b/src/view-map.js
@@ -7,7 +7,7 @@ this.recline.View = this.recline.View || {};
// ## Map view for a Dataset using Leaflet mapping library.
//
-// This view allows to plot gereferenced documents on a map. The location
+// This view allows to plot gereferenced records on a map. The location
// information can be provided either via a field with
// [GeoJSON](http://geojson.org) objects or two fields with latitude and
// longitude coordinates.
@@ -115,14 +115,14 @@ my.Map = Backbone.View.extend({
self.render()
});
- // Listen to changes in the documents
- this.model.currentDocuments.bind('add', function(doc){self.redraw('add',doc)});
- this.model.currentDocuments.bind('change', function(doc){
+ // Listen to changes in the records
+ this.model.currentRecords.bind('add', function(doc){self.redraw('add',doc)});
+ this.model.currentRecords.bind('change', function(doc){
self.redraw('remove',doc);
self.redraw('add',doc);
});
- this.model.currentDocuments.bind('remove', function(doc){self.redraw('remove',doc)});
- this.model.currentDocuments.bind('reset', function(){self.redraw('reset')});
+ this.model.currentRecords.bind('remove', function(doc){self.redraw('remove',doc)});
+ this.model.currentRecords.bind('reset', function(){self.redraw('reset')});
this.bind('view:show',function(){
// If the div was hidden, Leaflet needs to recalculate some sizes
@@ -184,9 +184,9 @@ my.Map = Backbone.View.extend({
// Actions can be:
//
// * reset: Clear all features
- // * add: Add one or n features (documents)
- // * remove: Remove one or n features (documents)
- // * refresh: Clear existing features and add all current documents
+ // * add: Add one or n features (records)
+ // * remove: Remove one or n features (records)
+ // * refresh: Clear existing features and add all current records
redraw: function(action, doc){
var self = this;
action = action || 'refresh';
@@ -201,7 +201,7 @@ my.Map = Backbone.View.extend({
if (this.geomReady && this.mapReady){
if (action == 'reset' || action == 'refresh'){
this.features.clearLayers();
- this._add(this.model.currentDocuments.models);
+ this._add(this.model.currentRecords.models);
} else if (action == 'add' && doc){
this._add(doc);
} else if (action == 'remove' && doc){
@@ -266,11 +266,11 @@ my.Map = Backbone.View.extend({
// Private: Add one or n features to the map
//
- // For each document passed, a GeoJSON geometry will be extracted and added
+ // For each record passed, a GeoJSON geometry will be extracted and added
// to the features layer. If an exception is thrown, the process will be
// stopped and an error notification shown.
//
- // Each feature will have a popup associated with all the document fields.
+ // Each feature will have a popup associated with all the record fields.
//
_add: function(docs){
var self = this;
@@ -281,7 +281,7 @@ my.Map = Backbone.View.extend({
var wrongSoFar = 0;
_.every(docs,function(doc){
count += 1;
- var feature = self._getGeometryFromDocument(doc);
+ var feature = self._getGeometryFromRecord(doc);
if (typeof feature === 'undefined' || feature === null){
// Empty field
return true;
@@ -338,9 +338,9 @@ my.Map = Backbone.View.extend({
},
- // Private: Return a GeoJSON geomtry extracted from the document fields
+ // Private: Return a GeoJSON geomtry extracted from the record fields
//
- _getGeometryFromDocument: function(doc){
+ _getGeometryFromRecord: function(doc){
if (this.geomReady){
if (this.state.get('geomField')){
var value = doc.get(this.state.get('geomField'));
diff --git a/src/view-slickgrid.js b/src/view-slickgrid.js
index f42e905e..efe34eac 100644
--- a/src/view-slickgrid.js
+++ b/src/view-slickgrid.js
@@ -19,9 +19,9 @@ my.SlickGrid = Backbone.View.extend({
var self = this;
this.el = $(this.el);
_.bindAll(this, 'render');
- this.model.currentDocuments.bind('add', this.render);
- this.model.currentDocuments.bind('reset', this.render);
- this.model.currentDocuments.bind('remove', this.render);
+ this.model.currentRecords.bind('add', this.render);
+ this.model.currentRecords.bind('reset', this.render);
+ this.model.currentRecords.bind('remove', this.render);
var state = _.extend({
hiddenColumns: [],
@@ -110,7 +110,7 @@ my.SlickGrid = Backbone.View.extend({
var data = [];
- this.model.currentDocuments.each(function(doc){
+ this.model.currentRecords.each(function(doc){
var row = {};
self.model.fields.each(function(field){
row[field.id] = doc.getFieldValue(field);
diff --git a/src/view-timeline.js b/src/view-timeline.js
index 18ad35ef..9d98d371 100644
--- a/src/view-timeline.js
+++ b/src/view-timeline.js
@@ -31,7 +31,7 @@ my.Timeline = Backbone.View.extend({
this.model.fields.bind('reset', function() {
self._setupTemporalField();
});
- this.model.currentDocuments.bind('all', function() {
+ this.model.currentRecords.bind('all', function() {
self.reloadData();
});
var stateData = _.extend({
@@ -78,11 +78,11 @@ my.Timeline = Backbone.View.extend({
]
}
};
- this.model.currentDocuments.each(function(doc) {
+ this.model.currentRecords.each(function(doc) {
var start = doc.get(self.state.get('startField'));
if (start) {
- var end = moment(doc.get(self.state.get('endField')));
- end = end ? end.toDate() : null;
+ var end = doc.get(self.state.get('endField'));
+ end = end ? moment(end).toDate() : null;
var tlEntry = {
"startDate": moment(start).toDate(),
"endDate": end,
diff --git a/src/view-transform-dialog.js b/src/view-transform-dialog.js
index e4bee9ae..a0ae741f 100644
--- a/src/view-transform-dialog.js
+++ b/src/view-transform-dialog.js
@@ -98,7 +98,7 @@ my.ColumnTransform = Backbone.View.extend({
}
this.el.modal('hide');
this.trigger('recline:flash', {message: "Updating all visible docs. This could take a while...", persist: true, loader: true});
- var docs = self.model.currentDocuments.map(function(doc) {
+ var docs = self.model.currentRecords.map(function(doc) {
return doc.toJSON();
});
// TODO: notify about failed docs?
@@ -107,14 +107,14 @@ my.ColumnTransform = Backbone.View.extend({
function onCompletedUpdate() {
totalToUpdate += -1;
if (totalToUpdate === 0) {
- self.trigger('recline:flash', {message: toUpdate.length + " documents updated successfully"});
+ self.trigger('recline:flash', {message: toUpdate.length + " records updated successfully"});
alert('WARNING: We have only updated the docs in this view. (Updating of all docs not yet implemented!)');
self.remove();
}
}
// TODO: Very inefficient as we search through all docs every time!
_.each(toUpdate, function(editedDoc) {
- var realDoc = self.model.currentDocuments.get(editedDoc.id);
+ var realDoc = self.model.currentRecords.get(editedDoc.id);
realDoc.set(editedDoc);
realDoc.save().then(onCompletedUpdate).fail(onCompletedUpdate);
});
@@ -158,7 +158,7 @@ my.ColumnTransform = Backbone.View.extend({
var editFunc = costco.evalFunction(e.target.value);
if (!editFunc.errorMessage) {
errors.text('No syntax error.');
- var docs = self.model.currentDocuments.map(function(doc) {
+ var docs = self.model.currentRecords.map(function(doc) {
return doc.toJSON();
});
var previewData = costco.previewTransform(docs, editFunc, self.state.currentColumn);
diff --git a/test/backend.elasticsearch.test.js b/test/backend.elasticsearch.test.js
index c0a19831..0c08607f 100644
--- a/test/backend.elasticsearch.test.js
+++ b/test/backend.elasticsearch.test.js
@@ -155,11 +155,11 @@ test("write", function() {
stop();
var id = parseInt(Math.random()*100000000).toString();
- var doc = {
+ var rec = {
id: id,
title: 'my title'
};
- var jqxhr = backend.upsert(doc);
+ var jqxhr = backend.upsert(rec);
jqxhr.done(function(data) {
ok(data.ok);
equal(data._id, id);
@@ -167,16 +167,16 @@ test("write", function() {
equal(data._version, 1);
// update
- doc.title = 'new title';
- var jqxhr = backend.upsert(doc);
+ rec.title = 'new title';
+ var jqxhr = backend.upsert(rec);
jqxhr.done(function(data) {
equal(data._version, 2);
// delete
- var jqxhr = backend.delete(doc.id);
+ var jqxhr = backend.delete(rec.id);
jqxhr.done(function(data) {
ok(data.ok);
- doc = null;
+ rec = null;
// try to get ...
var jqxhr = backend.get(id);
@@ -233,10 +233,10 @@ test("query", function() {
dataset.fetch().done(function(dataset) {
deepEqual(['_created', '_last_modified', 'end', 'owner', 'start', 'title'], _.pluck(dataset.fields.toJSON(), 'id'));
- dataset.query().then(function(docList) {
+ dataset.query().then(function(recList) {
equal(3, dataset.docCount);
- equal(3, docList.length);
- equal('Note 1', docList.models[0].get('title'));
+ equal(3, recList.length);
+ equal('Note 1', recList.models[0].get('title'));
start();
});
});
@@ -254,14 +254,14 @@ test("write", function() {
stop();
var id = parseInt(Math.random()*100000000).toString();
- var doc = new recline.Model.Document({
+ var rec = new recline.Model.Record({
id: id,
title: 'my title'
});
- doc.backend = backend;
- doc.dataset = dataset;
- dataset.currentDocuments.add(doc);
- var jqxhr = doc.save();
+ rec.backend = backend;
+ rec.dataset = dataset;
+ dataset.currentRecords.add(rec);
+ var jqxhr = rec.save();
jqxhr.done(function(data) {
ok(data.ok);
equal(data._id, id);
@@ -269,29 +269,29 @@ test("write", function() {
equal(data._version, 1);
// update
- doc.set({title: 'new title'});
- var jqxhr = doc.save();
+ rec.set({title: 'new title'});
+ var jqxhr = rec.save();
jqxhr.done(function(data) {
equal(data._version, 2);
// delete
- var jqxhr = doc.destroy();
+ var jqxhr = rec.destroy();
jqxhr.done(function(data) {
ok(data.ok);
- doc = null;
+ rec = null;
// try to get ...
- var olddoc = new recline.Model.Document({id: id});
- equal(olddoc.get('title'), null);
- olddoc.dataset = dataset;
- olddoc.backend = backend;
- var jqxhr = olddoc.fetch();
+ var oldrec = new recline.Model.Record({id: id});
+ equal(oldrec.get('title'), null);
+ oldrec.dataset = dataset;
+ oldrec.backend = backend;
+ var jqxhr = oldrec.fetch();
jqxhr.done(function(data) {
// should not be here
ok(false, 'Should have got 404');
}).error(function(error) {
equal(error.status, 404);
- equal(typeof olddoc.get('title'), 'undefined');
+ equal(typeof oldrec.get('title'), 'undefined');
start();
});
});
diff --git a/test/backend/csv.test.js b/test/backend/csv.test.js
index e47c46bf..fc944252 100644
--- a/test/backend/csv.test.js
+++ b/test/backend/csv.test.js
@@ -26,7 +26,7 @@ test("parseCSV", function() {
'"Other, AN", 12:35\n';
var dataset = recline.Backend.CSV.csvToDataset(csv);
dataset.query();
- equal(dataset.currentDocuments.length, 3);
+ equal(dataset.currentRecords.length, 3);
});
test("parseCSVsemicolon", function() {
diff --git a/test/backend/memory.test.js b/test/backend/memory.test.js
index 20ce290a..06e32e77 100644
--- a/test/backend/memory.test.js
+++ b/test/backend/memory.test.js
@@ -30,8 +30,8 @@ test('query', function () {
, from: 2
};
var out = data.query(queryObj);
- deepEqual(out.documents[0], memoryData[2]);
- equal(out.documents.length, 4);
+ deepEqual(out.records[0], memoryData[2]);
+ equal(out.records.length, 4);
equal(out.total, 6);
});
@@ -43,18 +43,18 @@ test('query sort', function () {
]
};
var out = data.query(queryObj);
- equal(out.documents[0].x, 6);
+ equal(out.records[0].x, 6);
});
test('query string', function () {
var data = _wrapData();
var out = data.query({q: 'UK'});
equal(out.total, 3);
- deepEqual(_.pluck(out.documents, 'country'), ['UK', 'UK', 'UK']);
+ deepEqual(_.pluck(out.records, 'country'), ['UK', 'UK', 'UK']);
var out = data.query({q: 'UK 6'})
equal(out.total, 1);
- deepEqual(out.documents[0].id, 1);
+ deepEqual(out.records[0].id, 1);
});
test('filters', function () {
@@ -63,7 +63,7 @@ test('filters', function () {
query.addTermFilter('country', 'UK');
var out = data.query(query.toJSON());
equal(out.total, 3);
- deepEqual(_.pluck(out.documents, 'country'), ['UK', 'UK', 'UK']);
+ deepEqual(_.pluck(out.records, 'country'), ['UK', 'UK', 'UK']);
});
test('facet', function () {
@@ -118,7 +118,7 @@ var memoryData = {
, id: 'test-dataset'
},
fields: [{id: 'x'}, {id: 'y'}, {id: 'z'}, {id: 'country'}, {id: 'label'}],
- documents: [
+ records: [
{id: 0, x: 1, y: 2, z: 3, country: 'DE', label: 'first'}
, {id: 1, x: 2, y: 4, z: 6, country: 'UK', label: 'second'}
, {id: 2, x: 3, y: 6, z: 9, country: 'US', label: 'third'}
@@ -129,16 +129,16 @@ var memoryData = {
};
function makeBackendDataset() {
- var dataset = new recline.Backend.Memory.createDataset(memoryData.documents, null, memoryData.metadata);
+ var dataset = new recline.Backend.Memory.createDataset(memoryData.records, null, memoryData.metadata);
return dataset;
}
test('createDataset', function () {
- var dataset = recline.Backend.Memory.createDataset(memoryData.documents);
+ var dataset = recline.Backend.Memory.createDataset(memoryData.records);
equal(dataset.fields.length, 6);
deepEqual(['id', 'x', 'y', 'z', 'country', 'label'], dataset.fields.pluck('id'));
dataset.query();
- equal(memoryData.documents.length, dataset.currentDocuments.length);
+ equal(memoryData.records.length, dataset.currentRecords.length);
});
test('basics', function () {
@@ -162,8 +162,8 @@ test('query', function () {
size: 4
, from: 2
};
- dataset.query(queryObj).then(function(documentList) {
- deepEqual(data[2], documentList.models[0].toJSON());
+ dataset.query(queryObj).then(function(recordList) {
+ deepEqual(data[2], recordList.models[0].toJSON());
});
});
@@ -177,7 +177,7 @@ test('query sort', function () {
]
};
dataset.query(queryObj).then(function() {
- var doc0 = dataset.currentDocuments.models[0].toJSON();
+ var doc0 = dataset.currentRecords.models[0].toJSON();
equal(doc0.x, 6);
});
});
@@ -186,13 +186,13 @@ test('query string', function () {
var dataset = makeBackendDataset();
dataset.fetch();
dataset.query({q: 'UK'}).then(function() {
- equal(dataset.currentDocuments.length, 3);
- deepEqual(dataset.currentDocuments.pluck('country'), ['UK', 'UK', 'UK']);
+ equal(dataset.currentRecords.length, 3);
+ deepEqual(dataset.currentRecords.pluck('country'), ['UK', 'UK', 'UK']);
});
dataset.query({q: 'UK 6'}).then(function() {
- equal(dataset.currentDocuments.length, 1);
- deepEqual(dataset.currentDocuments.models[0].id, 1);
+ equal(dataset.currentRecords.length, 1);
+ deepEqual(dataset.currentRecords.models[0].id, 1);
});
});
@@ -200,8 +200,8 @@ test('filters', function () {
var dataset = makeBackendDataset();
dataset.queryState.addTermFilter('country', 'UK');
dataset.query().then(function() {
- equal(dataset.currentDocuments.length, 3);
- deepEqual(dataset.currentDocuments.pluck('country'), ['UK', 'UK', 'UK']);
+ equal(dataset.currentRecords.length, 3);
+ deepEqual(dataset.currentRecords.pluck('country'), ['UK', 'UK', 'UK']);
});
});
@@ -247,7 +247,7 @@ test('update and delete', function () {
// Test Delete
doc1.destroy().then(function() {
equal(data.data.length, 5);
- equal(data.data[0].x, memoryData.documents[1].x);
+ equal(data.data[0].x, memoryData.records[1].x);
});
});
});
diff --git a/test/model.test.js b/test/model.test.js
index fef946e7..90d2e6d7 100644
--- a/test/model.test.js
+++ b/test/model.test.js
@@ -39,7 +39,7 @@ test('Field: basics', function () {
});
test('Field: default renderers', function () {
- var doc = new recline.Model.Document({
+ var doc = new recline.Model.Record({
x: 12.3,
myobject: {a: 1, b: 2},
link: 'http://abc.com/',
@@ -74,7 +74,7 @@ test('Field: default renderers', function () {
});
test('Field: custom deriver and renderer', function () {
- var doc = new recline.Model.Document({x: 123});
+ var doc = new recline.Model.Record({x: 123});
var cellRenderer = function(value, field) {
return '' + value + '';
}
diff --git a/test/view-grid.test.js b/test/view-grid.test.js
index 4d2d0a96..d455173c 100644
--- a/test/view-grid.test.js
+++ b/test/view-grid.test.js
@@ -38,7 +38,7 @@ test('state', function () {
test('new GridRow View', function () {
var $el = $('