@furkot/export-expense-report 0.0.1

package/Readme.md

@@ -0,0 +1,36 @@
+[![NPM version][npm-image]][npm-url]
+[![Build Status][build-image]][build-url]
+[![Dependency Status][deps-image]][deps-url]
+
+# expense-report
+
+Generate CSV expense report from [Furkot] trip data.
+
+## Install
+
+```sh
+$ npm install --save @furkot/export-expense-report
+```
+
+## Usage
+
+```js
+const expenseReport = require('@furkot/export-expense-report');
+
+expenseReport(trip);
+```
+
+## License
+
+MIT © [Natalia Kowalczyk](https://melitele.me)
+
+[Furkot]: https://trips.furkot.com
+
+[npm-image]: https://img.shields.io/npm/v/@furkot/export-expense-report
+[npm-url]: https://npmjs.org/package/@furkot/export-expense-report
+
+[build-url]: https://github.com/furkot/export-expense-report/actions/workflows/check.yaml
+[build-image]: https://img.shields.io/github/actions/workflow/status/furkot/export-expense-report/check.yaml?branch=main
+
+[deps-image]: https://img.shields.io/librariesio/release/npm/@furkot/export-expense-report
+[deps-url]: https://libraries.io/npm/@furkot%2Fexport-expense-report

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/expense-report');

package/lib/expense-report.js

@@ -0,0 +1,136 @@
+const format = require('./format');
+
+exports = module.exports = expenseReport;
+
+exports.contentType = 'text/csv';
+exports.extension = 'csv';
+exports.encoding = 'utf8';
+
+const types = init(
+  [98, 161],
+  'parking',
+  init(
+    [10, 25, 178, 179],
+    'fuel',
+    init(
+      [9, 24, 27, 28, 30, 31, 32, 90, 139, 143, 156, 158, 159, 172],
+      'meal',
+      Object.create(null)
+    )
+  )
+);
+
+function init(arr, tp, r) {
+  return arr.reduce((r, v) => {
+    r[v] = tp;
+    return r;
+  }, r);
+}
+function prepare(line) {
+  return line.map(function (item) {
+    if (typeof item === 'number') {
+      return '' + item;
+    }
+    if (typeof item === 'string') {
+      // quote strings
+      return '"' + item.replace(/"/g, '""') + '"';
+    }
+    // empty string for everything else
+    return '';
+  }).join(',') + '\n';
+}
+
+function getType({
+  nights,
+  sym
+}) {
+  if (nights) {
+    return 'lodging';
+  }
+  return types[sym] || '';
+}
+
+function* expenseReport(options) {
+  const {
+    metadata: {
+      currency,
+      units,
+      mileageRate
+    },
+    routes
+  } = options;
+
+  const header = [
+    'Description',
+    'Date',
+    'Amount',
+    'Type',
+    'Notes'
+  ];
+
+  const steps = routes[0].points;
+  let from;
+
+  function getLines(i) {
+    const {
+      address,
+      arrival_time,
+      cost,
+      costRoute,
+      distance,
+      name,
+      notes,
+      tags
+    } = steps[i];
+    const to = name || address;
+    const date = format.date(new Date(arrival_time));
+    const lines = [];
+
+    if (mileageRate && distance) {
+      const line = [];
+
+      line.push(format.description(
+        [from, to].join(' - '),
+        format.distance(distance, 1, units, true),
+        currency
+      ));
+      line.push(date);
+      line.push(format.distance(distance * mileageRate / 100, 2, units));
+      line.push('mileage');
+
+      lines.push(prepare(line));
+    }
+    if (costRoute) {
+      const line = [];
+
+      line.push(format.description([from, to].join(' - '), currency));
+      line.push(date);
+      line.push(format.amount(costRoute / 100, 2));
+      line.push('tolls');
+
+      lines.push(prepare(line));
+    }
+    if (cost) {
+      const line = [];
+
+      line.push(format.description(name || address, tags, currency));
+      line.push(date);
+      line.push(format.amount(cost / 100, 2));
+      line.push(getType(steps[i]));
+      line.push(notes);
+
+      lines.push(prepare(line));
+    }
+
+    from = to;
+    return lines;
+  }
+
+  yield prepare(header);
+  for (let i = 0; i < steps.length; i += 1) {
+    const lines = getLines(i);
+    for (let j = 0; j < lines.length; j += 1) {
+      yield lines[j];
+    }
+  }
+}

package/lib/format.js

@@ -0,0 +1,43 @@
+module.exports = {
+  amount,
+  date,
+  description,
+  distance
+};
+
+function pad(n) {
+  return n < 10 ? '0' + n : n;
+}
+
+function amount(amt, precision) {
+  precision = precision || 0;
+  return amt.toFixed(precision);
+}
+
+function date(d) {
+  return [d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate()].map(pad).join('-');
+}
+
+function description() {
+  return Array.prototype.reduce.call(arguments, (r, v) => {
+    if (v) {
+      if (Array.isArray(v)) {
+        r.push(...v);
+      }
+      else {
+        r.push(v);
+      }
+    }
+    return r;
+  }, []).join(' / ');
+}
+
+function distance(dist, precision, units, withUnits) {
+  const div = units === 'km' ? 1000 : 1609.344;
+  precision = precision || 0;
+  const result = (dist / div).toFixed(precision);
+  if (withUnits) {
+    return `${result} ${units}`;
+  }
+  return result;
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@furkot/export-expense-report",
+  "version": "0.0.1",
+  "description": "Generate CSV expense report from Furkot trip data.",
+  "author": {
+    "name": "Natalia Kowalczyk",
+    "email": "melitele@code42day.com",
+    "url": "https://melitele.me"
+  },
+  "repository": "furkot/export-expense-report",
+  "license": "MIT",
+  "keywords": [
+    "expense-report",
+    "furkot",
+    "roadtrip",
+    "export",
+    "planner",
+    "CSV"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@pirxpilot/jshint": "~3",
+    "should": "~13"
+  },
+  "scripts": {
+    "test": "make check"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ]
+}