xdbc 1.0.95 → 1.0.96

package/.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-	"cSpell.words": ["alia", "esign", "ontract", "Paramvalue"]
+	"cSpell.words": ["alia", "esign", "ontract", "Paramvalue", "Postconditions"]
 }

package/README.md

@@ -46,17 +46,22 @@ npm install --save xdbc
 
 ## Usage
 
-As by now there're nine contracts that can be used:
+As by now there're 14 contracts that can be used:
 
 - AE (*Each element of the value-array has to fulfill a certain set of contracts*)
 - EQ (*Value has to be equal to a supplied reference value*)
-- GREATER (*Value has to be greater than a supplied reference value*)
+- COMPARISON (*Value has to be greater, less, greater/equal, equal or less/equal than a supplied reference value*)
 - INSTANCE (*Value has to be an instance of a supplied type*)
 - JSON.OP (*Value has to contain certain properties of certain type*)
 - JSON.Parse (*String-value has to be a parsable JSON*)
 - OR (*At least one of a set of contracts has to be fulfilled*)
 - REGEX (*Value has to be validated by a supplied regular expression*)
 - TYPE (*Value has to be of a certain type*)
+- GREATER (*Derived from COMPARISON*)
+- GREATER_OR_EQUAL (*Derived from COMPARISON*)
+- LESS (*Derived from COMPARISON*)
+- LESS_OR_EQUAL (*Derived from COMPARISON*)
+- DIFFERENT (*Derived from EQ*)
 
 All of which expose a method **PRE**, **POST** and **INVARIANT** (*precondition, postcondition and invariant*).<br>
 Import the classes to use from **xdbc**. If parameters shall be decorated with contracts import class **DBC** also. <br><br>
@@ -85,10 +90,12 @@ With **PRE**, **POST** and **INVARIANT** decorators an optional **path** paramet
 
 Multiple instances of the class **DBC** with varying settings for e.g. reporting infringements may be instantiated. Which of these instances is used to report can be defined when either using **PRE**, **POST** or **INVARIANT** by defining their **dbc** parameter: **@DBC.INVARIANT([new EQ(1)],"length","MyVendor.MyDBCInstance")**, for example. The standard path (*WaXCode.DBC*) leads to an automatically created instance, that is generated when the Framework is imported.
 
