apidoc-lite (2020.6.8)

Code coverage report for node-apidoc-lite/test.js

Ignored Statements Branches Functions Lines
Statements: 50
Branches: 40
Functions: 12
100%
(109 / 109)
100%
(60 / 60)
100%
(19 / 19)
100%
(109 / 109)
All files » node-apidoc-lite/ » test.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311           2   2 2   2   2 1 1         1 1 1 1       2 2 2   2           2       2       1 1       1 1 1     1 1     1 1 1   1   1 1 1 1     2       1 1   1                                 2       1 1 1 1 1 1 1   1   1   2       1   2       1   2         1 1 1     1 1 1 1 1   1         1       1 1     2         1 1 1                   2           2   2 2 2   2           2 2 2 2       2 1 1   1                                                         1 1   1     1       1 1   1 1 1 1 1   1                       1   1     1   1     1 1     2       2 1 1     1         1       1       1                   1       1      
/* istanbul instrument in package apidoc */
// assets.utility2.header.js - start
/* jslint utility2:true */
/* istanbul ignore next */
// run shared js-env code - init-local
(function (globalThis) {
    "use strict";
    let consoleError;
    let local;
    // init globalThis
    globalThis.globalThis = globalThis.globalThis || globalThis;
    // init debugInline
    Iif (!globalThis.debugInline) {
        consoleError = console.error;
        globalThis.debugInline = function (...argList) {
        /*
         * this function will both print <argList> to stderr
         * and return <argList>[0]
         */
            consoleError("\n\ndebugInline");
            consoleError(...argList);
            consoleError("\n");
            return argList[0];
        };
    }
    // init local
    local = {};
    local.local = local;
    globalThis.globalLocal = local;
    // init isBrowser
    local.isBrowser = (
        typeof globalThis.XMLHttpRequest === "function"
        && globalThis.navigator
        && typeof globalThis.navigator.userAgent === "string"
    );
    // init isWebWorker
    local.isWebWorker = (
        local.isBrowser && typeof globalThis.importScripts === "function"
    );
    // init function
    local.assertJsonEqual = function (aa, bb) {
    /*
     * this function will assert JSON.stringify(<aa>) === JSON.stringify(<bb>)
     */
        let objectDeepCopyWithKeysSorted;
        objectDeepCopyWithKeysSorted = function (obj) {
        /*
         * this function will recursively deep-copy <obj> with keys sorted
         */
            let sorted;
            if (typeof obj !== "object" || !obj) {
                return obj;
            }
            // recursively deep-copy list with child-keys sorted
            if (Array.isArray(obj)) {
                return obj.map(objectDeepCopyWithKeysSorted);
            }
            // recursively deep-copy obj with keys sorted
            sorted = {};
            Object.keys(obj).sort().forEach(function (key) {
                sorted[key] = objectDeepCopyWithKeysSorted(obj[key]);
            });
            return sorted;
        };
        aa = JSON.stringify(objectDeepCopyWithKeysSorted(aa));
        bb = JSON.stringify(objectDeepCopyWithKeysSorted(bb));
        if (aa !== bb) {
            throw new Error(JSON.stringify(aa) + " !== " + JSON.stringify(bb));
        }
    };
    local.assertOrThrow = function (passed, msg) {
    /*
     * this function will throw <msg> if <passed> is falsy
     */
        if (passed) {
            return;
        }
        throw (
            (
                msg
                && typeof msg.message === "string"
                && typeof msg.stack === "string"
            )
            // if msg is err, then leave as is
            ? msg
            : new Error(
                typeof msg === "string"
                // if msg is string, then leave as is
                ? msg
                // else JSON.stringify(msg)
                : JSON.stringify(msg, undefined, 4)
            )
        );
    };
    local.coalesce = function (...argList) {
    /*
     * this function will coalesce null, undefined, or "" in <argList>
     */
        let arg;
        let ii;
        ii = 0;
        while (ii < argList.length) {
            arg = argList[ii];
            if (arg !== undefined && arg !== null && arg !== "") {
                return arg;
            }
            ii += 1;
        }
        return arg;
    };
    local.identity = function (val) {
    /*
     * this function will return <val>
     */
        return val;
    };
    local.nop = function () {
    /*
     * this function will do nothing
     */
        return;
    };
    local.objectAssignDefault = function (tgt = {}, src = {}, depth = 0) {
    /*
     * this function will if items from <tgt> are null, undefined, or "",
     * then overwrite them with items from <src>
     */
        let recurse;
        recurse = function (tgt, src, depth) {
            Object.entries(src).forEach(function ([
                key, bb
            ]) {
                let aa;
                aa = tgt[key];
                if (aa === undefined || aa === null || aa === "") {
                    tgt[key] = bb;
                    return;
                }
                if (
                    depth !== 0
                    && typeof aa === "object" && aa && !Array.isArray(aa)
                    && typeof bb === "object" && bb && !Array.isArray(bb)
                ) {
                    recurse(aa, bb, depth - 1);
                }
            });
        };
        recurse(tgt, src, depth | 0);
        return tgt;
    };
    // bug-workaround - throw unhandledRejections in node-process
    Iif (
        typeof process === "object" && process
        && typeof process.on === "function"
        && process.unhandledRejections !== "strict"
    ) {
        process.unhandledRejections = "strict";
        process.on("unhandledRejection", function (err) {
            throw err;
        });
    }
}((typeof globalThis === "object" && globalThis) || window));
// assets.utility2.header.js - end



/* jslint utility2:true */
/* istanbul ignore next */
(function (local) {
"use strict";



// run shared js-env code - init-before
(function () {
// init local
local = globalThis.utility2 || require("utility2");
local = local.requireReadme();
globalThis.local = local;
// init test
local.testRunDefault(local);
}());



// run shared js-env code - function
(function () {
let assertJsonEqual;
assertJsonEqual = local.assertJsonEqual;
local.testCase_apidocCreate_default = function (options, onError) {
/*
 * this function will test apidocCreate's default handling-behavior-behavior
 */
    if (local.isBrowser) {
        onError(null, options);
        return;
    }
    options = {
        // test invalid-exampleFile handling-behavior
        exampleFileList: [
            "undefined"
        ],
        libFileList: [
            // test invalid-libFile handling-behavior
            "lib.undefined.js"
        ],
        moduleDict: {
            // test invalid-module-name handling-behavior
            "invalid name": {}
        },
        // test packageJson handling-behavior
        packageJson: {
            _: "",
            aa: "bb",
            emailDict: {
                email: "a@a.com"
            },
            emailList: [
                {
                    email: "a@a.com"
                }
            ],
            readme: ""
        }
    };
    // test weird-module handling-behavior
    options.moduleDict.undefined = function () {
        return;
    };
    options.moduleDict.undefined();
    // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/
    // Working_with_Objects#Defining_getters_and_setters
    Object.defineProperty(options.moduleDict.undefined, "error", {
        get: local.throwError,
        set: local.throwError
    });
    options.moduleDict.undefined.toString = local.throwError;
    local.apidocCreate(options);
    // validate options
    assertJsonEqual(options.packageJson._, undefined);
    assertJsonEqual(options.packageJson.aa, "bb");
    assertJsonEqual(options.packageJson.emailDict.email, undefined);
    assertJsonEqual(options.packageJson.emailList[0].email, undefined);
    assertJsonEqual(options.packageJson.readme, undefined);
    // test swgg.apiDict handling-behavior
    options = {
        moduleDict: {
            undefined: {
                swgg: {
                    apiDict: {
                        "aa bb": {}
                    }
                }
            }
        },
        packageJson: {}
    };
    local.apidocCreate(options);
    // test modeNoApidoc handling-behavior
    options = {
        modeNoApidoc: true
    };
    local.apidocCreate(options);
    // test invalid-require handling-behavior
    options = {
        require: local.nop
    };
    local.apidocCreate(options);
    onError(null, options);
};

local.testCase_moduleDirname_default = function (opt, onError) {
/*
 * this function will test moduleDirname's default handling-behavior
 */
    if (local.isBrowser) {
        onError(undefined, opt);
        return;
    }
    // test null-case handling-behavior
    assertJsonEqual(
        local.moduleDirname(undefined, module.paths),
        process.cwd()
    );
    // test path handling-behavior
    assertJsonEqual(
        local.moduleDirname(".", module.paths),
        process.cwd()
    );
    assertJsonEqual(
        local.moduleDirname("./", module.paths),
        process.cwd()
    );
    assertJsonEqual(
        local.moduleDirname(
            require("path").basename(process.cwd()),
            [
                require("path").dirname(process.cwd())
            ]
        ),
        process.cwd()
    );
    // test module-does-not-exist handling-behavior
    assertJsonEqual(
        local.moduleDirname("syntax-err", module.paths),
        ""
    );
    onError(undefined, opt);
};
}());
}());