@datarailsshared/dr_renderer 1.4.94 → 1.4.99

package/src/value.formatter.js

@@ -0,0 +1,30 @@
+const lodash = require('lodash');
+
+function getAggregatorPercentageValueIfRequired(value, render_options, data, rowKey, colKey) {
+    const isPercentage = lodash.get(render_options, 'comboOptions.secondaryAxisSettings.is_percentage', false);
+    const deltaColumnName = lodash.get(render_options, 'chartOptions.delta_column.name', '');
+    const currentRowName = rowKey && rowKey.length ? String(rowKey[0]) : '';
+    const isVariance = currentRowName.replace('_', '').toLowerCase() === deltaColumnName.replace('_', '').toLowerCase();
+    const baseRowKey = data && data.rowKeys && data.rowKeys.length ? data.rowKeys[0] : null;
+    const currentColKey = colKey ? colKey : [];
+    const agg = data ? data.getAggregator(baseRowKey, currentColKey) : null;
+    
+    if (isPercentage && isVariance && baseRowKey && agg) {
+        const baseValue = agg.value();
+        return getPercentageValue(value, baseValue) + '%';
+    }
+
+    return null;
+};
+
+function getPercentageValue(value, baseValue) {
+    if (!baseValue)
+        return value < 0 ? -100 : 100;
+
+    return Math.round(value / baseValue * 100);
+};
+
+module.exports = {
+    getAggregatorPercentageValueIfRequired,
+    getPercentageValue
+};

package/tests/highcharts_renderer.test.js

@@ -8,6 +8,7 @@ import addInDynamicRanges from './mock/add-in-dynamic-ranges.json';
 import widgets from './mock/widgets.json';
 import initPivotTable from "../src/pivottable";
 import initDRPivotTable from "../src/dr_pivottable";
+import valueFormatter from "../src/value.formatter";
 import { DrGaugeChart, GAUGE_OPTIONS_DEFAULT } from "../src/charts/dr_gauge_chart";
 
 const mockDrChartRender = jest.fn();
