@lumjs/tests 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -6,11 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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.1.0...HEAD
+[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/{src → lib}/functional.js

@@ -51,17 +51,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}/test.js

@@ -1,5 +1,5 @@
-
-const {F,S,N,isType,isInstance,def} = require('@lumjs/core').types;
+const core = require('@lumjs/core');
+const {F,S,N,isType,isObj,isInstance,def} = core.types;
 
 // We use a separate class to represent test logs.
 const Log = require('./log');
@@ -16,18 +16,59 @@ class Test
   /**
    * Build a new Test instance.
    * 
-   * @param {number} [plan] If used, passed to `plan()` method.
-   *  
+   * @param {object} [opts] Named options.
+   * @param {string} [opts.id] A unique test id, used by Harness.
+   * @param {number} [opts.plan] Passed to `plan()` method.
+   * @param {object} [opts.moduleName] Options for `core.modules.name()`.
+   * @param {object} [opts.module] The node module to export this test to.
+   *
+   *   If you use this option, `opts.module.exports` will be assigned
+   *   to the test instance, overriding anything that may have been 
+   *   assigned to it previously.
+   *
+   *   Also, if this is passed, and `opts.id` was not specified, and id
+   *   will be auto-generated based on the filename of the module.
+   *
    */
-  constructor (plan)
+  constructor (opts={})
   {
+    if (typeof opts === N)
+    {
+      opts = {plan: opts};
+    }
+    else if (typeof opts === S)
+    {
+      opts = {id: opts};
+    }
+
+    const hasModule = isObj(opts.module);
+
+    if (typeof opts.id === S)
+    { // A specific id was specified.
+      this.id = opts.id;
+    }
+    else if (hasModule)
+    { // We're going to generate a simple name.
+      this.id = core.modules.name(opts.module, opts.moduleName);
+    }
+    else 
+    { // An anonymous test.
+      this.id = null;
+    }
+
     this.failed = 0;
     this.skipped = 0;
     this.planned = 0;
     this.log = [];
-    if (plan)
+
+    if (typeof opts.plan === N)
     {
-      this.plan(plan);
+      this.plan(opts.plan);
+    }
+
+    if (hasModule)
+    { // Finally, if a module was passed, its going to export this test.
+      opts.module.exports = this;
     }
   }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lumjs/tests",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "1.1.0",
+  "main": "lib/index.js",
   "license": "MIT",
   "repository":
   {

package/test/basics.js

@@ -1,4 +1,4 @@
-const Test = require('../index').Test;
+const Test = require('../lib').Test;
 const def = require('./inc/basics.js');
 
 const test = new Test();

package/test/dies.js

@@ -1,6 +1,6 @@
 const def = require('./inc/dies.js');
 // Using the 'new()' function.
-const test = require('../index').new({module, plan: def.plan});
+const test = require('../lib').new({module, plan: def.plan});
 
 for (const dt of def.diesErrors)
 {

package/test/functional_basics.js

@@ -1,6 +1,6 @@
 // Testing the basic functions of the functional testing API.
 
-const {test,plan,ok,pass,is,isnt,cmp,tap} = require('../index').functional();
+const {test,plan,ok,pass,is,isnt,cmp,tap} = require('../lib').functional();
 const def = require('./inc/basics.js');
 
 plan(def.plan);

package/test/functional_dies.js

@@ -1,6 +1,6 @@
 const def = require('./inc/dies.js');
 
-const {dies,output} = require('../index').functional({module, plan: def.plan});
+const {dies,output} = require('../lib').functional({module, plan: def.plan});
 
 for (const dt of def.diesErrors)
 {

package/index.js

@@ -1,23 +0,0 @@
-/**
- * Several test related classes.
- */
-
-const Test = require('./src/test');
-
-module.exports.Test = Test;
-module.exports.Harness = require('./src/harness');
-
-// This one is not a class, but a special function.
-module.exports.functional = require('./src/functional');
-
-// This one is a quick shortcut function.
-module.exports.new = function({plan,module}={})
-{
-  const test = new Test(plan);
-  if (module)
-  {
-    module.exports = test;
-  }
-  return test;
-}
-