@lumjs/tests 1.0.0 → 1.3.0

package/CHANGELOG.md

@@ -6,11 +6,61 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2022-07-27
+### Added
+- `$call()` function; powers `call()`, `lives()`, `dies()`, and `diesWith()`. 
+- `call()` method; test the result of a function call.
+- `diesWith()` method; like `dies()` but also tests the thrown `Error`.
+- `run()` method; for running a bunch of similar tests with a compact syntax.
+### Changed
+- How `functional` gets its list of test methods to proxy.
+- Cleaned up a bunch of stuff in the `Log` class.
+- Added a `details.info` structure to the `Log` class.
+- Refactored `lives()` and `dies()` to use the new `$call()` function.
+- Updated `ok()` to support passing `details` to it directly.
+- Some further cleanups in the `Test` class.
+
+## [1.2.0] - 2022-07-26
+### Added
+- `lives()` method; the inverse of `dies()`.
+- `nota()` method; the inverse of `isa()`.
+- `isntJSON()` method; the inverse of `isJSON()`.
+- Tests for `isa()`, `isJSON()`, and all the new methods.
+### Changed
+- `isa()` uses `core.types.isa()` method now.
+- `isa()` supports multiple `wants` values, just use an Array.
+- Anything that used `JSON.stringify()` now uses `core.types.stringify()`.
+
+## [1.1.1] - 2022-07-15
+### Fixed
+- Dependency issue in `package.json` with pre-release parent.
+### Added
+- A temporary `npm test` script using the `prove` utility from Perl 5.
+
+## [1.1.0] - 2022-07-08
+### Fixed
+- Changelog had wrong URLs.
+### Changed
+- Renamed `src` to `lib` like `@lumjs/core` did.
+- Moved `index.js` into `lib` and updated `package.json` to reflect that.
+- Updated all the tests to use the new paths.
+- Changed `Test` constructor to support a bunch of options.
+  - `id` option will be used in the future.
+  - `plan` option replaces the old `plan` pararameter.
+  - `module` option will assign the test instance to `opts.module.exports`.
+  - `module` can also auto-generate an `id` if one was not passed.
+  - `moduleName` is used for the automatic `id` generation.
+- Updated `functional()` and `new()` to pass their options to the constructor.
+
 ## [1.0.0] - 2022-06-22
 ### Added
 - Ported from Lum.js v4 library set.
 - Added a few more features from the PHP version.
 
-[Unreleased]: https://github.com/supernovus/simpledom/compare/v1.0.0...HEAD
-[1.0.0]: https://github.com/supernovus/simpledom/releases/tag/v1.0.0
+[Unreleased]: https://github.com/supernovus/lum.tests.js/compare/v1.3.0...HEAD
+[1.3.0]: https://github.com/supernovus/lum.tests.js/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/supernovus/lum.tests.js/compare/v1.1.1...v1.2.0
+[1.1.1]: https://github.com/supernovus/lum.tests.js/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/supernovus/lum.tests.js/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/supernovus/lum.tests.js/releases/tag/v1.0.0
 

package/TODO.md

@@ -1,7 +1,10 @@
 # TODO
 
