Merge pull request #35 from codingtools/feature/date-utility

Feature/date utility basic functionality

Author: pateash

README.md

@@ -49,6 +49,7 @@ USAGE
 * [`cdt autocomplete [SHELL]`](#cdt-autocomplete-shell)
 * [`cdt bundlephobia [PACKAGE]`](#cdt-bundlephobia-package)
 * [`cdt crypto [STRING]`](#cdt-crypto-string)
+* [`cdt datetime [DATE]`](#cdt-datetime-date)
 * [`cdt hash [STRING]`](#cdt-hash-string)
 * [`cdt help [COMMAND]`](#cdt-help-command)
 * [`cdt minify [FILE]`](#cdt-minify-file)
@@ -112,6 +113,24 @@ OPTIONS
 
 _See code: [src/commands/crypto.ts](https://github.com/codingtools/cdt/blob/v0.1.4/src/commands/crypto.ts)_
 
+## `cdt datetime [DATE]`
+
+Date and Time utility
+
+```
+USAGE
+  $ cdt datetime [DATE]
+
+OPTIONS
+  -d, --date=date          Datetime input string, could also be passed through argument
+  -f, --format=format      Datetime format
+  -h, --help               show CLI help
+  -l, --locale=locale      Locale, default: en
+  -z, --timezone=timezone  Timezone for Datetime
+```
+
+_See code: [src/commands/datetime.ts](https://github.com/codingtools/cdt/blob/v0.1.4/src/commands/datetime.ts)_
+
 ## `cdt hash [STRING]`
 
 Hashing functionality for a string/file

package-lock.json

@@ -16,13 +16,13 @@
     "@oclif/plugin-help": "^2.2.1",
     "@oclif/plugin-not-found": "^1.2.3",
     "@oclif/plugin-warn-if-update-available": "^1.7.0",
-    "@types/crypto-js": "^3.1.43",
-    "@types/signale": "^1.2.1",
     "axios": "^0.19.0",
     "chalk": "^2.4.2",
     "crypto-js": "^3.1.9-1",
     "jshashes": "^1.0.7",
     "minify": "^4.1.3",
+    "moment": "^2.24.0",
+    "moment-timezone": "^0.5.27",
     "nyc": "^14.1.1",
     "ora": "^4.0.2",
     "signale": "^1.4.0",
@@ -34,7 +34,10 @@
     "@oclif/tslint": "^3.1.1",
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
+    "@types/moment-timezone": "^0.5.12",
     "@types/node": "^12.11.2",
+    "@types/crypto-js": "^3.1.43",
+    "@types/signale": "^1.2.1",
     "chai": "^4.2.0",
     "globby": "^10.0.1",
     "mocha": "^6.2.2",
@@ -61,6 +64,9 @@
   "oclif": {
     "commands": "./lib/commands",
     "bin": "cdt",
+    "macos": {
+      "identifier": "@codingtools/cdt"
+    },
     "plugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-not-found",

package.json

@@ -0,0 +1,99 @@
+import {Command, flags} from '@oclif/command'
+import chalk from 'chalk'
+import * as moment from 'moment-timezone' //has both momentjs and timezone support
+
+// @ts-ignore
+moment.suppressDeprecationWarnings = true
+
+import Logger from '../utilities/logger'
+
+// TODO: add timezone support for input and output
+export default class Datetime extends Command {
+  static description = 'Date and Time utility'
+
+  static defaultFormat = 'Do MMMM YYYY, h:m:s A, Z UTC'
+
+  static flags = {
+    help: flags.help({char: 'h'}),
+    date: flags.string({char: 'd', description: 'Datetime input string, default: Current Datetime, could also be passed through argument'}),
+    format: flags.string({char: 'f', description: `Datetime format, default: ${Datetime.defaultFormat}`}),
+    timezone: flags.string({char: 'z', description: 'Timezone for Datetime parsing, default: Your timezone'}),
+    locale: flags.string({char: 'l', description: 'Locale, default: en'}),
+  }
+
+  static args = [{name: 'date'}]
+
+  //arguments 'date' ( default now() ), 'format' ( default 'dd-MMM-YYYY' ), 'timezone' (default user local)
+  async run() {
+    const {args, flags} = this.parse(Datetime)
+
+    args.date = this.getDateString(flags, args) // getting date object
+    args.locale = this.getLocale(flags, args) // getting date object
+    args.format = this.getFormat(flags, args) // getting date object
+    args.timezone = this.getTimezone(flags, args) // getting date object
+
+    Logger.info(this, `Input String: ${ args.date ? args.date : chalk.magenta('Not Provided, using Current timestamp') }`)
+    Logger.info(this, `Locale: ${chalk.magenta(args.locale)}`)
+    Logger.info(this, `Format: ${chalk.magenta(args.format)}`)
+    Logger.info(this, `Timezone: ${chalk.magenta(args.timezone)}`) // true - do not used cached timezone, find every time
+
+    args.momentDate = this.getMomentDate(flags, args)
+    this.checkParameters(flags, args)
+
+    Logger.success(this, `${args.momentDate.tz(args.timezone).format(args.format)}`)
+
+  }
+
+  // tslint:disable-next-line:no-unused
+  private getTimezone(flags: any, args: any) {
+    if (flags.timezone)
+      return flags.timezone
+    else
+      return moment.tz.guess(true)
+  }
+
+  // tslint:disable-next-line:no-unused
+  private getLocale(flags: any, args: any) {
+    if (flags.locale)
+      return flags.locale
+    else
+      return 'en'
+  }
+
+  private getDateString(flags: any, args: any) {
+    let dateString: string | undefined
+
+    if (args.date)
+      dateString = args.date
+    else if (flags.date)
+      dateString = flags.date
+    else
+      dateString = undefined // will be set to  now()
+
+    return dateString
+  }
+
+  private getMomentDate(flags: any, args: any) {
+    let date: moment.Moment
+
+    if (args.date)
+      date = moment.tz(args.date, args.timezone)
+    else
+      date = moment.tz([], args.timezone) // return now() if args.date is undefined
+
+    // set locale
+    date.locale(flags.locale)
+    return date
+  }
+
+  // tslint:disable-next-line:no-unused
+  private checkParameters(flags: any, args: any) {
+    if (!args.momentDate.isValid())
+      Logger.error(this, 'Invalid Date String Passed')
+  }
+
+  // tslint:disable-next-line:no-unused
+  private getFormat(flags: any, args: any) {
+    return flags.format ? flags.format : Datetime.defaultFormat
+  }
+}

src/commands/datetime.ts

@@ -0,0 +1,59 @@
+import {expect, test} from '@oclif/test'
+import * as moment from 'moment-timezone' //has both momentjs and timezone support
+
+describe('datetime', () => {
+  test
+    .stdout()
+    .command(['datetime', '2019-07-01 00:00:00'])
+    .it('If locale is not given, default - en', ctx => {
+      expect(ctx.stdout).to.contain(`1st July 2019, 12:0:0 AM, ${moment('01-Jul-2019').format('Z')} UTC`)
+    })
+
+  test
+    .stdout()
+    .command(['datetime', '2019-07-01 00:00:00', '-l', 'fr'])
+    .it('If locale is given for french', ctx => {
+      expect(ctx.stdout).to.contain(`1er juillet 2019, 12:0:0 AM, ${moment('01-Jul-2019').format('Z')} UTC`)
+    })
+
+
+  // test for hindi commented because of Timezone runtime
+  // test
+  //   .stdout()
+  //   .command(['datetime', '2019-07-01 00:00:00', '-l', 'hi'])
+  //   .it('If locale is given for hindi', ctx => {
+  //     expect(ctx.stdout).to.contain('१ जुलाई २०१९, १२:०:० रात, +०५:३० UTC')
+  //   })
+
+  test
+    .stdout()
+    .command(['datetime', 'not a real date'])
+    .exit(0)
+    .it('Invalid Datetime or Datetime format with args', ctx => {
+      expect(ctx.stdout).to.contain('Invalid Date String Passed')
+    })
+
+  test
+    .stdout()
+    .command(['datetime', '-d', 'not a real date'])
+    .exit(0)
+    .it('Invalid Datetime or Datetime format with flags', ctx => {
+      expect(ctx.stdout).to.contain('Invalid Date String Passed')
+    })
+
+  test
+    .stdout()
+    .command(['datetime', '20190501', '-f', 'DD-MM-YYYY'])
+    .it('Format Date with a valid Format', ctx => {
+      expect(ctx.stdout).to.contain('01-05-2019')
+    })
+
+  test
+    .stdout()
+    .command(['datetime', '201901d'])
+    .exit(0)
+    .it('Invalid Date passed', ctx => {
+      expect(ctx.stdout).to.contain('Invalid Date String Passed')
+    })
+
+})