@lumjs/tests 1.5.0 → 1.7.0

package/CHANGELOG.md

@@ -4,8 +4,53 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+In this document, an identifier of `@tests` is not a real package name, but a 
+shorthand form for the real package name of `@lumjs/tests`.
+So a reference to an exported sub-module will be in `@tests/submodule` format,
+and a reference to a property of a module will be in `@tests.propName` format.
+
 ## [Unreleased]
 
+## [1.7.0] - 2022-09-29
+#### The *harness* update
+### Added
+- Implemented `tests.Harness` library.
+- Added a `Tap` grammar using the `peggy` library.
+- Added `.npmignore` file, separate from `.gitignore`.
+  - The grammar source is ignored by `npm`, but kept in `git`.
+  - The compiled grammar is ignored by `git`, but kept in `npm`. 
+- Added `bin/build-grammar.sh` developer-only helper.
+- Added `bin/lumtest.js` package CLI script.
+- Using `lumtest.js` instead of `prove` for `npm test` now.
+### Changed
+- Split `Test` class into `Stats` (test stats) and `Test` (actual testing methods.)
+- A bunch of restructuring of the internal files:
+  - `test.js` → `test/index.js`, `test/stats.js`
+  - `log.js` → `test/log.js`
+  - `functional.js` → `test/functional.js` 
+  - `harness.js` → `harness/index.js`
+- Made the default module use *lazy-loading* for anything other than `tests.Test`.
+
+## [1.6.0] - 2022-09-12
+#### The *sub-classes* update
+### Added
+- `Test.new()` works like the `@lumjs/tests.new()`, but uses `this` so it's sub-classable.
+- `Test.static()`, calls `@lumjs/tests.functional()`, and passes `this` as the `testClass`.
+- `Test#TAP`, read-only accessor alias to `Test#tap()`.
+- `Test.$METHODS.$meta`, a list of properties to skip in `$METHODS.all` output.
+- `Test.$METHODS.extend()`, allow `Test` *sub-classes* to build upon the `$METHODS`
+  without changing the list in the original `Test` class.
+### Changed
+- Reworked a bunch of the DocBlocks to make the docs better.
+- Modified the `functional()` method to accept a `testClass` parameter.
+  This allows *sub-classes* to make their own functional APIs.
+- Changed `Log.tap()` to make the `details` structure more flexible.
+  The `wanted` property is now optional.
+- The `Test` class saves the test method list for `call()` into `this.$testMethods`
+  instead of using the `.$METHODS.test` directly.
+### Fixed
+- Added some missing functions to the registered list of test methods.
+
 ## [1.5.0] - 2022-08-30
 ### Added
 - Sample `data` used in some of the old tests.
@@ -26,7 +71,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `matches` method for using a regular expression to match a string.
 - Added `callIs()` method that is like `call()` but takes a desired value and passes the function return value to `cmp()`, `isa()`, or other test methods.
 - A new `test.ran` computed property.
-
 ### Changed
 - Updated `@lumjs/core` dependency to `^1.0.0` (no more *beta* tags!)
 - Updated various *docblocks* for documentation.
@@ -85,7 +129,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Ported from Lum.js v4 library set.
 - Added a few more features from the PHP version.
 
-[Unreleased]: https://github.com/supernovus/lum.tests.js/compare/v1.5.0...HEAD
+[Unreleased]: https://github.com/supernovus/lum.tests.js/compare/v1.7.0...HEAD
+[1.7.0]: https://github.com/supernovus/lum.tests.js/compare/v1.6.0...v1.7.0
+[1.6.0]: https://github.com/supernovus/lum.tests.js/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/supernovus/lum.tests.js/compare/v1.4.0...v1.5.0
 [1.4.0]: https://github.com/supernovus/lum.tests.js/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/supernovus/lum.tests.js/compare/v1.2.0...v1.3.0

package/TODO.md

@@ -6,7 +6,6 @@
   - `callIs()`
   - `matches()`
   - `run()`
-- Write the `Harness` class, based of the Lum.php version.
-- Add tests for `Harness`.
-- Create `lumtest` binary for running the harness without `prove` utility.
+- Test the `harness/parser` and associated `grammar/tap` libraries.
+- Test the *external* test mode in `Harness`.
 

package/bin/lumtest.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+const process = require('node:process');
+const Harness = require('../lib/harness');
+const core = require('@lumjs/core');
+const {S} = core.types;
+
+const args = process.argv.slice(2);
+
+const hOpts =
+{
+  plannedFailure: true,
+  plannedWarning: true,
+}
+
+let rPlan = true;
+let aDir = './test';
+
+const aOpts = 
+{
+  ext: '.js',
+}
+
+const flags =
+{
+  '-d': v => aDir = v,
+  '-e': v => aOpts.ext = v,
+  '-r': v => aOpts.recurse = parseInt(v), 
+}
+
+const toggles = 
+{
+  '-f': () => hOpts.plannedFailure = false,
+  '-q': () => hOpts.plannedWarning = false,
+  '-R': () => aOpts.recurse = 99, // Never will go this far down
+  '-P': () => rPlan = false,
+}
+
+let mode = null;
+
+for (const arg of args)
+{
+  if (flags[arg])
+  { // A mode switch
+    mode = arg;
+  }
+  else if (typeof mode === S)
+  { // A flag that has a single argument
+    const flag = flags[mode];
+    flag(arg);
+    mode = null;
+  }
+  else if (toggles[arg])
+  { // A toggle that takes no arguments
+    toggles[arg]();
+  }
+  else 
+  {
+    console.warn("unsupported argument", arg);
+  }
+}
+
+const harness = new Harness(hOpts); // Create our Harness instance.
+module.exports = harness;           // Export it as the 'main' module.
+harness.addDir(aDir, aOpts);        // Add all the files in the test dir.
+harness.run(rPlan);                 // Run all the tests.

package/lib/grammar/README.md

@@ -0,0 +1,6 @@
+# Note
+
+The `.js` files in this directory are dynamically generated from
+files in the source package using the `peggy` grammar compiler.
+
+Do not edit any of these files directly.