risei 1.0.4 → 1.1.0

package/README.md

@@ -1,18 +1,20 @@
 
-# RiseiJs
+# Risei
 
-## What RiseiJs is
+## What Risei is
 
-**RiseiJs is a new way to write unit tests that allows you to:**
+**Risei is a new way to write unit tests that allows you to:**
 * Whip up full test coverage of object-oriented or object-hosted JavaScript in no time.
 * Refactor or replace existing designs without worrying about the cost in past or future test time.
 * Create tests with immediate confidence, because you can't introduce mistakes in test code you write.
 
-RiseiJs' `npm`-friendly name is **Risei**.   The package is often referred to as **Rjs** here for brevity.
+Risei was originally known as _RiseiJs_.   Risei is often referred to as **Rs** here for brevity.
 
-### Basics of the RiseiJs approach
 
-RiseiJs replaces coded tests with simple declarative syntax that's far easier to draft than any other unit-testing approach.
+
+## Basics of the Risei approach
+
+Risei replaces coded tests with simple declarative syntax that's far easier to draft than any other unit-testing approach.
 
 Here are two example tests.   `SortModel.countSort()` is being tested with the inputs found in `.in` and the expected output found in `.out`: 
 
@@ -41,9 +43,10 @@ Test runs also feature a title bar, as well as a summary bar at the bottom:
 </div>
 
 
-## How to use RiseiJs
 
-1. Install RiseiJs the usual way for a development-time `npm` package, using its `npm`-friendly name `risei`:
+## How to install Risei
+
+1. Install Risei the usual way for a development-time `npm` package:
 
 <div style="padding-left: 1.5rem;">
 
@@ -59,16 +62,16 @@ npm install --save-dev risei
 </summary>
 <br>
 
-- RiseiJs is an `npm` package that uses ESM syntax.&nbsp;  It only works well with modern versions of Node that automatically support ESM.
-  - Although ESM is usable with older Node versions using external workarounds, a modern version is highly recommended, and Rjs is not guaranteed to work with older versions.
-- You can install Rjs as a regular dependency if you want, using `npm install risei`, but ordinarily this doesn't make sense, and exposing tests in production is generally considered a bad practice.
-  - RiseiJs doesn't directly add any security risks to your code, but exposing tests that use it might (as it can with other test frameworks).
+- Risei is an `npm` package that uses ESM syntax.&nbsp;  It only works well with modern versions of Node that automatically support ESM.
+  - Although ESM is usable with older Node versions using external workarounds, a modern version is highly recommended, and Rs is not guaranteed to work with older versions.
+- You can install Rs as a regular dependency if you want, using `npm install risei`, but ordinarily this doesn't make sense, and exposing tests in production is generally considered a bad practice.
+  - Risei doesn't directly add any security risks to your code, but exposing tests that use it might (as it can with other test frameworks).
 
 </details>
 
 
 
-2. Add a `risei` node to your project's `package.json` to tell Rjs what kind of files to find tests in:
+2. Add a `risei` node to your project's `package.json` to tell Rs what kind of files to find tests in:
 
 <div style="padding-left: 1.5rem;">
 
@@ -93,7 +96,9 @@ npm install --save-dev risei
 
 
 
-3. Create test files with a `.rt.js` extension.
+## How to use Risei
+
+1. Create test files with a `.rt.js` extension.
 
 <details>
 <summary>
@@ -107,7 +112,7 @@ npm install --save-dev risei
 
 
 
-4. Import `ATestSource` from `risei/ATestSource` in each test file, subclass it, and set `tests` to an array of test definitions.
+2. Import `ATestSource` from `risei/ATestSource` in each test file, subclass it, and set `tests` to an array of test definitions.
 
 <div style="padding-left: 1.5rem;">
 
