feat: migrate date (#83)

Author: Shinigami92

src/date.ts

@@ -0,0 +1,207 @@
+import type { Faker } from '.';
+
+export class _Date {
+  constructor(private readonly faker: Faker) {
+    // Bind `this` so namespaced is working correctly
+    for (const name of Object.getOwnPropertyNames(_Date.prototype)) {
+      if (name === 'constructor' || typeof this[name] !== 'function') {
+        continue;
+      }
+      this[name] = this[name].bind(this);
+    }
+  }
+
+  /**
+   * past
+   *
+   * @method faker.date.past
+   * @param years
+   * @param refDate
+   */
+  past(years?: number, refDate?: string): Date {
+    let date = new Date();
+    if (typeof refDate !== 'undefined') {
+      date = new Date(Date.parse(refDate));
+    }
+
+    const range = {
+      min: 1000,
+      max: (years || 1) * 365 * 24 * 3600 * 1000,
+    };
+
+    let past = date.getTime();
+    past -= this.faker.datatype.number(range); // some time from now to N years ago, in milliseconds
+    date.setTime(past);
+
+    return date;
+  }
+
+  /**
+   * future
+   *
+   * @method faker.date.future
+   * @param years
+   * @param refDate
+   */
+  future(years?: number, refDate?: string): Date {
+    let date = new Date();
+    if (typeof refDate !== 'undefined') {
+      date = new Date(Date.parse(refDate));
+    }
+
+    const range = {
+      min: 1000,
+      max: (years || 1) * 365 * 24 * 3600 * 1000,
+    };
+
+    let future = date.getTime();
+    future += this.faker.datatype.number(range); // some time from now to N years later, in milliseconds
+    date.setTime(future);
+
+    return date;
+  }
+
+  /**
+   * between
+   *
+   * @method faker.date.between
+   * @param from
+   * @param to
+   */
+  between(from: string, to: string): Date {
+    const fromMilli = Date.parse(from);
+    const dateOffset = this.faker.datatype.number(Date.parse(to) - fromMilli);
+
+    const newDate = new Date(fromMilli + dateOffset);
+
+    return newDate;
+  }
+
+  /**
+   * betweens
+   *
+   * @method faker.date.between
+   * @param from
+   * @param to
+   * @param num
+   */
+  betweens(from: string, to: string, num?: number): Date[] {
+    if (typeof num == 'undefined') {
+      num = 3;
+    }
+    const newDates: Date[] = [];
+    let fromMilli = Date.parse(from);
+    const dateOffset = (Date.parse(to) - fromMilli) / (num + 1);
+    let lastDate: string | Date = from;
+    for (let i = 0; i < num; i++) {
+      // TODO @Shinigami92 2022-01-11: It may be a bug that `lastDate` is passed to parse if it's a `Date` not a `string`
+      // @ts-expect-error
+      fromMilli = Date.parse(lastDate);
+      lastDate = new Date(fromMilli + dateOffset);
+      newDates.push(lastDate);
+    }
+    return newDates;
+  }
+
+  /**
+   * recent
+   *
+   * @method faker.date.recent
+   * @param days
+   * @param refDate
+   */
+  recent(days?: number, refDate?: string): Date {
+    let date = new Date();
+    if (typeof refDate !== 'undefined') {
+      date = new Date(Date.parse(refDate));
+    }
+
+    const range = {
+      min: 1000,
+      max: (days || 1) * 24 * 3600 * 1000,
+    };
+
+    let future = date.getTime();
+    future -= this.faker.datatype.number(range); // some time from now to N days ago, in milliseconds
+    date.setTime(future);
+
+    return date;
+  }
+
+  /**
+   * soon
+   *
+   * @method faker.date.soon
+   * @param days
+   * @param refDate
+   */
+  soon(days?: number, refDate?: string): Date {
+    let date = new Date();
+    if (typeof refDate !== 'undefined') {
+      date = new Date(Date.parse(refDate));
+    }
+
+    const range = {
+      min: 1000,
+      max: (days || 1) * 24 * 3600 * 1000,
+    };
+
+    let future = date.getTime();
+    future += this.faker.datatype.number(range); // some time from now to N days later, in milliseconds
+    date.setTime(future);
+
+    return date;
+  }
+
+  /**
+   * month
+   *
+   * @method faker.date.month
+   * @param options
+   */
+  month(options?: { abbr?: boolean; context?: boolean }) {
+    options = options || {};
+
+    let type = 'wide';
+    if (options.abbr) {
+      type = 'abbr';
+    }
+    if (
+      options.context &&
+      typeof this.faker.definitions.date.month[type + '_context'] !==
+        'undefined'
+    ) {
+      type += '_context';
+    }
+
+    const source = this.faker.definitions.date.month[type];
+
+    return this.faker.random.arrayElement(source);
+  }
+
+  /**
+   * weekday
+   *
+   * @method faker.date.weekday
+   * @param options
+   */
+  weekday(options?: { abbr?: boolean; context?: boolean }) {
+    options = options || {};
+
+    let type = 'wide';
+    if (options.abbr) {
+      type = 'abbr';
+    }
+    if (
+      options.context &&
+      typeof this.faker.definitions.date.weekday[type + '_context'] !==
+        'undefined'
+    ) {
+      type += '_context';
+    }
+
+    const source = this.faker.definitions.date.weekday[type];
+
+    return this.faker.random.arrayElement(source);
+  }
+}

src/index.ts

@@ -1,4 +1,5 @@
 import { Datatype } from './datatype';
+import { _Date } from './date';
 import { Mersenne } from './mersenne';
 import { Random } from './random';
 
@@ -166,7 +167,7 @@ export class Faker {
   readonly commerce = new (require('./commerce'))(this);
   readonly company = new (require('./company'))(this);
   readonly database = new (require('./database'))(this);
-  readonly date = new (require('./date'))(this);
+  readonly date: _Date = new _Date(this);
   readonly finance = new (require('./finance'))(this);
   readonly git = new (require('./git'))(this);
   readonly hacker = new (require('./hacker'))(this);