extracted logic from /parse into bot.parseMacro (related to #149)

Author: Zirak

source/bot.js

@@ -556,6 +556,7 @@ bot.beatInterval = 5000; //once every 5 seconds is Good Enough ™
 //#build eval.js
 
 //#build parseCommandArgs.js
+//#build parseMacro.js
 //#build suggestionDict.js
 
 //#build commands.js

source/commands.js

@@ -282,119 +282,15 @@ return function ( args ) {
 
 commands.eval.async = commands.coffee.async = true;
 
-var parse = commands.parse = (function () {
-var macros = {
-	who : function ( msgObj ) {
-		return msgObj.get( 'user_name' );
-	},
-
-	someone : function () {
-		var presentUsers = document.getElementById( 'sidebar' )
-			.getElementsByClassName( 'present-user' );
-
-		//the chat keeps a low opacity for users who remained silent for long,
-		// and high opacity for those who recently talked
-		var active = [].filter.call( presentUsers, function ( user ) {
-			return Number( user.style.opacity ) >= 0.5;
-		}),
-		user = active[ Math.floor(Math.random() * (active.length-1)) ];
-
-		if ( !user ) {
-			return 'Nobody';
-		}
+commands.parse = function ( args ) {
+	var msgObj = args.get(),
+		user = bot.users[ args.get('user_id') ],
 
-		return user.getElementsByTagName( 'img' )[ 0 ].title;
-	},
-
-	digit : function () {
-		return Math.floor( Math.random() * 10 );
-	},
-
-	encode : function ( msgObj, string ) {
-		return encodeURIComponent( string );
-	},
-
-	//random number, min <= n <= max
-	//treats non-numeric inputs like they don't exist
-	rand : function ( msgObj, min, max ) {
-		min = Number( min );
-		max = Number( max );
-		return Math.rand( min, max );
-	}
-};
-var macroRegex = /(?:.|^)\$(\w+)(?:\((.*?)\))?/g;
-
-//extraVars is for internal usage via other commands
-return function parse ( args, extraVars ) {
-	var isMsg = !!args.get,
-		//filler objects, solves
-		// https://github.com/Zirak/SO-ChatBot/issues/66
-		msgObj = isMsg ? args.get() : {},
-		user = isMsg ? bot.users[ args.get('user_id') ] : {};
-
-	extraVars = extraVars || {};
+	    extraVars = Object.merge( msgObj, user );
 	bot.log( args, extraVars, '/parse input' );
 
-	return args.replace( macroRegex, replaceMacro );
-
-	function replaceMacro ( $0, filler, fillerArgs ) {
-		//$$ makes a literal $
-		if ( $0.startsWith('$$') ) {
-			return $0.slice( 1 );
-		}
-
-		//include the character that was matched in the $$ check, unless
-		// it's a $
-		var ret = '';
-		if ( $0[0] !== '$' ) {
-			ret = $0[ 0 ];
-		}
-
-		var macro = findMacro( filler );
-
-		//not found? bummer.
-		if ( !macro ) {
-			return filler;
-		}
-
-		bot.log( macro, filler, fillerArgs, '/parse replaceMacro' );
-		//when the macro is a function
-		if ( macro.apply ) {
-			ret += macro.apply( null, parseMacroArgs(fillerArgs) );
-		}
-		//when the macro is simply a substitution
-		else {
-			ret += macro;
-		}
-		return ret;
-	}
-
-	function parseMacroArgs ( macroArgs ) {
-		bot.log( macroArgs, '/parse parseMacroArgs' );
-		if ( !macroArgs ) {
-			return [ args ];
-		}
-
-		//parse the arguments, split them into individual arguments,
-		// and trim'em (to cover the case of "arg,arg" and "arg, arg")
-		return (
-			[ args ].concat(
-				parse( macroArgs, extraVars )
-					.split( ',' ).invoke( 'trim' ) ) );
-		//this is not good code
-	}
-
-	function findMacro ( macro ) {
-		var container = [ macros, msgObj, user, extraVars ].first( hasMacro );
-
-		return ( container || {} )[ macro ];
-
-		function hasMacro ( obj ) {
-			return obj && obj.hasOwnProperty( macro );
-		}
-	}
+	return bot.parseMacro( args.toString(), extraVars );
 };
-}());
 
 commands.tell = (function () {
 var invalidCommands = { tell : true, forget : true };

source/parseMacro.js

@@ -0,0 +1,107 @@
+//(function () {
+"use strict";
+
+var macros = {
+	who : function ( msgObj ) {
+		return msgObj.get( 'user_name' );
+	},
+
+	someone : function () {
+		var presentUsers = document.getElementById( 'sidebar' )
+			.getElementsByClassName( 'present-user' );
+
+		//the chat keeps a low opacity for users who remained silent for long,
+		// and high opacity for those who recently talked
+		var active = [].filter.call( presentUsers, function ( user ) {
+			return Number( user.style.opacity ) >= 0.5;
+		}),
+		user = active[ Math.floor(Math.random() * (active.length-1)) ];
+
+		if ( !user ) {
+			return 'Nobody';
+		}
+
+		return user.getElementsByTagName( 'img' )[ 0 ].title;
+	},
+
+	digit : function () {
+		return Math.floor( Math.random() * 10 );
+	},
+
+	encode : function ( msgObj, string ) {
+		return encodeURIComponent( string );
+	},
+
+	//random number, min <= n <= max
+	//treats non-numeric inputs like they don't exist
+	rand : function ( msgObj, min, max ) {
+		min = Number( min );
+		max = Number( max );
+		return Math.rand( min, max );
+	}
+};
+var macroRegex = /(?:.|^)\$(\w+)(?:\((.*?)\))?/g;
+
+bot.parseMacro = function parse ( source, extraVars ) {
+	return source.replace( macroRegex, replaceMacro );
+
+	function replaceMacro ( $0, filler, fillerArgs ) {
+		//$$ makes a literal $
+		if ( $0.startsWith('$$') ) {
+			return $0.slice( 1 );
+		}
+
+		//include the character that was matched in the $$ check, unless
+		// it's a $
+		var ret = '';
+		if ( $0[0] !== '$' ) {
+			ret = $0[ 0 ];
+		}
+
+		var macro = findMacro( filler );
+
+		//not found? bummer.
+		if ( !macro ) {
+			return filler;
+		}
+
+		bot.log( macro, filler, fillerArgs, '/parse replaceMacro' );
+		//when the macro is a function
+		if ( macro.apply ) {
+			ret += macro.apply( null, parseMacroArgs(fillerArgs) );
+		}
+		//when the macro is simply a substitution
+		else {
+			ret += macro;
+		}
+		return ret;
+	}
+
+	function parseMacroArgs ( macroArgs ) {
+		bot.log( macroArgs, '/parse parseMacroArgs' );
+		if ( !macroArgs ) {
+			return [ source ];
+		}
+
+		//parse the arguments, split them into individual arguments,
+		// and trim'em (to cover the case of "arg,arg" and "arg, arg")
+		return (
+			[ source ].concat(
+				parse( macroArgs, extraVars )
+					.split( ',' ).invoke( 'trim' ) ) );
+		//this is not good code
+	}
+
+	function findMacro ( macro ) {
+		var container = [ macros, extraVars ].first( hasMacro );
+
+		return ( container || {} )[ macro ];
+
+		function hasMacro ( obj ) {
+			return obj && obj.hasOwnProperty( macro );
+		}
+	}
+};
+
+
+//})();

source/plugins/learn.js

@@ -1,6 +1,5 @@
 (function () {
 "use strict";
-var parse = bot.getCommand( 'parse' );
 var storage = bot.memory.get( 'learn' );
 
 var replyPatterns = /^(<>|<user>|<msg>)/i,
@@ -87,7 +86,7 @@ function makeCustomCommand ( command ) {
 			return mismatchErrMessage.supplant( command );
 		}
 
-		var res = parse.exec( cmdArgs, parts );
+		var res = bot.parseMacro( cmdArgs, parts );
 
 		switch ( replyMethod ) {
 		case '':