Code organized

Author: numtel

README.md

@@ -4,6 +4,31 @@ NPM Package to provide events when a MySQL select statement result set changes.
 
 Built using the [`zongji` Binlog Tailer](https://github.com/nevill/zongji) and [`node-mysql`](https://github.com/felixge/node-mysql) projects.
 
+## *Under Construction*
+
+This package is yet completed. In order to test it, please use the following command sequence as a guide:
+
+```bash
+$ git clone https://github.com/numtel/mysql-live-select.git
+$ cd mysql-live-select
+$ npm install
+$ cd node_modules
+# Updated ZongJi module not yet available on NPM, clone repo instead:
+$ git clone https://github.com/nevill/zongji.git
+$ cd ..
+# To use example as-is, copy example data into MySQL
+$ mysql < example.sql
+# Configure example to match your MySQL settings
+# (Be sure to also to enable the binary log, as described in next section)
+$ vim example.js
+# Run example
+$ node example.js
+```
+
+Coming soon:
+
+* Automated tests
+
 ## Installation
 
 * Enable MySQL binlog in `my.cnf`, restart MySQL server after making the changes.

example.sql

@@ -0,0 +1,10 @@
+
+CREATE TABLE `players` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(45) DEFAULT NULL,
+  `score` int(11) NOT NULL DEFAULT '0',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=latin1;
+
+INSERT INTO `players` (`name`, `score`) VALUES 
+  ('Kepler', 40),('Leibniz',50),('Maxwell',60),('Planck',70);

lib/LiveMysql.js

@@ -0,0 +1,41 @@
+var ZongJi = require('zongji');
+var mysql = require('mysql');
+var LiveMysqlSelect = require('./LiveMysqlSelect');
+
+function LiveMysql(settings){
+  var self = this;
+  var zongji = new ZongJi(settings);
+  var db = mysql.createConnection(settings);
+
+  self.settings = settings;
+  self.zongji = zongji;
+  self.db = db;
+  self._select = [];
+
+  db.connect();
+
+  zongji.on('binlog', function(event) {
+    if(event.getEventName() === 'tablemap') return;
+
+    self._select.forEach(function(select){
+      if(select.matchRowEvent(event))
+        select.update();
+    });
+  });
+
+  zongji.start({
+    serverId: settings.serverId,
+    startAtEnd: true,
+    includeEvents: [ 'tablemap', 'writerows', 'updaterows', 'deleterows' ]
+  });
+}
+
+LiveMysql.prototype.select = function(query, triggers){
+  var self = this;
+  var newSelect = new LiveMysqlSelect(query, triggers, this);
+  self._select.push(newSelect);
+  return newSelect;
+};
+
+
+module.exports = LiveMysql;

index.js lib/LiveMysqlSelect.jsindex.js renamed to lib/LiveMysqlSelect.js

@@ -1,49 +1,12 @@
-var ZongJi = require('zongji');
-var mysql = require('mysql');
 var EventEmitter = require('events').EventEmitter;
 var util = require('util');
 
-function LiveMysql(settings){
-  var self = this;
-  var zongji = new ZongJi(settings);
-  var db = mysql.createConnection(settings);
-
-  self.settings = settings;
-  self.zongji = zongji;
-  self.db = db;
-  self._select = [];
-
-  db.connect();
-
-  zongji.on('binlog', function(event) {
-    if(event.getEventName() === 'tablemap') return;
-
-    self._select.forEach(function(select){
-      if(select.matchRowEvent(event))
-        select.update();
-    });
-  });
-
-  zongji.start({
-    serverId: settings.serverId,
-    startAtEnd: true,
-    includeEvents: [ 'tablemap', 'writerows', 'updaterows', 'deleterows' ]
-  });
-}
-
-LiveMysql.prototype.select = function(query, triggers){
-  var self = this;
-  var newSelect = new LiveMysqlSelect(query, triggers, this);
-  self._select.push(newSelect);
-  return newSelect;
-};
-
 function LiveMysqlSelect(query, triggers, base){
   if(!query)
     throw new Error('query required');
   if(!(triggers instanceof Array))
     throw new Error('triggers array required');
-  if(!(base instanceof LiveMysql))
+  if(typeof base !== 'object')
     throw new Error('base LiveMysql instance required');
 
   var self = this;
@@ -57,10 +20,8 @@ function LiveMysqlSelect(query, triggers, base){
 }
 
 util.inherits(LiveMysqlSelect, EventEmitter);
-// util.inherits(LiveMysqlSelect, Array);
-
 
-LiveMysqlSelect.prototype._escapeQueryFun: function(query){
+LiveMysqlSelect.prototype._escapeQueryFun = function(query){
   var self = this;
   if(typeof query === 'function'){
     var escId = self.base.db.escapeId;
@@ -114,4 +75,4 @@ LiveMysqlSelect.prototype.update = function(){
   }
 };
 
-module.exports = LiveMysql;
+module.exports = LiveMysqlSelect;

package.json

@@ -2,7 +2,8 @@
   "name": "mysql-live-select",
   "version": "0.0.1",
   "description": "Live updating MySQL SELECT statements",
-  "main": "index.js",
+  "main": "lib/LiveMysql.js",
+  "repository": "https://github.com/numtel/mysql-live-select",
   "scripts": {
     "test": "nodeunit --reporter=minimal test"
   },
@@ -14,5 +15,8 @@
     "update"
   ],
   "author": "Ben Green <ben@latenightsketches.com> (http://github.com/numtel)",
-  "license": "MIT"
+  "license": "MIT",
+  "dependencies": {
+    "mysql": "^2.5.4"
+  }
 }