@datarailsshared/dr_renderer 1.5.159 → 1.5.168

package/tests/suboptions.test.js

@@ -1,322 +0,0 @@
-/**
- * @fileoverview Snapshot tests for highchartsRenderer.suboptions
- * 
- * These tests ensure that the suboptions structure remains consistent
- * during the migration to the new builder pattern.
- */
-
-import * as JQuery from "jquery";
-import * as lodash from 'lodash';
-import moment from 'moment/min/moment.min';
-
-const getHighchartsRenderer = require('../src/highcharts_renderer');
-const DataFormatter = require('../src/dataformatter');
-
-const DEFAULT_USER_COLORS = {
-    colors: ['#008aff', '#91e7e7', '#f37789', '#ffdc65', '#0e569d', '#bbe0ff', '#57b2ff', '#5ecfb9', '#c7ffda', '#179ab9'],
-    variance_color: null
-};
-
-const $ = JQuery.default;
-let highchartsRenderer = {};
-let Highcharts;
-
-// Helper to strip function properties for snapshot comparison
-const stripFunctions = (obj) => {
-    return JSON.parse(JSON.stringify(obj, (key, value) => {
-        if (typeof value === 'function') {
-            return '[Function]';
-        }
-        return value;
-    }));
-};
-
-describe('highchartsRenderer.suboptions', () => {
-    beforeAll(() => {
-        Highcharts = {
-            charts: [],
-            opt: {},
-            setOptions: function(value) { Highcharts.opt = value; },
-            numberFormat: function(value) { return value; },
-            getOptions: function() { return Highcharts.opt; },
-            Tooltip: {},
-            wrap: () => {},
-            chart: () => {},
-        };
-
-        highchartsRenderer = getHighchartsRenderer(
-            $, 
-            document, 
-            Highcharts, 
-            lodash.cloneDeep(DEFAULT_USER_COLORS), 
-            highchartsRenderer,
-            DataFormatter, 
-            lodash, 
-            moment, 
-            true
-        );
-    });
-
-    describe('structure snapshots', () => {
-        // Dynamically generate tests for each suboption key
-        const expectedKeys = [
-            'widget_library',
-            'table_options',
-            'table_design_options',
-            'table_options_transpose',
-            'table_options_gauge',
-            'value',
-            'range',
-            'name',
-            'subtitle',
-            'chart',
-            'chart_grid',
-            'chart_forecast',
-            'total_value_label_donut',
-            'chart_position',
-            'label',
-            'label_pie',
-            'label_gauge',
-            'label_with_percentage',
-            'label_with_percentage_percent_stacked',
-            'axisY',
-            'axisY_percent_stacked',
-            'axisX',
-            'ticks',
-            'tooltips',
-            'tooltips_pie',
-            'tooltips_gauge',
-            'negative_number_format',
-            'delta_column',
-            'delta_column_for_drill_down',
-            'advanced',
-            'legends',
-            'gauge_goal',
-            'gauge_segments',
-            'gauge_is_absolute',
-        ];
-
-        test('all expected suboption keys exist', () => {
-            const actualKeys = Object.keys(highchartsRenderer.suboptions);
-            expectedKeys.forEach(key => {
-                expect(actualKeys).toContain(key);
-            });
-        });
-
-        expectedKeys.forEach(key => {
-            test(`${key} structure matches snapshot`, () => {
-                const suboption = highchartsRenderer.suboptions[key];
-                expect(suboption).toBeDefined();
-                expect(stripFunctions(suboption)).toMatchSnapshot();
-            });
-        });
-    });
-
-    describe('suboption structure validation', () => {
-        test('all suboptions have required properties', () => {
-            Object.entries(highchartsRenderer.suboptions).forEach(([key, suboption]) => {
-                // category_class is required
-                expect(suboption.category_class).toBeDefined();
-                
-                // category_type is required
-                expect(suboption.category_type).toBeDefined();
-                
-                // category_label is required
-                expect(suboption.category_label).toBeDefined();
-                
-                // Should have either elements array or default_value
-                const hasElements = Array.isArray(suboption.elements);
-                const hasDefaultValue = suboption.default_value !== undefined;
-                expect(hasElements || hasDefaultValue).toBe(true);
-            });
-        });
-
-        test('all elements have required properties', () => {
-            Object.entries(highchartsRenderer.suboptions).forEach(([key, suboption]) => {
-                if (!Array.isArray(suboption.elements)) return;
-
-                suboption.elements.forEach((element, index) => {
-                    // element_type is always required
-                    expect(element.element_type).toBeDefined();
-                    
-                    // For non-divider elements, value_name should be defined
-                    if (element.element_type !== 'devider' && element.element_type !== 'text') {
-                        expect(element.value_name).toBeDefined();
-                    }
-                });
-            });
-        });
-
-        test('element types are valid', () => {
-            const validTypes = [
-                'toggle', 'checkbox', 'input', 'select', 'radio', 
-                'color_picker', 'devider', 'textarea', 'tag', 'text'
-            ];
-
-            Object.entries(highchartsRenderer.suboptions).forEach(([key, suboption]) => {
-                if (!Array.isArray(suboption.elements)) return;
-
-                suboption.elements.forEach((element) => {
-                    expect(validTypes).toContain(element.element_type);
-                });
-            });
-        });
-    });
-
-    describe('getDefaultValueForChart', () => {
-        const chartTypesToTest = [
-            'line-chart',
-            'line-chart-smooth',
-            'line-chart-forecast',
-            'column-chart',
-            'column-chart-stacked',
-            'column-chart-stacked-percent',
-            'bar-chart',
-            'bar-chart-stacked',
-            'bar-chart-stacked-percent',
-            'scatter-chart',
-            'area-chart',
-            'area-chart-smooth',
-            'polygon-chart',
-            'pie-chart',
-            'pie-chart-drilldown',
-            'donut-chart',
-            'gauge-chart-enhanced',
-            'kpi-widget',
-            'text-widget',
-            'table_only',
-            'waterfall-chart-breakdown',
-            'waterfall-chart-walkthrough',
-        ];
-
-        chartTypesToTest.forEach(chartType => {
-            test(`${chartType} defaults match snapshot`, () => {
-                const defaults = highchartsRenderer.getDefaultValueForChart(chartType);
-                expect(stripFunctions(defaults)).toMatchSnapshot();
-            });
-        });
-    });
-
-    describe('getDefaultValueForSubOptions', () => {
-        test('extracts default values correctly for label suboption', () => {
-            const labelSuboption = highchartsRenderer.suboptions['label'];
-            const defaults = highchartsRenderer.getDefaultValueForSubOptions(labelSuboption, {}, 'column-chart');
-            
-            expect(defaults).toBeDefined();
-            expect(defaults.show).toBe(true);
-            expect(defaults.overlap).toBe(false);
-            expect(defaults.show_value).toBe(true);
-        });
-
-        test('extracts default values correctly for tooltips suboption', () => {
-            const tooltipsSuboption = highchartsRenderer.suboptions['tooltips'];
-            const defaults = highchartsRenderer.getDefaultValueForSubOptions(tooltipsSuboption, {}, 'column-chart');
-            
-            expect(defaults).toBeDefined();
-            expect(defaults.show).toBe(true);
-            expect(defaults.show_value).toBe(true);
-            expect(defaults.show_x_axis).toBe(true);
-        });
-
-        test('respects existing options when extracting defaults', () => {
-            const labelSuboption = highchartsRenderer.suboptions['label'];
-            const existingOptions = {
-                label: {
-                    show: false,
-                    font_size: '14'
-                }
-            };
-            const defaults = highchartsRenderer.getDefaultValueForSubOptions(labelSuboption, existingOptions, 'column-chart');
-            
-            expect(defaults.show).toBe(false);
-            expect(defaults.font_size).toBe('14');
-        });
-    });
-
-    describe('label suboptions consistency', () => {
-        test('label families share common structure', () => {
-            const labelKeys = ['label', 'label_pie', 'label_gauge', 'label_with_percentage'];
-            
-            labelKeys.forEach(key => {
-                const suboption = highchartsRenderer.suboptions[key];
-                expect(suboption).toBeDefined();
-                expect(suboption.category_label).toBe('Label');
-                expect(Array.isArray(suboption.elements)).toBe(true);
-                
-                // All should have show toggle
-                const showElement = suboption.elements.find(e => e.value_name === 'show');
-                expect(showElement).toBeDefined();
-                expect(showElement.element_type).toBe('toggle');
-            });
-        });
-
-        test('label families have font styling elements', () => {
-            const labelKeys = ['label', 'label_pie', 'label_gauge', 'label_with_percentage'];
-            
-            labelKeys.forEach(key => {
-                const suboption = highchartsRenderer.suboptions[key];
-                
-                const fontStyleElement = suboption.elements.find(e => e.value_name === 'font_style');
-                const fontSizeElement = suboption.elements.find(e => e.value_name === 'font_size');
-                const fontColorElement = suboption.elements.find(e => e.value_name === 'font_color');
-                
-                expect(fontStyleElement).toBeDefined();
-                expect(fontSizeElement).toBeDefined();
-                expect(fontColorElement).toBeDefined();
-            });
-        });
-    });
-
-    describe('tooltip suboptions consistency', () => {
-        test('tooltip families share common structure', () => {
-            const tooltipKeys = ['tooltips', 'tooltips_pie', 'tooltips_gauge'];
-            
-            tooltipKeys.forEach(key => {
-                const suboption = highchartsRenderer.suboptions[key];
-                expect(suboption).toBeDefined();
-                expect(suboption.category_label).toBe('Tooltip');
-                expect(suboption.category_type).toBe('tooltips');
-                expect(Array.isArray(suboption.elements)).toBe(true);
-                
-                // All should have show toggle
-                const showElement = suboption.elements.find(e => e.value_name === 'show');
-                expect(showElement).toBeDefined();
-                expect(showElement.element_type).toBe('toggle');
-            });
-        });
-    });
-
-    describe('axis suboptions consistency', () => {
-        test('axisY and axisY_percent_stacked share base structure', () => {
-            const axisY = highchartsRenderer.suboptions['axisY'];
-            const axisYPercent = highchartsRenderer.suboptions['axisY_percent_stacked'];
-            
-            expect(axisY.category_type).toBe('axisY');
-            expect(axisYPercent.category_type).toBe('axisY');
-            expect(axisY.category_label).toBe('Y Axis');
-            expect(axisYPercent.category_label).toBe('Y Axis');
-            
-            // Both should have autoylabel and name
-            const axisYAutoLabel = axisY.elements.find(e => e.value_name === 'autoylabel');
-            const axisYPercentAutoLabel = axisYPercent.elements.find(e => e.value_name === 'autoylabel');
-            
-            expect(axisYAutoLabel).toBeDefined();
-            expect(axisYPercentAutoLabel).toBeDefined();
-        });
-
-        test('axisY has min/max but axisY_percent_stacked does not', () => {
-            const axisY = highchartsRenderer.suboptions['axisY'];
-            const axisYPercent = highchartsRenderer.suboptions['axisY_percent_stacked'];
-            
-            const axisYMin = axisY.elements.find(e => e.value_name === 'min');
-            const axisYMax = axisY.elements.find(e => e.value_name === 'max');
-            const axisYPercentMin = axisYPercent.elements.find(e => e.value_name === 'min');
-            const axisYPercentMax = axisYPercent.elements.find(e => e.value_name === 'max');
-            
-            expect(axisYMin).toBeDefined();
-            expect(axisYMax).toBeDefined();
-            expect(axisYPercentMin).toBeUndefined();
-            expect(axisYPercentMax).toBeUndefined();
-        });
-    });
-});

