Generalize src handling function

Author: VeraZab

src/EditorControls.js

@@ -281,7 +281,10 @@ EditorControls.propTypes = {
   beforeUpdateTraces: PropTypes.func,
   children: PropTypes.node,
   className: PropTypes.string,
-  customSrcHandling: PropTypes.object,
+  customSrcHandling: PropTypes.shape({
+    toSrc: PropTypes.func,
+    fromSrc: PropTypes.func,
+  }),
   dataSourceOptionRenderer: PropTypes.func,
   dataSourceOptions: PropTypes.array,
   dataSources: PropTypes.object,
@@ -308,7 +311,10 @@ EditorControls.defaultProps = {
 EditorControls.childContextTypes = {
   advancedTraceTypeSelector: PropTypes.bool,
   config: PropTypes.object,
-  customSrcHandling: PropTypes.object,
+  customSrcHandling: PropTypes.shape({
+    toSrc: PropTypes.func,
+    fromSrc: PropTypes.func,
+  }),
   data: PropTypes.array,
   dataSourceOptionRenderer: PropTypes.func,
   dataSourceOptions: PropTypes.array,

src/PlotlyEditor.js

@@ -71,7 +71,10 @@ PlotlyEditor.propTypes = {
   divId: PropTypes.string,
   hideControls: PropTypes.bool,
   showFieldTooltips: PropTypes.bool,
-  customSrcHandling: PropTypes.object,
+  customSrcHandling: PropTypes.shape({
+    toSrc: PropTypes.func,
+    fromSrc: PropTypes.func,
+  }),
 };
 
 PlotlyEditor.defaultProps = {

src/components/fields/DataSelector.js

@@ -26,8 +26,13 @@ export class UnconnectedDataSelector extends Component {
     this.dataSourceOptions = context.dataSourceOptions || [];
 
     this.srcAttr = props.attr + 'src';
-    this.srcProperty = nestedProperty(props.container, this.srcAttr);
-    this.fullValue = this.srcProperty.get();
+    this.srcProperty = nestedProperty(props.container, this.srcAttr).get();
+    this.fullValue = this.context.customSrcHandling
+      ? this.context.customSrcHandling.toSrc(
+          this.srcProperty,
+          props.container.type
+        )
+      : this.srcProperty;
 
     this.is2D = false;
     if (props.container) {
@@ -44,15 +49,6 @@ export class UnconnectedDataSelector extends Component {
           ].includes(props.container.type)) ||
         (props.container.type === 'table' && props.attr !== 'columnorder');
     }
-
-    if (
-      this.is2D &&
-      this.fullValue &&
-      this.fullValue.length &&
-      this.context.customSrcHandling
-    ) {
-      this.fullValue = this.context.customSrcHandling.splitSrcs(this.fullValue);
-    }
   }
 
   updatePlot(value) {
@@ -81,8 +77,8 @@ export class UnconnectedDataSelector extends Component {
       this.srcAttr,
       this.props.container.type,
       {
-        joinSrcs: this.context.customSrcHandling
-          ? this.context.customSrcHandling.joinSrcs
+        fromSrc: this.context.customSrcHandling
+          ? this.context.customSrcHandling.fromSrc
           : null,
       }
     );
@@ -131,7 +127,10 @@ UnconnectedDataSelector.contextTypes = {
   dataSourceOptions: PropTypes.array,
   dataSourceValueRenderer: PropTypes.func,
   dataSourceOptionRenderer: PropTypes.func,
-  customSrcHandling: PropTypes.object,
+  customSrcHandling: PropTypes.shape({
+    toSrc: PropTypes.func,
+    fromSrc: PropTypes.func,
+  }),
 };
 
 function modifyPlotProps(props, context, plotProps) {

src/lib/__tests__/dereference-test.js

@@ -54,7 +54,7 @@ describe('dereference', () => {
     dereference(
       container,
       {z1: [1, 2, 3], z2: [2, 2, 2]},
-      {splitSrcs: customParsing}
+      {toSrc: customParsing}
     );
 
     // contents should have been transposed

src/lib/__tests__/maybeAdjustSrc-test.js

@@ -1,19 +1,14 @@
 import {maybeAdjustSrc} from '../index';
 /* eslint-disable no-magic-numbers */
 describe('maybeAdjustSrc', () => {
-  it('uses custom joinSrcs function if one is provided', () => {
-    const customJoin = srcs => srcs.join('$');
+  it('uses custom parsing function if one is provided', () => {
+    const custom = srcs => srcs.join('$');
     const adjusted = maybeAdjustSrc(['z1', 'z2'], 'zsrc', 'heatmap', {
-      joinSrcs: customJoin,
+      fromSrc: custom,
     });
     expect(adjusted).toBe('z1$z2');
   });
 
-  it('reduces src to string when just one src element in array', () => {
-    const adjusted = maybeAdjustSrc(['z1'], 'zsrc', 'heatmap');
-    expect(adjusted).toBe('z1');
-  });
-
   it('reduces src to string for special table case', () => {
     const adjusted = maybeAdjustSrc(['z1'], 'header.valuessrc', 'table');
     expect(adjusted).toBe('z1');

src/lib/dereference.js

@@ -16,12 +16,12 @@ export default function dereference(
     const dataKey = key.replace(SRC_ATTR_PATTERN, '');
     const traceType = parent.type;
 
+    let srcRef = config.toSrc ? config.toSrc(parent[key]) : parent[key];
+
     // making this into an array to more easily lookup 1d and 2d srcs in dataSourceOptions
-    const srcRef = config.splitSrcs
-      ? config.splitSrcs(parent[key])
-      : Array.isArray(parent[key])
-        ? parent[key]
-        : [parent[key]];
+    if (!Array.isArray(srcRef)) {
+      srcRef = [srcRef];
+    }
 
     let data = srcRef.map(ref => {
       if (config.deleteKeys && !(ref in dataSources)) {

src/lib/index.js

@@ -164,20 +164,11 @@ function maybeAdjustSrc(src, srcAttributePath, traceType, config) {
     return null;
   }
 
-  if (Array.isArray(src)) {
-    if (src.length > 1 && config && config.joinSrcs) {
-      return config.joinSrcs(src, traceType);
-    }
-
-    if (
-      (specialTableCase(traceType, srcAttributePath) && src.length === 1) ||
-      src.length === 1
-    ) {
-      return src[0];
-    }
+  if (specialTableCase(traceType, srcAttributePath) && src.length === 1) {
+    return src[0];
   }
 
-  return src;
+  return config && config.fromSrc ? config.fromSrc(src, traceType) : src;
 }
 
 export {