@@ -129,7 +134,7 @@ export TargetClassTests extends ATestSource {
 <br>
 
 - Tests must be placed in subclasses of `ATestSource`.
-  - RiseiJs looks for this class relationship internally, so duck-typing does not work.
+  - Risei looks for this class relationship internally, so duck-typing does not work.
 - You have to `import` the class/es being tested in the file/s containing their tests.
 - Don't use &cross;`this.tests` by accident &mdash; it just causes an exception when tests are run.
 
@@ -137,7 +142,7 @@ export TargetClassTests extends ATestSource {
 
 
 
-5. Write each test as a JavaScript object literal in the array, using RiseiJs' simple, light syntax: 
+3. Write each test as a JavaScript object literal in the array, using Risei's simple, light syntax: 
 
 <div style="padding-left: 1.5rem;">
 
@@ -183,7 +188,7 @@ export TargetClassTests extends ATestSource {
 
 
 
-6. Write more tests with less syntax, by defining properties that are automatically reused in upcoming tests, and/or setting only the properties in a test that are different from the previous test/s:
+4. Write more tests with less syntax, by defining properties that are automatically reused in upcoming tests, and/or setting only the properties in a test that are different from the previous test/s:
 
 <div style="padding-left: 1.5rem;">
 
@@ -221,7 +226,7 @@ export TargetClassTests extends ATestSource {
 
 
 
-7. To isolate any tests with dependencies, you define test-only results for the methods depended on using _spoofing_, which is similar to mocks or fakes, but easier to use.&nbsp;  Definitions for spoofs are set in the `.plus` property:
+5. To isolate any tests with dependencies, you define test-only results for the methods depended on using _spoofing_, which is similar to mocks or fakes, but easier to use.&nbsp;  Definitions for spoofs are set in the `.plus` property:
 
 <div style="padding-left: 1.5rem;">
 
@@ -332,7 +337,9 @@ export TargetClassTests extends ATestSource {
 
 
 
-8. Run your tests by invoking RiseiJs' `index.js` file:
+## How to run Risei tests
+
+1. Run your tests by invoking Risei's `index.js` file:
 
 <div style="padding-left: 1.5rem;">
 
@@ -348,13 +355,13 @@ node ./node_modules/risei/index.js
 </summary>
 <br>
 
-- At present, Rjs isn't set up as a script that runs independently, nor as a compiled executable, so you have to run it via its entry-point script.
+- At present, Rs isn't set up as a script that runs independently, nor as a compiled executable, so you have to run it via its entry-point script.
 
 </details>
 
 
 
-9. Or write the `test` script in `package.json` to invoke `index.js`, to make your life easier:
+2. Or write the `test` script in `package.json` to invoke `index.js`, to make your life easier:
 
 <div style="padding-left: 1.5rem;">
 
@@ -371,7 +378,7 @@ node ./node_modules/risei/index.js
 </summary>
 <br>
 
-- You can instead write a unique script for Rjs, though this takes more syntax to call later:
+- You can instead write a unique script for Rs, though this takes more syntax to call later:
 
 <div style="padding-left: 1.5rem;">
 
@@ -383,7 +390,7 @@ node ./node_modules/risei/index.js
 
 </div>
 
-- You can define your test scripting to include the RiseiJs tests alongside other tests if you wish to mix framework usages, which may be appropriate for some scenarios:
+- You can define your test scripting to include the Risei tests alongside other tests if you wish to mix framework usages, which may be appropriate for some scenarios:
 
 <div style="padding-left: 1.5rem;">
 
@@ -400,7 +407,7 @@ node ./node_modules/risei/index.js
 
 
 
-7. Run that script whenever you want to run tests:
+3. Run that script whenever you want to run tests:
 
 <div style="padding-left: 1.5rem;">
 
@@ -430,16 +437,32 @@ npm run risei
 
 
 
-## Advanced RiseiJs usage
+## Advanced Risei usage
+
+### Testing special test conditions with `.and`
+
+You can use the special test property `.and`, always a string, to indicate special conditions that apply to your test.&nbsp;  At present, the values available are `"static"` and `"throw"` / `"throws"` (either one works).&nbsp;  You can list `static` and `throw` / `throws` together if needed, separated by a space.
+
+<details>
+<summary>
+&nbsp; More information
+</summary>
+<br>
+
+- The `.and` property is an expansion point for supporting more special conditions in the future.&nbsp;  Values will always be listable together (as long as any particular grouping makes sense).
+
+</details>
+
 
-### Testing static methods
 
-To test a static method, you add an `.and` property to a test, with the value `"static"`:
+#### Testing static methods
+
+To test a static method, use an `.and` of `"static"`:
 
 <div style="padding-left: 1.5rem">
 
 ```javascript
-{ on: StaticModel, with: [] },
+{ on: StaticTextProfileModel, with: [] },
 
 { of: "getTextProfile",
   for: "Returns accurate profile of arg text.",
@@ -451,15 +474,27 @@ To test a static method, you add an `.and` property to a test, with the value `"
 
 </div>
 
-<details>
-<summary>
-&nbsp; More information
-</summary>
-<br>
 
-- The `.and` property is an expansion point for supporting more unusual situations in the future.&nbsp;  At present, it only supports static operations.
 
-</details>
+#### Testing throws
+
+To test a throw, use an `.and` of `"throw"` or `"throws"`:
+
+<div style="padding-left: 1.5rem">
+
+```javascript
+{ on: InstanceTextProfileModel, with: [] },
+
+{ of: "getTextProfile",
+  for: "Throws with a helpful message when there is no arg text.",
+  and: "throws",
+  in: [ ],
+  out: "Could not build a profile.  Did you forget to provide a text?"
+}
+```
+
+</div>
+
 
 
 ### Testing object properties and other non-`return` results
@@ -540,6 +575,7 @@ When the contents of `.from` are a function, these are the two parameters:
 </details>
 
 
+
 ### Property long names
 
 Property names are short so they're easy to use.&nbsp;  Some of them overlap with JavaScript keywords, but this causes no harm.
@@ -590,7 +626,8 @@ All test properties have long names that you can use instead of the short ones i
 </details>
 
 
-### Further capabilities of RiseiJs
+
+### Further capabilities of Risei
 
 Constructors can be tested with no special test properties or keywords.
 - The method name in `.of` is simply `"constructor"`.
@@ -598,7 +635,8 @@ Constructors can be tested with no special test properties or keywords.
   - However, a `.with` must still be provided.&nbsp;  It can simply be an empty array `[ ]`.
 
 
-### Limitations in RiseiJs
+
+### Limitations in Risei
 
 The following are not supported at present:
 - Use of `async` syntax
@@ -607,9 +645,11 @@ The following are not supported at present:
 - Spoofing mixes of properties and methods, such as `something.method.property.method`
 - Debugging model code during tests.
 
+
+
 ## Troubleshooting
 
-Most problems with using RiseiJs are minor mistakes in syntax, or omissions in test definitions:
+Most problems with using Risei are minor mistakes in syntax, or omissions in test definitions:
 
 | Error text                                                          | Probable cause / fix                                                                               |
 |---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
@@ -621,22 +661,24 @@ Most problems with using RiseiJs are minor mistakes in syntax, or omissions in t
 When something is wrong in one test file, other test files still usually load and run, so a good sign that there's a problem is a sudden decrease in the number of run tests reported.
 
 
-## Who makes RiseiJs
 
-RiseiJs is written by myself, Ed Fallin.&nbsp;  I'm a longtime software developer who likes to find better ways to do things.
+## Who makes Risei
+
+Risei is written by myself, Ed Fallin.&nbsp;  I'm a longtime software developer who likes to find better ways to do things.
+
+If you find Risei useful, consider spreading the word to other devs, making a donation, suggesting enhancements, or proposing sponsorships.
 
-If you find RiseiJs useful, consider spreading the word to other devs, making a donation, suggesting enhancements, or proposing sponsorships.
+You can get in touch about Risei at **Riseimaker@gmail.com**.
 
-You can get in touch about RiseiJs at **riseijsmaker@gmail.com**.
 
 
-## What the RiseiJs license is
+## What the Risei license is
 
-RiseiJs is published for use under the terms of the MIT license:
+Risei is published for use under the terms of the MIT license:
 
 <div style="border: solid darkgray 1px; padding: 0.5rem;">
 
-<b>RiseiJs Copyright &copy; 2023 Ed Fallin</b>
+<b>Risei Copyright &copy; 2023 Ed Fallin</b>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,23 +1,36 @@
 {
   "name": "risei",
-  "version": "1.0.4",
-  "description": "RiseiJs is the framework that allows you to write unit tests as collections of values in JavaScript objects, so it's easy and fast, and tests don't serve as a drag on redesigns.",
-  "keywords": [ "unit test", "test", "unit testing", "testing", "easy", "fast", "values", "objects", "declarative" ],
+  "version": "1.1.0",
+  "description": "Risei is the framework that allows you to write unit tests as collections of values in JavaScript objects, so it's easy and fast, and tests don't serve as a drag on redesigns.",
+  "keywords": [
+    "unit test",
+    "test",
+    "unit testing",
+    "testing",
+    "easy",
+    "fast",
+    "simple",
+    "values",
+    "objects",
+    "declarative"
+  ],
   "author": "Ed Fallin <riseijsmaker@gmail.com>",
   "license": "MIT",
   "type": "module",
   "private": false,
   "scripts": {
     "start": "node ./bin/www",
-    "risei": "node ./index.js",
-    "rtest": "clear; node ./public/javascript/Risei.js",
+    "rself": "clear; node ./public/javascript/Risei.js",
+    "rtest": "clear; node ./node_modules/risei/index.js",
     "xtest": "clear; mocha **/*.tests.js",
-    "test": "clear; mocha **/*.tests.js; node ./public/javascript/Risei.js"
+    "mixedtest": "clear; mocha **/*.tests.js; node ./node_modules/risei/index.js",
+    "alltest": "clear; mocha **/*.tests.js; node ./node_modules/risei/index.js; node ./public/javascript/Risei.js",
+    "test": "clear; node ./node_modules/risei/index.js"
   },
   "risei": {
     "tests": "**.rt.js"
   },
-  "exports":{
+  "exports": {
     ".": "./index.js",
     "./ATestSource": "./public/javascript/ATestSource.js"
   },
@@ -34,6 +47,7 @@
     "express": "~4.16.1",
     "fs": "^0.0.1-security",
     "mocha": "^10.0.0",
-    "morgan": "~1.9.1"
+    "morgan": "~1.9.1",
+    "risei": "^1.0.4"
   }
 }

package/public/javascript/ASpoofingFixture.js

@@ -72,7 +72,7 @@ export class ASpoofingFixture extends ATestFixture {
             name = names.shift();
             name = name.replace("()", "");
 
-            // Actually spoofing method.
+            // Actually spoofing, as method only.
             let method = this.spoofMethod(output);
             next[name] = method;
         }

package/public/javascript/ChosenTestFinder.js

@@ -3,15 +3,16 @@
 /* ChosenTestFinder is an ATestFinder that finds tests in the places coded in its constructor. */
 
 import { ATestFinder } from "./ATestFinder.js";
-import { Tests } from "./topic-tests/Tests.rt.js";
-import { SelfTests } from "./self-tests/SelfTests.rt.js";
+import { TopicTests } from "./topic-tests/TopicTests.outward-rt.js";
+import { SelfTests } from "./self-tests/SelfTests.outward-rt.js";
 
 export class ChosenTestFinder extends ATestFinder {
     constructor() {
         super();
         
-        let testSource = new Tests();
+        let testSource = new TopicTests();
         let selfTestSource = new SelfTests();
+        
         this.testSources = [ testSource, selfTestSource ];
     }
 

package/public/javascript/SpoofTuple.js

@@ -162,7 +162,6 @@ export class SpoofTuple {
         return true;
     }
     
-    /* &cruft, test or drop */
     static isASpoof(nonce) {
         return !this.isNotASpoof(nonce);
     }