3.0.7

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,21 +37,11 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +53,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -117,8 +109,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
+    - npmci command npm install -g typedoc typescript
-    - npmci command npmpage
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
     - notpriv
@@ -128,3 +122,4 @@ pages:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

npmextra.json

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

package.json

@@ -1,23 +1,30 @@
 {
   "name": "@pushrocks/smarttime",
   "private": false,
-  "version": "2.0.2",
+  "version": "3.0.7",
-  "description": "handle timeformats in smart ways",
+  "description": "handle time in smart ways",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tsrun ./test/test.ts)",
+    "test": "(tstest ./test/)",
-    "build": "(npmts)"
+    "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.1.2",
+    "@gitzone/tsbuild": "^2.1.8",
-    "@types/node": "^10.5.2",
+    "@gitzone/tsrun": "^1.2.5",
-    "tapbundle": "^2.0.2"
+    "@gitzone/tstest": "^1.0.20",
+    "@pushrocks/tapbundle": "^3.0.9",
+    "@types/node": "^11.13.2",
+    "tslint": "^5.15.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartpromise": "^3.0.2",
-    "moment": "^2.21.0"
+    "@types/cron": "^1.7.0",
+    "@types/luxon": "^1.12.0",
+    "cron": "^1.7.0",
+    "luxon": "^1.12.1"
   }
 }

readme.md

@@ -1,33 +1,39 @@
-# smarttime
+# @pushrocks/smarttime
+handle time in smart ways
 
-handle timeformats in smart ways
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarttime)
-## Availabililty
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smarttime)
-
+* [github.com (source mirror)](https://github.com/pushrocks/smarttime)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smarttime)
+* [docs (typedoc)](https://pushrocks.gitlab.io/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/)
 
 ## Status for master
-
+[![build status](https://gitlab.com/pushrocks/smarttime/badges/master/build.svg)](https://gitlab.com/pushrocks/smarttime/commits/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)
-[![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)
-[![npm downloads per month](https://img.shields.io/npm/dm/smarttime.svg)](https://www.npmjs.com/package/smarttime)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarttime/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarttime)
-[![Dependency Status](https://david-dm.org/pushrocks/smarttime.svg)](https://david-dm.org/pushrocks/smarttime)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smarttime/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smarttime/master/dependencies/npm)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smarttime/badges/code.svg)](https://www.bithound.io/github/pushrocks/smarttime)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-[![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/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
 
 Use TypeScript for best in class instellisense.
 
-For further information read the linked docs at the top of this README.
+Smarttime offers smart ways to deal with time.
+
+### class ExtendedDate
+
+This class offers static functions to create zone speicific 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.
 
 > 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.date.ts

@@ -0,0 +1,19 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+
+import * as smarttime from '../ts/index';
+
+tap.test('should create a valid JavaScript Date from European TimeStamp', async () => {
+  const extendedDate = smarttime.ExtendedDate.fromEuropeanDate('1.6.2018');
+  console.log(extendedDate);
+});
+
+tap.test('should create a date and time with European Format', async () => {
+  const extendedDate = smarttime.ExtendedDate.fromEuropeanDateAndTime(
+    '9.8.2018',
+    '08:00:00',
+    'Europe/Berlin'
+  );
+  console.log(extendedDate);
+});
+
+tap.start();

test/test.timer.ts

@@ -1,5 +1,5 @@
 // tslint:disable-next-line:no-implicit-dependencies
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 
 import { Timer } from '../ts/index';
 
@@ -15,4 +15,12 @@ tap.test('should start timer', async () => {
   await testTimer.completed;
 });
 
+tap.test('should reset a timer', async () => {
+  testTimer.reset();
+  testTimer.start();
+  testTimer.reset();
+  testTimer.start();
+  await testTimer.completed;
+});
+
 tap.start();

test/test.ts

@@ -1,5 +1,5 @@
 // tslint:disable-next-line:no-implicit-dependencies
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 import * as smarttime from '../ts/index';
 
 // Test TimeStamp class

ts/index.ts

@@ -1,8 +1,10 @@
 import * as plugins from './smarttime.plugins';
 
+export * from './smarttime.classes.cronmanager';
+export * from './smarttime.classes.date';
 export * from './smarttime.classes.hrtmeasurement';
 export * from './smarttime.classes.timer';
 export * from './smarttime.classes.timestamp';
 export * from './smarttime.units';
 
-export { moment } from './smarttime.plugins';
+export { luxon } from './smarttime.plugins';

ts/smarttime.classes.cronmanager.ts

@@ -0,0 +1,35 @@
+import * as plugins from './smarttime.plugins';
+
+export class CronManager {
+  public status: 'started' | 'stopped' = 'stopped';
+
+  public cronjobs: plugins.cron.CronJob[] = [];
+
+  public addCronjob(cronIdentifierArg: string, cronFunctionArg: plugins.cron.CronCommand) {
+    const newCronJob = new plugins.cron.CronJob(cronIdentifierArg,cronFunctionArg);
+    if (this.status === 'started') {
+      newCronJob.start();
+    }
+    this.cronjobs.push(newCronJob);
+  };
+
+  /**
+   * starts the cronjob
+   */
+  public start() {
+    this.status = 'started';
+    for (const cron of this.cronjobs) {
+      cron.start();
+    }
+  }
+
+  /**
+   * stops all cronjobs
+   */
+  public stop() {
+    this.status = 'stopped';
+    for (const cron of this.cronjobs) {
+      cron.stop();
+    }
+  }
+}

ts/smarttime.classes.date.ts

@@ -1 +1,40 @@
 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.timer.ts

@@ -61,15 +61,26 @@ export class Timer {
   }
 
   public pause() {
+    if (this.startedAt) {
       clearTimeout(this.currentTimeout);
+      this.currentTimeout = null;
       this.pausedAt = TimeStamp.fromTimeStamp(this.startedAt);
     }
+  }
 
   public resume() {
     if (this.startedAt) {
       this.currentTimeout = setTimeout(() => {
         this.completedDeferred.resolve();
       }, this.timeLeft);
+    } else {
+      throw new Error('timer has NOT been started before. Please use .start() instead');
     }
   }
+
+  public reset() {
+    this.pause();
+    this.startedAt = null;
+    this.pausedAt = null;
+  }
 }

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,4 +1,10 @@
-import * as moment from 'moment';
+// @pushrocks scope
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { moment, smartpromise };
+export { smartpromise };
+
+// third parties
+import * as luxon from 'luxon';
+import * as cron from 'cron';
+
+export { luxon, cron };

tslint.json

@@ -1,6 +1,17 @@
 {
-    "extends": [
+  "extends": ["tslint:latest", "tslint-config-prettier"],
-        "tslint:latest",
+  "rules": {
-        "tslint-config-prettier"
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
         ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }