risei 1.0.4 → 1.1.1

package/{public/javascript → system}/TerminalReporter.js

@@ -1,222 +1,249 @@
-/**/
-
-/* TerminalReporter is an ATestReporter that sends each result to the terminal / console for display. */
-
-import { ATestReporter } from "./ATestReporter.js";
-import { TestGroup } from "./TestGroup.js";
-import { ClassTestGroup } from "./ClassTestGroup.js";
-import { MethodTestGroup } from "./MethodTestGroup.js";
-import { TestResult } from "./TestResult.js";
-import { TestSummary } from "./TestSummary.js";
-
-import chalk from "chalk";
-
-export class TerminalReporter extends ATestReporter {
-    // region Private fields
-
-    /* Foreground-colors using dependency calls and hex. */
-    #trueWhite = chalk.hex("FFFFFF");
-    #trueBlack = chalk.hex("000000");
-
-    /* Background colors as hex for dependency 
-       calls to use, needed syntactically. */
-    #blue = "0000CD";
-    #aqua = "00BFFF";
-    #paleGreen = "90EE90";
-    #paleRed = "F08080";
-
-    /* Full fore- and background color output styles. */
-
-    #classGroup = this.#trueWhite.bgHex(this.#blue).bold;
-    #methodGroup = this.#trueWhite.bgHex(this.#aqua).bold;
-    #passed = this.#trueBlack.bgHex(this.#paleGreen);
-    #failed = this.#trueBlack.bgHex(this.#paleRed);
-    #passedSummary = this.#trueBlack.bgHex(this.#paleGreen).bold;
-    #failedSummary = this.#trueBlack.bgHex(this.#paleRed).bold;
-    #summary = chalk.hex("000080").bgHex("FAFAD2").bold;
-
-    // Count of characters used for indent 
-    // and text to the left of each test.
-    #preUsedWidth = 20;
-
-    // endregion PrivateFields
-
-    // region ATestReporter
-
-    reportNext(result) {
-        // The next result introduces a group of tests.
-        if (result instanceof TestGroup) {
-            this.reportGroup(result);
-            return;
-        }
-
-        // The next result is from one test.
-        if (result instanceof TestResult) {
-            this.#reportTestResult(result);
-            return;
-        }
-
-        // The next result is the summary of all tests.
-        if (result instanceof TestSummary) {
-            this.reportSummary(result);
-            return;
-        }
-    }
-
-    reportGroup(result) {
-        if (result instanceof ClassTestGroup) {
-            console.log(this.#classGroup(` ${ result.group }: `));
-        }
-
-        if (result instanceof MethodTestGroup) {
-            console.log("   " + this.#methodGroup(` ${ result.group }(): `));
-        }
-    }
-
-    // region Private dependencies of reportNext()
-
-    #reportTestResult(result) {
-        if (result.didPass) {
-            this.reportPassed(result);
-        }
-
-        if (!result.didPass) {
-            this.reportFailed(result);
-        }
-    }
-
-    // endregion Private dependencies of reportNext()
-
-    reportPassed(result) {
-        this.#reportOneTestResult(result, "Passed", this.#passed);
-    }
-
-    reportFailed(result) {
-        this.#reportOneTestResult(result, "Failed", this.#failed);
-    }
-
-    // region Private dependencies of reportPassed() and reportFailed()
-
-    /* cruft, changes here */
-    #reportOneTestResult(result, net, styler) {
-        let { lineOne, lineTwo, lineThree } = this.#calculateResultDisplay(result);
-
-        console.log(
-            "\t" + styler(` ${ net }:  ${ lineOne }`)
-        );
-
-        if (lineTwo) {
-            console.log(
-                "\t\t  " + styler(` ${ lineTwo }`)
-            );
-        }
-
-        if (lineThree) {
-            console.log(
-                "\t\t  " + styler(` ${ lineThree }`)
-            );
-        }
-    }
-    
-    /* &cruft, changes here and/or factoring 
-       to lengths and tactics branching */
-    #calculateResultDisplay(result) {
-        /* Getting lengths to determine if output should 
-         * be split to multiple lines to fit the window. */
-
-        let forInputsLength
-            = this.#preUsedWidth
-            + result.identityText.length
-            + result.inputsText.length;
-
-        let allLength
-            = forInputsLength
-            + result.expectedText.length
-            + result.actualText.length;
-
-        /* Splitting as much as is needed. */
-        
-        let identityText = result.identityText;
-        let inputsText = result.inputsText;
-        let expectedText = result.expectedText;
-        let actualText = result.actualText;
-
-        if (forInputsLength >= process.stdout.columns) {
-            return this.#threeLineTactic(identityText, inputsText, expectedText, actualText);
-        }
-
-        if (allLength >= process.stdout.columns) {
-            return this.#twoLineTactic(identityText, inputsText, expectedText, actualText);
-        }
-
-        return this.#oneLineTactic(identityText, inputsText, expectedText, actualText);
-    }
-
-    // region Private dependencies of #calculateResultDisplay()
-
-    #threeLineTactic(identityText, inputsText, expectedText, actualText) {
-        // Each line, with two spaces between phrases on same line.
-        let lineOne = identityText;
-        let lineTwo = inputsText;
-        let lineThree = expectedText + " " + actualText;
-
-        return { lineOne, lineTwo, lineThree };
-    }
-
-    #twoLineTactic(identityText, inputsText, expectedText, actualText) {
-        // Each line, with two spaces between phrases on same line.
-        let lineOne = identityText + " " + inputsText;
-        let lineTwo = expectedText + " " + actualText;
-
-        // Left undefined.
-        let lineThree;
-
-        return { lineOne, lineTwo, lineThree };
-    }
-
-    #oneLineTactic(identityText, inputsText, expectedText, actualText) {
-        // Single line, with two spaces between all phrases.
-        let lineOne
-            = identityText
-            + " "
-            + inputsText
-            + " "
-            + expectedText
-            + " "
-            + actualText;
-
-        // Left undefined.
-        let lineTwo, lineThree;
-
-        return { lineOne, lineTwo, lineThree };
-    }
-
-    // endregion Private dependencies of #calculateResultDisplay()
-
-    // endregion Private dependencies of reportPassed() and reportFailed()
-
-    reportSummary(summary) {
-        console.log();
-
-        if (summary.anyWereRun) {
-            if (summary.allDidPass) {
-                console.log(this.#passedSummary(this.#toFullWidth(" Test run succeeded.")));
-            }
-            else {
-                console.log(this.#failedSummary(this.#toFullWidth(" Test run failed.")));
-            }
-        }
-
-        console.log(this.#summary(this.#toFullWidth(` ${ summary.summary }`)));
-    }
-
-    #toFullWidth(text) {
-        text = text || "";
-        let width = process.stdout.columns;
-
-        return text.padEnd(width, "\u00A0");
-    }
-
-    // endregion ATestReporter
-
-}
+/**/
+
+/* TerminalReporter is an ATestReporter that sends each result to the terminal / console for display. */
+
+import { ATestReporter } from "./ATestReporter.js";
+import { TestGroup } from "./TestGroup.js";
+import { ClassTestGroup } from "./ClassTestGroup.js";
+import { MethodTestGroup } from "./MethodTestGroup.js";
+import { TestResult } from "./TestResult.js";
+import { TestSummary } from "./TestSummary.js";
+
+import chalk from "chalk";
+
+export class TerminalReporter extends ATestReporter {
+    // region Private fields
+
+    /* Foreground-colors using dependency calls and hex. */
+    #trueWhite = chalk.hex("FFFFFF");
+    #trueBlack = chalk.hex("000000");
+
+    /* Background colors as hex for dependency 
+       calls to use, needed syntactically. */
+    #blue = "0000CD";
+    #aqua = "00BFFF";
+    #paleGreen = "90EE90";
+    #paleRed = "F08080";
+
+    /* Full fore- and background color output styles. */
+
+    #classGroup = this.#trueWhite.bgHex(this.#blue).bold;
+    #methodGroup = this.#trueWhite.bgHex(this.#aqua).bold;
+    #passed = this.#trueBlack.bgHex(this.#paleGreen);
+    #failed = this.#trueBlack.bgHex(this.#paleRed);
+    #passedSummary = this.#trueBlack.bgHex(this.#paleGreen).bold;
+    #failedSummary = this.#trueBlack.bgHex(this.#paleRed).bold;
+    #summary = chalk.hex("000080").bgHex("FAFAD2").bold;
+
+    // Count of characters used for indent 
+    // and text to the left of each test.
+    #preUsedWidth = 20;
+
+    // endregion PrivateFields
+
+    // region ATestReporter
+
+    reportNext(result) {
+        // The next result introduces a group of tests.
+        if (result instanceof TestGroup) {
+            this.reportGroup(result);
+            return;
+        }
+
+        // The next result is from one test.
+        if (result instanceof TestResult) {
+            this.#reportTestResult(result);
+            return;
+        }
+
+        // The next result is the summary of all tests.
+        if (result instanceof TestSummary) {
+            this.reportSummary(result);
+            return;
+        }
+    }
+
+    reportGroup(result) {
+        if (result instanceof ClassTestGroup) {
+            console.log(this.#classGroup(` ${ result.group }: `));
+        }
+
+        if (result instanceof MethodTestGroup) {
+            console.log("   " + this.#methodGroup(` ${ result.group }(): `));
+        }
+    }
+
+    // region Private dependencies of reportNext()
+
+    #reportTestResult(result) {
+        if (result.didPass) {
+            this.reportPassed(result);
+        }
+
+        if (!result.didPass) {
+            this.reportFailed(result);
+        }
+    }
+
+    // endregion Private dependencies of reportNext()
+
+    reportPassed(result) {
+        this.#reportOneTestResult(result, "Passed", this.#passed);
+    }
+
+    reportFailed(result) {
+        this.#reportOneTestResult(result, "Failed", this.#failed);
+    }
+
+    // region Private dependencies of reportPassed() and reportFailed()
+
+    /* &cruft, changes here / in dependencies 
+       for better splitting to multiple lines */
+    #reportOneTestResult(result, net, styler) {
+        let { lineOne, lineTwo, lineThree, lineFour } = this.#calculateResultDisplay(result);
+
+        console.log(
+            "\t" + styler(` ${ net }:  ${ lineOne }`)
+        );
+
+        if (lineTwo) {
+            console.log(
+                "\t\t  " + styler(` ${ lineTwo }`)
+            );
+        }
+
+        if (lineThree) {
+            console.log(
+                "\t\t  " + styler(` ${ lineThree }`)
+            );
+        }
+        
+        if (lineFour) {
+            console.log(
+                "\t\t  " + styler(` ${ lineFour }`)
+            );
+        }
+    }
+    
+    #calculateResultDisplay(result) {
+        /* Getting lengths to determine if output should 
+         * be split to multiple lines to fit the window. */
+
+        let forInputsLength
+            = this.#preUsedWidth
+            + result.identityText.length
+            + result.inputsText.length;
+
+        let allLength
+            = forInputsLength
+            + result.expectedText.length
+            + result.actualText.length;
+        
+        let forOutputsLength 
+            = this.#preUsedWidth
+            + result.expectedText.length
+            + result.actualText.length;
+
+        /* Splitting as much as is needed. */
+        
+        let identityText = result.identityText;
+        let inputsText = result.inputsText;
+        let expectedText = result.expectedText;
+        let actualText = result.actualText;
+
+        if (forOutputsLength >= process.stdout.columns) {
+            return this.#fourLineTactic(identityText, inputsText, expectedText, actualText);
+        }
+
+        if (forInputsLength >= process.stdout.columns) {
+            return this.#threeLineTactic(identityText, inputsText, expectedText, actualText);
+        }
+
+        if (allLength >= process.stdout.columns) {
+            return this.#twoLineTactic(identityText, inputsText, expectedText, actualText);
+        }
+
+        return this.#oneLineTactic(identityText, inputsText, expectedText, actualText);
+    }
+
+    // region Private dependencies of #calculateResultDisplay()
+
+    #fourLineTactic(identityText, inputsText, expectedText, actualText) {
+        // Each line on its own.
+        let lineOne = identityText;
+        let lineTwo = inputsText;
+        let lineThree = expectedText;
+        let lineFour = actualText;
+        
+        return { lineOne, lineTwo, lineThree, lineFour };
+    }
+
+    #threeLineTactic(identityText, inputsText, expectedText, actualText) {
+        // Each line, with two spaces between phrases on same line.
+        let lineOne = identityText;
+        let lineTwo = inputsText;
+        let lineThree = expectedText + " " + actualText;
+
+        // Left undefined.
+        let lineFour;
+
+        return { lineOne, lineTwo, lineThree, lineFour };
+    }
+
+    #twoLineTactic(identityText, inputsText, expectedText, actualText) {
+        // Each line, with two spaces between phrases on same line.
+        let lineOne = identityText + " " + inputsText;
+        let lineTwo = expectedText + " " + actualText;
+
+        // Left undefined.
+        let lineThree, lineFour;
+
+        return { lineOne, lineTwo, lineThree, lineFour };
+    }
+
+    #oneLineTactic(identityText, inputsText, expectedText, actualText) {
+        // Single line, with two spaces between all phrases.
+        let lineOne
+            = identityText
+            + " "
+            + inputsText
+            + " "
+            + expectedText
+            + " "
+            + actualText;
+
+        // Left undefined.
+        let lineTwo, lineThree, lineFour;
+
+        return { lineOne, lineTwo, lineThree, lineFour };
+    }
+
+    // endregion Private dependencies of #calculateResultDisplay()
+
+    // endregion Private dependencies of reportPassed() and reportFailed()
+
+    reportSummary(summary) {
+        console.log();
+
+        if (summary.anyWereRun) {
+            if (summary.allDidPass) {
+                console.log(this.#passedSummary(this.#toFullWidth(" Test run succeeded.")));
+            }
+            else {
+                console.log(this.#failedSummary(this.#toFullWidth(" Test run failed.")));
+            }
+        }
+
+        console.log(this.#summary(this.#toFullWidth(` ${ summary.summary }`)));
+    }
+
+    #toFullWidth(text) {
+        text = text || "";
+        let width = process.stdout.columns;
+
+        return text.padEnd(width, "\u00A0");
+    }
+
+    // endregion ATestReporter
+
+}

package/system/TestFrame.js

@@ -0,0 +1,187 @@
+/**/
+
+import { TestStages } from "./TestStages.js";
+
+export class TestFrame {
+    /* &cruft : when TestStages is ready, use it and its methods here */
+    
+    #stages;
+
+    constructor() {
+        // A TestStages is inited for each test.
+        this.#stages = new TestStages();
+    }
+    
+    testFrame(test) {
+        console.log(`cruft : a`);
+        // Outer try for fails of groundwork requested.
+        try {
+            console.log(`cruft : b`);
+            /* &cruft, maybe simplify explanations here */
+
+            // Certain args must be isolated for collapsing forward, in case tested 
+            // code mutates them.  Sets test.localInitors and test.localInputs.
+            this.#stages.setLocalInitorsAndInputs(test);
+
+            console.log(`cruft : c`);
+
+            // Spoofing, setting static properties, and so on.
+            this.#stages.anyPreTargetingGroundwork(test);
+            
+            console.log(`cruft : d`);
+
+            // Target may be instance, prototype for constructors, the class 
+            // itself for statics, or nonce for properties.  Sets test.target.
+            this.#stages.setLocalTarget(test);
+            
+            console.log(`cruft : e`);
+            
+            // Method under test may be on instance, class, 
+            // or nonce for properties.  Sets test.callable.
+            this.#stages.setLocalCallable(test);
+            
+            console.log(`cruft : f`);
+            
+            // Setting instance properties and so on.
+            this.#stages.anyPostTargetingGroundwork(test);
+            
+            
+            console.log(`cruft : g`);
+            
+            // Inner try for fails of targeted code only.
+            try {
+                console.log(`cruft : h`);
+                
+                console.log(`cruft : test.actual:`, test.actual);
+                console.log(`cruft : test.localTarget:`, test.localTarget);
+                console.log(`cruft : test.localCallable:`, test.localCallable);
+                console.log(`cruft : test.localInputs:`, test.localInputs);
+            
+                // Tests usually look for this.
+                test.actual = test.localTarget[test.localCallable](...test.localInputs);
+                
+                console.log(`cruft : test.actual:`, test.actual);
+                console.log(`cruft : i`);
+            }
+            catch (thrown) {
+                console.log(`cruft : j`);
+                
+                // Sometimes tests look for this.
+                test.thrown = thrown;
+                
+                console.log(`cruft : k`);
+            }
+
+            console.log(`cruft : l`);
+
+            // Sometimes tests look for results elsewhere. 
+            this.#stages.anyModifyActual(test);
+
+            console.log(`cruft : m`);
+
+            /* &cruft, remove test-checking line when all tests pass */
+            // test.didPass = "fails";
+
+            // Actually testing the result.
+            test.didPass = this.#stages.compareResults(test.output, test.actual);
+            
+            console.log(`cruft : n`);
+            
+        }
+        finally {
+            console.log(`cruft : o`);
+        
+            // Undoing any groundwork changes made. 
+            this.#stages.anyGroundworkReversion(test);
+            
+            console.log(`cruft : p`);
+        }
+        
+        console.log(`cruft : q`);
+    }
+
+    // // region Dependencies of test frames
+    //
+    // /* &cruft, remove if / once superseded by code in TestStages */
+    //
+    // #anyOriginalPropertyGetting(target, settables) {
+    //     if (!Array.isArray(settables)) {
+    //         return;
+    //     }
+    //
+    //     let unsettables = [ ];
+    //    
+    //     for (let settable of settables) {
+    //         // Not a setter tuple.
+    //         if (!settable.of) {
+    //             continue;
+    //         }
+    //        
+    //         // Retaining original.
+    //         let original = target[settable.of];
+    //         let unsettable = { of: settable.of, as: original };
+    //         unsettables.push(unsettable);
+    //     }
+    //    
+    //     return unsettables;
+    // }
+    //
+    // #anyPropertySetting(target, settables) {
+    //     // No properties to set.
+    //     if (!Array.isArray(settables)) {
+    //         return;
+    //     }
+    //
+    //     for (let settable of settables) {
+    //         // Not a setter tuple.
+    //         if (!settable.of) {
+    //             continue;
+    //         }
+    //
+    //         // Actually setting property.
+    //         target[settable.of] = settable.as;
+    //     }
+    // }
+    //
+    // #anyPropertyUnsetting(target, unsettables) {
+    //     // Unsetting is the same as setting, 
+    //     // but with tuples of original values.
+    //     return this.#anyPropertySetting(target, unsettables);
+    // }
+    //
+    // // #compare(expected, actual) {
+    // //     return this.#comparer.compare(expected, actual);
+    // // }
+    //
+    // #supplyNonReturnActual(test, target) {
+    //     // When there is a .from that's a string, 
+    //     // the actual is the named target member.
+    //     if (typeof test.from === "string") {
+    //         // Common member host; 
+    //         // undefined if static.
+    //         let host = target;
+    //        
+    //         // When .and defines static.
+    //         if (this.#doesAddressStatics(test)) {
+    //             host = test.on;
+    //         }
+    //    
+    //         return host[test.from];
+    //     }
+    //    
+    //     // When there is a .from that's a function, 
+    //     // the actual is the result of calling it, 
+    //     // given everything that might be needed.
+    //     if (test.from instanceof Function) {
+    //         return test.from(target, test);
+    //     }
+    //
+    //     // When there is any other .from, the actual is the
+    //     // value of the code element provided as .from.
+    //     return test.from;
+    // }
+    //
+    // // endregion Dependencies of test frames
+    //
+
+}