middleman 2.0.9.pre.2 → 2.0.9.pre.3

data/lib/middleman/templates/mobile/source/tools/wspl/dbwrapperapi.js

@@ -0,0 +1,202 @@
+/*
+  Copyright 2009 Google Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+/**
+ * @fileoverview Generic Database API.
+ *
+ * A small set of classes to define how we interact with databases that can
+ * easily be implemented on top of HTML5 and Gears.  The classes in this file
+ * should be extended to provide the missing method implementations and more
+ * sophisticated constructors where applicable.
+ *
+ */
+
+/**
+ * Constructs a Statement object.  A Statement is an SQL statement paired
+ * with the parameters needed to execute it.
+ *
+ * @constructor
+ * @param {!string} sql The SQL statement.
+ * @param {Array.<Object>?} opt_params The parameters for the SQL statement.
+ */
+google.wspl.Statement = function(sql, opt_params) {
+
+  /**
+   * The SQL statement with '?' in place of parameters.
+   * @type {string}
+   */
+  this.sql = sql;
+
+  /**
+   * The parameters to use with the SQL statement.
+   * @type {!Array}
+   */
+  this.params = opt_params || [];
+};
+
+/**
+ * Returns a new statement object from the given statement with the parameters
+ * set as specified.
+ * @param {Array.<Object>} params The array of values for ? placeholders.
+ * @return {!google.wspl.Statement} The created Statement.
+ */
+google.wspl.Statement.prototype.createStatement = function(params) {
+  return new google.wspl.Statement(this.sql, params);
+};
+
+/**
+ * Constructs a Transaction object.  Transaction objects
+ * group together a series of statements into a single atomic
+ * action on the database.
+ *
+ * @constructor
+ */
+google.wspl.Transaction = function() {
+};
+
+/**
+ * Takes a statement and an optional callback object and
+ * runs the statement on the database. The callback can be used to
+ * add more statements to the same transaction, or execute can be
+ * called repeatedly and the transactions will later execute in the
+ * order provided.
+ *
+ * @param {google.wspl.Statement} statement The statement to execute.
+ * @param {Object} opt_callback An object containing onSuccess and onFailure
+ *     handlers.
+ */
+google.wspl.Transaction.prototype.execute = function(statement,
+    opt_callback) {
+  this.executeAll([statement], opt_callback);
+};
+
+/**
+ * Runs an array of statements in a single database transaction.
+ * Invokes the onSuccess callback once for each successfully executed
+ * statement and once for the first failed statement. The callback can be
+ * used to add more statements to the same transaction, or executeAll can
+ * be called repeatedly and each block of statements given will execute
+ * in the same order as the sequence of calls to executeAll.
+ *
+ * @param {Array.<google.wspl.Statement>} statements The statements to
+ *     execute.
+ * @param {Object?} opt_callback An object containing onSuccess and onFailure
+ *     handlers.
+ */
+google.wspl.Transaction.prototype.executeAll = function(statements,
+    opt_callback) {
+  throw Error('executeAll not implemented');
+};
+
+/**
+ * Constructs a Database object. Database objects are handles that allow
+ * access to a database (and create the corresponding database if it doesn't
+ * already exist). To open the database, pass the name of the needed
+ * database to the constructor, and then execute transactions on it using
+ * the execute method.
+ *
+ * @constructor
+ */
+google.wspl.Database = function() {
+};
+
+/**
+ * Creates a transaction object that can execute a series of SQL statements
+ * atomically.
+ *
+ * @param {Function} populate A callback to run execute calls on the
+ *     transaction.
+ * @param {Object?} opt_callback An optional success/failure callback that is
+ *     called when the entire transaction is finished executing.
+ */
+google.wspl.Database.prototype.createTransaction = function(populate,
+    opt_callback) {
+  throw Error('createTransaction not implemented');
+};
+
+/**
+ * Executes an array of statements on the database, invoking the optional
+ * callback after statement execution and the optional transactionCallback upon
+ * completion of the transaction.
+ *
+ * @param {google.wspl.Statement} statement the statement to execute
+ * @param {Object?} opt_callback object that defines onSuccess and onFailure
+ * @param {Object?} opt_transactionCallback object that defines onSuccess and
+ *    onFailure
+ */
+google.wspl.Database.prototype.execute = function(statement,
+                                                  opt_callback,
+                                                  opt_transactionCallback) {
+  this.createTransaction(function(tx) {
+    tx.execute(statement, opt_callback);
+  }, opt_transactionCallback);
+};
+
+/**
+ * Executes an array of statements on the database, invoking the optional
+ * callback for each statement in the transaction.  In the case of a statement
+ * failure, only the first failed statement will be reported and the transaction
+ * will be rolled back.  This method invokes the optional transactionCallback
+ * upon completion of the transaction.
+ *
+ * @param {Array.<google.wspl.Statement>} statements the statements to execute
+ * @param {Object?} opt_callback object that defines onSuccess and onFailure
+ * @param {Object?} opt_transactionCallback object that defines onSuccess and
+ *     onFailure
+ */
+google.wspl.Database.prototype.executeAll = function(statements,
+                                                     opt_callback,
+                                                     opt_transactionCallback) {
+  this.createTransaction(function(tx) {
+    tx.executeAll(statements, opt_callback);
+  }, opt_transactionCallback);
+};
+
+/**
+ * An immutable set of results that is returned from a single successful query
+ * on the database.
+ *
+ * @constructor
+ */
+google.wspl.ResultSet = function() {
+};
+
+/**
+ * Returns true if next() will advance to a valid row in the result set.
+ *
+ * @return {boolean} if next() will advance to a valid row in the result set
+ */
+google.wspl.ResultSet.prototype.isValidRow = function() {
+  throw Error('isValidRow not implemented');
+};
+
+/**
+ * Advances to the next row in the results.
+ */
+google.wspl.ResultSet.prototype.next = function() {
+  throw Error('next not implemented');
+};
+
+/**
+ * Returns the current row as an object with a property for each field returned
+ * by the database.  The property will have the name of the column and the value
+ * of the cell.
+ *
+ * @return {Object} The current row
+ */
+google.wspl.ResultSet.prototype.getRow = function() {
+  throw Error('getRow not implemented');
+};

