@everyonesoftware/common 2.0.0 → 4.0.0

package/sources/condition.ts

@@ -1,329 +0,0 @@
-import { Bytes } from "./bytes";
-import { JavascriptIterable } from "./javascript";
-import { MutableCondition } from "./mutableCondition";
-import { Type } from "./types";
-
-/**
- * A collection of condition methods that can be used to assert the state of an application.
- */
-export abstract class Condition
-{
-    protected constructor()
-    {
-    }
-
-    /**
-     * Create a new {@link MutableCondition} object.
-     */
-    public static create(): MutableCondition
-    {
-        return MutableCondition.create();
-    }
-
-    /**
-     * Assert that the provided value is undefined.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public assertUndefined(value: unknown, expression?: string, message?: string): asserts value is undefined
-    {
-        Condition.assertUndefined(this, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is undefined.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public static assertUndefined(condition: Condition, value: unknown, expression?: string, message?: string): asserts value is undefined
-    {
-        condition.assertSame(undefined, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is not undefined and not null.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public assertNotUndefined<T>(value: T, expression?: string, message?: string): asserts value is NonNullable<T>
-    {
-        Condition.assertNotUndefined(this, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is not undefined and not null.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public static assertNotUndefined<T>(condition: Condition, value: T, expression?: string, message?: string): asserts value is NonNullable<T>
-    {
-        condition.assertNotSame(undefined, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is not undefined and not null.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public assertNotUndefinedAndNotNull<T>(value: T, expression?: string, message?: string): asserts value is NonNullable<T>
-    {
-        Condition.assertNotUndefinedAndNotNull(this, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is not undefined and not null.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public static assertNotUndefinedAndNotNull<T>(condition: Condition, value: T, expression?: string, message?: string): asserts value is NonNullable<T>
-    {
-        condition.assertNotSame(undefined, value, expression, message);
-        condition.assertNotSame(null, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is true.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public assertTrue(value: boolean, expression?: string, message?: string): asserts value is true
-    {
-        Condition.assertTrue(this, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is true.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public static assertTrue(condition: Condition, value: boolean, expression?: string, message?: string): asserts value is true
-    {
-        condition.assertSame(true, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is false.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public assertFalse(value: boolean, expression?: string, message?: string): asserts value is false
-    {
-        Condition.assertFalse(this, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided value is false.
-     * @param value The value to check.
-     * @param expression The name of the expression that produced the value.
-     * @param message An additional message that will be included with the error.
-     */
-    public static assertFalse(condition: Condition, value: boolean, expression?: string, message?: string): asserts value is false
-    {
-        condition.assertSame(false, value, expression, message);
-    }
-
-    /**
-     * Assert that the provided actual value is the same as the provided expected value.
-     * @param expected The expected value.
-     * @param actual The actual value.
-     * @param expression The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertSame<T>(expected: T, actual: T, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided actual value is not the same as the provided expected value.
-     * @param expected The expected value.
-     * @param actual The actual value.
-     * @param expression The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertNotSame<T>(expected: T, actual: T, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided actual value is equal to the provided expected value.
-     * @param expected The expected value.
-     * @param actual The actual value.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertEqual<T>(expected: T, actual: T, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided actual value is not equal to the provided expected value.
-     * @param notExpected The not expected value.
-     * @param actual The actual value.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertNotEqual<T>(notExpected: T, actual: T, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided value is not empty.
-     * @param value The value to check.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertNotEmpty(value: JavascriptIterable<unknown> | string | undefined | null, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided value is less than the provided upperBound.
-     * @param value The value to check.
-     * @param upperBound The upperBound that the value must be less than.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertLessThan(value: number, upperBound: number, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided value is less than or equal to the provided upperBound.
-     * @param value The value to check.
-     * @param upperBound The upperBound that the value must be less than.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertLessThanOrEqualTo(value: number, upperBound: number, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided value is greater than or equal to the provided lowerBound.
-     * @param value The value to check.
-     * @param lowerBound The lowerBound that the value must be greater than or equal to.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertGreaterThanOrEqualTo(value: number, lowerBound: number, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided value is greater than the provided lowerBound.
-     * @param value The value to check.
-     * @param lowerBound The lowerBound that the value must be greater than.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertGreaterThan(value: number, lowerBound: number, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the value is greater than or equal to the lowerBound and less than or equal to
-     * the upperBound.
-     * @param lowerBound The lowerBound that the value must be greater than or equal to.
-     * @param value The value to check.
-     * @param upperBound The upperBound that the value must be less than or equal to.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public abstract assertBetween(lowerBound: number, value: number, upperBound: number, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the index is within the access bounds of an indexable with the provided count.
-     * @param index The index to check.
-     * @param count The number of elements in the indexable.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public assertAccessIndex(index: number, count: number, expression?: string, message?: string): void
-    {
-        Condition.assertAccessIndex(this, index, count, expression, message);
-    }
-
-    /**
-     * Assert that the index is within the access bounds of an indexable with the provided count.
-     * @param index The index to check.
-     * @param count The number of elements in the indexable.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public static assertAccessIndex(condition: Condition, index: number, count: number, expression?: string, message?: string): void
-    {
-        condition.assertBetween(0, index, count - 1, expression, message);
-    }
-
-    /**
-     * Assert that the index is within the insertion bounds of a {@link List} with the provided count.
-     * @param index The index to check.
-     * @param count The number of elements in the indexable.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public assertInsertIndex(index: number, count: number, expression?: string, message?: string): void
-    {
-        Condition.assertInsertIndex(this, index, count, expression, message);
-    }
-
-    /**
-     * Assert that the index is within the insertion bounds of a {@link List} with the provided count.
-     * @param index The index to check.
-     * @param count The number of elements in the indexable.
-     * @param expression  The expression that produced the actual value.
-     * @param message An optional message that describes the scenario.
-     */
-    public static assertInsertIndex(condition: Condition, index: number, count: number, expression?: string, message?: string): void
-    {
-        condition.assertBetween(0, index, count, expression, message);
-    }
-
-    /**
-     * Assert that the value is one of the possibilities.
-     * @param possibilities The possible values that the value can be.
-     * @param value The value to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public abstract assertOneOf<T>(possibilities: JavascriptIterable<T>, value: T, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the value is within the bounds of a byte.
-     * @param value The value to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public assertByte(value: number, expression?: string, message?: string): void
-    {
-        Condition.assertByte(this, value, expression, message);
-    }
-
-    /**
-     * Assert that the value is within the bounds of a byte.
-     * @param value The value to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public static assertByte(condition: Condition, value: number, expression?: string, message?: string): void
-    {
-        condition.assertBetween(Bytes.minimumValue, value, Bytes.maximumValue, expression, message);
-        condition.assertInteger(value, expression, message);
-    }
-
-    /**
-     * Assert that the value is an integer.
-     * @param value The value to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public abstract assertInteger(value: number, expression?: string, message?: string): void;
-
-    /**
-     * Assert that the provided value is an instance of the provided {@link Type}.
-     * @param value The value to check.
-     * @param type The {@link Type} to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public abstract assertInstanceOf<T>(value: unknown, type: Type<T>, typeCheck?: (value: unknown) => value is T, expression?: string, message?: string): asserts value is T;
-    /**
-     * Assert that the provided value is an instance of the provided {@link Type}.
-     * @param value The value to check.
-     * @param type The {@link Type} to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public abstract assertInstanceOf<T>(parameters: { value: unknown, type: Type<T>, typeCheck?: (value: unknown) => value is T, expression?: string, message?: string }): void;
-}

package/sources/currentProcess.ts

@@ -1,158 +0,0 @@
-import { CharacterWriteStream } from "./characterWriteStream";
-import { CommandLineParameters } from "./commandLineParameters";
-import { JavascriptIterable } from "./javascript";
-import { Network } from "./network";
-import { NodeJSCharacterWriteStream } from "./nodeJSCharacterWriteStream";
-import { PreCondition } from "./preCondition";
-import { Property } from "./property";
-import { RealNetwork } from "./realNetwork";
-import { isNumber } from "./types";
-
-/**
- * An object that provides all of the resources that are available to the current process.
- */
-export class CurrentProcess
-{
-    private args: JavascriptIterable<string> | undefined
-    private parameters: CommandLineParameters | undefined;
-    private outputWriteStream: CharacterWriteStream | undefined;
-    private exitCodeProperty: Property<number> | undefined;
-    private network: Network | undefined;
-
-    private constructor()
-    {
-    }
-
-    public static create(): CurrentProcess
-    {
-        return new CurrentProcess();
-    }
-
-    public static async run(action: (currentProcess: CurrentProcess) => void | number | Promise<void | number>): Promise<void>
-    {
-        PreCondition.assertNotUndefinedAndNotNull(action, "action");
-
-        const currentProcess: CurrentProcess = CurrentProcess.create();
-        try
-        {
-            const result: void | number = await action(currentProcess);
-            if (isNumber(result))
-            {
-                currentProcess.setExitCode(result);
-            }
-        }
-        catch (error)
-        {
-            currentProcess.setExitCode(-1);
-            const writeStream: CharacterWriteStream = currentProcess.getOutputWriteStream();
-            if (error instanceof Error && error.stack)
-            {
-                writeStream.writeLine(error.stack);
-            }
-            else
-            {
-                writeStream.writeLine(`${error}`);
-            }
-        }
-    }
-
-    public getArguments(): JavascriptIterable<string>
-    {
-        if (!this.args)
-        {
-            this.args = process.argv;
-        }
-        return this.args;
-    }
-
-    public setArguments(args: JavascriptIterable<string>): this
-    {
-        PreCondition.assertNotUndefinedAndNotNull(args, "args");
-        PreCondition.assertUndefined(this.parameters, "this.parameters");
-
-        this.args = args;
-        return this;
-    }
-
-    public getParameters(): CommandLineParameters
-    {
-        if (!this.parameters)
-        {
-            this.parameters = CommandLineParameters.create(this.getArguments());
-        }
-        return this.parameters;
-    }
-
-    public getOutputWriteStream(): CharacterWriteStream
-    {
-        if (!this.outputWriteStream)
-        {
-            this.outputWriteStream = NodeJSCharacterWriteStream.create(process.stdout);
-        }
-        return this.outputWriteStream;
-    }
-
-    public setOutputWriteStream(outputWriteStream: CharacterWriteStream): this
-    {
-        PreCondition.assertNotUndefinedAndNotNull(outputWriteStream, "outputWriteStream");
-
-        this.outputWriteStream = outputWriteStream;
-
-        return this;
-    }
-
-    public getExitCode(): number
-    {
-        return this.getExitCodeProperty().getValue();
-    }
-
-    public setExitCode(exitCode: number): this
-    {
-        PreCondition.assertNotUndefinedAndNotNull(exitCode, "exitCode");
-
-        this.getExitCodeProperty().setValue(exitCode);
-
-        return this;
-    }
-
-    public getExitCodeProperty(): Property<number>
-    {
-        if (!this.exitCodeProperty)
-        {
-            this.exitCodeProperty = Property.create({
-                getter: () => process.exitCode as number,
-                setter: (value: number) => { process.exitCode = value; },
-            });
-        }
-        return this.exitCodeProperty;
-    }
-
-    public setExitCodeProperty(exitCodeProperty: Property<number>): this
-    {
-        PreCondition.assertNotUndefinedAndNotNull(exitCodeProperty, "exitCodeProperty");
-
-        this.exitCodeProperty = exitCodeProperty;
-
-        return this;
-    }
-
-    public getNetwork(): Network
-    {
-        if (!this.network)
-        {
-            this.network = RealNetwork.create();
-        }
-        return this.network;
-    }
-
-    public setNetwork(network: Network): this
-    {
-        PreCondition.assertUndefined(this.network, "this.network");
-        PreCondition.assertNotUndefinedAndNotNull(network, "network");
-
-        this.network = network;
-
-        return this;
-
-    }
-}

package/sources/dateTime.ts

@@ -1,130 +0,0 @@
-import { LuxonDateTime } from "./luxonDateTime";
-
-export abstract class DateTime
-{
-    public static parse(text: string): DateTime
-    {
-        return LuxonDateTime.parse(text);
-    }
-
-    public static now(): DateTime
-    {
-        return LuxonDateTime.now();
-    }
-
-    public abstract getYear(): number;
-
-    public abstract getMonth(): number;
-
-    public abstract getDay(): number;
-
-    public abstract getHour(): number;
-
-    public abstract getMinute(): number;
-
-    public abstract getSecond(): number;
-
-    public abstract addDays(days: number): DateTime;
-
-    /**
-     * Compare this {@link DateTime} to the provided {@link DateTime}. If this {@link DateTime} is
-     * less than the provided {@link DateTime}, then a negative number will be returned, 0 if
-     * they're equal, or a positive number if this {@link DateTime} is greater than the provided
-     * {@link DateTime}.
-     * @param dateTime The {@link DateTime} to compare to this {@link DateTime}.
-     */
-    public compareTo(dateTime: DateTime, compareTimes: boolean): number
-    {
-        return DateTime.compareTo(this, dateTime, compareTimes);
-    }
-
-    public static compareTo(left: DateTime, right: DateTime, compareTimes: boolean): number
-    {
-        let result: number = left.getYear() - right.getYear();
-        if (result === 0)
-        {
-            result = left.getMonth() - right.getMonth();
-            if (result === 0)
-            {
-                result = left.getDay() - right.getDay();
-                if (compareTimes && result === 0)
-                {
-                    result = left.getHour() - right.getHour();
-                    if (result === 0)
-                    {
-                        result = left.getMinute() - right.getMinute();
-                        if (result === 0)
-                        {
-                            result = left.getSecond(); - right.getSecond();
-                        }
-                    }
-                }
-            }
-        }
-        return result;
-    }
-
-    public lessThan(dateTime: DateTime, compareTimes: boolean): boolean
-    {
-        return DateTime.lessThan(this, dateTime, compareTimes);
-    }
-
-    public static lessThan(left: DateTime, right: DateTime, compareTimes: boolean): boolean
-    {
-        return left.compareTo(right, compareTimes) < 0;
-    }
-
-    public lessThanOrEqualTo(dateTime: DateTime, compareTimes: boolean): boolean
-    {
-        return DateTime.lessThanOrEqualTo(this, dateTime, compareTimes);
-    }
-
-    public static lessThanOrEqualTo(left: DateTime, right: DateTime, compareTimes: boolean): boolean
-    {
-        return left.compareTo(right, compareTimes) <= 0;
-    }
-
-    public equals(dateTime: DateTime, compareTimes: boolean): boolean
-    {
-        return DateTime.equals(this, dateTime, compareTimes);
-    }
-
-    public static equals(left: DateTime, right: DateTime, compareTimes: boolean): boolean
-    {
-        return left.compareTo(right, compareTimes) === 0;
-    }
-
-    public greaterThanOrEqualTo(dateTime: DateTime, compareTimes: boolean): boolean
-    {
-        return DateTime.greaterThanOrEqualTo(this, dateTime, compareTimes);
-    }
-
-    public static greaterThanOrEqualTo(left: DateTime, right: DateTime, compareTimes: boolean): boolean
-    {
-        return left.compareTo(right, compareTimes) >= 0;
-    }
-
-    public greaterThan(dateTime: DateTime, compareTimes: boolean): boolean
-    {
-        return DateTime.greaterThan(this, dateTime, compareTimes);
-    }
-
-    public static greaterThan(left: DateTime, right: DateTime, compareTimes: boolean): boolean
-    {
-        return left.compareTo(right, compareTimes) > 0;
-    }
-
-    public get debug(): string
-    {
-        return DateTime.debug(this);
-    }
-
-    public static debug(dateTime: DateTime): string
-    {
-        return dateTime.toString();
-    }
-
-    public abstract toString(): string;
-
-    public abstract toDateString(): string;
-}