js-2dmath/dist.js

Fast 2d geometry math: Vector2, Rectangle, Circle, Matrix2x3 (2D transformation), Circle, BoundingBox, Line2, Segment2, Intersections, Distances, Transitions (animation/tween), Random numbers, Noise

var falafel = require("falafel"),
    object = require("object-enhancements"),
    fs = require("fs");

var methods,
    valid_arguments,
    comments,
    common = require("./config.json").docs.arguments,
    files = require("./config.json").components,
    src,
    mod_required;

function isAssertCall(node) {
    return node.type === "CallExpression" &&
        node.callee.type === "Identifier" &&
        node.callee.name === "assert";
}

function isComment(node) {
    return node.type === "Block" && node.parent.type === "Program";
}

function isFunction(node) {
    return node.type === "FunctionDeclaration" && node.id && node.id.name;
}

function getArguments(node, white_list) {
    var args = [],
        arg,
        i,
        max;

    if (node.type === "FunctionDeclaration" && node.id && node.id.name) {
        if (node.id.name[0] === "_") {
            //internal skip!
            return;
        }

        // define a new function!


        for (i = 0, max = node.params.length; i < max; ++i) {
            arg = node.params[i].name;
            if (!white_list[arg]) {
                console.log(node);
                throw new Error(files[cls].filename + ":" + arg + " is an invalid argument name, not in whitelist");
            }
            args.push({name: arg, type: white_list[arg]});
        }
    }

    return args;
}

function attr_parse(attr, line, comments, full_line) {
    switch(attr.toLowerCase()) {
    case "returns":
    case "return":
        var line = line.substring(line.indexOf("{"));
        line = line.substring(1, line.indexOf("}"));
        methods[i].returns = line;
        break;
    case "see":
    case "alias":
        comments.push("  **see**: [" + line + "](#" + cls + "-" + line + ")");
        break;
    case "http":
        comments.push("  **link**: [" + line + "](" + line + ")");
        break;
    case "source":
        comments.push("  **source**: [" + line + "](" + line + ")");
        break;
    case "reference":
        comments.push("  **reference**: [" + line + "](" + line + ")");
        break;
    case "note":
        comments.push("  *note*: " + line);
    case "todo":
        comments.push("  *todo*: " + line);
    }
}

function parse_comments(list) {
    var description = [],
        extra = [];

    list.forEach(function (c) {
        var line,
            attr,
            at_pos = c.indexOf("@");

        if (at_pos > -1 && at_pos < 5) {
            line = c.substring(c.indexOf("@") + 1);
            attr = line.substring(0, line.indexOf(" "));
            line = line.substring(line.indexOf(" ") + 1);
            attr_parse(attr, line, extra, c);
        } else {
            line = c.trim().replace(/^\*(\s{0,1})/, "").replace(/^\*$/, "");
            if (line.length && line != "!") {
                description.push("  " + line);
            }
        }
    });

    description = description.concat(extra);

    return description.join("\n\n");
}

function create_number_validator(post_str) {
    post_str = post_str || "";
    return "if (%var%" + post_str + " == undefined) { console.log(%var%); throw new Error('%var%" + post_str + " is undefined/null'); }\n" +
           "if (Number.isNaN(%var%" + post_str + ")) { console.log(%var%); throw new Error('%var%" + post_str + " is nan'); }\n";
}


var validators = {
    "Number": create_number_validator()
};

validators.Vec2 = [0, 1].map(function (i) {return create_number_validator("[" + i + "]"); }).join("\n");

validators.Matrix23 = [0, 1, 2, 3, 4, 5].map(function (i) {return create_number_validator("[" + i + "]"); }).join("\n");

validators.Matrix22 = [0, 1, 2, 3].map(function (i) {return create_number_validator("[" + i + "]"); }).join("\n");

validators.AABB2 = validators.Segment2 = validators.Matrix22;

validators.Rectangle = [0, 1].map(function (i) {
    return [0, 1].map(function (j) {
        return create_number_validator("[" + i + "][" + j + "]");
    }).join("\n");
}).join("\n");

