Merge pull request #42 from RobotlegsJS/code-coverage

tiagoschenkel · web-flow · commit a1425bf5e247 · 2018-01-22T22:15:39.000+01:00
Improve code coverage to reach 100%
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,14 +10,18 @@
 
   - [x] **printWidth** should be around **140** characters per line.
 
-- [ ] Improve Code Coverage to reach 100%.
+- [x] Improve Code Coverage to reach 100%.
+
+- [ ] Move `event` package to an external dependency.
 
 - [ ] Migrate [original documentation](https://github.com/robertpenner/as3-signals#readme) and adapt it to TypeScript.
 
 ## Signals 0.0.1
 
 ### v0.0.13
 
+- Improve code coverage to reach 100% (see #42).
+
 - Use `rimraf` instead of `rm -rf` (see #41).
 
 - Update Prettier rules (see #40).
diff --git a/dist/signals.min.js b/dist/signals.min.js
diff --git a/src/org/osflash/signals/DeluxeSignal.ts b/src/org/osflash/signals/DeluxeSignal.ts
@@ -33,11 +33,11 @@ export class DeluxeSignal extends PrioritySignal {
      * NOTE: Subclasses cannot call super.apply(null, valueClasses),
      * but this constructor has logic to support super(valueClasses).
      */
-    constructor(target: Object = null, ...valueClasses) {
+    constructor(target: Object = null, ...valueClasses: any[]) {
         // Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
         valueClasses = valueClasses.length === 1 && valueClasses[0] instanceof Array ? valueClasses[0] : valueClasses;
 
-        super(valueClasses);
+        /* istanbul ignore next */ super(valueClasses);
 
         // @CHANGED - this was the first call in the constructor
         // Typescript does not allow "this" to be called before super
@@ -63,7 +63,7 @@ export class DeluxeSignal extends PrioritySignal {
      * @throws ArgumentError <code>ArgumentError</code>: Value object is not an instance of the appropriate valueClasses Class.
      */
     /*override*/
-    public dispatch(...valueObjects): void {
+    public dispatch(...valueObjects: any[]): void {
         // Validate value objects against pre-defined value classes.
         let numValueClasses: number = this._valueClasses.length;
         let numValueObjects: number = valueObjects.length;
@@ -114,6 +114,7 @@ export class DeluxeSignal extends PrioritySignal {
         while (currentTarget && currentTarget.hasOwnProperty("parent")) {
             currentTarget = (<any>currentTarget).parent;
 
+            /* istanbul ignore else */
             if ((<any>currentTarget).onEventBubbled !== null) {
                 event.currentTarget = currentTarget;
 
diff --git a/src/org/osflash/signals/IOnceSignal.ts b/src/org/osflash/signals/IOnceSignal.ts
@@ -31,7 +31,7 @@ export interface IOnceSignal {
      * @param    valueObjects    Any number of parameters to send to listeners. Will be type-checked against valueClasses.
      * @throws    ArgumentError    <code>ArgumentError</code>:    valueObjects are not compatible with valueClasses.
      */
-    dispatch(...valueObjects): void;
+    dispatch(...valueObjects: any[]): void;
 
     /**
      * Unsubscribes a listener from the signal.
diff --git a/src/org/osflash/signals/IPrioritySignal.ts b/src/org/osflash/signals/IPrioritySignal.ts
@@ -18,7 +18,7 @@ export interface IPrioritySignal extends ISignal {
      * @return a ISlot, which contains the Function passed as the parameter
      * @see ISlot
      */
-    addWithPriority(listener: Function, priority: number): ISlot;
+    addWithPriority(listener: Function, priority?: number): ISlot;
 
     /**
      * Subscribes a one-time listener for this signal.
@@ -34,5 +34,5 @@ export interface IPrioritySignal extends ISignal {
      * @return a ISlot, which contains the Function passed as the parameter
      * @see ISlot
      */
-    addOnceWithPriority(listener: Function, priority: number): ISlot;
+    addOnceWithPriority(listener: Function, priority?: number): ISlot;
 }
diff --git a/src/org/osflash/signals/MonoSignal.ts b/src/org/osflash/signals/MonoSignal.ts
@@ -27,7 +27,7 @@ export class MonoSignal implements ISignal {
      * NOTE: Subclasses cannot call super.apply(null, valueClasses),
      * but this constructor has logic to support super(valueClasses).
      */
-    constructor(...valueClasses) {
+    constructor(...valueClasses: any[]) {
         // Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
         this.valueClasses = valueClasses.length === 1 && valueClasses[0] instanceof Array ? valueClasses[0] : valueClasses;
     }
@@ -105,7 +105,7 @@ export class MonoSignal implements ISignal {
      * @throws ArgumentError <code>ArgumentError</code>: Incorrect number of arguments.
      * @throws ArgumentError <code>ArgumentError</code>: Value object is not an instance of the appropriate valueClasses Class.
      */
-    public dispatch(...valueObjects): void {
+    public dispatch(...valueObjects: any[]): void {
         // If valueClasses is empty, value objects are not type-checked.
         let numValueClasses: number = this._valueClasses.length;
         let numValueObjects: number = valueObjects.length;
diff --git a/src/org/osflash/signals/OnceSignal.ts b/src/org/osflash/signals/OnceSignal.ts
@@ -34,7 +34,7 @@ export class OnceSignal implements IOnceSignal {
      * NOTE: In AS3, subclasses cannot call super.apply(null, valueClasses),
      * but this constructor has logic to support super(valueClasses).
      */
-    constructor(...valueClasses) {
+    constructor(...valueClasses: any[]) {
         // Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
         this.valueClasses = valueClasses.length === 1 && valueClasses[0] instanceof Array ? valueClasses[0] : valueClasses;
     }
@@ -101,7 +101,7 @@ export class OnceSignal implements IOnceSignal {
      * @throws ArgumentError <code>ArgumentError</code>: Incorrect number of arguments.
      * @throws ArgumentError <code>ArgumentError</code>: Value object is not an instance of the appropriate valueClasses Class.
      */
-    public dispatch(...valueObjects): void {
+    public dispatch(...valueObjects: any[]): void {
         // If valueClasses is empty, value objects are not type-checked.
         let numValueClasses: number = this._valueClasses.length;
         let numValueObjects: number = valueObjects.length;
diff --git a/src/org/osflash/signals/PrioritySignal.ts b/src/org/osflash/signals/PrioritySignal.ts
@@ -4,13 +4,6 @@ import { ISlot } from "./ISlot";
 import { Slot } from "./Slot";
 
 export class PrioritySignal extends Signal implements IPrioritySignal {
-    constructor(...valueClasses) {
-        // Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
-        valueClasses = valueClasses.length === 1 && valueClasses[0] instanceof Array ? valueClasses[0] : valueClasses;
-
-        super(valueClasses);
-    }
-
     /**
      * @inheritDoc
      * @throws flash.errors.IllegalOperationError <code>IllegalOperationError</code>: You cannot addOnce() then add() the same listener without removing the relationship first.
@@ -34,7 +27,7 @@ export class PrioritySignal extends Signal implements IPrioritySignal {
         return this.registerListenerWithPriority(listener, once);
     }
 
-    protected registerListenerWithPriority(listener: Function, once: boolean = false, priority: number = 0): ISlot {
+    protected registerListenerWithPriority(listener: Function, once: boolean, priority: number = 0): ISlot {
         if (this.registrationPossible(listener, once)) {
             let slot: ISlot = new Slot(listener, this, once, priority);
             this.slots = this.slots.insertWithPriority(slot);
diff --git a/src/org/osflash/signals/Promise.ts b/src/org/osflash/signals/Promise.ts
@@ -22,7 +22,7 @@ export class Promise extends OnceSignal {
      * @throws flash.errors.IllegalOperationError <code>IllegalOperationError</code>: You cannot dispatch() a Promise more than once
      */
     /*override*/
-    public dispatch(...valueObjects): void {
+    public dispatch(...valueObjects: any[]): void {
         if (this.isDispatched) {
             throw new Error("You cannot dispatch() a Promise more than once");
         } else {
diff --git a/src/org/osflash/signals/Signal.ts b/src/org/osflash/signals/Signal.ts
@@ -19,24 +19,6 @@ import { ISlot } from "./ISlot";
  * Project home: <a target="_top" href="http://github.com/robertpenner/as3-signals/">http://github.com/robertpenner/as3-signals/</a>
  */
 export class Signal extends OnceSignal implements ISignal {
-    /**
-     * Creates a Signal instance to dispatch value objects.
-     * @param    valueClasses Any number of class references that enable type checks in dispatch().
-     * For example, new Signal(String, uint)
-     * would allow: signal.dispatch("the Answer", 42)
-     * but not: signal.dispatch(true, 42.5)
-     * nor: signal.dispatch()
-     *
-     * NOTE: In AS3, subclasses cannot call super.apply(null, valueClasses),
-     * but this constructor has logic to support super(valueClasses).
-     */
-    constructor(...valueClasses) {
-        // Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
-        valueClasses = valueClasses.length === 1 && valueClasses[0] instanceof Array ? valueClasses[0] : valueClasses;
-
-        super(valueClasses);
-    }
-
     /**
      * @inheritDoc
      * @throws flash.errors.IllegalOperationError <code>IllegalOperationError</code>: You cannot addOnce() then add() the same listener without removing the relationship first.
diff --git a/test/org/osflash/signals/DeluxeSignalTargetTest.test.ts b/test/org/osflash/signals/DeluxeSignalTargetTest.test.ts
@@ -17,6 +17,16 @@ describe("DeluxeSignaltargetTest", () => {
         signal = null;
     });
 
+    it("target_should_be_empty()", () => {
+        signal = new DeluxeSignal();
+        assert.isNull(signal.target);
+    });
+
+    it("target_should_be_null()", () => {
+        signal = new DeluxeSignal(null);
+        assert.isNull(signal.target);
+    });
+
     it("set_target_should_change_target()", () => {
         let target: object = {};
         signal.target = target;
diff --git a/test/org/osflash/signals/DeluxeSignalValueClassesTest.test.ts b/test/org/osflash/signals/DeluxeSignalValueClassesTest.test.ts
@@ -17,6 +17,16 @@ describe("DeluxeSignalValueClassesTest", () => {
         signal = null;
     });
 
+    it("constructor_should_accept_array_of_value_classes()", () => {
+        signal = new DeluxeSignal(self, [Number, String, Boolean]);
+        assert.deepEqual(signal.valueClasses, [Number, String, Boolean]);
+    });
+
+    it("constructor_should_accept_empty_value_classes()", () => {
+        signal = new DeluxeSignal(self);
+        assert.deepEqual(signal.valueClasses, []);
+    });
+
     it("get_value_classes_should_return_same_value_classes_used_in_constructor()", () => {
         assert.deepEqual(signal.valueClasses, [Number, String, Boolean]);
     });
@@ -25,6 +35,16 @@ describe("DeluxeSignalValueClassesTest", () => {
         signal.valueClasses = [Number, String, Boolean];
     });
 
+    it("set_value_classes_should_accept_null()", () => {
+        signal.valueClasses = null;
+        assert.deepEqual(signal.valueClasses, []);
+    });
+
+    it("set_value_classes_should_accept_undefined()", () => {
+        signal.valueClasses = undefined;
+        assert.deepEqual(signal.valueClasses, []);
+    });
+
     it("set_value_classes_throws_error_when_objects_are_passed()", () => {
         assert.throws(() => {
             signal.valueClasses = [0, "", false];
diff --git a/test/org/osflash/signals/MonoSignalValueClassesTest.test.ts b/test/org/osflash/signals/MonoSignalValueClassesTest.test.ts
@@ -20,10 +20,25 @@ describe("MonoSignalValueClassesTest", () => {
         assert.deepEqual(signal.valueClasses, [Number, String, Boolean]);
     });
 
+    it("constructor_should_accept_array_of_value_classes()", () => {
+        signal = new MonoSignal([Number, String, Boolean]);
+        assert.deepEqual(signal.valueClasses, [Number, String, Boolean]);
+    });
+
     it("set_value_classes_should_accept_only_class_objects()", () => {
         signal.valueClasses = [Number, String, Boolean];
     });
 
+    it("set_value_classes_should_accept_null()", () => {
+        signal.valueClasses = null;
+        assert.deepEqual(signal.valueClasses, []);
+    });
+
+    it("set_value_classes_should_accept_undefined()", () => {
+        signal.valueClasses = undefined;
+        assert.deepEqual(signal.valueClasses, []);
+    });
+
     it("set_value_classes_throws_error_when_objects_are_passed()", () => {
         assert.throws(() => {
             signal.valueClasses = [0, "", false];
diff --git a/test/org/osflash/signals/PrioritySignalOnceTest.test.ts b/test/org/osflash/signals/PrioritySignalOnceTest.test.ts
@@ -105,6 +105,32 @@ describe("PrioritySignalOnceTest", () => {
         assertNumListenersEqual(prioritySignal.numListeners, 0);
     });
 
+    it("listeners_added_once_with_priority_zero_should_be_called_after_high_and_before_negative_1()", () => {
+        let expectedListenerDispatchOrder: any[] = [A, B, C];
+
+        prioritySignal.addOnceWithPriority(listenerC, -10);
+        prioritySignal.addOnceWithPriority(listenerB);
+        prioritySignal.addOnceWithPriority(listenerA, 10);
+
+        prioritySignal.dispatch();
+
+        assertArrayEqual(expectedListenerDispatchOrder, gotListenerDispatchOrder);
+        assertNumListenersEqual(prioritySignal.numListeners, 0);
+    });
+
+    it("listeners_added_once_with_priority_zero_should_be_called_after_high_and_before_negative_2()", () => {
+        let expectedListenerDispatchOrder: any[] = [A, B, C];
+
+        prioritySignal.addOnceWithPriority(listenerC, -10);
+        prioritySignal.addOnceWithPriority(listenerA, 10);
+        prioritySignal.addOnceWithPriority(listenerB);
+
+        prioritySignal.dispatch();
+
+        assertArrayEqual(expectedListenerDispatchOrder, gotListenerDispatchOrder);
+        assertNumListenersEqual(prioritySignal.numListeners, 0);
+    });
+
     function listenerA(): void {
         gotListenerDispatchOrder.push(A);
     }
