Merge pull request #67 from qlik-oss/DEB-136/readme

Updated github readme

README.md

@@ -1,52 +1,22 @@
 # P&L Smart Pivot, a Qlik Sense Extension for Financial reporting
-[![CircleCI](https://circleci.com/gh/qlik-oss/PLSmartPivot.svg?style=svg)](https://circleci.com/gh/qlik-oss/PLSmartPivot)
+This extension is part of the extension bundles for Qlik Sense. The repository is maintained and moderated by Qlik RD.
 
-This extension is useful to create reports where the look&feel is rellevantand and pivot a second dimension is needed. Based on P&L Smart.
-
-It's specifically focused on financial reports, trying to solve some common needs of this area:
-- smart export to excel
-- easy creation of reports
-- custom corporate reporting (bold, italic, background color, letter size, headers,...)
-- selections inside the reports
-- custom external templates
-- analytical reports
-
-
-# Manual
-You'll find a manual [Qlik Sense P&LSmart Pivot Extension Manual.pdf](resources/Qlik Sense P&LSmart Pivot Extension Manual.pdf) and one app example [P&LSmartPivot_demo.qvf](resources/P&LSmartPivot_demo.qvf).
-
-
-# Installation
-
-1. Download the extension zip, `qlik-smart-pivot_<version>.zip`, from the latest release(https://github.com/qlik-oss/PLSmartPivot/releases/latest)
-2. Install the extension:
-
-   a. **Qlik Sense Desktop**: unzip to a directory under [My Documents]/Qlik/Sense/Extensions.
-
-   b. **Qlik Sense Server**: import the zip file in the QMC.
+Feel free to fork and suggest pull requests for improvements and bug fixes. Changes will be moderated and reviewed before inclusion in future bundle versions. Please note that emphasis is on backward compatibility, i.e. breaking changes will most likely not be approved.
 
+Usage documentation for the extension is available at https://help.qlik.com.
 
 # Developing the extension
-
 If you want to do code changes to the extension follow these simple steps to get going.
 
 1. Get Qlik Sense Desktop
-1. Create a new app and add the extension to a sheet.
+1. Create a new app and add P&L pivot to a sheet.
 2. Clone the repository
 3. Run `npm install`
-4. Set the environment variable `BUILD_PATH` to your extensions directory. It will be something like `C:/Users/<user>/Documents/Qlik/Sense/Extensions/<extension_name>`.
-5. You now have two options. Either run the watch task or the build task. They are explained below. Both of them default to development mode but can be run in production by setting `NODE_ENV=production` before running the npm task.
-
-   a. **Watch**: `npm run watch`. This will start a watcher which will rebuild the extension and output all needed files to the `buildFolder` for each code change you make. See your changes directly in your Qlik Sense app.
-
-   b. **Build**: `npm run build`. If you want to build the extension package. The output zip-file can be found in the `buildFolder`.
-
+4. Run `npm run build` - to build a dev-version to the /dist folder.
+5. Move the content of the /dist folder to the extension directory. Usually in `C:/Users/<user>/Documents/Qlik/Sense/Extensions/qlik-smart-pivot`.
 
 # Original authors
-
 [github.com/iviasensio](https://github.com/iviasensio)
 
-
 # License
-
-Released under the [MIT License](LICENSE).
+Released under the [MIT License](LICENSE).

src/data-table/data-cell.jsx

@@ -1,5 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import { ApplyPreMask } from '../masking';
+import { addSeparators } from '../utilities';
 import Tooltip from '../tooltip/index.jsx';
 
 class DataCell extends React.PureComponent {
@@ -43,9 +45,11 @@ class DataCell extends React.PureComponent {
     const isEmptyCell = measurement.displayValue === '';
     const isColumnPercentageBased = (/%/).test(measurement.format);
     let formattedMeasurementValue;
-    if (isEmptyCell || styleBuilder.hasComments()) {
+    if (isEmptyCell) {
       formattedMeasurementValue = '';
       cellStyle.cursor = 'default';
+    } else if (styleBuilder.hasComments()) {
+      formattedMeasurementValue = '.';
     } else {
       formattedMeasurementValue = formatMeasurementValue(measurement, styling);
     }
@@ -125,11 +129,51 @@ DataCell.propTypes = {
 export default DataCell;
 
 function formatMeasurementValue (measurement, styling) {
-  if (isNaN(measurement.value)) {
-    return styling.symbolForNulls;
+  const isColumnPercentageBased = (/%/).test(measurement.format);
+  let formattedMeasurementValue = '';
+  if (isColumnPercentageBased) {
+    if (isNaN(measurement.value)) {
+      formattedMeasurementValue = styling.symbolForNulls;
+    } else {
+      formattedMeasurementValue = ApplyPreMask('0,00%', measurement.value);
+    }
   } else {
-    return measurement.displayValue;
+    let magnitudeDivider;
+    switch (measurement.magnitude.toLowerCase()) {
+      case 'k':
+        magnitudeDivider = 1000;
+        break;
+      case 'm':
+        magnitudeDivider = 1000000;
+        break;
+      default:
+        magnitudeDivider = 1;
+    }
+    const formattingStringWithoutMagnitude = measurement.format.replace(/k|K|m|M/gi, '');
+    if (isNaN(measurement.value)) {
+      formattedMeasurementValue = styling.symbolForNulls;
+    } else {
+      let preFormatValue = measurement.value;
+      if (isColumnPercentageBased) {
+        preFormatValue *= 100;
+      }
+      switch (formattingStringWithoutMagnitude) {
+        case '#.##0':
+          formattedMeasurementValue = addSeparators((preFormatValue / magnitudeDivider), '.', ',', 0);
+          break;
+        case '#,##0':
+          formattedMeasurementValue = addSeparators((preFormatValue / magnitudeDivider), ',', '.', 0);
+          break;
+        default:
+          formattedMeasurementValue = ApplyPreMask(
+            formattingStringWithoutMagnitude,
+            (preFormatValue / magnitudeDivider)
+          );
+          break;
+      }
+    }
   }
+  return formattedMeasurementValue;
 }
 
 function getConditionalColor (measurement, conditionalColoring) {

src/masking.js

@@ -0,0 +1,132 @@
+import { addSeparators } from './utilities';
+
+export function ApplyPreMask (mask, value) { // aqui
+  if (mask.indexOf(';') >= 0) {
+    if (value >= 0) {
+      switch (mask.substring(0, mask.indexOf(';'))) {
+        case '#.##0':
+          return (addSeparators(value, '.', ',', 0));
+        case '#,##0':
+          return (addSeparators(value, ',', '.', 0));
+        case '+#.##0':
+          return (addSeparators(value, '.', ',', 0));
+        case '+#,##0':
+          return (addSeparators(value, ',', '.', 0));
+        default:
+          return (applyMask(mask.substring(0, mask.indexOf(';')), value));
+      }
+    } else {
+      const vMyValue = value * -1;
+      let vMyMask = mask.substring(mask.indexOf(';') + 1, mask.length);
+      vMyMask = vMyMask.replace('(', '');
+      vMyMask = vMyMask.replace(')', '');
+      switch (vMyMask) {
+        case '#.##0':
+          return (`(${addSeparators(vMyValue, '.', ',', 0)})`);
+        case '#,##0':
+          return (`(${addSeparators(vMyValue, ',', '.', 0)})`);
+        case '-#.##0':
+          return (`(${addSeparators(vMyValue, '.', ',', 0)})`);
+        case '-#,##0':
+          return (`(${addSeparators(vMyValue, ',', '.', 0)})`);
+        default:
+          return (`(${applyMask(vMyMask, vMyValue)})`);
+      }
+    }
+  } else {
+    return (applyMask(mask, value));
+  }
+}
+
+function applyMask (originalMask, originalValue) {
+  if (!originalMask || isNaN(Number(originalValue))) {
+    return originalValue;
+  }
+
+  let isNegative;
+  let result;
+  let integer;
+  // find prefix/suffix
+  let len = originalMask.length;
+  const start = originalMask.search(/[0-9\-\+#]/);
+  const prefix = start > 0 ? originalMask.substring(0, start) : '';
+  // reverse string: not an ideal method if there are surrogate pairs
+  let str = originalMask.split('')
+    .reverse()
+    .join('');
+  const end = str.search(/[0-9\-\+#]/);
+  let offset = len - end;
+  const substr = originalMask.substring(offset, offset + 1);
+  let index = offset + ((substr === '.' || (substr === ',')) ? 1 : 0);
+  const suffix = end > 0 ? originalMask.substring(index, len) : '';
+
+  // mask with prefix & suffix removed
+  let mask = originalMask.substring(start, index);
+
+  // convert any string to number according to formation sign.
+  let value = mask.charAt(0) === '-' ? -originalValue : Number(originalValue);
+  isNegative = value < 0 ? value = -value : 0; // process only abs(), and turn on flag.
+
+  // search for separator for grp & decimal, anything not digit, not +/- sign, not #.
+  result = mask.match(/[^\d\-\+#]/g);
+  const decimal = (result && result[result.length - 1]) || '.'; // treat the right most symbol as decimal
+  const group = (result && result[1] && result[0]) || ','; // treat the left most symbol as group separator
+
+  // split the decimal for the format string if any.
+  mask = mask.split(decimal);
+  // Fix the decimal first, toFixed will auto fill trailing zero.
+  value = value.toFixed(mask[1] && mask[1].length);
+  value = String(Number(value)); // convert number to string to trim off *all* trailing decimal zero(es)
+
+  // fill back any trailing zero according to format
+  const posTrailZero = mask[1] && mask[1].lastIndexOf('0'); // look for last zero in format
+  const part = value.split('.');
+  // integer will get !part[1]
+  if (!part[1] || (part[1] && part[1].length <= posTrailZero)) {
+    value = (Number(value)).toFixed(posTrailZero + 1);
+  }
+  const szSep = mask[0].split(group); // look for separator
+  mask[0] = szSep.join(''); // join back without separator for counting the pos of any leading 0.
+
+  const posLeadZero = mask[0] && mask[0].indexOf('0');
+  if (posLeadZero > -1) {
+    while (part[0].length < (mask[0].length - posLeadZero)) {
+      part[0] = `0${part[0]}`;
+    }
+  } else if (Number(part[0]) === 0) {
+    part[0] = '';
+  }
+
+  value = value.split('.');
+  value[0] = part[0];
+
+  // process the first group separator from decimal (.) only, the rest ignore.
+  // get the length of the last slice of split result.
+  const posSeparator = (szSep[1] && szSep[szSep.length - 1].length);
+  if (posSeparator) {
+    integer = value[0];
+    str = '';
+    offset = integer.length % posSeparator;
+    len = integer.length;
+    for (index = 0; index < len; index++) {
+      str += integer.charAt(index); // ie6 only support charAt for sz.
+      // -posSeparator so that won't trail separator on full length
+      // jshint -W018
+      if (!((index - offset + 1) % posSeparator) && index < len - posSeparator) {
+        str += group;
+      }
+    }
+    value[0] = str;
+  }
+  value[1] = (mask[1] && value[1]) ? decimal + value[1] : '';
+
+  // remove negative sign if result is zero
+  result = value.join('');
+  if (result === '0' || result === '') {
+    // remove negative sign if result is zero
+    isNegative = false;
+  }
+
+  // put back any negation, combine integer and fraction, and add back prefix & suffix
+  return prefix + ((isNegative ? '-' : '') + result) + suffix;
+}

src/utilities.js

@@ -9,6 +9,21 @@ export function distinctArray (array) {
     .map(entry => JSON.parse(entry));
 }
 
+export function addSeparators (number, thousandSeparator, decimalSeparator, numberOfDecimals) {
+  const numberString = number.toFixed(numberOfDecimals);
+  const numberStringParts = numberString.split('.');
+  let [
+    wholeNumber,
+    decimal
+  ] = numberStringParts;
+  decimal = numberStringParts.length > 1 ? decimalSeparator + decimal : '';
+  const regexCheckForThousand = /(\d+)(\d{3})/;
+  while (regexCheckForThousand.test(wholeNumber)) {
+    wholeNumber = wholeNumber.replace(regexCheckForThousand, `$1${thousandSeparator}$2`);
+  }
+  return wholeNumber + decimal;
+}
+
 export function Deferred () {
   this.promise = new Promise((resolve, reject) => {
     this.resolve = resolve;