p71924506
/
cylon
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #176 from hybridgroup/remove-class-cruft-and-namespace 

Remove class cruft and namespace from Basestar
This commit is contained in:
Ron Evans 2014-05-04 02:34:14 -07:00
parent f9d39151af a9ae09bdce
commit 2958f148f3
4 changed files with 118 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/adaptor.js
View File

@ -8,7 +8,8 @@
"use strict"; "use strict";
require('./basestar'); var Basestar = require('./basestar');
var namespace = require('node-namespace'); var namespace = require('node-namespace');
// The Adaptor class is a base class for Adaptor classes in external Cylon // The Adaptor class is a base class for Adaptor classes in external Cylon
@ -63,5 +64,5 @@ namespace("Cylon", function() {
return Adaptor; return Adaptor;
})(Cylon.Basestar); })(Basestar);
}); });

165
lib/basestar.js
View File

@ -9,99 +9,94 @@
"use strict"; "use strict";
require('./utils'); require('./utils');
var namespace = require('node-namespace');
var EventEmitter = require('events').EventEmitter; var EventEmitter = require('events').EventEmitter;
// Basestar is a base class to be used when writing external Cylon adaptors and // Basestar is a base class to be used when writing external Cylon adaptors and
// drivers. It provides some useful base methods and functionality // drivers. It provides some useful base methods and functionality
// //
// It also extends EventEmitter, so child classes are capable of emitting events // It also extends EventEmitter, so child classes are capable of emitting events
// for other parts of the system to handle. // for other parts of the system to handle.
namespace("Cylon", function() { var Basestar;
this.Basestar = (function(klass) {
subclass(Basestar, klass);
function Basestar(opts) { module.exports = Basestar = function Basestar(opts) {
this.self = this; this.self = this;
}
subclass(Basestar, EventEmitter);
// Public: Proxies calls from all methods in the object to a target object
//
// methods - array of methods to proxy
// target - object to proxy methods to
// source - object to proxy methods from
// force - whether or not to overwrite existing method definitions
//
// Returns the klass where the methods have been proxied
Basestar.prototype.proxyMethods = function(methods, target, source, force) {
if (force == null) { force = false; }
return proxyFunctionsToObject(methods, target, source, force);
};
// Public: Defines an event handler that proxies events from a source object
// to a target object
//
// opts - object containing options:
// - targetEventName or eventName - event that should be emitted from the
// target
// - target - object to proxy event to
// - source - object to proxy event from
// - sendUpdate - whether or not to send an 'update' event
//
// Returns the source
Basestar.prototype.defineEvent = function(opts) {
var self = this;
opts.sendUpdate = opts.sendUpdate || false;
opts.targetEventName = opts.targetEventName || opts.eventName;
opts.source.on(opts.eventName, function() {
var args = arguments.length >= 1 ? [].slice.call(arguments, 0) : [];
args.unshift(opts.targetEventName);
opts.target.emit.apply(opts.target, args);
if (opts.sendUpdate) {
args.unshift('update');
opts.target.emit.apply(opts.target, args);
} }
});
// Public: Proxies calls from all methods in the object to a target object return opts.source;
// };
// methods - array of methods to proxy
// target - object to proxy methods to
// source - object to proxy methods from
// force - whether or not to overwrite existing method definitions
//
// Returns the klass where the methods have been proxied
Basestar.prototype.proxyMethods = function(methods, target, source, force) {
if (force == null) { force = false; }
return proxyFunctionsToObject(methods, target, source, force);
};
// Public: Defines an event handler that proxies events from a source object // Public: Creates an event handler that proxies events from an adaptor's
// to a target object // 'connector' (reference to whatever module is actually talking to the hw)
// // to the adaptor's associated connection.
// opts - object containing options: //
// - targetEventName or eventName - event that should be emitted from the // opts - hash of opts to be passed to defineEvent()
// target //
// - target - object to proxy event to // Returns this.connector
// - source - object to proxy event from Basestar.prototype.defineAdaptorEvent = function(opts) {
// - sendUpdate - whether or not to send an 'update' event if (typeof opts === 'string') { opts = { eventName: opts }; }
//
// Returns the source
Basestar.prototype.defineEvent = function(opts) {
var self = this;
opts.sendUpdate = opts.sendUpdate || false; opts['source'] = this.connector;
opts.targetEventName = opts.targetEventName || opts.eventName; opts['target'] = this.connection;
opts.source.on(opts.eventName, function() { return this.defineEvent(opts);
var args = arguments.length >= 1 ? [].slice.call(arguments, 0) : []; };
args.unshift(opts.targetEventName);
opts.target.emit.apply(opts.target, args);
if (opts.sendUpdate) { // Public: Creates an event handler that proxies events from an device's
args.unshift('update'); // 'connector' (reference to whatever module is actually talking to the hw)
opts.target.emit.apply(opts.target, args); // to the device's associated connection.
} //
}); // opts - hash of opts to be passed to defineEvent()
//
// Returns this.connection
Basestar.prototype.defineDriverEvent = function(opts) {
if (typeof opts === 'string') { opts = { eventName: opts }; }
return opts.source; opts['source'] = this.connection;
}; opts['target'] = this.device;
// Public: Creates an event handler that proxies events from an adaptor's return this.defineEvent(opts);
// 'connector' (reference to whatever module is actually talking to the hw) };
// to the adaptor's associated connection.
//
// opts - hash of opts to be passed to defineEvent()
//
// Returns this.connector
Basestar.prototype.defineAdaptorEvent = function(opts) {
if (typeof opts === 'string') { opts = { eventName: opts }; }
opts['source'] = this.connector;
opts['target'] = this.connection;
return this.defineEvent(opts);
};
// Public: Creates an event handler that proxies events from an device's
// 'connector' (reference to whatever module is actually talking to the hw)
// to the device's associated connection.
//
// opts - hash of opts to be passed to defineEvent()
//
// Returns this.connection
Basestar.prototype.defineDriverEvent = function(opts) {
if (typeof opts === 'string') { opts = { eventName: opts }; }
opts['source'] = this.connection;
opts['target'] = this.device;
return this.defineEvent(opts);
};
return Basestar;
})(EventEmitter);
});

5
lib/driver.js
View File

@ -8,7 +8,8 @@
'use strict'; 'use strict';
require('./basestar'); var Basestar = require('./basestar');
var namespace = require('node-namespace'); var namespace = require('node-namespace');
// The Driver class is a base class for Driver classes in external Cylon // The Driver class is a base class for Driver classes in external Cylon
@ -65,5 +66,5 @@ namespace("Cylon", function() {
return Driver; return Driver;
})(Cylon.Basestar); })(Basestar);
}); });

80
test/specs/basestar.spec.js
View File

@ -1,13 +1,13 @@
"use strict"; "use strict";
source('basestar'); var Basestar = source('basestar');
var EventEmitter = require('events').EventEmitter; var EventEmitter = require('events').EventEmitter;
describe('Basestar', function() { describe('Basestar', function() {
describe('constructor', function() { describe('constructor', function() {
it('assigns @self to the instance of the Basestar class', function() { it('assigns @self to the instance of the Basestar class', function() {
var instance = new Cylon.Basestar(); var instance = new Basestar();
expect(instance.self).to.be.eql(instance); expect(instance.self).to.be.eql(instance);
}); });
}); });
@ -15,36 +15,26 @@ describe('Basestar', function() {
describe('#proxyMethods', function() { describe('#proxyMethods', function() {
var methods = ['asString', 'toString', 'returnString']; var methods = ['asString', 'toString', 'returnString'];
var ProxyClass = (function() { var ProxyClass = function ProxyClass() {}
function ProxyClass() {}
ProxyClass.prototype.asString = function() { ProxyClass.prototype.asString = function() {
return "[object ProxyClass]"; return "[object ProxyClass]";
}; };
ProxyClass.prototype.toString = function() { ProxyClass.prototype.toString = function() {
return "[object ProxyClass]"; return "[object ProxyClass]";
}; };
ProxyClass.prototype.returnString = function(string) { ProxyClass.prototype.returnString = function(string) {
return string; return string;
}; };
return ProxyClass; var TestClass = function TestClass() {
this.testInstance = new ProxyClass;
this.proxyMethods(methods, this.testInstance, this, true);
}
})(); subclass(TestClass, Basestar);
var TestClass = (function(_super) {
subclass(TestClass, _super);
function TestClass() {
this.testInstance = new ProxyClass;
this.proxyMethods(methods, this.testInstance, this, true);
}
return TestClass;
})(Cylon.Basestar);
it('can alias methods', function() { it('can alias methods', function() {
var testclass = new TestClass; var testclass = new TestClass;
@ -66,28 +56,22 @@ describe('Basestar', function() {
}); });
describe("#defineEvent", function() { describe("#defineEvent", function() {
var ProxyClass = (function(klass) {
subclass(ProxyClass, klass);
function ProxyClass() {}
return ProxyClass;
})(Cylon.Basestar);
var EmitterClass = (function(klass) { var ProxyClass = function ProxyClass() {};
subclass(EmitterClass, klass);
function EmitterClass(update) { var EmitterClass = function EmitterClass(update) {
update || (update = false); update || (update = false);
this.proxy = new ProxyClass(); this.proxy = new ProxyClass();
this.defineEvent({ this.defineEvent({
eventName: "testevent", eventName: "testevent",
source: this, source: this,
target: this.proxy, target: this.proxy,
sendUpdate: update sendUpdate: update
}); });
} }
return EmitterClass; subclass(ProxyClass, Basestar);
})(Cylon.Basestar); subclass(EmitterClass, Basestar);
it("proxies events from one class to another", function() { it("proxies events from one class to another", function() {
var eventSpy = spy(), var eventSpy = spy(),
@ -127,7 +111,7 @@ describe('Basestar', function() {
var basestar; var basestar;
before(function() { before(function() {
basestar = new Cylon.Basestar(); basestar = new Basestar();
basestar.connector = new EventEmitter(); basestar.connector = new EventEmitter();
basestar.connection = new EventEmitter(); basestar.connection = new EventEmitter();
}); });
@ -159,7 +143,7 @@ describe('Basestar', function() {
var basestar; var basestar;
before(function() { before(function() {
basestar = new Cylon.Basestar(); basestar = new Basestar();
basestar.connection = new EventEmitter(); basestar.connection = new EventEmitter();
basestar.device = new EventEmitter(); basestar.device = new EventEmitter();
}); });