validators.Triangle = [0, 1, 2].map(function (i) {
    return [0, 1].map(function (j) {
        return create_number_validator("[" + i + "][" + j + "]");
    }).join("\n");
}).join("\n");


var cls_list = [],
    cls,
    i,
    description;

for (cls in files) {
    cls_list.push("[" + cls + "](#" + cls + ")");

}

function isFileDesccription(node) {
    return node.loc.start.line === 1;
}

function getNearestFunction(node) {
    // search nearest function
    var fn = null,
        min_diff = 9999;

    node.parent.body.every(function (subnode) {
        if (subnode.type === "FunctionDeclaration") {
            var diff = subnode.loc.start.line - node.loc.end.line;

            if (diff > 0 && diff < min_diff) {
                min_diff = diff;
                fn = subnode;
            }
        }

        return true;
    });

    return fn;
}


for (cls in files) {

    console.log("* [" + cls + "](https://github.com/llafuente/js-2dmath/blob/master/" + files[cls].doc_file.replace("./", "") + ")");

    description = null;

    methods = {};
    src = fs.readFileSync(files[cls].filename, "utf-8");

    mod_required = require(files[cls].filename);

    // test
    //src = fs.readFileSync("doc-test.js", "utf-8");

    valid_arguments = object.merge(common, files[cls].valid_arguments);

    //
    // - documentation
    //
    falafel(src, {comment: true, loc: true}, function (node) {
        //console.log(node);

        if (isFunction(node) && node.id.name[0] != "_") {
            methods[node.id.name] = {
                arguments: getArguments(node, valid_arguments),
                comments: [],
                returns: null,
                loc: node.loc
            };
        }

        if (isComment(node)) {
            if (isFileDesccription(node)) {
                description = node.value.split("\n");
            } else {

                var fn = getNearestFunction(node);

                if (fn && methods[fn.id.name]) {
                    methods[fn.id.name].comments = node.value.split("\n");
                }
            }
        }
    });

    // DEFINES
    for (i in mod_required) {
        if ("function" === typeof mod_required[i] && !methods[i]) {
            // check if it"s an alias
            if (methods[mod_required[i].name]) {
                //alias!
                methods[i] = object.clone(methods[mod_required[i].name]);
                methods[i].comments = ["@alias " + mod_required[i].name];
            } else {
                // this is for complex cases - generated code
                try {
                    falafel(mod_required[i], {comment: true, loc: true}, function (node) {
                        //console.log(node);

                        isFunction(node);
                    });
                } catch (e) {
                    methods[i] = {
                        arguments: [],
                        comments: [],
                        returns: null,
                        loc: null
                    };
                }
            }
        }
    }

    var contents = [],
        i;
    contents.push("<a name=\"" + cls + "\"></a>");
    contents.push("## " + cls);

    if (description) {
        contents.push(parse_comments(description));
    }

    // DEFINES
    for (i in mod_required) {
        if ("function" !== typeof mod_required[i]) {
            if ("object" !== typeof mod_required[i]) {
                contents.push("* **" + i + "** = " + mod_required[i]);
            }
        }
    }

    for (i in methods) {
        if (methods[i].comments.length) {
            methods[i].comments = parse_comments(methods[i].comments);
        }

        contents.push("");
        contents.push("<a name=\"" + cls + "-" + i + "\"></a>");


        if (!methods[i].arguments) {
            console.log(i);
            console.log(methods[i]);
            process.exit();
        }

        var args_str = methods[i].arguments.map(function (a) {
            return "*" + a.name + "*: " + a.type;
        }).join(", ");

        if (methods[i].returns) {
            contents.push("* **" + i + "** (" + args_str + "): " + methods[i].returns);
        } else {
            contents.push("* **" + i + "** (" + args_str + ")");
        }

        if (methods[i].comments.length) {
            contents.push("");
            contents.push(methods[i].comments);
            contents.push("");
        }
    }

    fs.writeFileSync(files[cls].doc_file, contents.join("\n"), "utf-8");
}