Include API examples from website

Upgrade the included version of grunt-contrib-jshint so that global
variables may be specified on a per-file bases.

Gruntfile.js

@@ -282,7 +282,19 @@ module.exports = function(grunt) {
         "src/parsers/google_spreadsheet.js",
         "src/parsers/delimited.js",
         "test/unit/**/*.js"
-      ]
+      ],
+
+      apiExamples: {
+        options: {
+          globals: {
+            log: true,
+            Miso: true
+          }
+        },
+        files: {
+          src: ["examples/api/*.js"]
+        }
+      }
     },
 
     jscs: {

examples/api/column.js

@@ -0,0 +1,7 @@
+var col = new Miso.Dataset.Column({
+  name: 'inoculated',
+  type: 'boolean',
+  data: [true, false, false, true]
+});
+
+log(col.data);

examples/api/column/coerce.js

@@ -0,0 +1,9 @@
+var col = new Miso.Dataset.Column({
+  name: 'amount',
+  type: 'number',
+  data: [2, 3, '4']
+});
+
+log (col.data);
+col.coerce();
+log (col.data);

examples/api/column/numeric-at.js

@@ -0,0 +1,8 @@
+var col = new Miso.Dataset.Column({
+  name: 'inoculated',
+  type: 'boolean',
+  data: [true, false, false, true]
+});
+
+log (col.numericAt(0));
+log (col.numericAt(1));

examples/api/dataset.js

@@ -0,0 +1,12 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 }
+  ]
+});
+
+var ds2 = new Miso.Dataset({
+  url: '/data/simple.json'
+});
+
+log( ds instanceof Miso.Dataset );
+log( ds2 instanceof Miso.Dataset );

examples/api/dataset/add-column.js

@@ -0,0 +1,15 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 }
+  ]
+});
+ds.fetch({
+  success: function() {
+    this.addColumn({
+      type: 'string',
+      name: 'four'
+    });
+
+    log(this.columnNames());
+  }
+});

examples/api/dataset/add.js

@@ -0,0 +1,12 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 }
+  ]
+});
+ds.fetch({
+  success: function() {
+    this.add({ one: 44, two: 9 });
+    log( this.column('two').data );
+    log( this.column('three').data );
+  }
+});

examples/api/dataset/fetch.js

@@ -0,0 +1,10 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+}).fetch({
+  success: function() {
+    log( this.column('one').data );
+  }
+});

examples/api/dataset/remove.js

@@ -0,0 +1,17 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+ds.fetch({
+  success: function() {
+    log(this.column('two').data);
+
+    this.remove(function(row) {
+      return row.three === 7;
+    });
+
+    log(this.column('two').data);
+  }
+});

examples/api/dataset/reset.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log( this.column('two').data );
+    this.reset();
+    log( this.column('two').data );
+  }
+});

examples/api/dataset/update.js

@@ -0,0 +1,31 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+
+    log(this.column('two').data);
+
+    // update just the first row
+    var firstRow = this.rowByPosition(0);
+    this.update({ _id : firstRow._id, one : 100 });
+
+    log(this.rowByPosition(0));
+
+    // update all rows where col three == 7
+    this.update(function(row) {
+      if (row.three === 7) {
+        row.two = 99;
+        return row;
+      } else {
+        return false;
+      }
+    });
+
+    log(this.column('two').data);
+  }
+});

examples/api/dataview/column-names.js

@@ -0,0 +1,12 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log(this.columnNames());
+  }
+});

examples/api/dataview/column.js

@@ -0,0 +1,12 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log(this.column('one').data);
+  }
+});

examples/api/dataview/columns.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    var oneTwo = this.columns(['one','two']);
+    log(this.columnNames());
+    log(oneTwo.columnNames());
+  }
+});

examples/api/dataview/count-by.js

@@ -0,0 +1,13 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 },
+    { one : 1, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log(this.countBy('one').toJSON());
+  }
+});

examples/api/dataview/each-column.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    this.eachColumn(function(colName, colObject, index) {
+      log(colName);
+    });
+  }
+});

examples/api/dataview/each.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data : [
+    { one : 12,  two : 40},
+    { one : 1,   two : 40},
+    { one : 102, two : 430}
+  ]
+});
+ds.fetch({
+  success : function() {
+    this.each(function(row) {
+      log(JSON.stringify(row));
+    });
+  }
+});

examples/api/dataview/group-by.js

@@ -0,0 +1,13 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 },
+    { one : 6, two : 8, three : 55 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log(this.groupBy('one', ['two']));
+  }
+});

examples/api/dataview/has-column.js

@@ -0,0 +1,12 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+ds.fetch({
+  success : function() {
+    log(this.hasColumn('three'));
+    log(this.hasColumn('otter'));
+  }
+});

examples/api/dataview/max.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 },
+    { one : 6, two : 8, three : 55 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log( "Column 'one' max: " + this.max('one') );
+    log( "Column 'two' max: " + this.max('two') );
+  }
+});

examples/api/dataview/mean.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 },
+    { one : 6, two : 8, three : 55 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log( "Column 'one' mean: " + this.mean('one') );
+    log( "Column 'three' mean: " + this.mean('three') );
+  }
+});

examples/api/dataview/min.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 },
+    { one : 6, two : 8, three : 55 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    log( "Column 'one' min: " + this.min('one') );
+    log( "Column 'two' min: " + this.min('two') );
+  }
+});

examples/api/dataview/reverse-each.js

@@ -0,0 +1,14 @@
+var ds = new Miso.Dataset({
+  data : [
+    { one : 12,  two : 4},
+    { one : 1,   two : 40},
+    { one : 102, two : 430}
+  ]
+});
+ds.fetch({
+  success : function() {
+    this.reverseEach(function(row) {
+      log(JSON.stringify(row));
+    });
+  }
+});

examples/api/dataview/row-by-id.js

@@ -0,0 +1,13 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+    var rowOneID = this.column('_id').data[1];
+    log(ds.rowById(rowOneID));
+  }
+});

examples/api/dataview/row-by-position.js

@@ -0,0 +1,11 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+ds.fetch({
+  success : function() {
+    log(ds.rowByPosition(1));
+  }
+});

examples/api/dataview/rows.js

@@ -0,0 +1,18 @@
+var ds = new Miso.Dataset({
+  data: [
+    { one : 1, two : 4, three : 7 },
+    { one : 2, two : 5, three : 8 }
+  ]
+});
+
+ds.fetch({
+  success: function() {
+
+    var rowTwo = ds.rows(function(row) {
+      return row.one === 2;
+    });
+
+    log(rowTwo.columnNames());
+    log(rowTwo.length);
+  }
+});