data/lib/middleman/templates/mobile/source/tools/wspl/dbwrapperapi_test.html

@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<!--
+  Copyright 2009 Google Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<html>
+<head>
+<title>Database wrapper api</title>
+<script type="text/javascript" src="../jsunit/app/jsUnitCore.js"></script>
+<script type="text/javascript" src="jsmock.js"></script>
+<script type="text/javascript" src="global_functions.js"></script>
+<script type="text/javascript" src="dbwrapperapi.js"></script>
+</head>
+<body>
+<script type='text/javascript'>
+
+function subStatementTest(stm) {
+  assertEquals('statement not set correctly', 'bar', stm.sql);
+  assertEquals('first param not set correctly', 1, stm.params[0]);
+  assertEquals('second param not set correctly', 2, stm.params[1]);
+}
+
+function testConstructStatement() {
+  var stm = new google.wspl.Statement('foo');
+  assertEquals('statement not set correctly', 'foo', stm.sql);
+
+  var stm = new google.wspl.Statement('bar', [1,2]);
+  subStatementTest(stm);
+}
+
+function testConstructStatementFromTemplate() {
+  var temp = new google.wspl.Statement('bar');
+  var stm = temp.createStatement([1,2]);
+  subStatementTest(stm);
+}
+
+</script>
+</body>
+</html>

data/lib/middleman/templates/mobile/source/tools/wspl/gears_resultset.js

@@ -0,0 +1,71 @@
+/*
+  Copyright 2009 Google Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+/**
+ * @fileoverview A Gears implementation of dbwrapperapi ResultSet.
+ */
+
+/**
+ * Creates a Gears ResultSet object.
+ * @see google.wspl.ResultSet#ResultSet
+ *
+ * @constructor
+ * @extends google.wspl.ResultSet
+ * @param {!Array.<Object>} resultArray An array of hash objects where the
+ *     column names in the query are used as members of the objects.
+ */
+google.wspl.gears.ResultSet = function(resultArray) {
+  google.wspl.ResultSet.call(this);
+
+  /**
+   * The result set as an array of hash objects.
+   * @type {!Array.<Object>}
+   * @private
+   */
+  this.resultArray_ = resultArray;
+};
+google.inherits(google.wspl.gears.ResultSet, google.wspl.ResultSet);
+
+/**
+ * The current record in the result set.
+ * @type {number}
+ * @private
+ */
+google.wspl.gears.ResultSet.prototype.current_ = 0;
+
+/**
+ * @see google.wspl.ResultSet#isValidRow
+ * @inheritDoc
+ */
+google.wspl.gears.ResultSet.prototype.isValidRow = function() {
+  return this.current_ < this.resultArray_.length;
+};
+
+/**
+ * @see google.wspl.ResultSet#next
+ * @inheritDoc
+ */
+google.wspl.gears.ResultSet.prototype.next = function() {
+  this.current_++;
+};
+
+/**
+ * @see google.wspl.ResultSet#getRow
+ * @inheritDoc
+ */
+google.wspl.gears.ResultSet.prototype.getRow = function() {
+  return this.resultArray_[this.current_];
+};

