3.0.14

.gitignore

@@ -1,5 +1,22 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,4 +1,4 @@
-# gitzone standard
+# gitzone ci_default
 image: hosttoday/ht-docker-node:npmci
 
 cache:
@@ -37,18 +37,6 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
@@ -90,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -121,10 +101,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smarttime",
+      "shortDescription": "handle time in smart ways",
+      "npmPackagename": "@pushrocks/smarttime",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,28 +1,42 @@
 {
   "name": "@pushrocks/smarttime",
   "private": false,
-  "version": "3.0.5",
-  "description": "handle timeformats in smart ways",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "version": "3.0.14",
+  "description": "handle time in smart ways",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest ./test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild && tsbundle npm)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.13",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.10",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.16.0"
+    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbundle": "^1.0.69",
+    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.9",
+    "@types/node": "^14.0.5",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@types/luxon": "^1.4.1",
-    "luxon": "^1.8.0"
-  }
+    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@types/cron": "^1.7.1",
+    "@types/luxon": "^1.15.1",
+    "cron-parser": "^2.14.0",
+    "luxon": "^1.16.0"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -1,24 +1,20 @@
 # @pushrocks/smarttime
+handle time in smart ways
 
-handle timeformats in smart ways
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smarttime)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smarttime)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smarttime)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smarttime/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarttime)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smarttime)
+* [github.com (source mirror)](https://github.com/pushrocks/smarttime)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smarttime/)
 
 ## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smarttime/badges/master/build.svg)](https://GitLab.com/pushrocks/smarttime/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smarttime/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smarttime/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smarttime.svg)](https://www.npmjs.com/package/smarttime)
-[![Dependency Status](https://david-dm.org/pushrocks/smarttime.svg)](https://david-dm.org/pushrocks/smarttime)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smarttime/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smarttime/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smarttime/badges/code.svg)](https://www.bithound.io/github/pushrocks/smarttime)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![build status](https://gitlab.com/pushrocks/smarttime/badges/master/build.svg)](https://gitlab.com/pushrocks/smarttime/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smarttime/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smarttime/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smarttime.svg)](https://www.npmjs.com/package/@pushrocks/smarttime)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarttime/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarttime)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
@@ -26,18 +22,29 @@ Use TypeScript for best in class instellisense.
 
 Smarttime offers smart ways to deal with time.
 
-### class ExtendedDate
+### class CronManager
+This class provides scheduling of functions with a cron syntax
 
-This class offers static functions to create zone speicific JavaScript dates from European formated time strings.
+```typescript
+import { CronManager } from '@pushrocks/smarrtime';
+const cronManagerInstance = new CronManager();
+cronManagerInstance.addConrjob('* * * * * *', async () => {
+  console.log('hello'); // will log 'hello' to console once every second;
+})
+cronManagerInstance.start();
+```
+
+### class ExtendedDate
+This class offers static functions to create zone specific JavaScript dates from European formated time strings.
 
 ```TypeScript
 import { ExtendedDate } from '@pushrocks/smarttime'
 const myDate: Date = ExtendedDate.fromEuropeanDate('8.6.2018')
 ```
 
-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

test/test.cronmanager.ts

@@ -0,0 +1,27 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as smarttime from '../ts/index';
+
+let testCronManager: smarttime.CronManager;
+
+tap.test('should create a valid instance of cronmanager', async () => {
+  testCronManager = new smarttime.CronManager();
+  expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
+});
+
+tap.test('should create a valid cronJon', async tools => {
+  const done = tools.defer();
+  let counter = 0;
+  testCronManager.addCronjob('* * * * * *', () => {
+    if (counter === 10) {
+      done.resolve();
+    }
+    counter++;
+    console.log(`hey ${counter}`);
+  });
+  testCronManager.start();
+  await done.promise;
+  testCronManager.stop();
+});
+
+tap.start();

test/test.extendeddate.ts

@@ -16,4 +16,9 @@ tap.test('should create a date and time with European Format', async () => {
   console.log(extendedDate);
 });
 
+tap.test('should create a European date string', async () => {
+  const extendedDate = smarttime.ExtendedDate.fromHyphedDate('2018-02-13');
+  expect(extendedDate.exportToEuropeanDate()).to.equal('13.02.2018');
+});
+
 tap.start();

ts/index.ts

@@ -1,6 +1,7 @@
 import * as plugins from './smarttime.plugins';
 
-export * from './smarttime.classes.date';
+export * from './smarttime.classes.cronmanager';
+export * from './smarttime.classes.extendeddate';
 export * from './smarttime.classes.hrtmeasurement';
 export * from './smarttime.classes.timer';
 export * from './smarttime.classes.timestamp';

ts/smarttime.classes.cronjob.ts

@@ -0,0 +1,45 @@
+import * as plugins from './smarttime.plugins';
+import { CronManager } from './smarttime.classes.cronmanager';
+
+export type TJobFunction = (() => void) | (() => Promise<any>);
+
+export class CronJob {
+  public status: 'started' | 'stopped' | 'initial' = 'initial';
+  public cronExpression: string;
+  public jobFunction: TJobFunction;
+  
+  private cronInterval= plugins.cronParser.parseExpression('* * * * * *');
+  private nextExecutionUnix: number = 0;
+
+  constructor(cronManager: CronManager, cronExpressionArg: string, jobFunction: TJobFunction ) {
+    this.cronExpression = cronExpressionArg;
+    this.jobFunction = jobFunction;
+  }
+
+  /**
+   * checks wether the cronjob needs to be executed
+   */
+  public checkExecution() {
+    if (this.nextExecutionUnix === 0) {
+      this.nextExecutionUnix = this.cronInterval.next().toDate().getTime();
+      return;
+    }
+    if (Date.now() > this.nextExecutionUnix) {
+      this.jobFunction();
+      this.nextExecutionUnix = this.cronInterval.next().toDate().getTime();
+    }
+  }
+
+  public start() {
+    this.cronInterval = this.getCronInterval();
+    this.status = 'started';
+  }
+
+  public stop() {
+    this.status = 'stopped';
+  }
+
+  private getCronInterval () {
+    return plugins.cronParser.parseExpression(this.cronExpression);
+  }
+}

ts/smarttime.classes.cronmanager.ts

@@ -0,0 +1,49 @@
+import * as plugins from './smarttime.plugins';
+import { CronJob } from './smarttime.classes.cronjob';
+import { Timer } from './smarttime.classes.timer';
+import { Interval } from './smarttime.classes.interval';
+
+export class CronManager {
+  public cronInterval = new Interval(1000);
+
+  public status: 'started' | 'stopped' = 'stopped';
+  public cronjobs: CronJob[] = [];
+
+  constructor() {
+    this.cronInterval.addIntervalJob(() => {
+      for (const cronJob of this.cronjobs) {
+        cronJob.checkExecution();
+      }
+    });
+  }
+
+  public addCronjob(cronIdentifierArg: string, cronFunctionArg: () => any) {
+    const newCronJob = new CronJob(this, cronIdentifierArg, cronFunctionArg);
+    this.cronjobs.push(newCronJob);
+    if (this.status === 'started') {
+      newCronJob.start();
+    }
+  }
+
+  /**
+   * starts the cronjob
+   */
+  public start() {
+    this.status = 'started';
+    for (const cron of this.cronjobs) {
+      cron.start();
+    }
+    this.cronInterval.start();
+  }
+
+  /**
+   * stops all cronjobs
+   */
+  public stop() {
+    this.status = 'stopped';
+    for (const cron of this.cronjobs) {
+      cron.stop();
+    }
+    this.cronInterval.stop();
+  }
+}

ts/smarttime.classes.date.ts

@@ -1,40 +0,0 @@
-import * as plugins from './smarttime.plugins';
-
-export type TAvailableZone = 'Europe/Berlin';
-
-export class ExtendedDate extends Date {
-  public static fromEuropeanDate(europeanDate: string) {
-    const dateArray = /(.*)\.(.*)\.(.*)/.exec(europeanDate);
-    const luxonDate = plugins.luxon.DateTime.utc(
-      parseFloat(dateArray[3]), // year
-      parseFloat(dateArray[2]), // month
-      parseFloat(dateArray[1]) // day
-    );
-    const unixMilli = luxonDate.toMillis();
-    return new ExtendedDate(unixMilli);
-  }
-
-  /** */
-  public static fromEuropeanDateAndTime(
-    europeanDateArg: string,
-    timeArg: string,
-    zoneArg: TAvailableZone
-  ) {
-    const dateArray = /(.*)\.(.*)\.(.*)/.exec(europeanDateArg);
-    const sliceDate = (dateString: string) => {
-      return `0${dateString}`.slice(-2);
-    };
-    const dateTimeString = `${dateArray[3]}-${sliceDate(dateArray[2])}-${sliceDate(
-      dateArray[1]
-    )}T${timeArg}`;
-    const luxonDate = plugins.luxon.DateTime.fromISO(dateTimeString, {
-      zone: zoneArg
-    });
-    const unixMilli = luxonDate.toMillis();
-    return new ExtendedDate(unixMilli);
-  }
-
-  constructor(unixMilli: number) {
-    super(unixMilli);
-  }
-}

ts/smarttime.classes.extendeddate.ts

@@ -0,0 +1,127 @@
+import * as plugins from './smarttime.plugins';
+
+export type TAvailableZone = 'Europe/Berlin';
+
+export interface IDateUnits {
+  year: number;
+  yearString: string;
+  month: number;
+  monthString: string;
+  monthName: string;
+  day: number;
+  dayString: string;
+  dayOfTheWeek: number;
+  dayOfTheWeekName: string;
+}
+
+export class ExtendedDate extends Date {
+  // STATIC factories
+  public static fromMillis(milliSeconds: number) {
+    return new ExtendedDate(milliSeconds);
+  }
+
+  public static fromDate(dateArg: Date) {
+    return new ExtendedDate(dateArg.getTime());
+  }
+
+  public static fromEuropeanDate(europeanDate: string) {
+    const dateArray = /(.*)\.(.*)\.(.*)/.exec(europeanDate);
+    const luxonDate = plugins.luxon.DateTime.utc(
+      parseFloat(dateArray[3]), // year
+      parseFloat(dateArray[2]), // month
+      parseFloat(dateArray[1]) // day
+    );
+    const unixMilli = luxonDate.toMillis();
+    return new ExtendedDate(unixMilli);
+  }
+
+  /**
+   * creates an Extended date from a hypedDate like "2018-03-28"
+   * @param dateString
+   */
+  public static fromHyphedDate(dateString: string) {
+    // guards
+    // implementation
+    const dateMillis = new Date(dateString).getTime();
+    return new ExtendedDate(dateMillis);
+  }
+
+  /**
+   * Same as .fromEuropeanDate(), but accepts additional timeArg and zoneArg
+   */
+  public static fromEuropeanDateAndTime(
+    europeanDateArg: string,
+    timeArg: string = '12:00:00',
+    zoneArg: TAvailableZone = 'Europe/Berlin'
+  ) {
+    // guards
+
+    // implementation
+    const dateArray = /(.*)\.(.*)\.(.*)/.exec(europeanDateArg);
+    const sliceDate = (dateString: string) => {
+      return `0${dateString}`.slice(-2);
+    };
+    const dateTimeString = `${dateArray[3]}-${sliceDate(dateArray[2])}-${sliceDate(
+      dateArray[1]
+    )}T${timeArg}`;
+    const luxonDate = plugins.luxon.DateTime.fromISO(dateTimeString, {
+      zone: zoneArg
+    });
+    const unixMilli = luxonDate.toMillis();
+    return new ExtendedDate(unixMilli);
+  }
+
+  // INSTANCE
+  public timezone: TAvailableZone;
+
+
+  constructor(unixMilli: number) {
+    super(unixMilli);
+  }
+
+  //
+  public exportToEuropeanDate() {
+    const units = this.exportToUnits();
+    return `${units.dayString}.${units.monthString}.${units.yearString}`;
+  }
+
+  /**
+   * exports units
+   */
+  public exportToUnits(): IDateUnits {
+    const monthsArray = [
+      'January',
+      'February',
+      'March',
+      'April',
+      'May',
+      'June',
+      'July',
+      'August',
+      'September',
+      'October',
+      'November',
+      'December'
+    ];
+    const daysArray = [
+      'Monday',
+      'Tuesday',
+      'Wednesday',
+      'Thursday',
+      'Friday',
+      'Saturday',
+      'Sunday'
+    ];
+    return {
+      year: this.getFullYear(),
+      yearString: `${this.getFullYear()}`,
+      month: this.getMonth() + 1,
+      monthString: ("0" + (this.getMonth() + 1)).slice(-2),
+      monthName: monthsArray[this.getMonth()],
+      day: this.getDate(),
+      dayString: ("0" + this.getDate()).slice(-2),
+      dayOfTheWeek: this.getDay(),
+      dayOfTheWeekName: daysArray[this.getDay()]
+    };
+  }
+}

ts/smarttime.classes.hrtmeasurement.ts

@@ -1,11 +1,9 @@
-import * as process from 'process';
-
 /**
  * easy high resolution time measurement
  */
 export class HrtMeasurement {
-  nanoSeconds: number = null;
-  milliSeconds: number = null;
+  public nanoSeconds: number = null;
+  public milliSeconds: number = null;
   private _hrTimeStart = null;
   private _hrTimeStopDiff = null;
   private _started: boolean = false;
@@ -13,7 +11,7 @@ export class HrtMeasurement {
   /**
    * start the measurement
    */
-  start() {
+  public start() {
     this._started = true;
     this._hrTimeStart = process.hrtime();
   }
@@ -21,7 +19,7 @@ export class HrtMeasurement {
   /**
    * stop the measurement
    */
-  stop() {
+  public stop() {
     if (this._started === false) {
       console.log("Hasn't started yet");
       return;
@@ -35,7 +33,7 @@ export class HrtMeasurement {
   /**
    * reset the measurement
    */
-  reset() {
+  public reset() {
     this.nanoSeconds = null;
     this.milliSeconds = null;
     this._hrTimeStart = null;

ts/smarttime.classes.interval.ts

@@ -0,0 +1,40 @@
+import * as plugins from './smarttime.plugins';
+
+export class Interval {
+  public status: 'started' | 'stopped' | 'initial' = 'initial';
+  private statusAuthorization: any = null;
+  
+  public intervalMilliseconds: number;
+  public intervalJobs: Array<() => any> = [];
+  constructor(intervalMillisencondsArg: number) {
+    this.intervalMilliseconds = intervalMillisencondsArg;
+  }
+
+  public start() {
+    this.status = 'started';
+    const statusAuth = new Date();
+    this.statusAuthorization = statusAuth;
+    const runInterval = async () => {
+      while (this.status === 'started' && this.statusAuthorization === statusAuth) {
+        await plugins.smartdelay.delayFor(this.intervalMilliseconds);
+        this.executeIntervalJobs();
+      }
+    };
+    runInterval();
+  }
+
+  public stop () {
+    this.status = 'stopped';
+    this.statusAuthorization = null;
+  }
+
+  public addIntervalJob(funcArg: () => any) {
+    this.intervalJobs.push(funcArg);
+  }
+
+  private executeIntervalJobs () {
+    for (const funcArg of this.intervalJobs) {
+      funcArg();
+    }
+  }
+}

ts/smarttime.classes.timestamp.ts

@@ -65,6 +65,11 @@ export class TimeStamp {
     }
   }
 
+  /**
+   * returns a boolean for wether a timestamp is younger
+   * @param TimeStampArg
+   * @param tresholdTimeArg
+   */
   public isYoungerThanOtherTimeStamp(TimeStampArg: TimeStamp, tresholdTimeArg: number = 0) {
     if (this.milliSeconds > TimeStampArg.milliSeconds + tresholdTimeArg) {
       return true;

ts/smarttime.plugins.ts

@@ -1,9 +1,11 @@
 // @pushrocks scope
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { smartpromise };
+export { smartdelay, smartpromise };
 
 // third parties
+import cronParser from 'cron-parser';
 import * as luxon from 'luxon';
 
-export { luxon };
+export { cronParser, luxon };