From b3e68c152df78df7667741794055a5f652cef04f Mon Sep 17 00:00:00 2001 From: Daniel Beilinson Date: Tue, 23 Oct 2012 23:06:52 +0400 Subject: [PATCH 01/16] couchDB broken sort and filter fixed --- src/backend.couchdb.js | 83 +++++++++++++++++++++++++++++++++++------- 1 file changed, 70 insertions(+), 13 deletions(-) diff --git a/src/backend.couchdb.js b/src/backend.couchdb.js index 1691f756..4d338b48 100755 --- a/src/backend.couchdb.js +++ b/src/backend.couchdb.js @@ -317,12 +317,15 @@ my.query = function(queryObj, dataset) { query_result.hits = _applyFreeTextQuery(query_result.hits, queryObj); // not complete sorting! _.each(queryObj.sort, function(sortObj) { - var fieldName = _.keys(sortObj)[0]; - query_result.hits = _.sortBy(query_result.hits, function(doc) { - var _out = doc[fieldName]; - return (sortObj[fieldName].order == 'asc') ? _out : -1*_out; + var fieldName = sortObj.field; + query_result.hits = _.sortBy(query_result.hits, function(doc) { + var _out = doc[fieldName]; + return _out; + }); + if (sortObj.order == 'desc') { + query_result.hits.reverse(); + } }); - }); query_result.total = query_result.hits.length; query_result.facets = _computeFacets(query_result.hits, queryObj); query_result.hits = query_result.hits.slice(cdb_q.skip, cdb_q.skip + cdb_q.limit+1); @@ -335,13 +338,67 @@ my.query = function(queryObj, dataset) { // in place filtering _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]); - }); - }); - return results; + var filters = queryObj.filters; + // register filters + var filterFunctions = { + term : term, + range : range, + geo_distance : geo_distance + }; + var dataParsers = { + integer: function (e) { return parseFloat(e, 10); }, + 'float': function (e) { return parseFloat(e, 10); }, + string : function (e) { return e.toString() }, + date : function (e) { return new Date(e).valueOf() }, + datetime : function (e) { return new Date(e).valueOf() } + }; + + function getDataParser(filter) { + //sample = results[0][filter.field]); + var fieldType = 'string'; + return dataParsers[fieldType]; + } + + // filter records + return _.filter(results, function (record) { + //alert(record); + var passes = _.map(filters, function (filter) { + return filterFunctions[filter.type](record, filter); + }); + + // return only these records that pass all filters + //alert(passes); + return _.all(passes, _.identity); + }); + + // filters definitions + function term(record, filter) { + var parse = getDataParser(filter); + var value = parse(record[filter.field]); + var term = parse(filter.term); + + return (value === term); + } + + function range(record, filter) { + var startnull = (filter.start == null || filter.start === ''); + var stopnull = (filter.stop == null || filter.stop === ''); + var parse = getDataParser(filter); + var value = parse(record[filter.field]); + var start = parse(filter.start); + var stop = parse(filter.stop); + + // if at least one end of range is set do not allow '' to get through + // note that for strings '' <= {any-character} e.g. '' <= 'a' + if ((!startnull || !stopnull) && value === '') { + return false; + } + return ((startnull || value >= start) && (stopnull || value <= stop)); + } + + function geo_distance() { + // TODO code here + } }; // we OR across fields but AND across terms in query string @@ -498,4 +555,4 @@ _deleteDocument = function (del_doc, dataset) { return dfd.promise(); } }; -}(jQuery, this.recline.Backend.CouchDB)); +}(jQuery, this.recline.Backend.CouchDB)); \ No newline at end of file From 7e471407a3b0963aebcd4f44520edbb100906f7e Mon Sep 17 00:00:00 2001 From: Daniel Beilinson Date: Wed, 24 Oct 2012 23:13:28 +0400 Subject: [PATCH 02/16] _createDocument fixed, randomId function added --- src/backend.couchdb.js | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/src/backend.couchdb.js b/src/backend.couchdb.js index 4d338b48..570bfbf4 100755 --- a/src/backend.couchdb.js +++ b/src/backend.couchdb.js @@ -361,13 +361,11 @@ _applyFilters = function(results, queryObj) { // filter records return _.filter(results, function (record) { - //alert(record); var passes = _.map(filters, function (filter) { return filterFunctions[filter.type](record, filter); }); // return only these records that pass all filters - //alert(passes); return _.all(passes, _.identity); }); @@ -463,6 +461,18 @@ _computeFacets = function(records, queryObj) { }); return facetResults; }; + +//Define random Id for new records without _id +function randomId(length, chars) { + var mask = ''; + if (chars.indexOf('a') > -1) mask += 'abcdefghijklmnopqrstuvwxyz'; + if (chars.indexOf('A') > -1) mask += 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'; + if (chars.indexOf('#') > -1) mask += '0123456789'; + if (chars.indexOf('!') > -1) mask += '~`!@#$%^&*()_+-={}[]:";\'<>?,./|\\'; + var result = ''; + for (var i = length; i > 0; --i) result += mask[Math.round(Math.random() * (mask.length - 1))]; + return result; +} _createDocument = function (new_doc, dataset) { var dfd = $.Deferred(); @@ -471,25 +481,17 @@ _createDocument = function (new_doc, dataset) { var _id = new_doc['id']; var cdb = new my.CouchDBWrapper(db_url, view_url); - delete new_doc['id']; + delete new_doc['id']; - if (view_url.search('_all_docs') !== -1) { - jqxhr = cdb.get(_id); + if (dataset.record_create) + new_doc = dataset.record_create(new_doc); + if (_id !== 1) { + new_doc['_id'] = _id; } else { - _id = new_doc['_id'].split('__')[0]; - jqxhr = cdb.get(_id); + new_doc['_id'] = randomId(16, '#a'); } - - jqxhr.done(function(old_doc){ - if (dataset.record_create) - new_doc = dataset.record_create(new_doc, old_doc); - new_doc = _.extend(old_doc, new_doc); - new_doc['_id'] = _id; - dfd.resolve(cdb.upsert(new_doc)); - }).fail(function(args){ - dfd.reject(args); - }); + dfd.resolve(cdb.upsert(new_doc)); return dfd.promise(); }; From 7a12003a35a5099c3c92b2f8c9a06826d22ae696 Mon Sep 17 00:00:00 2001 From: Daniel Beilinson Date: Mon, 29 Oct 2012 01:43:52 +0400 Subject: [PATCH 03/16] undfinded _id for couchDB, 33 symbols ID generator --- src/backend.couchdb.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/backend.couchdb.js b/src/backend.couchdb.js index 570bfbf4..0ef3f625 100755 --- a/src/backend.couchdb.js +++ b/src/backend.couchdb.js @@ -485,11 +485,11 @@ _createDocument = function (new_doc, dataset) { if (dataset.record_create) new_doc = dataset.record_create(new_doc); - if (_id !== 1) { + if (_id !== 1 && _id !== undefined) { new_doc['_id'] = _id; } else { - new_doc['_id'] = randomId(16, '#a'); + new_doc['_id'] = randomId(32, '#a'); } dfd.resolve(cdb.upsert(new_doc)); From c7ff853acbac4e1af165e37c67ceade96c1109d1 Mon Sep 17 00:00:00 2001 From: Frederick Ros Date: Mon, 22 Oct 2012 19:07:57 +0200 Subject: [PATCH 04/16] Fixed typo in comments --- src/view.slickgrid.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/view.slickgrid.js b/src/view.slickgrid.js index c751c83f..bc98f09a 100644 --- a/src/view.slickgrid.js +++ b/src/view.slickgrid.js @@ -24,8 +24,8 @@ this.recline.View = this.recline.View || {}; // state: { // gridOptions: {editable: true}, // columnsEditor: [ -// {column: 'date', editor: Slick.Editor.Date }, -// {column: 'title', editor: Slick.Editor.Text} +// {column: 'date', editor: Slick.Editors.Date }, +// {column: 'title', editor: Slick.Editors.Text} // ] // } // }); From 24ee9fa0196cbd3f9e0f273df1eab1cf4562c4b7 Mon Sep 17 00:00:00 2001 From: Frederick Ros Date: Sun, 21 Oct 2012 01:56:02 +0200 Subject: [PATCH 05/16] Update the grid when a record is changed Fixes #255 --- src/view.slickgrid.js | 34 +++++++++++++++++++++++++++++----- test/view.slickgrid.test.js | 25 +++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 5 deletions(-) diff --git a/src/view.slickgrid.js b/src/view.slickgrid.js index bc98f09a..d9f61deb 100644 --- a/src/view.slickgrid.js +++ b/src/view.slickgrid.js @@ -39,6 +39,7 @@ my.SlickGrid = Backbone.View.extend({ this.model.records.bind('add', this.render); this.model.records.bind('reset', this.render); this.model.records.bind('remove', this.render); + this.model.records.bind('change', this.onRecordChanged, this) var state = _.extend({ hiddenColumns: [], @@ -58,6 +59,19 @@ my.SlickGrid = Backbone.View.extend({ events: { }, + onRecordChanged: function(record) { + // Ignore if the grid is not yet drawn + if (!this.grid) { + return; + } + + // Let's find the row corresponding to the index + var row_index = this.grid.getData().getModelRow( record ); + this.grid.invalidateRow(row_index); + this.grid.getData().updateItem(record, row_index); + this.grid.render(); + }, + render: function() { var self = this; @@ -129,6 +143,15 @@ my.SlickGrid = Backbone.View.extend({ } columns = columns.concat(tempHiddenColumns); + // Transform a model object into a row + function toRow(m) { + var row = {}; + self.model.fields.each(function(field){ + row[field.id] = m.getFieldValueUnrendered(field); + }); + return row; + } + function RowSet() { var models = []; var rows = []; @@ -142,16 +165,17 @@ my.SlickGrid = Backbone.View.extend({ this.getItem = function(index) { return rows[index];} this.getItemMetadata= function(index) { return {};} this.getModel= function(index) { return models[index]; } + this.getModelRow = function(m) { return models.indexOf(m);} + this.updateItem = function(m,i) { + rows[i] = toRow(m); + models[i] = m + }; }; var data = new RowSet(); this.model.records.each(function(doc){ - var row = {}; - self.model.fields.each(function(field){ - row[field.id] = doc.getFieldValueUnrendered(field); - }); - data.push(doc, row); + data.push(doc, toRow(doc)); }); this.grid = new Slick.Grid(this.el, data, visibleColumns, options); diff --git a/test/view.slickgrid.test.js b/test/view.slickgrid.test.js index f3cf05f3..0ff639b1 100644 --- a/test/view.slickgrid.test.js +++ b/test/view.slickgrid.test.js @@ -101,6 +101,31 @@ test('editable', function () { }, e, view.grid); }); +test('update', function() { + var dataset = Fixture.getDataset(); + var view = new recline.View.SlickGrid({ + model: dataset, + state: { + hiddenColumns:['x','lat','title'], + columnsOrder:['lon','id','z','date', 'y', 'country'], + columnsWidth:[ + {column:'id',width: 250} + ], + gridOptions: {editable: true}, + columnsEditor: [{column: 'country', editor: Slick.Editors.Text}] + } + }); + + $('.fixtures .test-datatable').append(view.el); + view.render(); + view.grid.init(); + + var zbefore = view.grid.getData().getItem(1)['z']; + // Change the model at row 1 + dataset.records.at(1).set('z', zbefore + 1); + equal( zbefore + 1, view.grid.getData().getItem(1)['z']); +}); + test('renderers', function () { var dataset = Fixture.getDataset(); From 4e8a8eb340c6d0d4b40934e2ad184f48fd479052 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 2 Nov 2012 09:36:25 +0000 Subject: [PATCH 06/16] [#183,demos/search][xs]: rename js file. --- demos/search/{app.js => demo.search.app.js} | 0 demos/search/index.html | 4 ++-- 2 files changed, 2 insertions(+), 2 deletions(-) rename demos/search/{app.js => demo.search.app.js} (100%) diff --git a/demos/search/app.js b/demos/search/demo.search.app.js similarity index 100% rename from demos/search/app.js rename to demos/search/demo.search.app.js diff --git a/demos/search/index.html b/demos/search/index.html index a26646b6..ae54b243 100644 --- a/demos/search/index.html +++ b/demos/search/index.html @@ -85,7 +85,7 @@ ul.facet-items {
-

This demo shows how Recline can be used to build a search app. It includes faceting as well as search. You can find the source javascript here – please feel free to reuse!

+

This demo shows how Recline can be used to build a search app. It includes faceting as well as search. You can find the source javascript here – please feel free to reuse!

The default setup uses local example data but you can also connect directly to any other backend supported by Recline, for example SOLR, ElasticSearch or even a google docs spreadsheet. As an example: here's an example running against the SOLR-style OpenSpending API and here's an example running against a GDocs spreadsheet (Oil spills in the Niger Delta).

@@ -95,5 +95,5 @@ ul.facet-items {
- + From da1da609427b0dee3d9493032760724b093cd1ff Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 2 Nov 2012 09:56:09 +0000 Subject: [PATCH 07/16] [docs][xs]: latest version of docco.css. --- docs/src/docco.css | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/src/docco.css b/docs/src/docco.css index 5aa0a8d7..04cc7ecb 100644 --- a/docs/src/docco.css +++ b/docs/src/docco.css @@ -21,6 +21,12 @@ h1, h2, h3, h4, h5, h6 { h1 { margin-top: 40px; } +hr { + border: 0 none; + border-top: 1px solid #e5e5ee; + height: 1px; + margin: 20px 0; +} #container { position: relative; } @@ -115,7 +121,7 @@ table td { } pre, tt, code { font-size: 12px; line-height: 18px; - font-family: Monaco, Consolas, "Lucida Console", monospace; + font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace; margin: 0; padding: 0; } From 3362083db6d151ae19c1522e51ba2071fbb531b1 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 2 Nov 2012 09:58:42 +0000 Subject: [PATCH 08/16] [#183,demos/search][s]: improve commenting in search demo js and produced docco'd version. --- demos/search/demo.search.app.js | 72 +++++++--- demos/search/index.html | 2 +- docs/src/demo.search.app.html | 236 ++++++++++++++++++++++++++++++++ 3 files changed, 293 insertions(+), 17 deletions(-) create mode 100644 docs/src/demo.search.app.html diff --git a/demos/search/demo.search.app.js b/demos/search/demo.search.app.js index df2f9bfc..72b5937a 100644 --- a/demos/search/demo.search.app.js +++ b/demos/search/demo.search.app.js @@ -1,25 +1,43 @@ +// (c) Open Knowledge Foundation 2012. Dedicated to the public domain. Please +// use and reuse freely - you don't even need to credit (though a link back to +// ReclineJS.com is always appreciated)! + + +// ## Our main loop - on document ready jQuery(function($) { var $el = $('.search-here'); + // ### Overview + // + // We have a slightly more complex setup than is needed to allow for using + // this demo with different backends + // + // There are 2 alternatives: more complex and a simpler one + // + // If you just want to see how this work skip to the simple case ... + + // ### 1. More complex - use data from a backend configured in query string + // Check for config from url query string - // (this allows us to point to specific data sources backends) var config = recline.View.parseQueryString(decodeURIComponent(window.location.search)); if (config.backend) { + // If we had it hand off to our more complex example setup setupMoreComplexExample(config); return; } - // the simple example case + // ### 2. The simple example case + // + // We will just set up from some example local data (at the bottom of thile file) - // Create our Recline Dataset - // We'll just use some sample local data (see end of this file) + // #### Create our Recline Dataset from sample local data var dataset = new recline.Model.Dataset({ records: sampleData }); - // Set up the search View - - // We give it a custom template for rendering the example records + // #### Custom template + // + // Create a custom template for rendering the records var template = ' \
\

\ @@ -29,6 +47,8 @@ jQuery(function($) {

${{price}}

\

\ '; + + // #### Set up the search View (using custom template) var searchView = new SearchView({ el: $el, model: dataset, @@ -36,40 +56,48 @@ jQuery(function($) { }); searchView.render(); - // Optional - we configure the initial query a bit and set up facets + // #### Optional - we configure the initial query a bit and set up facets dataset.queryState.set({ size: 10 }, {silent: true} ); dataset.queryState.addFacet('Author'); - // Now do the first query - // After this point the Search View will take over handling queries + + // #### Finally - now do the first query + // + // After this point the Search View will take over handling queries! dataset.query(); }); -// Simple Search View +// ## Simple Search View // -// Pulls together various Recline UI components and the central Dataset and Query (state) object -// -// Plus support for customization e.g. of template for list of results +// This is a simple bespoke Backbone view for the Search. It Pulls together +// various Recline UI components and the central Dataset and Query (state) +// object // +// It also provides simple support for customization e.g. of template for list of results // // var view = new SearchView({ // el: $('some-element'), // model: dataset +// // EITHER a mustache template (passed a JSON version of recline.Model.Record +// // OR a function which receives a record in JSON form and returns html // template: mustache-template-or-function // }); var SearchView = Backbone.View.extend({ initialize: function(options) { this.el = $(this.el); _.bindAll(this, 'render'); - this.recordTemplate = options.template || this.defaultTemplate; + this.recordTemplate = options.template; + // Every time we do a search the recline.Dataset.records Backbone + // collection will get reset. We want to re-render each time! this.model.records.bind('reset', this.render); this.templateResults = options.template; }, + // overall template for this view template: ' \
\
\ @@ -84,6 +112,7 @@ var SearchView = Backbone.View.extend({
\ ', + // render the view render: function() { var results = ''; if (_.isFunction(this.templateResults)) { @@ -100,8 +129,13 @@ var SearchView = Backbone.View.extend({ }); this.el.html(html); + // Set the total records found info this.el.find('.total span').text(this.model.recordCount); + // ### Now setup all the extra mini-widgets + // + // Facets, Pager, QueryEditor etc + var view = new recline.View.FacetViewer({ model: this.model }); @@ -121,8 +155,14 @@ var SearchView = Backbone.View.extend({ }); // -------------------------------------------------------- -// Stuff very specific to this demo +// ## Custom code very specific to this demo +// e.g. to provide custom templates for the google doc and openspending examples + + +// ### Handle case where we get data from a specific backend +// +// Includes providing custom templates function setupMoreComplexExample(config) { var $el = $('.search-here'); var dataset = new recline.Model.Dataset(config); diff --git a/demos/search/index.html b/demos/search/index.html index ae54b243..e19ada5b 100644 --- a/demos/search/index.html +++ b/demos/search/index.html @@ -85,7 +85,7 @@ ul.facet-items {
-

This demo shows how Recline can be used to build a search app. It includes faceting as well as search. You can find the source javascript here – please feel free to reuse!

+

This demo shows how Recline can be used to build a search app. It includes faceting as well as search. You can find the source javascript here (plus prettified version of source for readability) – please feel free to reuse!

The default setup uses local example data but you can also connect directly to any other backend supported by Recline, for example SOLR, ElasticSearch or even a google docs spreadsheet. As an example: here's an example running against the SOLR-style OpenSpending API and here's an example running against a GDocs spreadsheet (Oil spills in the Niger Delta).

diff --git a/docs/src/demo.search.app.html b/docs/src/demo.search.app.html new file mode 100644 index 00000000..e97a180f --- /dev/null +++ b/docs/src/demo.search.app.html @@ -0,0 +1,236 @@ + demo.search.app.js

demo.search.app.js

(c) Open Knowledge Foundation 2012. Dedicated to the public domain. Please +use and reuse freely - you don't even need to credit (though a link back to +ReclineJS.com is always appreciated)!

Our main loop - on document ready

jQuery(function($) {
+  var $el = $('.search-here');

Overview

+ +

We have a slightly more complex setup than is needed to allow for using +this demo with different backends

+ +

There are 2 alternatives: more complex and a simpler one

+ +

If you just want to see how this work skip to the simple case ...

1. More complex - use data from a backend configured in query string

Check for config from url query string

  var config = recline.View.parseQueryString(decodeURIComponent(window.location.search));
+  if (config.backend) {

If we had it hand off to our more complex example setup

    setupMoreComplexExample(config);
+    return;
+  }

2. The simple example case

+ +

We will just set up from some example local data (at the bottom of thile file)

Create our Recline Dataset from sample local data

  var dataset = new recline.Model.Dataset({
+    records: sampleData
+  });

Custom template

+ +

Create a custom template for rendering the records

  var template = ' \
+    <div class="record"> \
+      <h3> \
+        {{title}} <em>by {{Author}}</em> \
+      </h3> \
+      <p>{{description}}</p> \
+      <p><code>${{price}}</code></p> \
+    </div> \
+  ';

Set up the search View (using custom template)

  var searchView = new SearchView({
+    el: $el,
+    model: dataset,
+    template: template 
+  });
+  searchView.render();

Optional - we configure the initial query a bit and set up facets

  dataset.queryState.set({
+      size: 10
+    },
+    {silent: true}
+  );
+  dataset.queryState.addFacet('Author');

Finally - now do the first query

+ +

After this point the Search View will take over handling queries!

  dataset.query();
+});

Simple Search View

+ +

This is a simple bespoke Backbone view for the Search. It Pulls together +various Recline UI components and the central Dataset and Query (state) +object

+ +

It also provides simple support for customization e.g. of template for list of results

+ +
 var view = new SearchView({
+   el: $('some-element'),
+   model: dataset
+   // EITHER a mustache template (passed a JSON version of recline.Model.Record
+   // OR a function which receives a record in JSON form and returns html
+   template: mustache-template-or-function
+ });
+
var SearchView = Backbone.View.extend({
+  initialize: function(options) {
+    this.el = $(this.el);
+    _.bindAll(this, 'render');
+    this.recordTemplate = options.template;

Every time we do a search the recline.Dataset.records Backbone +collection will get reset. We want to re-render each time!

    this.model.records.bind('reset', this.render);
+    this.templateResults = options.template;
+  },

overall template for this view

  template: ' \
+    <div class="controls"> \
+      <div class="query-here"></div> \
+    </div> \
+    <div class="total"><h2><span></span> records found</h2></div> \
+    <div class="body"> \
+      <div class="sidebar"></div> \
+      <div class="results"> \
+        {{{results}}} \
+      </div> \
+    </div> \
+    <div class="pager-here"></div> \
+  ',
+ 

render the view

  render: function() {
+    var results = '';
+    if (_.isFunction(this.templateResults)) {
+      var results = _.map(this.model.records.toJSON(), this.templateResults).join('\n');
+    } else {

templateResults is just for one result ...

      var tmpl = '{{#records}}' + this.templateResults + '{{/records}}'; 
+      var results = Mustache.render(tmpl, {
+        records: this.model.records.toJSON()
+      });
+    }
+    var html = Mustache.render(this.template, {
+      results: results
+    });
+    this.el.html(html);

Set the total records found info

    this.el.find('.total span').text(this.model.recordCount);

Now setup all the extra mini-widgets

+ +

Facets, Pager, QueryEditor etc

    var view = new recline.View.FacetViewer({
+      model: this.model
+    });
+    view.render();
+    this.el.find('.sidebar').append(view.el);
+
+    var pager = new recline.View.Pager({
+      model: this.model.queryState
+    });
+    this.el.find('.pager-here').append(pager.el);
+
+    var queryEditor = new recline.View.QueryEditor({
+      model: this.model.queryState
+    });
+    this.el.find('.query-here').append(queryEditor.el);
+  }
+});

+ +

Custom code very specific to this demo

e.g. to provide custom templates for the google doc and openspending examples

Handle case where we get data from a specific backend

+ +

Includes providing custom templates

function setupMoreComplexExample(config) {
+  var $el = $('.search-here');
+  var dataset = new recline.Model.Dataset(config);

async as may be fetching remote

  dataset.fetch().done(function() {
+    var template = templates[dataset.get('url')] || templates['generic'];
+    var searchView = new SearchView({
+      el: $el,
+      model: dataset,
+      template: template 
+    });
+    searchView.render();
+
+    dataset.queryState.set({
+        size: 5
+      },
+      {silent: true}
+    );
+    if (dataset.get('url') in templates) {

for gdocs example

      dataset.queryState.addFacet('cause');
+    }
+    dataset.query();
+  });
+};
+
+var templates = {

generic template function

  'generic': function(record) {
+    var template = '<div class="record"> \
+      <ul> \
+       {{#data}} \
+       <li>{{key}}: {{value}}</li> \
+       {{/data}} \
+     </ul> \
+    </div> \
+    ';
+    var data = _.map(_.keys(record), function(key) {
+      return { key: key, value: record[key] };
+    });
+    return Mustache.render(template, {
+      data: data
+    });
+  },
+  'http://openspending.org/api/search': function(record) {
+    record['time'] = record['time.label_facet']
+    var template = '<div class="record"> \
+      <h3> \
+        <a href="http://openspending.org/{{record.dataset}}/entries/{{record.id}}">{{record.dataset}} {{record.time}}</a> \
+        &ndash; <img src="http://openspending.org/static/img/icons/cd_16x16.png" /> {{amount_formatted}} \
+      </h3> \
+      <ul> \
+       {{#data}} \
+         <li>{{key}}: {{value}}</li> \
+       {{/data}} \
+       </ul> \
+    </div> \
+    ';
+    var data = [];
+    _.each(_.keys(record), function(key) {
+      if (key !='_id' && key != 'id') {
+        data.push({ key: key, value: record[key] });
+      }
+    });
+    return Mustache.render(template, {
+      record: record,
+      amount_formatted: formatAmount(record['amount']),
+      data: data
+    });
+  },
+  'https://docs.google.com/spreadsheet/ccc?key=0Aon3JiuouxLUdExXSTl2Y01xZEszOTBFZjVzcGtzVVE': function(record) {
+    var template = '<div class="record"> \
+      <h3> \
+        {{record.incidentsite}} &ndash; {{record.datereported}} &ndash; {{record.estimatedspillvolumebbl}} barrels \
+      </h3> \
+      <ul> \
+       {{#data}} \
+         <li>{{key}}: {{value}}</li> \
+       {{/data}} \
+       </ul> \
+    </div> \
+    ';
+    var data = [];
+    _.each(_.keys(record), function(key) {
+      data.push({ key: key, value: record[key] });
+    });
+    return Mustache.render(template, {
+      record: record,
+      data: data
+    });
+  }
+}
+
+var sampleData = [
+  {
+    title: 'War and Peace',
+    description: 'The epic tale of love, war and history',
+    Author: 'Tolstoy',
+    price: 7.99
+  },
+  {
+    title: 'Anna Karenina',
+    description: 'How things go wrong in love and ultimately lead to suicide. This is why you should not have affairs, girls!',
+    Author: 'Tolstoy',
+    price: 8.50
+  },
+  {
+    title: "Fathers and Sons",
+    description: "Another 19th century Russian novel",
+    Author: "Turgenev",
+    price: 11
+  }
+];
+
+var formatAmount = function (num) {
+  var billion = 1000000000;
+  var million = 1000000;
+  var thousand = 1000;
+  var numabs = Math.abs(num);
+  if (numabs > billion) {
+    return (num / billion).toFixed(0) + 'bn';
+  }
+  if (numabs > (million / 2)) {
+    return (num / million).toFixed(0) + 'm';
+  }
+  if (numabs > thousand) {
+    return (num / thousand).toFixed(0) + 'k';
+  } else {
+    return num.toFixed(0);
+  }
+};
+
+
\ No newline at end of file From b2cd87cec453baa177e61e88c2bfbaa7494d414d Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Mon, 19 Nov 2012 12:24:06 +0000 Subject: [PATCH 09/16] Revert "Merge pull request #275 from citizen-cyberscience-centre/master". This reverts commit b900581605e7612bd896e4f1bec7837784a1ebbc, reversing changes made to 3226d8b11b1d41bdafcdab6f9ea424d3f553cbe3. --- src/view.timeline.js | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/view.timeline.js b/src/view.timeline.js index f49e119c..d00cb577 100644 --- a/src/view.timeline.js +++ b/src/view.timeline.js @@ -142,10 +142,7 @@ my.Timeline = Backbone.View.extend({ var out = date.trim(); out = out.replace(/(\d)th/g, '$1'); out = out.replace(/(\d)st/g, '$1'); - // parse a date in yyyy-mm-dd hh:mm format - var parts = out.match(/(\d+)/g); - out = new Date(parts[0],parts[1]-1,parts[2],parts[3],parts[4]); - out = moment(out); + out = out.trim() ? moment(out) : null; if (out.toDate() == 'Invalid Date') { return null; } else { From 5a322e2c7c23eb1a753992579c0e4c0e4de67eb1 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 9 Dec 2012 18:58:52 +0000 Subject: [PATCH 10/16] [#286,bugfix]: fix for case where fields array has nulls in it. If passed fields = [ null, ..., ...] or [ ... , null, ...] we fail in Dataset._normalizeRecordsAndFields method because: 1. If null is first element we do not do field generation correctly because typeof(null) is object - https://github.com/okfn/recline/blob/ede211646ad6baa82cfb3e53a599b1547abc2c6f/src/model.js#L108 2. We call toString on field names which fails for null https://github.com/okfn/recline/blob/ede211646ad6baa82cfb3e53a599b1547abc2c6f/src/model.js#L113 --- src/model.js | 8 ++++++-- test/model.test.js | 9 +++++---- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/src/model.js b/src/model.js index 84d0b14f..f5354210 100644 --- a/src/model.js +++ b/src/model.js @@ -105,12 +105,16 @@ my.Dataset = Backbone.Model.extend({ } // fields is an array of strings (i.e. list of field headings/ids) - if (fields && fields.length > 0 && typeof(fields[0]) != 'object') { + if (fields && fields.length > 0 && (fields[0] === null || typeof(fields[0]) != 'object')) { // Rename duplicate fieldIds as each field name needs to be // unique. var seen = {}; fields = _.map(fields, function(field, index) { - field = field.toString(); + if (field === null) { + field = ''; + } else { + field = field.toString(); + } // cannot use trim as not supported by IE7 var fieldId = field.replace(/^\s+|\s+$/g, ''); if (fieldId === '') { diff --git a/test/model.test.js b/test/model.test.js index 8f7dd909..0d227908 100644 --- a/test/model.test.js +++ b/test/model.test.js @@ -180,21 +180,22 @@ test('_normalizeRecordsAndFields', function () { records: null }, }, + // non-string fields { in_: { - fields: [ 1, 1, 3 ], - records: null + fields: [ null, 1, 1, 3 ], + records: [ [1,2,3,4] ] }, exp: { fields: [ + {id: '_noname_'}, {id: '1'}, {id: '11'}, {id: '3'} ], - records: null + records: [ { '_noname_': 1, '1': 2, '11': 3, '3': 4 } ] }, }, - // field is *not* a string // records array but no fields { in_: { From 8b2a076387c6a9b49f7c70479ffb9bea4d121136 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 9 Dec 2012 19:04:17 +0000 Subject: [PATCH 11/16] [#187,make][xs]: minify build command. --- make | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/make b/make index cc13d407..0e2b3900 100755 --- a/make +++ b/make @@ -28,6 +28,13 @@ def docs(): os.system('cd /tmp/recline-docs && %s %s && mv docs/* %s' % (docco_executable,files, dest)) print("** Docs built ok") +def minify(): + cmd = 'uglifyjs -o %s %s' % ('dist/recline.min.js', 'dist/recline.js') + os.system(cmd) + + cmd = 'uglifyjs -o %s %s' % ('dist/recline.dataset.min.js', 'dist/recline.dataset.js') + os.system(cmd) + if __name__ == '__main__': if not len(sys.argv) > 1: print 'make cat | docs | all' @@ -37,7 +44,10 @@ if __name__ == '__main__': cat() elif action == 'docs': docs() + elif action == 'minify': + minify() elif action == 'all': cat() docs() + minify() From 7f35cffe3c0648abd0993fe00fc5058045f0ec82 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sun, 9 Dec 2012 19:05:27 +0000 Subject: [PATCH 12/16] [build][xs]: build from latest code. --- dist/recline.dataset.js | 15 ++- dist/recline.js | 215 ++++++++++++++++++++++++++++++++++------ 2 files changed, 195 insertions(+), 35 deletions(-) diff --git a/dist/recline.dataset.js b/dist/recline.dataset.js index 2258a6a9..dfb4e401 100644 --- a/dist/recline.dataset.js +++ b/dist/recline.dataset.js @@ -105,12 +105,16 @@ my.Dataset = Backbone.Model.extend({ } // fields is an array of strings (i.e. list of field headings/ids) - if (fields && fields.length > 0 && typeof(fields[0]) != 'object') { + if (fields && fields.length > 0 && (fields[0] === null || typeof(fields[0]) != 'object')) { // Rename duplicate fieldIds as each field name needs to be // unique. var seen = {}; fields = _.map(fields, function(field, index) { - field = field.toString(); + if (field === null) { + field = ''; + } else { + field = field.toString(); + } // cannot use trim as not supported by IE7 var fieldId = field.replace(/^\s+|\s+$/g, ''); if (fieldId === '') { @@ -495,7 +499,11 @@ my.Query = Backbone.Model.extend({ var ourfilter = JSON.parse(JSON.stringify(filter)); // not fully specified so use template and over-write if (_.keys(filter).length <= 3) { - ourfilter = _.extend(this._filterTemplates[filter.type], ourfilter); + ourfilter = _.extend( + // crude deep copy + JSON.parse(JSON.stringify(this._filterTemplates[filter.type])), + ourfilter + ); } var filters = this.get('filters'); filters.push(ourfilter); @@ -686,6 +694,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; var dataParsers = { integer: function (e) { return parseFloat(e, 10); }, 'float': function (e) { return parseFloat(e, 10); }, + number: function (e) { return parseFloat(e, 10); }, string : function (e) { return e.toString() }, date : function (e) { return new Date(e).valueOf() }, datetime : function (e) { return new Date(e).valueOf() } diff --git a/dist/recline.js b/dist/recline.js index 3b195524..17e09693 100644 --- a/dist/recline.js +++ b/dist/recline.js @@ -910,7 +910,7 @@ this.recline.Backend.GDocs = this.recline.Backend.GDocs || {}; // Convenience function to get GDocs JSON API Url from standard URL my.getGDocsAPIUrls = function(url) { // https://docs.google.com/spreadsheet/ccc?key=XXXX#gid=YYY - var regex = /.*spreadsheet\/ccc?.*key=([^#?&+]+).*gid=([\d]+).*/; + var regex = /.*spreadsheet\/ccc?.*key=([^#?&+]+)[^#]*(#gid=([\d]+).*)?/; var matches = url.match(regex); var key; var worksheet; @@ -919,7 +919,10 @@ this.recline.Backend.GDocs = this.recline.Backend.GDocs || {}; if(!!matches) { key = matches[1]; // the gid in url is 0-based and feed url is 1-based - worksheet = parseInt(matches[2]) + 1; + worksheet = parseInt(matches[3]) + 1; + if (isNaN(worksheet)) { + worksheet = 1; + } urls = { worksheet : 'https://spreadsheets.google.com/feeds/list/'+ key +'/'+ worksheet +'/public/values?alt=json', spreadsheet: 'https://spreadsheets.google.com/feeds/worksheets/'+ key +'/public/basic?alt=json' @@ -1042,6 +1045,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; var dataParsers = { integer: function (e) { return parseFloat(e, 10); }, 'float': function (e) { return parseFloat(e, 10); }, + number: function (e) { return parseFloat(e, 10); }, string : function (e) { return e.toString() }, date : function (e) { return new Date(e).valueOf() }, datetime : function (e) { return new Date(e).valueOf() } @@ -1178,6 +1182,71 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; }(jQuery, this.recline.Backend.Memory)); this.recline = this.recline || {}; +this.recline.Backend = this.recline.Backend || {}; +this.recline.Backend.Solr = this.recline.Backend.Solr || {}; + +(function($, my) { + my.__type__ = 'solr'; + + // ### fetch + // + // dataset must have a solr or url attribute pointing to solr endpoint + my.fetch = function(dataset) { + var jqxhr = $.ajax({ + url: dataset.solr || dataset.url, + data: { + rows: 1, + wt: 'json' + }, + dataType: 'jsonp', + jsonp: 'json.wrf' + }); + var dfd = $.Deferred(); + jqxhr.done(function(results) { + // if we get 0 results we cannot get fields + var fields = [] + if (results.response.numFound > 0) { + fields = _.map(_.keys(results.response.docs[0]), function(fieldName) { + return { id: fieldName }; + }); + } + var out = { + fields: fields, + useMemoryStore: false + }; + dfd.resolve(out); + }); + return dfd.promise(); + } + + // TODO - much work on proper query support is needed!! + my.query = function(queryObj, dataset) { + var q = queryObj.q || '*:*'; + var data = { + q: q, + rows: queryObj.size, + start: queryObj.from, + wt: 'json' + }; + var jqxhr = $.ajax({ + url: dataset.solr || dataset.url, + data: data, + dataType: 'jsonp', + jsonp: 'json.wrf' + }); + var dfd = $.Deferred(); + jqxhr.done(function(results) { + var out = { + total: results.response.numFound, + hits: results.response.docs + }; + dfd.resolve(out); + }); + return dfd.promise(); + }; + +}(jQuery, this.recline.Backend.Solr)); +this.recline = this.recline || {}; this.recline.Data = this.recline.Data || {}; (function(my) { @@ -1417,12 +1486,16 @@ my.Dataset = Backbone.Model.extend({ } // fields is an array of strings (i.e. list of field headings/ids) - if (fields && fields.length > 0 && typeof(fields[0]) != 'object') { + if (fields && fields.length > 0 && (fields[0] === null || typeof(fields[0]) != 'object')) { // Rename duplicate fieldIds as each field name needs to be // unique. var seen = {}; fields = _.map(fields, function(field, index) { - field = field.toString(); + if (field === null) { + field = ''; + } else { + field = field.toString(); + } // cannot use trim as not supported by IE7 var fieldId = field.replace(/^\s+|\s+$/g, ''); if (fieldId === '') { @@ -1807,7 +1880,11 @@ my.Query = Backbone.Model.extend({ var ourfilter = JSON.parse(JSON.stringify(filter)); // not fully specified so use template and over-write if (_.keys(filter).length <= 3) { - ourfilter = _.extend(this._filterTemplates[filter.type], ourfilter); + ourfilter = _.extend( + // crude deep copy + JSON.parse(JSON.stringify(this._filterTemplates[filter.type])), + ourfilter + ); } var filters = this.get('filters'); filters.push(ourfilter); @@ -1912,9 +1989,10 @@ this.recline.View = this.recline.View || {}; // { // group: {column name for x-axis}, // series: [{column name for series A}, {column name series B}, ... ], -// graphType: 'line' +// graphType: 'line', +// graphOptions: {custom [Flotr2 options](http://www.humblesoftware.com/flotr2/documentation#configuration)} // } -// +// // NB: should *not* provide an el argument to the view but must let the view // generate the element itself (you can then append view.el to the DOM. my.Graph = Backbone.View.extend({ @@ -2144,7 +2222,14 @@ my.Graph = Backbone.View.extend({ }, grid: { hoverable: true, clickable: true } }; - return optionsPerGraphType[typeId]; + + if (self.state.get('graphOptions')){ + return _.extend(optionsPerGraphType[typeId], + self.state.get('graphOptions') + ) + }else{ + return optionsPerGraphType[typeId]; + } }, createSeries: function() { @@ -2625,9 +2710,14 @@ this.recline.View = this.recline.View || {}; // ## Map view for a Dataset using Leaflet mapping library. // // 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. +// information can be provided in 2 ways: +// +// 1. Via a single field. This field must be either a geo_point or +// [GeoJSON](http://geojson.org) object +// 2. Via two fields with latitude and longitude coordinates. +// +// Which fields in the data these correspond to can be configured via the state +// (and are guessed if no info is provided). // // Initialization arguments are as standard for Dataset Views. State object may // have the following (optional) configuration options: @@ -2638,6 +2728,9 @@ this.recline.View = this.recline.View || {}; // geomField: {id of field containing geometry in the dataset} // lonField: {id of field containing longitude in the dataset} // latField: {id of field containing latitude in the dataset} +// autoZoom: true, +// // use cluster support +// cluster: false // } // // @@ -2740,6 +2833,39 @@ my.Map = Backbone.View.extend({ return html; }, + // Options to use for the [Leaflet GeoJSON layer](http://leaflet.cloudmade.com/reference.html#geojson) + // See also + // + // e.g. + // + // pointToLayer: function(feature, latLng) + // onEachFeature: function(feature, layer) + // + // See defaults for examples + geoJsonLayerOptions: { + // pointToLayer function to use when creating points + // + // Default behaviour shown here is to create a marker using the + // popupContent set on the feature properties (created via infobox function + // during feature generation) + // + // NB: inside pointToLayer `this` will be set to point to this map view + // instance (which allows e.g. this.markers to work in this default case) + pointToLayer: function (feature, latlng) { + var marker = new L.Marker(latlng); + marker.bindPopup(feature.properties.popupContent); + // this is for cluster case + this.markers.addLayer(marker); + return marker; + }, + // onEachFeature default which adds popup in + onEachFeature: function(feature, layer) { + if (feature.properties && feature.properties.popupContent) { + layer.bindPopup(feature.properties.popupContent); + } + } + }, + // END: Customization section // ---- @@ -2804,6 +2930,15 @@ my.Map = Backbone.View.extend({ return; } + // this must come before zooming! + // if not: errors when using e.g. circle markers like + // "Cannot call method 'project' of undefined" + if (this.state.get('cluster')) { + this.map.addLayer(this.markers); + } else { + this.map.addLayer(this.features); + } + if (this.state.get('autoZoom')){ if (this.visible){ this._zoomToFeatures(); @@ -2811,11 +2946,6 @@ my.Map = Backbone.View.extend({ this._zoomPending = true; } } - if (this.state.get('cluster')) { - this.map.addLayer(this.markers); - } else { - this.map.addLayer(this.features); - } } }, @@ -2932,7 +3062,7 @@ my.Map = Backbone.View.extend({ } else { return null; } - } else if (value && value.slice) { + } else if (value && _.isArray(value)) { // [ lon, lat ] return { "type": "Point", @@ -3021,14 +3151,11 @@ my.Map = Backbone.View.extend({ this.markers = new L.MarkerClusterGroup(this._clusterOptions); - this.features = new L.GeoJSON(null,{ - pointToLayer: function (feature, latlng) { - var marker = new L.marker(latlng); - marker.bindPopup(feature.properties.popupContent); - self.markers.addLayer(marker); - return marker; - } - }); + // rebind this (as needed in e.g. default case above) + this.geoJsonLayerOptions.pointToLayer = _.bind( + this.geoJsonLayerOptions.pointToLayer, + this); + this.features = new L.GeoJSON(null, this.geoJsonLayerOptions); this.map.setView([0, 0], 2); @@ -3789,8 +3916,8 @@ this.recline.View = this.recline.View || {}; // state: { // gridOptions: {editable: true}, // columnsEditor: [ -// {column: 'date', editor: Slick.Editor.Date }, -// {column: 'title', editor: Slick.Editor.Text} +// {column: 'date', editor: Slick.Editors.Date }, +// {column: 'title', editor: Slick.Editors.Text} // ] // } // }); @@ -3804,6 +3931,7 @@ my.SlickGrid = Backbone.View.extend({ this.model.records.bind('add', this.render); this.model.records.bind('reset', this.render); this.model.records.bind('remove', this.render); + this.model.records.bind('change', this.onRecordChanged, this) var state = _.extend({ hiddenColumns: [], @@ -3823,6 +3951,19 @@ my.SlickGrid = Backbone.View.extend({ events: { }, + onRecordChanged: function(record) { + // Ignore if the grid is not yet drawn + if (!this.grid) { + return; + } + + // Let's find the row corresponding to the index + var row_index = this.grid.getData().getModelRow( record ); + this.grid.invalidateRow(row_index); + this.grid.getData().updateItem(record, row_index); + this.grid.render(); + }, + render: function() { var self = this; @@ -3894,6 +4035,15 @@ my.SlickGrid = Backbone.View.extend({ } columns = columns.concat(tempHiddenColumns); + // Transform a model object into a row + function toRow(m) { + var row = {}; + self.model.fields.each(function(field){ + row[field.id] = m.getFieldValueUnrendered(field); + }); + return row; + } + function RowSet() { var models = []; var rows = []; @@ -3907,16 +4057,17 @@ my.SlickGrid = Backbone.View.extend({ this.getItem = function(index) { return rows[index];} this.getItemMetadata= function(index) { return {};} this.getModel= function(index) { return models[index]; } + this.getModelRow = function(m) { return models.indexOf(m);} + this.updateItem = function(m,i) { + rows[i] = toRow(m); + models[i] = m + }; }; var data = new RowSet(); this.model.records.each(function(doc){ - var row = {}; - self.model.fields.each(function(field){ - row[field.id] = doc.getFieldValueUnrendered(field); - }); - data.push(doc, row); + data.push(doc, toRow(doc)); }); this.grid = new Slick.Grid(this.el, data, visibleColumns, options); From c6a8a33d32ff22ec8e06ed8c4610824bdc4d4077 Mon Sep 17 00:00:00 2001 From: John Glover Date: Thu, 6 Dec 2012 13:34:36 +0100 Subject: [PATCH 13/16] [284] Add json2.js which defines JSON for older browsers (IE7). Fixes filters and 6 test failures with IE7. --- _includes/recline-deps.html | 3 + test/index.html | 3 + vendor/json/json2.js | 486 ++++++++++++++++++++++++++++++++++++ 3 files changed, 492 insertions(+) create mode 100644 vendor/json/json2.js diff --git a/_includes/recline-deps.html b/_includes/recline-deps.html index 2316cee3..af8baeeb 100644 --- a/_includes/recline-deps.html +++ b/_includes/recline-deps.html @@ -33,6 +33,9 @@ + diff --git a/vendor/json/json2.js b/vendor/json/json2.js new file mode 100644 index 00000000..c7745df8 --- /dev/null +++ b/vendor/json/json2.js @@ -0,0 +1,486 @@ +/* + json2.js + 2012-10-08 + + Public Domain. + + NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK. + + See http://www.JSON.org/js.html + + + This code should be minified before deployment. + See http://javascript.crockford.com/jsmin.html + + USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO + NOT CONTROL. + + + This file creates a global JSON object containing two methods: stringify + and parse. + + JSON.stringify(value, replacer, space) + value any JavaScript value, usually an object or array. + + replacer an optional parameter that determines how object + values are stringified for objects. It can be a + function or an array of strings. + + space an optional parameter that specifies the indentation + of nested structures. If it is omitted, the text will + be packed without extra whitespace. If it is a number, + it will specify the number of spaces to indent at each + level. If it is a string (such as '\t' or ' '), + it contains the characters used to indent at each level. + + This method produces a JSON text from a JavaScript value. + + When an object value is found, if the object contains a toJSON + method, its toJSON method will be called and the result will be + stringified. A toJSON method does not serialize: it returns the + value represented by the name/value pair that should be serialized, + or undefined if nothing should be serialized. The toJSON method + will be passed the key associated with the value, and this will be + bound to the value + + For example, this would serialize Dates as ISO strings. + + Date.prototype.toJSON = function (key) { + function f(n) { + // Format integers to have at least two digits. + return n < 10 ? '0' + n : n; + } + + return this.getUTCFullYear() + '-' + + f(this.getUTCMonth() + 1) + '-' + + f(this.getUTCDate()) + 'T' + + f(this.getUTCHours()) + ':' + + f(this.getUTCMinutes()) + ':' + + f(this.getUTCSeconds()) + 'Z'; + }; + + You can provide an optional replacer method. It will be passed the + key and value of each member, with this bound to the containing + object. The value that is returned from your method will be + serialized. If your method returns undefined, then the member will + be excluded from the serialization. + + If the replacer parameter is an array of strings, then it will be + used to select the members to be serialized. It filters the results + such that only members with keys listed in the replacer array are + stringified. + + Values that do not have JSON representations, such as undefined or + functions, will not be serialized. Such values in objects will be + dropped; in arrays they will be replaced with null. You can use + a replacer function to replace those with JSON values. + JSON.stringify(undefined) returns undefined. + + The optional space parameter produces a stringification of the + value that is filled with line breaks and indentation to make it + easier to read. + + If the space parameter is a non-empty string, then that string will + be used for indentation. If the space parameter is a number, then + the indentation will be that many spaces. + + Example: + + text = JSON.stringify(['e', {pluribus: 'unum'}]); + // text is '["e",{"pluribus":"unum"}]' + + + text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t'); + // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]' + + text = JSON.stringify([new Date()], function (key, value) { + return this[key] instanceof Date ? + 'Date(' + this[key] + ')' : value; + }); + // text is '["Date(---current time---)"]' + + + JSON.parse(text, reviver) + This method parses a JSON text to produce an object or array. + It can throw a SyntaxError exception. + + The optional reviver parameter is a function that can filter and + transform the results. It receives each of the keys and values, + and its return value is used instead of the original value. + If it returns what it received, then the structure is not modified. + If it returns undefined then the member is deleted. + + Example: + + // Parse the text. Values that look like ISO date strings will + // be converted to Date objects. + + myData = JSON.parse(text, function (key, value) { + var a; + if (typeof value === 'string') { + a = +/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value); + if (a) { + return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4], + +a[5], +a[6])); + } + } + return value; + }); + + myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) { + var d; + if (typeof value === 'string' && + value.slice(0, 5) === 'Date(' && + value.slice(-1) === ')') { + d = new Date(value.slice(5, -1)); + if (d) { + return d; + } + } + return value; + }); + + + This is a reference implementation. You are free to copy, modify, or + redistribute. +*/ + +/*jslint evil: true, regexp: true */ + +/*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply, + call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours, + getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join, + lastIndex, length, parse, prototype, push, replace, slice, stringify, + test, toJSON, toString, valueOf +*/ + + +// Create a JSON object only if one does not already exist. We create the +// methods in a closure to avoid creating global variables. + +if (typeof JSON !== 'object') { + JSON = {}; +} + +(function () { + 'use strict'; + + function f(n) { + // Format integers to have at least two digits. + return n < 10 ? '0' + n : n; + } + + if (typeof Date.prototype.toJSON !== 'function') { + + Date.prototype.toJSON = function (key) { + + return isFinite(this.valueOf()) + ? this.getUTCFullYear() + '-' + + f(this.getUTCMonth() + 1) + '-' + + f(this.getUTCDate()) + 'T' + + f(this.getUTCHours()) + ':' + + f(this.getUTCMinutes()) + ':' + + f(this.getUTCSeconds()) + 'Z' + : null; + }; + + String.prototype.toJSON = + Number.prototype.toJSON = + Boolean.prototype.toJSON = function (key) { + return this.valueOf(); + }; + } + + var cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g, + escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g, + gap, + indent, + meta = { // table of character substitutions + '\b': '\\b', + '\t': '\\t', + '\n': '\\n', + '\f': '\\f', + '\r': '\\r', + '"' : '\\"', + '\\': '\\\\' + }, + rep; + + + function quote(string) { + +// If the string contains no control characters, no quote characters, and no +// backslash characters, then we can safely slap some quotes around it. +// Otherwise we must also replace the offending characters with safe escape +// sequences. + + escapable.lastIndex = 0; + return escapable.test(string) ? '"' + string.replace(escapable, function (a) { + var c = meta[a]; + return typeof c === 'string' + ? c + : '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4); + }) + '"' : '"' + string + '"'; + } + + + function str(key, holder) { + +// Produce a string from holder[key]. + + var i, // The loop counter. + k, // The member key. + v, // The member value. + length, + mind = gap, + partial, + value = holder[key]; + +// If the value has a toJSON method, call it to obtain a replacement value. + + if (value && typeof value === 'object' && + typeof value.toJSON === 'function') { + value = value.toJSON(key); + } + +// If we were called with a replacer function, then call the replacer to +// obtain a replacement value. + + if (typeof rep === 'function') { + value = rep.call(holder, key, value); + } + +// What happens next depends on the value's type. + + switch (typeof value) { + case 'string': + return quote(value); + + case 'number': + +// JSON numbers must be finite. Encode non-finite numbers as null. + + return isFinite(value) ? String(value) : 'null'; + + case 'boolean': + case 'null': + +// If the value is a boolean or null, convert it to a string. Note: +// typeof null does not produce 'null'. The case is included here in +// the remote chance that this gets fixed someday. + + return String(value); + +// If the type is 'object', we might be dealing with an object or an array or +// null. + + case 'object': + +// Due to a specification blunder in ECMAScript, typeof null is 'object', +// so watch out for that case. + + if (!value) { + return 'null'; + } + +// Make an array to hold the partial results of stringifying this object value. + + gap += indent; + partial = []; + +// Is the value an array? + + if (Object.prototype.toString.apply(value) === '[object Array]') { + +// The value is an array. Stringify every element. Use null as a placeholder +// for non-JSON values. + + length = value.length; + for (i = 0; i < length; i += 1) { + partial[i] = str(i, value) || 'null'; + } + +// Join all of the elements together, separated with commas, and wrap them in +// brackets. + + v = partial.length === 0 + ? '[]' + : gap + ? '[\n' + gap + partial.join(',\n' + gap) + '\n' + mind + ']' + : '[' + partial.join(',') + ']'; + gap = mind; + return v; + } + +// If the replacer is an array, use it to select the members to be stringified. + + if (rep && typeof rep === 'object') { + length = rep.length; + for (i = 0; i < length; i += 1) { + if (typeof rep[i] === 'string') { + k = rep[i]; + v = str(k, value); + if (v) { + partial.push(quote(k) + (gap ? ': ' : ':') + v); + } + } + } + } else { + +// Otherwise, iterate through all of the keys in the object. + + for (k in value) { + if (Object.prototype.hasOwnProperty.call(value, k)) { + v = str(k, value); + if (v) { + partial.push(quote(k) + (gap ? ': ' : ':') + v); + } + } + } + } + +// Join all of the member texts together, separated with commas, +// and wrap them in braces. + + v = partial.length === 0 + ? '{}' + : gap + ? '{\n' + gap + partial.join(',\n' + gap) + '\n' + mind + '}' + : '{' + partial.join(',') + '}'; + gap = mind; + return v; + } + } + +// If the JSON object does not yet have a stringify method, give it one. + + if (typeof JSON.stringify !== 'function') { + JSON.stringify = function (value, replacer, space) { + +// The stringify method takes a value and an optional replacer, and an optional +// space parameter, and returns a JSON text. The replacer can be a function +// that can replace values, or an array of strings that will select the keys. +// A default replacer method can be provided. Use of the space parameter can +// produce text that is more easily readable. + + var i; + gap = ''; + indent = ''; + +// If the space parameter is a number, make an indent string containing that +// many spaces. + + if (typeof space === 'number') { + for (i = 0; i < space; i += 1) { + indent += ' '; + } + +// If the space parameter is a string, it will be used as the indent string. + + } else if (typeof space === 'string') { + indent = space; + } + +// If there is a replacer, it must be a function or an array. +// Otherwise, throw an error. + + rep = replacer; + if (replacer && typeof replacer !== 'function' && + (typeof replacer !== 'object' || + typeof replacer.length !== 'number')) { + throw new Error('JSON.stringify'); + } + +// Make a fake root object containing our value under the key of ''. +// Return the result of stringifying the value. + + return str('', {'': value}); + }; + } + + +// If the JSON object does not yet have a parse method, give it one. + + if (typeof JSON.parse !== 'function') { + JSON.parse = function (text, reviver) { + +// The parse method takes a text and an optional reviver function, and returns +// a JavaScript value if the text is a valid JSON text. + + var j; + + function walk(holder, key) { + +// The walk method is used to recursively walk the resulting structure so +// that modifications can be made. + + var k, v, value = holder[key]; + if (value && typeof value === 'object') { + for (k in value) { + if (Object.prototype.hasOwnProperty.call(value, k)) { + v = walk(value, k); + if (v !== undefined) { + value[k] = v; + } else { + delete value[k]; + } + } + } + } + return reviver.call(holder, key, value); + } + + +// Parsing happens in four stages. In the first stage, we replace certain +// Unicode characters with escape sequences. JavaScript handles many characters +// incorrectly, either silently deleting them, or treating them as line endings. + + text = String(text); + cx.lastIndex = 0; + if (cx.test(text)) { + text = text.replace(cx, function (a) { + return '\\u' + + ('0000' + a.charCodeAt(0).toString(16)).slice(-4); + }); + } + +// In the second stage, we run the text against regular expressions that look +// for non-JSON patterns. We are especially concerned with '()' and 'new' +// because they can cause invocation, and '=' because it can cause mutation. +// But just to be safe, we want to reject all unexpected forms. + +// We split the second stage into 4 regexp operations in order to work around +// crippling inefficiencies in IE's and Safari's regexp engines. First we +// replace the JSON backslash pairs with '@' (a non-JSON character). Second, we +// replace all simple value tokens with ']' characters. Third, we delete all +// open brackets that follow a colon or comma or that begin the text. Finally, +// we look to see that the remaining characters are only whitespace or ']' or +// ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval. + + if (/^[\],:{}\s]*$/ + .test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@') + .replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']') + .replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) { + +// In the third stage we use the eval function to compile the text into a +// JavaScript structure. The '{' operator is subject to a syntactic ambiguity +// in JavaScript: it can begin a block or an object literal. We wrap the text +// in parens to eliminate the ambiguity. + + j = eval('(' + text + ')'); + +// In the optional fourth stage, we recursively walk the new structure, passing +// each name/value pair to a reviver function for possible transformation. + + return typeof reviver === 'function' + ? walk({'': j}, '') + : j; + } + +// If the text is not JSON parseable, then a SyntaxError is thrown. + + throw new SyntaxError('JSON.parse'); + }; + } +}()); From 9bfbce776bbbec15f55c55dd171671d19d9b1e3d Mon Sep 17 00:00:00 2001 From: John Glover Date: Mon, 10 Dec 2012 16:57:44 +0100 Subject: [PATCH 14/16] [#264] Fix for #264 from ckan-updates branch. Uses _.defaults rather than performing an explicit deep copy. --- src/model.js | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/model.js b/src/model.js index f5354210..e912d8e5 100644 --- a/src/model.js +++ b/src/model.js @@ -499,11 +499,7 @@ my.Query = Backbone.Model.extend({ var ourfilter = JSON.parse(JSON.stringify(filter)); // not fully specified so use template and over-write if (_.keys(filter).length <= 3) { - ourfilter = _.extend( - // crude deep copy - JSON.parse(JSON.stringify(this._filterTemplates[filter.type])), - ourfilter - ); + ourfilter = _.defaults(ourfilter, this._filterTemplates[filter.type]); } var filters = this.get('filters'); filters.push(ourfilter); From 3610d95e7474f1c5c3752ff2f73447f7be2b5546 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 22 Dec 2012 19:51:03 +0000 Subject: [PATCH 15/16] [#291,bugfix][s]: memory backend transform function now works even when records do not have id - fixes #291. * Also simplified (and made more efficient) by removing dependency on (not very useful) recline.Data.Transform.mapDocs function * As documented in #291 issue was that an id was required in the docs --- src/backend.memory.js | 13 ++++++++----- test/backend.memory.test.js | 25 +++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/src/backend.memory.js b/src/backend.memory.js index f42aae07..ef17451b 100644 --- a/src/backend.memory.js +++ b/src/backend.memory.js @@ -227,12 +227,15 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; }; this.transform = function(editFunc) { - var toUpdate = recline.Data.Transform.mapDocs(this.data, editFunc); - // TODO: very inefficient -- could probably just walk the documents and updates in tandem and update - _.each(toUpdate.updates, function(record, idx) { - self.data[idx] = record; + var dfd = $.Deferred(); + // TODO: should we clone before mapping? Do not see the point atm. + self.data = _.map(self.data, editFunc); + // now deal with deletes (i.e. nulls) + self.data = _.filter(self.data, function(record) { + return record != null; }); - return this.save(toUpdate); + dfd.resolve(); + return dfd.promise(); }; }; diff --git a/test/backend.memory.test.js b/test/backend.memory.test.js index 5743d6d3..822c64f2 100644 --- a/test/backend.memory.test.js +++ b/test/backend.memory.test.js @@ -187,6 +187,31 @@ test('update and delete', function () { equal(data.data[0].x, memoryData[1].x); }); +test('transform', function () { + var data = [ + {a: 1, b: " bla"}, + {a: 2, b: "foo "}, + {a: 3, b: "bar"} + ]; + var store = new recline.Backend.Memory.Store(data); + store.transform(function(d) { + d.a = d.a * 10; + return d; + }) + equal(store.data[0].a, 10); + equal(store.data[1].a, 20); +}); + +test('transform deletes', function () { + var data = [{a: 1, b: " bla"},{a: 2, b: "foo "},{a: 3, b: "bar"}]; + var store = new recline.Backend.Memory.Store(data); + store.transform(function(d) { + if (d.a == '1') return null; + else return d; + }) + equal(store.data.length, 2); +}); + })(this.jQuery); // ====================================== From 4eb68fbf0feb461a163d7f9b0779bab1591e8f0c Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 22 Dec 2012 19:56:37 +0000 Subject: [PATCH 16/16] [build][xs]: build latest. --- dist/recline.dataset.js | 19 +++++++++---------- dist/recline.js | 19 +++++++++---------- 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/dist/recline.dataset.js b/dist/recline.dataset.js index dfb4e401..963cac53 100644 --- a/dist/recline.dataset.js +++ b/dist/recline.dataset.js @@ -499,11 +499,7 @@ my.Query = Backbone.Model.extend({ var ourfilter = JSON.parse(JSON.stringify(filter)); // not fully specified so use template and over-write if (_.keys(filter).length <= 3) { - ourfilter = _.extend( - // crude deep copy - JSON.parse(JSON.stringify(this._filterTemplates[filter.type])), - ourfilter - ); + ourfilter = _.defaults(ourfilter, this._filterTemplates[filter.type]); } var filters = this.get('filters'); filters.push(ourfilter); @@ -820,12 +816,15 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; }; this.transform = function(editFunc) { - var toUpdate = recline.Data.Transform.mapDocs(this.data, editFunc); - // TODO: very inefficient -- could probably just walk the documents and updates in tandem and update - _.each(toUpdate.updates, function(record, idx) { - self.data[idx] = record; + var dfd = $.Deferred(); + // TODO: should we clone before mapping? Do not see the point atm. + self.data = _.map(self.data, editFunc); + // now deal with deletes (i.e. nulls) + self.data = _.filter(self.data, function(record) { + return record != null; }); - return this.save(toUpdate); + dfd.resolve(); + return dfd.promise(); }; }; diff --git a/dist/recline.js b/dist/recline.js index 17e09693..3f0591ba 100644 --- a/dist/recline.js +++ b/dist/recline.js @@ -1171,12 +1171,15 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {}; }; this.transform = function(editFunc) { - var toUpdate = recline.Data.Transform.mapDocs(this.data, editFunc); - // TODO: very inefficient -- could probably just walk the documents and updates in tandem and update - _.each(toUpdate.updates, function(record, idx) { - self.data[idx] = record; + var dfd = $.Deferred(); + // TODO: should we clone before mapping? Do not see the point atm. + self.data = _.map(self.data, editFunc); + // now deal with deletes (i.e. nulls) + self.data = _.filter(self.data, function(record) { + return record != null; }); - return this.save(toUpdate); + dfd.resolve(); + return dfd.promise(); }; }; @@ -1880,11 +1883,7 @@ my.Query = Backbone.Model.extend({ var ourfilter = JSON.parse(JSON.stringify(filter)); // not fully specified so use template and over-write if (_.keys(filter).length <= 3) { - ourfilter = _.extend( - // crude deep copy - JSON.parse(JSON.stringify(this._filterTemplates[filter.type])), - ourfilter - ); + ourfilter = _.defaults(ourfilter, this._filterTemplates[filter.type]); } var filters = this.get('filters'); filters.push(ourfilter);