data/lib/middleman/templates/mobile/source/tools/wspl/gears_resultset_test.html

@@ -0,0 +1,86 @@
+<!DOCTYPE html>
+<!--
+  Copyright 2009 Google Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<html>
+<head>
+<title>Gears resultset tests</title>
+<script type="text/javascript" src="../jsunit/app/jsUnitCore.js"></script>
+<script type="text/javascript" src="jsmock.js"></script>
+<script type="text/javascript" src="global_functions.js"></script>
+<script type="text/javascript" src="dbwrapperapi.js"></script>
+<script type="text/javascript" src="gears_resultset.js"></script>
+</head>
+<body>
+<script type='text/javascript'>
+
+var resultArray;
+
+function setUp() {
+  var obj1 = {
+    field1: 'a',
+    field2: 2,
+    field3: 'c'
+  };
+
+  var obj2 = {
+    field1: 'd',
+    field2: 4,
+    field3: 'f'
+  };
+
+  var obj3 = {
+    field1: 'g',
+    field2: 6,
+    field3: 'i'
+  };
+
+  resultArray = [obj1, obj2, obj3];
+}
+
+function testResultSetNext() {
+  var result = new google.wspl.gears.ResultSet(resultArray);
+  assertEquals('incorrect value for current', 0, result.current_);
+  result.next();
+  assertEquals('incorrect value for current', 1, result.current_);
+  result.next();
+  assertEquals('incorrect value for current', 2, result.current_);
+}
+
+function testResultSetIsValidRow() {
+  var result = new google.wspl.gears.ResultSet(resultArray);
+  assertTrue('incorrect return from isValidRow', result.isValidRow());
+  result.next();
+  assertTrue('incorrect return from isValidRow', result.isValidRow());
+  result.next();
+  assertTrue('incorrect return from isValidRow', result.isValidRow());
+  result.next();
+  assertFalse('incorrect return from isValidRow', result.isValidRow());
+}
+
+function testResultSetGetRow() {
+  var result = new google.wspl.gears.ResultSet(resultArray);
+  result.next();
+
+  var row = result.getRow();
+  assertEquals('first field is not valid', 'd', row.field1);
+  assertEquals('first field is not valid', 4, row.field2);
+  assertEquals('first field is not valid', 'f', row.field3);
+}
+
+</script>
+</body>
+</html>

data/lib/middleman/templates/mobile/source/tools/wspl/gears_transaction.js

