mahabhuta 0.7.7 → 0.7.8

package/TODO.md

@@ -0,0 +1,7 @@
+# Ideas for things to do
+
+**Implement a test suite**: This is a must, really.
+
+**Implement a command-line tool**:  It would take a module name to load that will contain Mahafuncs, then take input file and output file names.
+
+**Do something more significant with Mahafunc bundles**: 

package/index.js

@@ -151,11 +151,13 @@ exports.PageProcessor = class PageProcessor extends exports.Mahafunc {
 const _mahaarray_name = Symbol('name');
 const _mahaarray_options = Symbol('options');
 const _mahaarray_functions = Symbol('functions');
+const _mahaarray_final_functions = Symbol('final_functions');
 
 exports.MahafuncArray = class MahafuncArray {
 
     constructor(name, config) {
         this[_mahaarray_functions] = [];
+        this[_mahaarray_final_functions] = [];
         this[_mahaarray_name] = name;
         this[_mahaarray_options] = config;
         // console.log(`new MahafuncArray ${this[_mahaarray_name]} ${util.inspect(this[_mahaarray_options])}`);
@@ -167,6 +169,8 @@ exports.MahafuncArray = class MahafuncArray {
 
     get functions() { return this[_mahaarray_functions]; }
 
+    get final_functions() { return this[_mahaarray_final_functions]; }
+
     addMahafunc(func) {
         if (!(func instanceof exports.Mahafunc
            || func instanceof exports.MahafuncArray
@@ -195,87 +199,119 @@ exports.MahafuncArray = class MahafuncArray {
         }
     }
 
+    setFinalMahafuncArray(final_functions) {
+        if (!(Array.isArray(final_functions))) {
+            throw new Error("Improper mahafunction array "+ util.inspect(final_functions));
+        } else {
+            this[_mahaarray_final_functions] = final_functions;
+            for (let func of this[_mahaarray_final_functions]) {
+                if (func instanceof exports.Mahafunc) {
+                    func.array = this;
+                }
+            }
+        }
+    }
+
+    addFinalMahafunc(func) {
+        if (!(func instanceof exports.Mahafunc
+           || func instanceof exports.MahafuncArray
+           || typeof func === 'function'
+           || Array.isArray(func))) {
+            throw new Error("Improper addition "+ util.inspect(func));
+        } else {
+            this.final_functions.push(func);
+            if (func instanceof exports.Mahafunc) {
+                func.array = this;
+            }
+        }
+        return this; // support chaining
+    }
+
     async process($, metadata, dirty) {
         if (traceFlag)  console.log(`Mahabhuta starting array ${this.name}`);
         const loops = [];
         // const startProcessing = new Date();
-        for (var mahafunc of this.functions) {
-            if (mahafunc instanceof exports.CustomElement) {
-                if (traceFlag) console.log(`Mahabhuta calling CustomElement ${this.name} ${mahafunc.elementName}`);
-                try {
-                    await mahafunc.processAll($, metadata, dirty);
-                } catch (errCustom) {
-                    throw new Error(`Mahabhuta ${this.name} caught error in CustomElement(${mahafunc.elementName}): ${errCustom.message}`);
-                }
-                // loops.push(`... CustomElement ${mahafunc.elementName} ${(new Date() - startProcessing) / 1000} seconds`);
-            } else if (mahafunc instanceof exports.Munger) {
-                if (traceFlag)  console.log(`Mahabhuta calling Munger ${this.name} ${mahafunc.selector}`);
-                try {
-                    await mahafunc.processAll($, metadata, dirty);
-                } catch (errMunger) {
-                    throw new Error(`Mahabhuta ${this.name} caught error in Munger(${mahafunc.selector}): ${errMunger.message}`);
-                }
-                if (traceFlag)  console.log(`Mahabhuta FINISHED Munger ${this.name} ${mahafunc.selector}`);
-                // loops.push(`... Munger ${mahafunc.selector} ${(new Date() - startProcessing) / 1000} seconds`);
-            } else if (mahafunc instanceof exports.PageProcessor) {
-                // Performance testing
-                let _start;
-                if (tracePerf) _start = new Date();
-                if (traceFlag)  console.log(`Mahabhuta calling ${this.name} PageProcessor `);
-                try {
-                    await mahafunc.process($, metadata, dirty);
-                } catch (errPageProcessor) {
-                    throw new Error(`Mahabhuta ${this.name} caught error in PageProcessor: ${errPageProcessor.message}`);
-                }
-                // Performance testing
-                if (tracePerf) console.log(`PageProcessor ${this.name} ${(new Date() - _start) / 1000} seconds`)
-                // loops.push(`... PageProcessor ${(new Date() - startProcessing) / 1000} seconds`);
-            } else if (mahafunc instanceof exports.MahafuncArray) {
-                // Performance testing
-                let _start;
-                if (tracePerf) _start = new Date();
-                let results = [];
-                try {
-                    results = await mahafunc.process($, metadata, dirty);
-                } catch (errMahafuncArray) {
-                    throw new Error(`Mahabhuta ${this.name} caught error in MahafuncArray: ${errMahafuncArray.message}`);
-                }
-                // Performance testing
-                if (tracePerf) console.log(`MahafuncArray ${this.name} ${mahafunc.name} ${(new Date() - _start) / 1000} seconds`)
-
-                // results.forEach(result => { loops.push(`    ... "${mahafunc.name} result" ${result} ${(new Date() - startProcessing) / 1000} seconds`); });
-                // loops.push(`... MahafuncArray ${mahafunc.name} ${(new Date() - startProcessing) / 1000} seconds`);
-            } else if (typeof mahafunc === 'function') {
-                // Performance testing
-                let _start;
-                if (tracePerf) _start = new Date();
-                if (traceFlag)  console.log(`Mahabhuta calling an ${this.name} "function" `);
-                try {
-                    await new Promise((resolve, reject) => {
-                        mahafunc($, metadata, dirty, err => {
-                            if (err) reject(err);
-                            else resolve();
+
+        // Run the functions, then run the final_functions
+        for (let funclist of [ this.functions, this.final_functions]) {
+            for (let mahafunc of funclist) {
+                if (mahafunc instanceof exports.CustomElement) {
+                    if (traceFlag) console.log(`Mahabhuta calling CustomElement ${this.name} ${mahafunc.elementName}`);
+                    try {
+                        await mahafunc.processAll($, metadata, dirty);
+                    } catch (errCustom) {
+                        throw new Error(`Mahabhuta ${this.name} caught error in CustomElement(${mahafunc.elementName}): ${errCustom.message}`);
+                    }
+                    // loops.push(`... CustomElement ${mahafunc.elementName} ${(new Date() - startProcessing) / 1000} seconds`);
+                } else if (mahafunc instanceof exports.Munger) {
+                    if (traceFlag)  console.log(`Mahabhuta calling Munger ${this.name} ${mahafunc.selector}`);
+                    try {
+                        await mahafunc.processAll($, metadata, dirty);
+                    } catch (errMunger) {
+                        throw new Error(`Mahabhuta ${this.name} caught error in Munger(${mahafunc.selector}): ${errMunger.message}`);
+                    }
+                    if (traceFlag)  console.log(`Mahabhuta FINISHED Munger ${this.name} ${mahafunc.selector}`);
+                    // loops.push(`... Munger ${mahafunc.selector} ${(new Date() - startProcessing) / 1000} seconds`);
+                } else if (mahafunc instanceof exports.PageProcessor) {
+                    // Performance testing
+                    let _start;
+                    if (tracePerf) _start = new Date();
+                    if (traceFlag)  console.log(`Mahabhuta calling ${this.name} PageProcessor `);
+                    try {
+                        await mahafunc.process($, metadata, dirty);
+                    } catch (errPageProcessor) {
+                        throw new Error(`Mahabhuta ${this.name} caught error in PageProcessor: ${errPageProcessor.message}`);
+                    }
+                    // Performance testing
+                    if (tracePerf) console.log(`PageProcessor ${this.name} ${(new Date() - _start) / 1000} seconds`)
+                    // loops.push(`... PageProcessor ${(new Date() - startProcessing) / 1000} seconds`);
+                } else if (mahafunc instanceof exports.MahafuncArray) {
+                    // Performance testing
+                    let _start;
+                    if (tracePerf) _start = new Date();
+                    let results = [];
+                    try {
+                        results = await mahafunc.process($, metadata, dirty);
+                    } catch (errMahafuncArray) {
+                        throw new Error(`Mahabhuta ${this.name} caught error in MahafuncArray: ${errMahafuncArray.message}`);
+                    }
+                    // Performance testing
+                    if (tracePerf) console.log(`MahafuncArray ${this.name} ${mahafunc.name} ${(new Date() - _start) / 1000} seconds`)
+
+                    // results.forEach(result => { loops.push(`    ... "${mahafunc.name} result" ${result} ${(new Date() - startProcessing) / 1000} seconds`); });
+                    // loops.push(`... MahafuncArray ${mahafunc.name} ${(new Date() - startProcessing) / 1000} seconds`);
+                } else if (typeof mahafunc === 'function') {
+                    // Performance testing
+                    let _start;
+                    if (tracePerf) _start = new Date();
+                    if (traceFlag)  console.log(`Mahabhuta calling an ${this.name} "function" `);
+                    try {
+                        await new Promise((resolve, reject) => {
+                            mahafunc($, metadata, dirty, err => {
+                                if (err) reject(err);
+                                else resolve();
+                            });
                         });
-                    });
-                } catch (errFunction) {
-                    throw new Error(`Mahabhuta ${this.name} caught error in function: ${errFunction.message}`);
+                    } catch (errFunction) {
+                        throw new Error(`Mahabhuta ${this.name} caught error in function: ${errFunction.message}`);
+                    }
+                    // Performance testing
+                    if (tracePerf) console.log(`function ${this.name} ${(new Date() - _start) / 1000} seconds`)
+                    // loops.push(`... MahafuncArray "function" ${(new Date() - startProcessing) / 1000} seconds`);
+                } else if (Array.isArray(mahafunc)) {
+                    // Performance testing
+                    let _start;
+                    if (tracePerf) _start = new Date();
+                    let mhObj = new exports.MahafuncArray("inline", this._config);
+                    mhObj.setMahafuncArray(mahafunc);
+                    let results = await mhObj.process($, metadata, dirty);
+                    // Performance testing
+                    if (tracePerf) console.log(`Array ${this.name} inline ${(new Date() - _start) / 1000} seconds`)
+                    // results.forEach(result => { loops.push(`    ... "inline result" ${result} ${(new Date() - startProcessing) / 1000} seconds`); });
+                    // loops.push(`... MahafuncArray "inline array" ${(new Date() - startProcessing) / 1000} seconds`);
+                } else {
+                    console.error(`BAD MAHAFUNC in array ${this.name} - ${util.inspect(mahafunc)}`);
                 }
-                // Performance testing
-                if (tracePerf) console.log(`function ${this.name} ${(new Date() - _start) / 1000} seconds`)
-                // loops.push(`... MahafuncArray "function" ${(new Date() - startProcessing) / 1000} seconds`);
-            } else if (Array.isArray(mahafunc)) {
-                // Performance testing
-                let _start;
-                if (tracePerf) _start = new Date();
-                let mhObj = new exports.MahafuncArray("inline", this._config);
-                mhObj.setMahafuncArray(mahafunc);
-                let results = await mhObj.process($, metadata, dirty);
-                // Performance testing
-                if (tracePerf) console.log(`Array ${this.name} inline ${(new Date() - _start) / 1000} seconds`)
-                // results.forEach(result => { loops.push(`    ... "inline result" ${result} ${(new Date() - startProcessing) / 1000} seconds`); });
-                // loops.push(`... MahafuncArray "inline array" ${(new Date() - startProcessing) / 1000} seconds`);
-            } else {
-                console.error(`BAD MAHAFUNC in array ${this.name} - ${util.inspect(mahafunc)}`);
             }
         }
         // return $.html();

package/package.json

@@ -21,7 +21,7 @@
     "type": "git",
     "url": "https://github.com/akashacms/mahabhuta.git"
   },
-  "version": "0.7.7",
+  "version": "0.7.8",
   "engines": {
     "node": ">=12.4"
   },

package/examples/express/app.js

@@ -1,72 +0,0 @@
-'use strict';
-
-const mahabhuta = require('mahabhuta');
-const maha      = require('./maha');
-
-const express = require('express');
-const util = require('util');
-const path = require('path');
-const favicon = require('serve-favicon');
-const logger = require('morgan');
-const cookieParser = require('cookie-parser');
-const bodyParser = require('body-parser');
-
-const routes = require('./routes/index');
-const users = require('./routes/users');
-
-var app = express();
-
-// view engine setup
-
-// TODO add more mahafuncs here
-maha.addMahafunc(mahabhuta.builtin.mahabhuta);
-maha.partialDir(path.join(__dirname, "partials"));
-maha.registerExpress(app, "maha");
-
-app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', 'maha');
-
-// uncomment after placing your favicon in /public
-//app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
-app.use(logger('dev'));
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({ extended: false }));
-app.use(cookieParser());
-app.use(express.static(path.join(__dirname, 'public')));
-
-app.use('/', routes);
-app.use('/users', users);
-
-// catch 404 and forward to error handler
-app.use(function(req, res, next) {
-  var err = new Error('Not Found');
-  err.status = 404;
-  next(err);
-});
-
-// error handlers
-
-// development error handler
-// will print stacktrace
-if (app.get('env') === 'development') {
-  app.use(function(err, req, res, next) {
-    res.status(err.status || 500);
-    res.render('error', {
-      message: err.message,
-      error: err
-    });
-  });
-}
-
-// production error handler
-// no stacktraces leaked to user
-app.use(function(err, req, res, next) {
-  res.status(err.status || 500);
-  res.render('error', {
-    message: err.message,
-    error: {}
-  });
-});
-
-
-module.exports = app;

package/examples/express/bin/www

@@ -1,90 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Module dependencies.
- */
-
-var app = require('../app');
-var debug = require('debug')('express:server');
-var http = require('http');
-
-/**
- * Get port from environment and store in Express.
- */
-
-var port = normalizePort(process.env.PORT || '3000');
-app.set('port', port);
-
-/**
- * Create HTTP server.
- */
-
-var server = http.createServer(app);
-
-/**
- * Listen on provided port, on all network interfaces.
- */
-
-server.listen(port);
-server.on('error', onError);
-server.on('listening', onListening);
-
-/**
- * Normalize a port into a number, string, or false.
- */
-
-function normalizePort(val) {
-  var port = parseInt(val, 10);
-
-  if (isNaN(port)) {
-    // named pipe
-    return val;
-  }
-
-  if (port >= 0) {
-    // port number
-    return port;
-  }
-
-  return false;
-}
-
-/**
- * Event listener for HTTP server "error" event.
- */
-
-function onError(error) {
-  if (error.syscall !== 'listen') {
-    throw error;
-  }
-
-  var bind = typeof port === 'string'
-    ? 'Pipe ' + port
-    : 'Port ' + port;
-
-  // handle specific listen errors with friendly messages
-  switch (error.code) {
-    case 'EACCES':
-      console.error(bind + ' requires elevated privileges');
-      process.exit(1);
-      break;
-    case 'EADDRINUSE':
-      console.error(bind + ' is already in use');
-      process.exit(1);
-      break;
-    default:
-      throw error;
-  }
-}
-
-/**
- * Event listener for HTTP server "listening" event.
- */
-
-function onListening() {
-  var addr = server.address();
-  var bind = typeof addr === 'string'
-    ? 'pipe ' + addr
-    : 'port ' + addr.port;
-  debug('Listening on ' + bind);
-}

package/examples/express/maha.js

@@ -1,92 +0,0 @@
-'use strict';
-
-const mahabhuta = require('mahabhuta');
-const ejs       = require('ejs');
-const fs        = require('fs-extra-promise');
-const path      = require('path');
-const util      = require('util');
-
-var mahafuncs = new mahabhuta.MahafuncArray("mahabhuta-express-example", {});
-
-var partialDirName;
-
-exports.partialDir = function(_partialDir) {
-    partialDirName = _partialDir;
-};
-
-exports.addMahafunc = function(newMahafuncs) {
-    mahafuncs.addMahafunc(newMahafuncs);
-};
-
-exports.registerExpress = function(app, ext) {
-   app.engine(ext, (filePath, options, callback)  => {
-       // console.log(`Mahabhuta Express Engine ${util.inspect(mahafuncs)}`);
-       fs.readFile(filePath, 'utf8', (err, content) => {
-           if (err) return callback(err);
-           // console.log(`Mahabhuta Express Engine ${util.inspect(mahafuncs)}`);
-           // console.log(`Mahabhuta Express Engine ${util.inspect(content)} ${util.inspect(options)}`)
-           content = ejs.render(content.toString(), options);
-           mahabhuta.process(content, options, mahafuncs, (err, html) => {
-               if (err) { /* console.error(`Mahabhuta Express Engine ERROR ${err}`); */ callback(err); }
-               else { /* console.log(`Mahabhuta OKAY: ${html}`); */ callback(undefined, html); }
-           });
-       });
-   });
-   // console.log(`Mahabhuta Express Engine constructor ${util.inspect(this)} ------ ${util.inspect(this.mahafuncs)}`);
-};
-
-mahabhuta.builtin.configuration.renderPartial = function(fileName, contentBody, metadata) {
-    var partialPath = path.join(partialDirName, fileName);
-    // console.log(`renderPartial ${fileName} ${partialPath} ${contentBody}`);
-    return fs.statAsync(partialPath)
-    .then(stats => {
-        if (stats && stats.isFile()) {
-            return fs.readFileAsync(partialPath, 'utf8');
-        } else throw new Error(`Path ${partialPath} not a file`);
-    })
-    .then(fileData => {
-        return new Promise((resolve, reject) => {
-            // console.log(`renderPartial fileData ${fileData}`);
-            var rendered = ejs.render(fileData, metadata, {});
-            // console.log(`renderPartial rendered ${rendered}`);
-            mahabhuta.process(rendered, metadata, mahafuncs, (err, html) => {
-                if (err) { reject(err); }
-                else {
-                    // console.log(`renderPartial html ${html}`);
-                    resolve(html);
-                }
-            });
-        });
-    });
-};
-
-
-/*
-TODO make the resulting application somewhat useful.
-* https://www.npmjs.com/package/lorem-hipsum
-* https://www.npmjs.com/package/lorem-ipsum
-* https://www.npmjs.com/package/lorem-pedia
-* https://www.npmjs.com/package/lipsumator
-* https://www.npmjs.com/package/placeholder-generator
-* https://www.npmjs.com/package/blindipsum
-* https://www.npmjs.com/package/chinesegen
-* https://www.npmjs.com/package/boganipsum
-* https://www.npmjs.com/package/vinoipsum
-* https://www.npmjs.com/package/hall-and-oates-ipsum
-* https://www.npmjs.com/package/schuler-ipsum
-* https://www.npmjs.com/package/anything-ipsum
-* https://www.npmjs.com/package/synergipsum
-* https://www.npmjs.com/package/smithers-loremipsum
-* https://www.npmjs.com/package/jack-ipsum
-* https://www.npmjs.com/package/englipsum
-* https://www.npmjs.com/package/kanyeloremipsum
-* https://www.npmjs.com/package/kanye-ipsum
-* https://www.npmjs.com/package/body-builder-ipsum
-* https://www.npmjs.com/package/hipsum
-* https://www.npmjs.com/package/ipsum
-* https://www.npmjs.com/package/schiffer-ipsum
-* https://www.npmjs.com/package/bavaria-ipsum
-* https://www.npmjs.com/package/lobsteripsum
-* https://www.npmjs.com/package/bacon-stream
-* https://www.npmjs.com/package/neah
-* https://www.npmjs.com/package/mayonnaise.js */

package/examples/express/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "express",
-  "version": "0.0.0",
-  "private": true,
-  "scripts": {
-    "start": "node ./bin/www"
-  },
-  "dependencies": {
-    "body-parser": "~1.15.1",
-    "cheerio": "^0.22.0",
-    "cookie-parser": "~1.4.3",
-    "debug": "~3.1.0",
-    "ejs": "^2.4.2",
-    "express": "~4.13.4",
-    "fs-extra-promise": "^0.4.1",
-    "morgan": "~1.9.1",
-    "serve-favicon": "~2.3.0",
-    "mahabhuta": ">=0.5"
-  }
-}

package/examples/express/partials/sweets.ejs

@@ -1,5 +0,0 @@
-<% if (sweets) { %>
-    <ul>
-        <% for (sweet in sweets) { %><li><%= sweets[sweet] %></li><% } %>
-    </ul>
-<% } %>

package/examples/express/partials/test.html

@@ -1,7 +0,0 @@
-<div>
-    <ul>
-        <li>Item 1</li>
-        <li>Item 2</li>
-        <li>Item 3</li>
-    </ul>
-</div>

package/examples/express/public/stylesheets/style.css

@@ -1,8 +0,0 @@
-body {
-  padding: 50px;
-  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
-}
-
-a {
-  color: #00B7FF;
-}

package/examples/express/routes/index.js

@@ -1,18 +0,0 @@
-var express = require('express');
-var router = express.Router();
-
-/* GET home page. */
-router.get('/', function(req, res, next) {
-  res.render('hello-world', {
-    title: 'Express',
-    sweets: [
-        "Chocolate", "Strawberry", "Honey", "Kumquat"
-    ]
-  });
-});
-
-router.get('/foo', function(req, res, next) {
-  res.render('index.ejs', { title: 'Express' });
-});
-
-module.exports = router;

package/examples/express/routes/users.js

@@ -1,9 +0,0 @@
-var express = require('express');
-var router = express.Router();
-
-/* GET users listing. */
-router.get('/', function(req, res, next) {
-  res.send('respond with a resource');
-});
-
-module.exports = router;

package/examples/express/views/error.ejs

@@ -1,3 +0,0 @@
-<h1><%= message %></h1>
-<h2><%= error.status %></h2>
-<pre><%= error.stack %></pre>

package/examples/express/views/error.maha

@@ -1,3 +0,0 @@
-<h1><%= message %></h1>
-<h2><%= error.status %></h2>
-<pre><%= error.stack %></pre>

package/examples/express/views/hello-world.maha

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title><%= title %></title>
-    <external-stylesheet href='/stylesheets/style.css' ></external-stylesheet>
-  </head>
-  <body>
-    <h1><%= title %></h1>
-    <p>Hello, World!  Welcome to <%= title %></p>
-    <table><tr>
-        <td><partial file-name="test.html"></partial></td>
-        <td><partial file-name="sweets.ejs"></partial></td>
-    </tr></table>
-  </body>
-</html>

package/examples/express/views/index.ejs

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title><%= title %></title>
-    <link rel='stylesheet' href='/stylesheets/style.css' />
-    <external-stylesheet href='/stylesheets/style.css' ></external-stylesheet>
-  </head>
-  <body>
-    <h1><%= title %></h1>
-    <p>index.ejs Welcome to <%= title %></p>
-  </body>
-</html>

package/examples/hello-world/hello-world.js

@@ -1,32 +0,0 @@
-'use strict';
-
-const mahabhuta = require('../../index');
-
-var mahafuncs = new mahabhuta.MahafuncArray("example", {});
-
-class HelloWorld extends mahabhuta.CustomElement {
-	get elementName() { return "hello-world"; }
-	process($element, metadata, dirty) {
-		return Promise.resolve("Hello, world!");
-	}
-}
-mahafuncs.addMahafunc(new HelloWorld());
-
-mahabhuta.config({
-    recognizeSelfClosing: true,
-    recognizeCDATA: true
-});
-
-mahabhuta.process(`
-    <html>
-    <head>
-    <title>Hi</title>
-    </head>
-    <body>
-    <hello-world></hello-world>
-    </body>
-    </html>
-`, {}, mahafuncs, (err, html) => {
-    if (err) console.error(err);
-    else console.log(html);
-});