@@ -68,6 +69,8 @@ let _document = document;
 let Highcharts;
 
 describe('highcharts_renderer', () => {
+    let getAggregatorPercentageValueIfRequiredMock;
+
     beforeAll(() => {
         Highcharts = {
             charts: [{
@@ -92,6 +95,12 @@ describe('highcharts_renderer', () => {
 
         highchartsRenderer = getHighchartsRenderer($, _document, Highcharts, lodash.cloneDeep(DEFAULT_USER_COLORS), highchartsRenderer,
             DataFormatter, lodash, moment, true);
+
+        getAggregatorPercentageValueIfRequiredMock = jest.spyOn(valueFormatter, 'getAggregatorPercentageValueIfRequired').mockImplementation(() => null);
+    });
+
+    afterAll(() => {
+        getAggregatorPercentageValueIfRequiredMock.mockRestore();
     });
 
     describe('Function filterFloat', () => {
@@ -444,7 +453,7 @@ describe('highcharts_renderer', () => {
             let funcContext = { value: '12345.678' };
             let persantageValueLabelsFormatterFn = highchartsRenderer.persantageValueLabelsFormatter(null, {})
             let result = persantageValueLabelsFormatterFn.call(funcContext)
-            expect(result).toBe('1,234,567.8%');
+            expect(result).toBe('12,345.678%');
         });
     });
 
@@ -2604,17 +2613,20 @@ describe('highcharts_renderer', () => {
                     it('Should return General format if there are no widget_values_format', () => {
                         aggregatorObject.widget_values_format = null;
                         expect(aggregatorObject.format(123.4567, false)).toBe('123.46');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return widget format if it\'s not calculated value', () => {
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(1123.4567, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return calculated value format if it\'s calculated value', () => {
                         aggregator = highchartsRenderer.rhPivotAggregatorSum(arg, widget_values_format, is_graph, render_options, calculated_info);
                         aggregatorObject = aggregator({}, ['Region average'], '');
                         expect(aggregatorObject.format(1123.45678, false)).toBe('112345.68%');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('if FF enabledNewWidgetValueFormatting is and some of secondaryAxis is true widget values format must be from seriesOptions and widget_value_format to equal first seriesOptions format', () => {
@@ -2631,6 +2643,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, ['Profit'], '');
                         aggregatorObject.push({ DR_Values: 'Profit', Profit: 123 });
                         expect(aggregatorObject.format(1123.45678, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
                 });
             });
@@ -2805,17 +2818,20 @@ describe('highcharts_renderer', () => {
                     it('Should return General format if there are no widget_values_format', () => {
                         aggregatorObject.widget_values_format = null;
                         expect(aggregatorObject.format(123.4567, false)).toBe('123.46');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return widget format if it\'s not calculated value', () => {
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(1123.4567, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return calculated value format if it\'s calculated value', () => {
                         aggregator = highchartsRenderer.rhPivotCount(arg, widget_values_format, is_graph, render_options, calculated_info);
                         aggregatorObject = aggregator({}, ['Region average'], '');
                         expect(aggregatorObject.format(1123.45678, false)).toBe('112345.68%');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('if FF enabledNewWidgetValueFormatting is and some of secondaryAxis is true widget values format must be from seriesOptions and widget_value_format to equal first seriesOptions format', () => {
@@ -2832,6 +2848,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, ['Profit'], '');
                         aggregatorObject.push({ DR_Values: 'Profit', Profit: 123 });
                         expect(aggregatorObject.format(1123.45678, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
                 });
             });
@@ -2964,6 +2981,7 @@ describe('highcharts_renderer', () => {
                     it('Should return widget format if it\'s graph', () => {
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(2, false)).toBe('$2.000');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return widget format if it\'s only_formats', () => {
@@ -2971,6 +2989,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, '', '');
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(2, true)).toBe('$2.000');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return uniq values if it\'s table and not only_formats', () => {
@@ -2978,6 +2997,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, '', '');
                         aggregatorObject.formated_values = ['val1', 'val2'];
                         expect(aggregatorObject.format(aggregatorObject.formated_values, false)).toBe('val1<br>val2');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
                 });
             });
@@ -3156,17 +3176,20 @@ describe('highcharts_renderer', () => {
                     it('Should return General format if there are no widget_values_format', () => {
                         aggregatorObject.widget_values_format = null;
                         expect(aggregatorObject.format(123.4567, false)).toBe('123.46');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return widget format if it\'s not calculated value', () => {
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(1123.4567, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return calculated value format if it\'s calculated value', () => {
                         aggregator = highchartsRenderer.rhPivotAggregatorAverage(arg, widget_values_format, is_graph, render_options, calculated_info);
                         aggregatorObject = aggregator({}, ['Region average'], '');
                         expect(aggregatorObject.format(1123.45678, false)).toBe('112345.68%');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('if FF enabledNewWidgetValueFormatting is and some of secondaryAxis is true widget values format must be from seriesOptions and widget_value_format to equal first seriesOptions format', () => {
@@ -3183,6 +3206,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, ['Profit'], '');
                         aggregatorObject.push({ DR_Values: 'Profit', Profit: 123 });
                         expect(aggregatorObject.format(1123.45678, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
                 });
             });
@@ -3358,17 +3382,20 @@ describe('highcharts_renderer', () => {
                     it('Should return General format if there are no widget_values_format', () => {
                         aggregatorObject.widget_values_format = null;
                         expect(aggregatorObject.format(123.4567, false)).toBe('123.46');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return widget format if it\'s not calculated value', () => {
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(1123.4567, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return calculated value format if it\'s calculated value', () => {
                         aggregator = highchartsRenderer.rhPivotAggregatorMin(arg, widget_values_format, is_graph, render_options, calculated_info);
                         aggregatorObject = aggregator({}, ['Region average'], '');
                         expect(aggregatorObject.format(1123.45678, false)).toBe('112345.68%');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('if FF enabledNewWidgetValueFormatting is and some of secondaryAxis is true widget values format must be from seriesOptions and widget_value_format to equal first seriesOptions format', () => {
@@ -3385,6 +3412,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, ['Profit'], '');
                         aggregatorObject.push({ DR_Values: 'Profit', Profit: 123 });
                         expect(aggregatorObject.format(1123.45678, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
                 });
             });
@@ -3560,17 +3588,20 @@ describe('highcharts_renderer', () => {
                     it('Should return General format if there are no widget_values_format', () => {
                         aggregatorObject.widget_values_format = null;
                         expect(aggregatorObject.format(123.4567, false)).toBe('123.46');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return widget format if it\'s not calculated value', () => {
                         aggregatorObject.widget_values_format = '\"$\"#,###.###';
                         expect(aggregatorObject.format(1123.4567, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('Should return calculated value format if it\'s calculated value', () => {
                         aggregator = highchartsRenderer.rhPivotAggregatorMax(arg, widget_values_format, is_graph, render_options, calculated_info);
                         aggregatorObject = aggregator({}, ['Region average'], '');
                         expect(aggregatorObject.format(1123.45678, false)).toBe('112345.68%');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
 
                     it('if FF enabledNewWidgetValueFormatting is and some of secondaryAxis is true widget values format must be from seriesOptions and widget_value_format to equal first seriesOptions format', () => {
@@ -3587,6 +3618,7 @@ describe('highcharts_renderer', () => {
                         aggregatorObject = aggregator({}, ['Profit'], '');
                         aggregatorObject.push({ DR_Values: 'Profit', Profit: 123 });
                         expect(aggregatorObject.format(1123.45678, false)).toBe('$1,123.457');
+                        expect(getAggregatorPercentageValueIfRequiredMock).toHaveBeenCalled();
                     });
                 });
             });

package/tests/value.formatter.test.js

@@ -0,0 +1,79 @@
+const { getAggregatorPercentageValueIfRequired, getPercentageValue } = require('../src/value.formatter');
+
+describe('Function getAggregatorPercentageValueIfRequired', () => {
+    let render_options, rowKey, colKey;
+
+    beforeEach(() => {
+        render_options = {
+            comboOptions: { secondaryAxisSettings: { is_percentage: true } },
+            chartOptions: { delta_column: { name: 'Variance' } }
+        };
+        rowKey = ['Variance'];
+        colKey = ['SomeCol'];
+    });
+
+    it('should return percentage string when all conditions are met', () => {
+        const data = {
+            rowKeys: ['Variance'],
+            getAggregator: jest.fn(() => ({
+                value: () => 200
+            }))
+        };
+        const result = getAggregatorPercentageValueIfRequired(50, render_options, data, rowKey, colKey);
+        expect(result).toBe('25%');
+    });
+
+    it('should return null if is_percentage is false', () => {
+        const data = {
+            rowKeys: ['Variance'],
+            getAggregator: jest.fn()
+        };
+        render_options.comboOptions.secondaryAxisSettings.is_percentage = false;
+        const result = getAggregatorPercentageValueIfRequired(50, render_options, data, rowKey, colKey);
+        expect(result).toBeNull();
+    });
+
+    it('should return null if isVariance is false', () => {
+        const data = {
+            rowKeys: ['NotVariance'],
+            getAggregator: jest.fn()
+        };
+        rowKey = ['NotVariance'];
+        const result = getAggregatorPercentageValueIfRequired(50, render_options, data, rowKey, colKey);
+        expect(result).toBeNull();
+    });
+
+    it('should return null if baseRowKey is missing', () => {
+        const data = {
+            rowKeys: [],
+            getAggregator: jest.fn()
+        };
+        const result = getAggregatorPercentageValueIfRequired(50, render_options, data, rowKey, colKey);
+        expect(result).toBeNull();
+    });
+
+    it('should return null if agg is missing', () => {
+        const data = {
+            rowKeys: ['Variance'],
+            getAggregator: jest.fn(() => null)
+        };
+        const result = getAggregatorPercentageValueIfRequired(50, render_options, data, rowKey, colKey);
+        expect(result).toBeNull();
+    });
+});
+
+describe('Function getPercentageValue', () => {
+    it('should return -100 when baseValue is falsy and value < 0', () => {
+        expect(getPercentageValue(-50, 0)).toBe(-100);
+    });
+
+    it('should return 100 when baseValue is falsy and value >= 0', () => {
+        expect(getPercentageValue(50, null)).toBe(100);
+    });
+
+    it('should return rounded percentage when baseValue is truthy', () => {
+        expect(getPercentageValue(25, 200)).toBe(13);
+        expect(getPercentageValue(50, 200)).toBe(25);
+        expect(getPercentageValue(200, 200)).toBe(100);
+    });
+});