-- Add tests for `isa()` method.
+- Write tests for:
+  - `call()`
+  - `diesWith()`
+  - `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.
+- Create `lumtest` binary for running the harness without `prove` utility.
 

package/{src → lib}/functional.js

@@ -2,11 +2,7 @@
 const Test = require('./test');
 
 // A list of methods we can proxy directly.
-const PROXY_METHODS = 
-[
-  'plan', 'ok', 'fail', 'pass', 'dies', 'cmp', 'isa', 'is', 'isnt', 
-  'isJSON', 'skip', 'diag', 'tap', 'output',
-];
+const PROXY_METHODS = Test.$METHODS.all;
 
 /**
  * A new test instance and a set of functions wrapping it.
@@ -16,20 +12,6 @@ const PROXY_METHODS =
  * All of the rest of the properties are functions that
  * can be imported into a JS scope using destructuring, and
  * which wrap the corresponding test instance method.
- * 
- * @property {function} plan 
- * @property {function} ok
- * @property {function} fail 
- * @property {function} pass 
- * @property {function} dies 
- * @property {function} cmp 
- * @property {function} isa 
- * @property {function} is 
- * @property {function} isnt 
- * @property {function} isJSON 
- * @property {function} skip 
- * @property {function} diag 
- * @property {function} tap  
  */
 
 /**
@@ -51,17 +33,15 @@ const PROXY_METHODS =
  * and a new set of wrapper functions for the test instance, you could
  * create multiple sets of functional tests in their own private scopes.
  * Not sure why you'd want to do that, but in case you do, there ya go.
+ *
+ * @param {object} [opts] Options to pass to the `Test` constructor.
  * 
  * @returns {Functional}
  * 
  */
-function functional({plan,module}={})
+function functional(opts={})
 {
-  const test = new Test(plan);
-  if (module)
-  {
-    module.exports = test;
-  }
+  const test = new Test(opts);
   const functions = { test };
   for (const meth of PROXY_METHODS)
   {

package/lib/index.js

@@ -0,0 +1,23 @@
+/**
+ * Several test related classes.
+ */
+
+const Test = require('./test');
+
+module.exports.Test = Test;
+module.exports.Harness = require('./harness');
+
+// This one is not a class, but a special function.
+module.exports.functional = require('./functional');
+
+/**
+ * Create a new Test instance.
+ *
+ * @param {object} [opts] Options to pass to the `Test` constructor.
+ * @returns {Test} A new test instance.
+ */
+module.exports.new = function(opts={})
+{
+  return new Test(opts);
+}
+

package/{src → lib}/log.js

@@ -1,5 +1,6 @@
 
-const {F,S,O} = require('@lumjs/core').types;
+const types = require('@lumjs/core').types;
+const {F,S,O,isArray,stringify} = types;
 
 /**
  * A log representing the results of a test.
@@ -34,7 +35,7 @@ class Log
    * Generally this is never needed to be used by outside code.
    * The `Test.tap()` method uses it when generating a full log.
    * 
-   * @param {*} num - The test #
+   * @param {*} num - The test number.
    * @returns {string} The TAP log.
    */
   tap (num)
@@ -53,7 +54,7 @@ class Log
     if (typeof this.directive === S)
       out += ' # ' + this.directive;
     else if (typeof this.directive == O && this.directive instanceof Error)
-      out += ' # ' + this.directive.name + ': ' + this.directive.message;
+      out += ` # ${this.directive.name}: ${this.directive.message}`;
     else if (this.skipped)
       out += ' # SKIP ' + this.skippedReason;
 
@@ -65,14 +66,28 @@ class Log
       var want = this.details.wanted;
       if (this.details.stringify)
       {
-        got = (typeof got === F) ? got.toString() : JSON.stringify(got);
-        want = (typeof want === F) ? want.toString() : JSON.stringify(want);
+        got = stringify(got);
+        want = stringify(want);
       }
-      out += '#       got: ' + got + "\n";
-      out += '#  expected: ' + want + "\n";
+      out += `#       got: ${got}\n`;
+      out += `#  expected: ${want}\n`;
       if (typeof this.details.comparitor === S)
       {
-        out += '#        op: ' + this.details.comparitor + "\n";
+        out += `#        op: ${this.details.comparitor}\n`;
+      }
+    }
+
+    if ('info' in this.details)
+    { // Extended information. Usually an array, but can be whatever.
+      const info 
+        = isArray(this.details.info) 
+        ? this.details.info
+        : [this.details.info];
+
+      for (const i in info)
+      {
+        const line = (typeof info[i] === S) ? info[i] : stringify(info[i]);
+        out += `## ${line}\n`;
       }
     }