Merge pull request #9 from stephlm2dev/feature/process-data

Schmidely Stéphane · web-flow · commit dc25b5eed4f1 · 2019-06-18T20:29:53.000+02:00
Extract raw data (without data aggregation)
diff --git a/package.json b/package.json
@@ -15,7 +15,9 @@
     "@types/inquirer": "^6.0.3",
     "@types/shelljs": "^0.8.5",
     "inquirer": "^6.3.1",
+    "json2csv": "^4.5.1",
     "moment": "^2.24.0",
+    "moment-range": "^4.0.2",
     "shelljs": "^0.8.3"
   },
   "devDependencies": {
diff --git a/src/commands/export.ts b/src/commands/export.ts
@@ -2,10 +2,14 @@ import { Command } from '@oclif/command'
 import { EOL } from 'os'
 
 // Our files - FIXME path import
-import { FLAGS, FORMATS, PROJECTS } from '../utils/commands/export/constants'
+import {
+  FLAGS, FORMATS, PROJECTS, TIMETRACKING
+} from '../utils/commands/export/constants'
 import ExportUi from '../utils/commands/export/ui'
 import ExportUtils from '../utils/commands/export/utils'
-import ExportValidator from '../utils/commands/export/validators'
+import ExportValidator, {
+  TimetrackingValidator
+} from '../utils/commands/export/validators'
 
 export default class Export extends Command {
   static description = 'export data for a specific date / project'
@@ -51,10 +55,12 @@ export default class Export extends Command {
     const { interactive, ...params } = flags
     this.checkParams(tools, params, availableFlagsValues)
 
-    // (FIXME) Step 4 - Extract data
-    // (FIXME) Step 5 - Filter data
-    // (FIXME) Step 6 - Aggregate data
-    // (FIXME) Step 7 - Save data
+    // Step 4 - Filter data
+    const data = this.filterData(tools, params, TIMETRACKING)
+
+    // (FIXME) Step 5 - Aggregate data
+    // Step 6 - Save data
+    await tools.utils.saveFile(data, params)
   }
 
   /**
@@ -103,7 +109,9 @@ export default class Export extends Command {
    * Check validity of every params
    */
   private checkParams(tools: any, params: any, availableFlagsValues: any) {
-    const invalidParams = tools.validator.checkParams(params, availableFlagsValues)
+    const invalidParams = tools.validator.checkParams(
+      params, availableFlagsValues
+    )
     if (invalidParams.length !== 0) {
       this.error(
         tools.utils.errorMessage('invalid param', invalidParams),
@@ -112,4 +120,19 @@ export default class Export extends Command {
     }
     return true
   }
+
+  /**
+   * Filter timetracking data from params
+   */
+  private filterData(tools, params: any, timetracking: Array<any>) {
+    return timetracking.reduce((acc: Array<any>, tracking: any) => {
+      let valid: boolean | string = new TimetrackingValidator().isValid(
+        tracking, params
+      )
+      if (valid) {
+        tracking = tools.utils.formatTimetracking(tracking)
+      }
+      return valid ? acc.concat([tracking]) : acc
+    }, [])
+  }
 }
diff --git a/src/utils/commands/export/constants.ts b/src/utils/commands/export/constants.ts
@@ -6,11 +6,13 @@ class Constants {
   private _flags: any
   private _formats: Array<string>
   private _projects: Array<string>
+  private _timetracking: Array<any>
 
   constructor() {
     this._flags = this.setFlags()
     this._formats = this.setFormats()
     this._projects = this.setProjects()
+    this._timetracking = this.setTimetracking()
   }
 
   get flags() {
@@ -25,6 +27,10 @@ class Constants {
     return this._projects
   }
 
+  get timetracking() {
+    return this._timetracking
+  }
+
   private setFlags() {
     return {
       // -h, --help
@@ -86,15 +92,31 @@ class Constants {
      */
     return stdout.trim().split(EOL)
   }
+
+  /**
+   * Export data from Timewarrior
+   */
+  private setTimetracking() {
+    const command = 'timew export'
+    const { stdout, stderr, code } = exec(command, { silent: true })
+    /* FIXME handle error case
+      if (code !== 0) {
+        this.error(stderr.trim(), { exit: code })
+      }
+     */
+    return JSON.parse(stdout)
+  }
 }
 
 const constants = new Constants()
 const FLAGS = constants.flags
 const FORMATS = constants.formats
 const PROJECTS = constants.projects
+const TIMETRACKING = constants.timetracking
 
 export {
   FLAGS,
   FORMATS,
-  PROJECTS
+  PROJECTS,
+  TIMETRACKING
 }
diff --git a/src/utils/commands/export/utils.ts b/src/utils/commands/export/utils.ts
@@ -1,3 +1,6 @@
+import * as fs from 'fs'
+import { parse } from 'json2csv'
+import * as moment from 'moment'
 import { EOL } from 'os'
 
 export default class ExportUtils {
@@ -13,6 +16,56 @@ export default class ExportUtils {
     })
   }
 
+  /**
+   * Format timetracking to standart format
+   */
+  public formatTimetracking(tracking: any) {
+    // {
+    //  "start":"20190612T150556Z",
+    //  "end":"20190612T170000Z",
+    //  "tags":["#sideproject","Task/time warrior export"]
+    // }
+    const startDate = moment(tracking.start)
+    const endDate = moment(tracking.end)
+    const duration = moment.duration(endDate.diff(startDate))
+    const formatDatetime = 'DD/MM/YYYY HH:mm'
+
+    const [project, description, ...tags] = tracking.tags
+    return {
+      start: startDate.format(formatDatetime),
+      end: endDate.format(formatDatetime),
+      duration: moment({
+        hour: duration.hours(),
+        minute: duration.minutes()
+      }).format('HH:mm'),
+      project,
+      description
+    }
+  }
+
+  /**
+   * Save file on disk
+   */
+  public saveFile(data: Array<any>, params: any) {
+    // #neurodecisions$2019-01-12$2019-12-12.csv
+    const fromDate = params.from.replace(/-/g, '')
+    const toDate = params.to.replace(/-/g, '')
+    const project = params.project.replace(/[^a-zA-Z ]/g, '')
+    const filename = `${project}-${fromDate}-${toDate}.${params.format}`
+    let writeData = null
+    if (params.format === 'json') {
+      writeData = this.formatAsJson(data)
+    } else if (params.format === 'csv') {
+      writeData = this.formatAsCsv(data)
+    }
+    try {
+      fs.writeFileSync(filename, writeData)
+      return true
+    } catch (err) {
+      // FIXME handle error (err)
+    }
+  }
+
   /**
    * Format error message
    */
@@ -24,4 +77,23 @@ export default class ExportUtils {
     }).join(EOL)
     return `${title}${EOL}${details}`
   }
+
+  /**
+   * Stringify data
+   */
+  private formatAsJson(data) {
+    return JSON.stringify(data)
+  }
+
+  /**
+   * Convert JSON as CSV
+   */
+  private formatAsCsv(data) {
+    const headers = ['start', 'end', 'duration', 'project', 'description']
+    try {
+      return parse(data, { fields: headers })
+    } catch (err) {
+      // FIXME handle error (err)
+    }
+  }
 }
diff --git a/src/utils/commands/export/validators.ts b/src/utils/commands/export/validators.ts
@@ -2,6 +2,7 @@ import DateValidator from './validators/date-validator'
 import FormatValidator from './validators/format-validator'
 import ProjectValidator from './validators/project-validator'
 import SystemRequirementValidator from './validators/system-requirement-validator'
+import TimetrackingValidator from './validators/timetracking-validator'
 
 export default class ExportValidator {
   private executables = [
@@ -51,5 +52,6 @@ export {
   DateValidator,
   FormatValidator,
   ProjectValidator,
-  SystemRequirementValidator
+  SystemRequirementValidator,
+  TimetrackingValidator
 }
diff --git a/src/utils/commands/export/validators/timetracking-validator.ts b/src/utils/commands/export/validators/timetracking-validator.ts
@@ -0,0 +1,33 @@
+import * as Moment from 'moment'
+import { extendMoment } from 'moment-range'
+
+import { Validator } from './validator'
+
+/**
+ * Validation for timetracking
+ */
+export default class TimetrackingValidator implements Validator {
+  public isValid(tracking: any, filters: any) {
+    // {
+    //  "start":"20190612T150556Z",
+    //  "end":"20190612T170000Z",
+    //  "tags":["#sideproject","Task/time warrior export"]
+    // }
+    let inInterval = false
+    const [project, description, ...tags] = tracking.tags
+    const isSameProject = (project === filters.project)
+
+    if (isSameProject) {
+      const moment = extendMoment(Moment)
+      const trackingRange = moment.range(
+        moment(tracking.start), moment(tracking.end)
+      )
+      const filtersRange = moment.range(
+        moment(filters.from), moment(filters.to)
+      )
+
+      inInterval = trackingRange.overlaps(filtersRange)
+    }
+    return isSameProject && inInterval
+  }
+}
diff --git a/src/utils/commands/export/validators/validator.ts b/src/utils/commands/export/validators/validator.ts
@@ -1,3 +1,5 @@
 export interface Validator {
-  isValid(value: string | any, arrayOfValues: Array<any> | null): boolean | string | Array<string>
+  isValid(
+    value: string | any, arrayOfValues: Array<any> | any | null
+  ): boolean | string | Array<string>
 }
diff --git a/yarn.lock b/yarn.lock
@@ -765,7 +765,7 @@ commander@2.15.1:
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"
   integrity sha512-VlfT9F3V0v+jr4yxPc5gg9s62/fIVWsd2Bk2iD435um1NlGMYdVCq+MjcXnhYq2icNOizHr1kK+5TI6H0Hy0ag==
 
-commander@^2.12.1, commander@~2.20.0:
+commander@^2.12.1, commander@^2.15.1, commander@~2.20.0:
   version "2.20.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.0.tgz#d58bb2b5c1ee8f87b0d340027e9e94e222c5a422"
   integrity sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==
@@ -840,6 +840,13 @@ cross-spawn@^6.0.0, cross-spawn@^6.0.5:
     shebang-command "^1.2.0"
     which "^1.2.9"
 
+d@1:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/d/-/d-1.0.0.tgz#754bb5bfe55451da69a58b94d45f4c5b0462d58f"
+  integrity sha1-dUu1v+VUUdpppYuU1F9MWwRi1Y8=
+  dependencies:
+    es5-ext "^0.10.9"
+
 debug-log@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debug-log/-/debug-log-1.0.1.tgz#2307632d4c04382b8df8a32f70b895046d52745f"
@@ -976,6 +983,32 @@ error-ex@^1.2.0, error-ex@^1.3.1:
   dependencies:
     is-arrayish "^0.2.1"
 
+es5-ext@^0.10.35, es5-ext@^0.10.9, es5-ext@~0.10.14:
+  version "0.10.50"
+  resolved "https://registry.yarnpkg.com/es5-ext/-/es5-ext-0.10.50.tgz#6d0e23a0abdb27018e5ac4fd09b412bc5517a778"
+  integrity sha512-KMzZTPBkeQV/JcSQhI5/z6d9VWJ3EnQ194USTUwIYZ2ZbpN8+SGXQKt1h68EX44+qt+Fzr8DO17vnxrw7c3agw==
+  dependencies:
+    es6-iterator "~2.0.3"
+    es6-symbol "~3.1.1"
+    next-tick "^1.0.0"
+
+es6-iterator@~2.0.3:
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/es6-iterator/-/es6-iterator-2.0.3.tgz#a7de889141a05a94b0854403b2d0a0fbfa98f3b7"
+  integrity sha1-p96IkUGgWpSwhUQDstCg+/qY87c=
+  dependencies:
+    d "1"
+    es5-ext "^0.10.35"
+    es6-symbol "^3.1.1"
+
+es6-symbol@^3.1.0, es6-symbol@^3.1.1, es6-symbol@~3.1.1:
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/es6-symbol/-/es6-symbol-3.1.1.tgz#bf00ef4fdab6ba1b46ecb7b629b4c7ed5715cc77"
+  integrity sha1-vwDvT9q2uhtG7Le2KbTH7VcVzHc=
+  dependencies:
+    d "1"
+    es5-ext "~0.10.14"
+
 escape-string-regexp@1.0.5, escape-string-regexp@^1.0.2, escape-string-regexp@^1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
@@ -1831,13 +1864,27 @@ json-parse-better-errors@^1.0.1:
   resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9"
   integrity sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==
 
+json2csv@^4.5.1:
+  version "4.5.1"
+  resolved "https://registry.yarnpkg.com/json2csv/-/json2csv-4.5.1.tgz#d16d1fa7bea3a8cdddeb500a4eca5d7d2888ecc1"
+  integrity sha512-o90Xa1ziGk3i7AJEO79Jac4+7SEUk58/DxS5mDPW6GF7poX0y7Y0pm1FbWrkz9VzKE4MpUW9aKBOCpJ0U1Ua8A==
+  dependencies:
+    commander "^2.15.1"
+    jsonparse "^1.3.1"
+    lodash.get "^4.4.2"
+
 jsonfile@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
   integrity sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=
   optionalDependencies:
     graceful-fs "^4.1.6"
 
+jsonparse@^1.3.1:
+  version "1.3.1"
+  resolved "https://registry.yarnpkg.com/jsonparse/-/jsonparse-1.3.1.tgz#3f4dae4a91fac315f71062f8521cc239f1366280"
+  integrity sha1-P02uSpH6wxX3EGL4UhzCOfE2YoA=
+
 kind-of@^3.0.2, kind-of@^3.0.3, kind-of@^3.2.0:
   version "3.2.2"
   resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-3.2.2.tgz#31ea21a734bab9bbb0f32466d893aea51e4a3c64"
@@ -1904,6 +1951,11 @@ lodash._reinterpolate@~3.0.0:
   resolved "https://registry.yarnpkg.com/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz#0ccf2d89166af03b3663c796538b75ac6e114d9d"
   integrity sha1-DM8tiRZq8Ds2Y8eWU4t1rG4RTZ0=
 
+lodash.get@^4.4.2:
+  version "4.4.2"
+  resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99"
+  integrity sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=
+
 lodash.template@^4.4.0:
   version "4.4.0"
   resolved "https://registry.yarnpkg.com/lodash.template/-/lodash.template-4.4.0.tgz#e73a0385c8355591746e020b99679c690e68fba0"
@@ -2101,6 +2153,13 @@ mock-stdin@^0.3.1:
   resolved "https://registry.yarnpkg.com/mock-stdin/-/mock-stdin-0.3.1.tgz#c657d9642d90786435c64ca5e99bbd4d09bd7dd3"
   integrity sha1-xlfZZC2QeGQ1xkyl6Zu9TQm9fdM=
 
+moment-range@^4.0.2:
+  version "4.0.2"
+  resolved "https://registry.yarnpkg.com/moment-range/-/moment-range-4.0.2.tgz#f7c3863df2a1ed7fd1822ba5a7bcf53a78701be9"
+  integrity sha512-n8sceWwSTjmz++nFHzeNEUsYtDqjgXgcOBzsHi+BoXQU2FW+eU92LUaK8gqOiSu5PG57Q9sYj1Fz4LRDj4FtKA==
+  dependencies:
+    es6-symbol "^3.1.0"
+
 moment@^2.22.1, moment@^2.24.0:
   version "2.24.0"
   resolved "https://registry.yarnpkg.com/moment/-/moment-2.24.0.tgz#0d055d53f5052aa653c9f6eb68bb5d12bf5c2b5b"
@@ -2148,6 +2207,11 @@ neo-async@^2.6.0:
   resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.1.tgz#ac27ada66167fa8849a6addd837f6b189ad2081c"
   integrity sha512-iyam8fBuCUpWeKPGpaNMetEocMt364qkCsfL9JuhjXX6dRnguRVOfk2GZaDpPjcOKiiXCPINZC1GczQ7iTq3Zw==
 
+next-tick@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/next-tick/-/next-tick-1.0.0.tgz#ca86d1fe8828169b0120208e3dc8424b9db8342c"
+  integrity sha1-yobR/ogoFpsBICCOPchCS524NCw=
+
 nice-try@^1.0.4:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366"

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
`1`	`1`	`export interface Validator {`
`2`		`- isValid(value: string \| any, arrayOfValues: Array<any> \| null): boolean \| string \| Array<string>`
	`2`	`+ isValid(`
	`3`	`+ value: string \| any, arrayOfValues: Array<any> \| any \| null`
	`4`	`+ ): boolean \| string \| Array<string>`
`3`	`5`	`}`