0.8.0pre4

Author: Havvy

examples/bare-config.json

@@ -0,0 +1,14 @@
+{
+    "server": "irc.network.net",
+    "channels": ["#channel"],
+    "nickserv": "nickserv",
+    "password": null,
+    "nick": "tennu-bot",
+    "user": "tennu",
+    "port": 6667,
+    "modules": [],
+    "realname": "tennu 0.8.0",
+    "trigger": "!",
+    "capab": false,
+    "secure": false
+}

lib/bisubscriber.js

@@ -51,7 +51,7 @@ BiEventSubscriber.prototype = {
 
     _onMap : function (typemap) {
         for (var type in typemap) {
-            this._onceString(type, typemap[type]);
+            this._onString(type, typemap[type]);
         }
     },
 

lib/client.js

@@ -1,22 +1,3 @@
-/**
- *
- * The public contract of the Client object is documented by readme.md.
- *
- * Public Methods:
- *   connect() -> void
- *   disconnect() -> void
- *   Configuration Storage iface
- *   IrcOutputSocket iface
- *   Bisubscriber iface
- *   Modules iface
- */
-
-/*
-I should see if there's a better way to make this class than
-all of these wrapped methods.
-*/
-
-const util = require('util');
 const lodash = require('lodash');
 
 const defaultFactoryConfiguration = {
@@ -119,7 +100,7 @@ const delegate = function (property, method) {
             client.say(config.nickserv, 'identify ' + config.password);
         }
 
-        if (util.isArray(config.channels)) {
+        if (Array.isArray(config.channels)) {
             client.notice('Joining default channels.');
             config.channels.forEach(function (channel) {
                 client.join(channel);
@@ -136,6 +117,8 @@ const delegate = function (property, method) {
         client.notice('Closing IRC Connection.');
         client.disconnect();
     });
+    // End of Startup stuff
+
 
     client.out = client._outputSocket;
     client.events = client._subscriber;
@@ -218,21 +201,14 @@ Client.prototype.nick = function () {
 Client.prototype.on = delegate('_subscriber', 'on');
 Client.prototype.once = delegate('_subscriber', 'once');
 
-// partially implements ModuleSubscriber
-
-Client.prototype.load = function (module) {
-    return this._modules.load(module);
-};
-
-Client.prototype.require = function (module) {
-    return this._modules.require(module);
-};
+// implements ModuleSystem
 
-Client.prototype.exports = Client.prototype.require;
-
-Client.prototype.loaded = function () {
-    return this._modules.loadedModules()
-};
+Client.prototype.use = delegate('modules', 'use');
+Client.prototype.getModule = delegate('modules', 'getModule');
+Client.prototype.getRole = delegate('modules', 'getRole');
+Client.prototype.initialize = delegate('modules', 'initialize');
+Client.prototype.isInitializable = delegate('modules', 'isInitializable');
+Client.prototype.addHook = delegate('modules', 'addHook');
 
 // implements Logger
 Client.prototype.debug = delegate('_logger', 'debug');

lib/command-handler.js

@@ -56,14 +56,15 @@ function CommandParser (config, nickname, logger) {
             const command = Command(privmsg, maybeCommand);
             logger.notice('Command Handler', 'Emitting command:', command.command);
             this.emit(command.command, command);
+            return command;
         }
-
-        return command;
     };
 
     parser.after(function (err, res, type, command) {
+        logger.debug(inspect(arguments));
         // Response types allowed:
         //     string U [string] U Promise<string U [string]>
+
         if (err) {
             logger.error('Command Handler', 'Error thrown in command handler!');
             logger.error('Command Handler', err.stack);
@@ -75,19 +76,13 @@ function CommandParser (config, nickname, logger) {
             return;
         }
 
-        if (Array.isArray(res) || typeof res === 'string') {
-            res = Q(res);
-        }
+        logger.debug('Command Handler', 'Response exists.');
 
-        if (typeof res.then !== 'function') {
+        if (Array.isArray(res) || typeof res === 'string') {
+            command.receiver.say(command.channel, res);
+        } else {
             logger.error('Command Handler', format(badResponseFormat, command.command, String(res)));
-            return;
         }
-
-        res.then(function (res) {
-            // FIXME: Pass receiver to Command Handler at initialization.
-            command.receiver.say(command.channel, res);
-        });
     });
 
     return parser;

lib/event-emitter.js

@@ -28,11 +28,12 @@
  */
 
 
-var Set = require('simplesets').Set;   // Still waiting on that ES6 Set API.
+const Set = require('simplesets').Set;   // Still waiting on that ES6 Set API.
+const Q = require('q');
 
-var EventEmitter = function () {
-    var events = {};                   // Object[Set[Fn]]
-    var postListenerCallback = null;   // Fn
+const EventEmitter = function () {
+    const events = {};                           // Object (Set Fn)
+    var postListenerCallback = function () {};   // Error -> any -> string -> ...any -> void
 
     return {
         on: function (type, listener) {
@@ -43,11 +44,11 @@ var EventEmitter = function () {
             events[type].add(listener);
         },
         once: function (type, listener) {
-            var that = this;
+            const that = this;
 
             function o () {
-                listener.apply(null, Array.prototype.slice.call(arguments));
                 that.off(type, o);
+                return listener.apply(null, Array.prototype.slice.call(arguments));
             }
 
             this.on(type, o);
@@ -57,41 +58,27 @@ var EventEmitter = function () {
                 events[type].remove(listener);
             }
         },
-        emit: function recur (type) {
-            var args = Array.prototype.slice.call(arguments, 1);
-
-            if (Array.isArray(type)) {
-                args.unshift(null);
-
-                type.forEach(function (t) {
-                    args[0] = t;
-                    recur.apply(this, args);
-                });
-
-                return;
-            }
+        emit: function (type) {
+            const args = Array.prototype.slice.call(arguments, 1);
 
             if (!events[type]) {
                 return;
             }
 
             events[type].each(function (listener) {
                 setImmediate(function () {
-                    try {
-                        var res = listener.apply(null, args);
-                    } catch (e) {
-                        var err = e;
-                    }
-
-                    try {
-                        // TODO: Give special treatment to promises.
-                        if (postListenerCallback) {
-                            postListenerCallback.apply(null, [err, res, type].concat(args));
-                        }
-                    } catch (e) {
-                        console.log(e.stack);
-                        throw e;
-                    }
+                    Q.fapply(listener, args)
+                    .then(function (res) {
+                        postListenerCallback.apply(null, [undefined, res, type].concat(args));
+                    }, function (err) {
+                        postListenerCallback.apply(null, [err, undefined, type].concat(args));
+                    })
+                    .catch(function (err) {
+                        console.log(err.name);
+                        console.log(err.stack);
+                        throw err;    
+                    })
+                    .done();
                 });
             });
         },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tennu",
-  "version": "0.8.0pre3",
+  "version": "0.8.0pre4",
   "description": "Tennu Node.js IRC Framework",
   "maintainers": [
     {

readme.md

@@ -168,9 +168,11 @@ For example, a command of "!do-it ARG1 ARG2" will have args be ["ARG1", "ARG2"]
 
 ## Actions ##
 
-All of the following are methods on Tennu for doing things once connected.
+All of the following are methods on Tennu that can be used once connected.
 
 These methods are also available on the client's 'out' property.
+In Tennu 0.9.0, the 'out' property will go away, and the 'actions' module
+will export these methods.
 
 ### say(channel, message) ###
 
@@ -244,18 +246,19 @@ users is either a string or an array of strings.
 
 Retrieves the userhost of the user(s).
 
-### _raw(message) ###
+### raw(message) ###
 
-Our IrcOutputSocket class does not have all commands. If you need to use one
-that is not listed here, you can use the internal _raw method, which takes
-the entire message as is as a string, use your own IrcOutputSocket class, or
-send in a patch.
+For actions that are lacking a command, you can use raw to perform them.
+You must either pass an array of arguments (and the multiword argument must
+be in a single index without the colon) or pass the full string.
 
-### _rawf(format, args...) ###
+If you find yourself using raw(), please file an issue.
+
+### rawf(format, args...) ###
 
 [0.7.1]
 
-As _raw(message), but the arguments are passed through util.format() first.
+As raw(message), but the arguments are passed through util.format() first.
 
 --------
 
@@ -268,9 +271,11 @@ You may access the module system's methods via the Client.modules property
 or by using one of the following methods:
 
 * client.require()
-* client.exports() [an alias of client.require()]
-* client.load()
-* client.loaded()
+* client.getModule()
+* client.getRole()
+* client.use()
+* client.initialize()
+* client.isInitializable()
 
 ### Creating Your Own Modules ###
 

tennu_modules/help.js

@@ -2,6 +2,7 @@ const HELP_NOT_FOUND = 'Help file for selected topic does not exist.';
 
 const isArray = require('util').isArray;
 const format = require('util').format;
+const inspect = require('util').inspect;
 const Set = require('simplesets').Set;
 
 module.exports = {
@@ -40,13 +41,16 @@ module.exports = {
         return {
             handlers: {
                 '!help': function (command) {
+                    client.notice('ModHelp', '!help being handled.');
                     // Default to showing the help for the help module if no args given.
-                    const query = command.params.length === 0 ? ['help'] : command.params.slice();
-
-                    return helpResponse(query)
+                    const query = command.args.length === 0 ? ['help'] : command.args.slice();
+                    const response = helpResponse(query);
+                    return response;
                 },
 
                 '!commands': function (command) {
+                    client.notice('ModHelp', '!commands being handled.');
+
                     const start = ["List of known commands: "];
                     return start.concat(commandset.array().map(function (command) {
                         return format(" * %s", command);
@@ -104,7 +108,7 @@ module.exports = {
             help: {
                 help: [
                     '!help <query>',
-                    '',
+                    ' ',
                     'Display the help message for the topic located at the given query.',
                     'Query can be made of multiple subtopics',
                     'Without a query, shows this help message.',
@@ -115,7 +119,7 @@ module.exports = {
 
                 commands: [
                     '!commands',
-                    '',
+                    ' ',
                     'Show the list of commands.'
                 ]
             },

test/command-handler.js

@@ -138,6 +138,7 @@ describe('Command Handler', function () {
             const after = handler.getAfter;
 
             handler.after(function () {
+                logfn("After function called.");
                 after.apply(handler, arguments);
                 setImmediate(function () {
                     assert(!receiver.say.called);

test/event-emitter.js

@@ -7,7 +7,7 @@ const format = require('util').format;
 const debug = false;
 const logfn = debug ? console.log.bind(console) : function () {};
 
-var EventEmiter = require('../lib/event-emitter.js');
+const EventEmiter = require('../lib/event-emitter.js');
 
 describe('After Event Emitter', function () {
     var EE;
@@ -45,5 +45,16 @@ describe('After Event Emitter', function () {
             });
             EE.emit('x', true, false);
         });
+
+        it('passes the error to err if an error is thrown', function (done) {
+            const error = new Error();
+            EE.on('x', function () {throw error});
+            EE.after(function (err, res, emitted) {
+                assert(err === error);
+                assert(res === undefined);
+                done();
+            });
+            EE.emit('x');
+        });
     });
 });