@@ -0,0 +1,196 @@
+/*
+  Copyright 2009 Google Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+/**
+ * @fileoverview A Gears implementation of dbwrapperapi Transaction.
+ */
+
+/**
+ * Creates a Gears Transaction object.
+ * @see google.wspl.ResultSet#ResultSet
+ *
+ * @constructor
+ * @extends google.wspl.Transaction
+ *
+ * @param {number} id The unique id for this transaction
+ * @param {google.wspl.gears.Database} db The Gears implementation of the
+ *    dbwrapperapi database
+ */
+google.wspl.gears.Transaction = function(id, db) {
+  google.wspl.Transaction.call(this);
+
+  /**
+   * The unique id for this transaction.
+   * @type {number}
+   * @private
+   */
+  this.id_ = id;
+
+  /**
+   * The Gears implementation of the dbwrapperapi database.
+   * @type {google.wspl.gears.Database}
+   * @private
+   */
+  this.db_ = db;
+
+  /**
+   * A map of statements, callback, and current statement.
+   * @type {Object}
+   * @private
+   */
+  this.activeExecutes_ = {};
+};
+google.inherits(google.wspl.gears.Transaction, google.wspl.Transaction);
+
+/**
+ * The number of active executes.
+ * @type {number}
+ * @private
+ */
+google.wspl.gears.Transaction.prototype.numActiveExecutes_ = 0;
+
+/**
+ * The id for the next call to execute.  Incremented after use.
+ * @type {number}
+ * @private
+ */
+google.wspl.gears.Transaction.prototype.nextCallbackId_ = 1;
+
+/**
+ * Whether the transaction should be rolled back or not. This property is set
+ * to true when a statement fails.
+ * @type {boolean}
+ * @private
+ */
+google.wspl.gears.Transaction.prototype.needsRollback_ = false;
+
+/**
+ * Begins a new transaction with the Gears database. Commits the transaction if
+ * all calls to executeAll for this transaction have finished receiving
+ * callbacks.  Rolls the transaction back if a statement failed.
+ *
+ * @see google.wspl.Transaction#executeAll
+ * @inheritDoc
+ */
+google.wspl.gears.Transaction.prototype.executeAll = function(statements,
+    opt_callback) {
+  if (statements.length == 0) {
+    throw Error('Possibly silly attempt to execute empty statement list.');
+  }
+  if (this.numActiveExecutes_ == 0) {
+    this.db_.doBegin(this.id_);
+  }
+
+  this.numActiveExecutes_++;
+  var callbackId = this.nextCallbackId_++;
+
+  var callback = opt_callback || {
+    onSuccess : function() {},
+    onFailure : function() {}
+  };
+
+  this.activeExecutes_[callbackId] = {
+    statements: statements,
+    currentStatement: 0,
+    callback: callback
+  };
+
+  this.db_.doExecute(statements, callbackId, this.id_);
+};
+
+/**
+ * Invokes onSuccess on the specified callback.
+ *
+ * @param {google.wspl.ResultSet} result The result of a successful statement
+ * @param {number} callbackId The callback to invoke
+ */
+google.wspl.gears.Transaction.prototype.success = function(result,
+                                                           callbackId) {
+  if (!this.needsRollback_) {
+    var activeExecute = this.activeExecutes_[callbackId];
+    activeExecute.callback.onSuccess(this, result);
+  }
+  this.endStatement_(callbackId);
+};
+
+/**
+ * Invokes onFailure on the specified callback.
+ *
+ * @param {Error} error The error of an unsuccessful statement
+ * @param {number} callbackId The callback to invoke
+ */
+google.wspl.gears.Transaction.prototype.failure = function(error,
+                                                           callbackId) {
+  if (!this.needsRollback_) {
+    this.needsRollback_ = true;
+    var activeExecute = this.activeExecutes_[callbackId];
+    activeExecute.callback.onFailure(error);
+  }
+  this.endStatement_(callbackId);
+};
+
+/**
+ * Handles clean up for the end of a single execution.
+ *
+ * @param {number} callbackId The callback to clean up.
+ * @private
+ */
+google.wspl.gears.Transaction.prototype.endStatement_ = function(callbackId) {
+  var activeExecute = this.activeExecutes_[callbackId];
+  var statements = activeExecute.statements;
+  var currentStatement = ++activeExecute.currentStatement;
+
+  if (currentStatement == statements.length) {
+    this.endExecute_(callbackId);
+  }
+};
+
+/**
+ * Handles clean up for the end of a call to executeAll.  Performs a commit or
+ * rollback if this is the last active execute to clean up.
+ *
+ * @param {number} callbackId The callback to clean up
+ * @private
+ */
+google.wspl.gears.Transaction.prototype.endExecute_ = function(callbackId) {
+  delete this.activeExecutes_[callbackId];
+  this.numActiveExecutes_--;
+  if (!this.isExecuting()) {
+    this.endTransaction_();
+  }
+};
+
+/**
+ * Instructs the worker to commit the transaction or roll it back if a failure
+ * occurred and a rollback is required.
+ *
+ * @private
+ */
+google.wspl.gears.Transaction.prototype.endTransaction_ = function() {
+  if (this.needsRollback_) {
+    this.db_.doRollback(this.id_);
+  } else {
+    this.db_.doCommit(this.id_);
+  }
+};
+
+/**
+ * @return {boolean} True if the transaction has statements executing, false
+ *     otherwise.
+ */
+google.wspl.gears.Transaction.prototype.isExecuting = function() {
+  return this.numActiveExecutes_ > 0;
+};