risei 1.0.2 → 1.0.4

package/README.md

@@ -264,7 +264,7 @@ export TargetClassTests extends ATestSource {
 - When necessary, you can provide a function to use in place of the real code, in `.as`.
 
 
-- This example uses both syntax options:
+- This example uses all three syntax options:
 
 <div style="padding-left: 1.5rem;">
 
@@ -282,9 +282,22 @@ export TargetClassTests extends ATestSource {
 
 </div>
 
-- Spoofed types (like `ArraySource` in the example) have to be imported normally.
-- The properties in the spoof objects within `.plus` don't collapse forward within the array, but must be repeated for each one.
-- You can spoof methods of objects in `.with` and `.in` as well, although you usually don't need to.
+- You can spoof methods nested inside of other objects  using `.` syntax in the `.of` property:
+
+<div style="padding-left: 1.5rem;">
+
+```javascript
+          plus: [
+            { on: SimpleObject, of: "getText", as: "Text" }, 
+            { on: DeepObject, of: "root.branch.leaf.getOptimum", as: 100 }
+          ]
+```
+
+</div>
+
+- Types whose members are being spoofed (like `ArraySource` or `SimpleObject` in the examples) have to be imported normally.
+- The properties in the spoof definitions within `.plus` don't collapse forward within the array, but must be repeated for each one.
+- You can spoof methods of objects provided in a test's `.with` and `.in` as well, although you usually don't need to.
 - Properties of spoof objects also have long names (covered later).
 
 <details>
@@ -293,7 +306,7 @@ export TargetClassTests extends ATestSource {
 </summary>
 <br>
 
-  - You can spoof many methods on a class at the same time with an array of partial spoof objects for the `.as` property:
+- You can spoof many methods on a class at the same time with an array of partial spoof objects for the `.as` property:
 
 <div style="padding-left: 1.5rem;">
 
@@ -309,21 +322,9 @@ export TargetClassTests extends ATestSource {
 
 </div>
 
-  - As with simple object-method spoof definitions, `.as` can be omitted in the nested partial spoof objects, with the same effect.
-  - You can use this syntax or list multiple full `.on`-`.as`-`.of` objects for a class, with the same effect either way.
-
-  - You can spoof methods and properties nested inside of other objects  using `.` syntax in the `.of` property:
-
-<div style="padding-left: 1.5rem;">
-
-```javascript
-          plus: [
-            { on: SimpleObject, of: "getText", as: "Text" }, 
-            { on: DeepObject, of: "root.branch.leaf.getOptimum", as: 100 }
-          ]
-```
-
-</div>
+- You can use this syntax, or list multiple full `.on`-`.as`-`.of` objects for a class in `.plus`, with the same effect either way.
+- Nested partial spoof definitions in `.as: [ ... ]` never contain `.on`, and must contain at least `.of`.
+- As in other spoof definitions, `.as` can be omitted in these nested partial spoof objects, with the same effect.
 
 </details>
 
@@ -382,7 +383,7 @@ node ./node_modules/risei/index.js
 
 </div>
 
-- You can define your test script 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 RiseiJs tests alongside other tests if you wish to mix framework usages, which may be appropriate for some scenarios:
 
 <div style="padding-left: 1.5rem;">
 
@@ -463,7 +464,7 @@ To test a static method, you add an `.and` property to a test, with the value `"
 
 ### Testing object properties and other non-`return` results
 
-To test a value that isn't the exercised code's return value, you add a `.from` property to a test, which can be one of two things:
+To test a value that isn't the exercised code's return value, you use `.out` normally, and you add a `.from` property to your test, which can be one of two things:
 
 <div style="padding-left: 1.5rem">
 
@@ -472,10 +473,11 @@ To test a value that isn't the exercised code's return value, you add a `.from`
 | Property name as string        | Retrieves the actual from the named property on the test's target class |
 | Specialized function | Retrieves the actual from either its `target` or `test` parameter       |
 
+</div>
+
 - Getting properties, mutated args, and other non-return values is known as _retrieving_.
 - Retrieving definitions collapse forward across tests unless  replaced with new definitions, or erased by setting `.from` to an empty array `[ ]`.
 
-</div>
 
 <details>
 <summary>
@@ -518,7 +520,7 @@ When the contents of `.from` are a function, these are the two parameters:
 - You can write a function for `.from` that uses `test.on` to get the values of static properties, in conjunction with `and: "static"` in the encompassing test.
 
 
-- Another usage of `.from` function is to look at an input to see if it was changed as expected:
+- Another usage of a `.from` function is to look at an input to see if it was changed as expected:
 
 <div style="padding-left: 1.5rem">
 
@@ -603,7 +605,7 @@ The following are not supported at present:
 - Standalone functions and other functionality not built into classes, AKA _loose code_
 - CJS syntax using `require()`
 - Spoofing mixes of properties and methods, such as `something.method.property.method`
-
+- Debugging model code during tests.
 
 ## Troubleshooting
 
@@ -611,21 +613,21 @@ Most problems with using RiseiJs are minor mistakes in syntax, or omissions in t
 
 | Error text                                                          | Probable cause / fix                                                                               |
 |---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
-| `"Test loading failed for...  SyntaxError: Unexpected token ':'"`   | A comma is missing in your tests in the file named.                                                |
-| `"Test loading failed for...  SyntaxError: Unexpected token '.'"`   | You used `this.tests = []` instead of `tests = []` in the file named.                              |
-| Other `... Unexpected token ...` errors                             | There is some other syntax error in the file named, most likely a missing or extra delimiter.      |
-| Unexpected actual values, or unexpected passes / fails in test runs | Spoofs, retrievals, or other special conditions from previous tests haven't been replaced / reset. 
+| `"Test loading failed for...  SyntaxError: Unexpected token ':'"`   | Missing comma in your tests in the named file                                                      |
+| `"Test loading failed for...  SyntaxError: Unexpected token '.'"`   | Using `this.tests = []` instead of `tests = []` in the file named                                  |
+| Other `... Unexpected token ...` errors                             | Some other syntax error in the file named, most likely a missing or extra delimiter                |
+| Unexpected actual values, or unexpected passes / fails in test runs | Spoofs, retrievals, or special conditions from previous tests not replaced or reset with `[ ]` 
 
-Usually when something is wrong in one test file, other test files still load and run, so a good sign of problems is a sudden decrease in the number of run tests reported.
+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 is behind RiseiJs
+## Who makes RiseiJs
 
-RiseiJs is made by Ed Fallin, a longtime software developer proficient in many technologies, with a knack for finding new answers to old questions.
+RiseiJs 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 RiseiJs useful, consider spreading the word to other devs, making a donation, suggesting enhancements, or proposing sponsorships.
 
-You can get in touch about Rjs using **riseijsmaker@gmail.com**.
+You can get in touch about RiseiJs at **riseijsmaker@gmail.com**.
 
 
 ## What the RiseiJs license is

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "risei",
-  "version": "1.0.2",
+  "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", "values", "objects", "easy", "fast" ],
+  "keywords": [ "unit test", "test", "unit testing", "testing", "easy", "fast", "values", "objects", "declarative" ],
   "author": "Ed Fallin <riseijsmaker@gmail.com>",
   "license": "MIT",
   "type": "module",