package/tests/value.formatter.test.js

@@ -1,143 +0,0 @@
-const { getAggregatorPercentageValueIfRequired, getRelatedValue, isAbsoluteValue } = 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',
-                    formula: 'x2-x1',
-                    is_percentage: false
-                } 
-            }
-        };
-        rowKey = ['Variance'];
-        colKey = ['SomeCol'];
-    });
-
-    it('should return percentage string when secondaryAxisSettings.is_percentage is true but delta_column.is_percentage is false', () => {
-        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 percentage string when secondaryAxisSettings.is_percentage is false but delta_column.is_percentage is true', () => {
-        const data = {
-            rowKeys: ['Variance'],
-            getAggregator: jest.fn(() => ({
-                value: () => 200
-            }))
-        };
-        render_options.comboOptions.secondaryAxisSettings.is_percentage = false;
-        render_options.chartOptions.delta_column.is_percentage = true;
-        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();
-    });
-
-    it('should return null if data is null', () => {
-        const result = getAggregatorPercentageValueIfRequired(50, render_options, null, rowKey, colKey);
-        expect(result).toBeNull();
-    });
-
-    it('should return null if data is undefined', () => {
-        const result = getAggregatorPercentageValueIfRequired(50, render_options, undefined, rowKey, colKey);
-        expect(result).toBeNull();
-    });
-
-    it('should return null if baseRowKey is null even when data exists', () => {
-        const data = {
-            rowKeys: [null],
-            getAggregator: jest.fn()
-        };
-        const result = getAggregatorPercentageValueIfRequired(50, render_options, data, rowKey, colKey);
-        expect(result).toBeNull();
-        expect(data.getAggregator).not.toHaveBeenCalled();
-    });
-});
-
-describe('Function getRelatedValue', () => {
-    it('should return -1 when baseValue is falsy and value < 0', () => {
-        expect(getRelatedValue(-50, 0)).toBe(-1);
-    });
-
-    it('should return 1 when baseValue is falsy and value >= 0', () => {
-        expect(getRelatedValue(50, null)).toBe(1);
-    });
-
-    it('should return related value when baseValue is truthy', () => {
-        expect(getRelatedValue(50, 200)).toBe(0.25);
-        expect(getRelatedValue(200, 200)).toBe(1);
-    });
-});
-
-describe('Function isAbsoluteValue', () => {
-    it('should return false if formula is undefined', () => {
-        expect(isAbsoluteValue(undefined)).toBe(false);
-    });
-
-    it('should return false if formula is null', () => {
-        expect(isAbsoluteValue(null)).toBe(false);
-    });
-
-    it('should return false if formula contains "/"', () => {
-        expect(isAbsoluteValue('/')).toBe(false);
-        expect(isAbsoluteValue(' / ')).toBe(false);
-    });
-
-    it('should return true if formula does not contain "/"', () => {
-        expect(isAbsoluteValue('x2-x1')).toBe(true);
-        expect(isAbsoluteValue(' x1 - x2 ')).toBe(true);
-        expect(isAbsoluteValue('some text x2-x1 more text')).toBe(true);
-    });
-
-    it('should ignore spaces in formula', () => {
-        expect(isAbsoluteValue('x2 - x1')).toBe(true);
-        expect(isAbsoluteValue('  x1   -   x2  ')).toBe(true);
-    });
-});