-Many contracts got further features like the **AE**-Contract that can check specific ranges within the tagged array or the **EQ**- and **GREATER**-Contract that can be inverted turning them into **not EQual**- or **LESS**-Contracts. Check out the [API](https://callaris.github.io/XDBC/) for details.
+Many contracts got further features like the **AE**-Contract that can check specific ranges within the tagged array or the **EQ**--Contract that can be inverted turning it into **not EQual**-Contract. Check out the [API](https://callaris.github.io/XDBC/) for details.
 
 A **DBC**'s **warningSettings** & **infringementSettings** determine what happens on warnings and errors, whereas warnings are not implemented yet.
 
+**DBC** can be turned off for **PRE**-, **POST**-Conditions and **INVARIANT**S separately by setting the proper **executionSettings** of the **DBC**-Class.
+
 ## Contribution
 Participation is highly valued and warmly welcomed. The ultimate goal is to create a tool that proves genuinely useful and empowers a wide range of developers to build more robust and reliable applications.
 

package/dist/DBC/COMPARISON/GREATER.js

@@ -1,22 +1,21 @@
 import { COMPARISON } from "../COMPARISON";
+/** See {@link COMPARISON }. */
 export class GREATER extends COMPARISON {
-    /** See {@link GREATER.PRE }. */
+    /** See {@link COMPARISON.PRE }. */
     static PRE(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
         return COMPARISON.PRE(equivalent, false, false, path, dbc);
     }
-    /** See {@link GREATER.POST }. */
+    /** See {@link COMPARISON.POST }. */
     static POST(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
         return COMPARISON.POST(equivalent, false, false, path, dbc);
     }
-    /** See {@link GREATER.INVARIANT }. */
+    /** See {@link COMPARISON.INVARIANT }. */
     static INVARIANT(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
         return COMPARISON.INVARIANT(equivalent, false, false, path, dbc);
     }
-    /** See {@link GREATER.constructor }. */
-    constructor(equivalent, equalityPermitted = false, invert = false) {
+    /** See {@link COMPARISON.constructor }. */
+    constructor(equivalent) {
         super(equivalent, false, false);
         this.equivalent = equivalent;
-        this.equalityPermitted = equalityPermitted;
-        this.invert = invert;
     }
 }

package/dist/DBC/COMPARISON/GREATER_OR_EQUAL.js

@@ -0,0 +1,21 @@
+import { COMPARISON } from "../COMPARISON";
+/** See {@link COMPARISON }. */
+export class GREATER_OR_EQUAL extends COMPARISON {
+    /** See {@link COMPARISON.PRE }. */
+    static PRE(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.PRE(equivalent, true, false, path, dbc);
+    }
+    /** See {@link COMPARISON.POST }. */
+    static POST(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.POST(equivalent, true, false, path, dbc);
+    }
+    /** See {@link COMPARISON.INVARIANT }. */
+    static INVARIANT(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.INVARIANT(equivalent, true, false, path, dbc);
+    }
+    /** See {@link COMPARISON.constructor }. */
+    constructor(equivalent) {
+        super(equivalent, true, false);
+        this.equivalent = equivalent;
+    }
+}

package/dist/DBC/COMPARISON/LESS.js

@@ -0,0 +1,21 @@
+import { COMPARISON } from "../COMPARISON";
+/** See {@link COMPARISON }. */
+export class LESS extends COMPARISON {
+    /** See {@link COMPARISON.PRE }. */
+    static PRE(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.PRE(equivalent, false, true, path, dbc);
+    }
+    /** See {@link COMPARISON.POST }. */
+    static POST(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.POST(equivalent, false, true, path, dbc);
+    }
+    /** See {@link COMPARISON.INVARIANT }. */
+    static INVARIANT(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.INVARIANT(equivalent, false, true, path, dbc);
+    }
+    /** See {@link COMPARISON.constructor }. */
+    constructor(equivalent) {
+        super(equivalent, false, true);
+        this.equivalent = equivalent;
+    }
+}

package/dist/DBC/COMPARISON/LESS_OR_EQUAL.js

@@ -0,0 +1,21 @@
+import { COMPARISON } from "../COMPARISON";
+/** See {@link COMPARISON }. */
+export class LESS_OR_EQUAL extends COMPARISON {
+    /** See {@link COMPARISON.PRE }. */
+    static PRE(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.PRE(equivalent, true, true, path, dbc);
+    }
+    /** See {@link COMPARISON.POST }. */
+    static POST(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.POST(equivalent, true, true, path, dbc);
+    }
+    /** See {@link COMPARISON.INVARIANT }. */
+    static INVARIANT(equivalent, equalityPermitted = false, invert = false, path = undefined, dbc = "WaXCode.DBC") {
+        return COMPARISON.INVARIANT(equivalent, true, true, path, dbc);
+    }
+    /** See {@link COMPARISON.constructor }. */
+    constructor(equivalent) {
+        super(equivalent, true, true);
+        this.equivalent = equivalent;
+    }
+}

package/dist/DBC/COMPARISON.js

@@ -1,13 +1,13 @@
 import { DBC } from "../DBC";
 /**
- * A {@link DBC } defining that two {@link object }s gotta be equal.
+ * A {@link DBC } defining a comparison between two {@link object }s.
  *
  * @remarks
  * Maintainer: Callari, Salvatore (XDBC@WaXCode.net) */
 export class COMPARISON extends DBC {
     // #region Condition checking.
     /**
-     * Checks if the value **toCheck** is nb   equal to the specified **equivalent**.
+     * Does a comparison between the {@link object } **toCheck** and the **equivalent**.
      *
      * @param toCheck		The value that has to be equal to it's possible **equivalent** for this {@link DBC } to be fulfilled.
      * @param equivalent	The {@link object } the one **toCheck** has to be equal to in order for this {@link DBC } to be
@@ -30,11 +30,11 @@ export class COMPARISON extends DBC {
         return true;
     }
     /**
-     * A parameter-decorator factory using the {@link GREATER.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+     * A parameter-decorator factory using the {@link COMPARISON.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
      * by the tagged parameter.
      *
-     * @param equivalent	    See {@link GREATER.checkAlgorithm }.
-     * @param equalityPermitted See {@link GREATER.checkAlgorithm }.
+     * @param equivalent	    See {@link COMPARISON.checkAlgorithm }.
+     * @param equalityPermitted See {@link COMPARISON.checkAlgorithm }.
      * @param path			    See {@link DBC.decPrecondition }.
      * @param dbc			    See {@link DBC.decPrecondition }.
      *
@@ -45,11 +45,11 @@ export class COMPARISON extends DBC {
         }, dbc, path);
     }
     /**
-     * A method-decorator factory using the {@link GREATER.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+     * A method-decorator factory using the {@link COMPARISON.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
      * by the tagged method's returnvalue.
      *
-     * @param equivalent	    See {@link GREATER.checkAlgorithm }.
-     * @param equalityPermitted See {@link GREATER.checkAlgorithm }.
+     * @param equivalent	    See {@link COMPARISON.checkAlgorithm }.
+     * @param equalityPermitted See {@link COMPARISON.checkAlgorithm }.
      * @param path			    See {@link DBC.Postcondition }.
      * @param dbc			    See {@link DBC.decPostcondition }.
      *
@@ -60,11 +60,11 @@ export class COMPARISON extends DBC {
         }, dbc, path);
     }
     /**
-     * A field-decorator factory using the {@link GREATER.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+     * A field-decorator factory using the {@link COMPARISON.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
      * by the tagged field.
      *
-     * @param equivalent	    See {@link GREATER.checkAlgorithm }.
-     * @param equalityPermitted See {@link GREATER.checkAlgorithm }.
+     * @param equivalent	    See {@link COMPARISON.checkAlgorithm }.
+     * @param equalityPermitted See {@link COMPARISON.checkAlgorithm }.
      * @param path			    See {@link DBC.decInvariant }.
      * @param dbc			    See {@link DBC.decInvariant }.
      *
@@ -76,20 +76,20 @@ export class COMPARISON extends DBC {
     // #region Referenced Condition checking.
     // #region Dynamic usage.
     /**
-     * Invokes the {@link GREATER.checkAlgorithm } passing the value **toCheck**, {@link GREATER.equivalent } and {@link GREATER.invert }.
+     * Invokes the {@link COMPARISON.checkAlgorithm } passing the value **toCheck**, {@link COMPARISON.equivalent } and {@link COMPARISON.invert }.
      *
-     * @param toCheck See {@link GREATER.checkAlgorithm }.
+     * @param toCheck See {@link COMPARISON.checkAlgorithm }.
      *
-     * @returns See {@link GREATER.checkAlgorithm}. */
+     * @returns See {@link COMPARISON.checkAlgorithm}. */
     check(toCheck) {
         return COMPARISON.checkAlgorithm(toCheck, this.equivalent, this.equalityPermitted, this.invert);
     }
     /**
-     * Creates this {@link GREATER } by setting the protected property {@link GREATER.equivalent }, {@link GREATER.equalityPermitted } and {@link GREATER.invert } used by {@link GREATER.check }.
+     * Creates this {@link COMPARISON } by setting the protected property {@link COMPARISON.equivalent }, {@link COMPARISON.equalityPermitted } and {@link COMPARISON.invert } used by {@link COMPARISON.check }.
      *
-     * @param equivalent        See {@link GREATER.check }.
-     * @param equalityPermitted See {@link GREATER.check }.
-     * @param invert            See {@link GREATER.check }. */
+     * @param equivalent        See {@link COMPARISON.check }.
+     * @param equalityPermitted See {@link COMPARISON.check }.
+     * @param invert            See {@link COMPARISON.check }. */
     constructor(equivalent, equalityPermitted = false, invert = false) {
         super();
         this.equivalent = equivalent;

package/dist/Demo.js

@@ -16,12 +16,13 @@ import { EQ } from "./DBC/EQ";
 import { TYPE } from "./DBC/TYPE";
 import { AE } from "./DBC/AE";
 import { INSTANCE } from "./DBC/INSTANCE";
+import { GREATER } from "./DBC/COMPARISON/GREATER";
 /** Demonstrative use of **D**esign **B**y **C**ontract Decorators */
 export class Demo {
     constructor() {
         // #region Check Property Decorator
         this.testProperty = "a";
-        // #endregion Check AE Index
+        // #endregion Check Comparison
     }
     // #endregion Check Property Decorator
     // #region Check Parameter. & Returnvalue Decorator
@@ -57,6 +58,9 @@ export class Demo {
     // #endregion Check AE Range
     // #region Check AE Index
     testAEIndex(x) { }
+    // #endregion Check AE Index
+    // #region Check Comparison
+    testGREATER(input) { }
 }
 __decorate([
     REGEX.INVARIANT(/^a$/),
@@ -134,6 +138,12 @@ __decorate([
     __metadata("design:paramtypes", [Array]),
     __metadata("design:returntype", void 0)
 ], Demo.prototype, "testAEIndex", null);
+__decorate([
+    __param(0, GREATER.PRE(2)),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", void 0)
+], Demo.prototype, "testGREATER", null);
 const demo = new Demo();
 try {
     demo.testProperty = "abd";
@@ -265,3 +275,16 @@ catch (X) {
     console.log(X);
     console.log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
 }
+demo.testGREATER(11);
+console.log("⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄");
+console.log("GREATER OK");
+console.log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
+try {
+    demo.testGREATER(2);
+}
+catch (X) {
+    console.log("⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄");
+    console.log("GREATER OK");
+    console.log(X);
+    console.log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
+}