extract function

Author: VeraZab

src/lib/unpackPlotProps.js

@@ -2,6 +2,103 @@ import nestedProperty from 'plotly.js/src/lib/nested_property';
 import isNumeric from 'fast-isnumeric';
 import {MULTI_VALUED, MULTI_VALUED_PLACEHOLDER} from './constants';
 
+export function computeVisibility(props, fullValue, customConfig) {
+  let isVisible = false;
+
+  const hasFullValue = () => fullValue !== void 0 && fullValue !== null;
+
+  const isValidCustomConfigObject = customConfig => {
+    if (customConfig.visibility_rules) {
+      const logRuleError = () => {
+        console.error(
+          'invalid customConfig: all customConfig visibility rules must include type and regex_match keys.'
+        );
+      };
+
+      if (
+        (customConfig.visibility_rules.blacklist &&
+          customConfig.visibility_rules.blacklist.some(r => !r.type || !r.regex_match)) ||
+        (customConfig.visibility_rules.whitelist &&
+          customConfig.visibility_rules.whitelist.some(r => !r.type || !r.regex_match))
+      ) {
+        logRuleError();
+        return false;
+      }
+
+      if (
+        customConfig.visibility_rules.order &&
+        Array.isArray(customConfig.visibility_rules.order) &&
+        customConfig.visibility_rules.order.some(o => !['blacklist', 'whitelist'].includes(o))
+      ) {
+        console.error(
+          "invalid customConfig: only 2 values are accepted in the visibility_rules.order array: 'blacklist' and 'whitelist'"
+        );
+        return false;
+      }
+
+      return true;
+    }
+    return false;
+  };
+
+  if (
+    customConfig &&
+    customConfig === Object(customConfig) &&
+    Object.keys(customConfig).length &&
+    isValidCustomConfigObject(customConfig)
+  ) {
+    const matches = o => {
+      if (customConfig.visibility_rules[o]) {
+        return customConfig.visibility_rules[o].some(rule => {
+          const regex = RegExp(rule.regex_match);
+          return rule.type === 'attrName' && regex.test(props.attr);
+        });
+      }
+      return false;
+    };
+
+    if (customConfig.visibility_rules.blacklist && customConfig.visibility_rules.whitelist) {
+      // Look to see if there was an order to blacklisting or whitelisting specified
+      const order =
+        customConfig.visibility_rules.order && customConfig.visibility_rules.order.length
+          ? customConfig.visibility_rules.order
+          : ['blacklist', 'whitelist'];
+
+      if (order[0] === 'blacklist') {
+        const shouldBlacklist = matches('blacklist') && !matches('whitelist');
+        if (!shouldBlacklist && hasFullValue()) {
+          isVisible = true;
+        }
+      }
+
+      if (order[0] === 'whitelist') {
+        const shouldWhitelist = matches('whitelist') && !matches('blacklist');
+        if (shouldWhitelist && hasFullValue()) {
+          isVisible = true;
+        }
+      }
+    } else {
+      if (customConfig.visibility_rules.blacklist) {
+        if (!matches('blacklist') && hasFullValue()) {
+          isVisible = true;
+        }
+      }
+
+      if (customConfig.visibility_rules.whitelist) {
+        if (matches('whitelist') && hasFullValue()) {
+          isVisible = true;
+        }
+      }
+    }
+  } else {
+    if (props.show || hasFullValue()) {
+      isVisible = true;
+    }
+  }
+
+  return isVisible;
+}
+
 export default function unpackPlotProps(props, context) {
   const {container, getValObject, defaultContainer, updateContainer, customConfig} = context;
 
@@ -28,48 +125,7 @@ export default function unpackPlotProps(props, context) {
     multiValued = true;
   }
 
-  let isVisible = false;
-  // Base visibility rules
-  if (props.show || (fullValue !== void 0 && fullValue !== null)) {
-    isVisible = true;
-  }
-  // We can override base visibility rules with a customConfig
-  if (
-    customConfig &&
-    customConfig === Object(customConfig) &&
-    Object.keys(customConfig).length &&
-    customConfig.visibility_rules
-  ) {
-    // Look to see if there was an order to blacklisting or whitelisting specified
-    const order =
-      customConfig.visibility_rules.order &&
-      Array.isArray(customConfig.visibility_rules.order) &&
-      customConfig.visibility_rules.order.length
-        ? customConfig.visibility_rules.order
-        : ['blacklist', 'whitelist'];
-
-    order.forEach(o => {
-      if (customConfig.visibility_rules[o]) {
-        customConfig.visibility_rules[o].forEach(r => {
-          if (r.type && r.regex_match) {
-            const regex = RegExp(r.regex_match);
-            if (o === 'blacklist' && r.type === 'attrName' && regex.test(props.attr)) {
-              isVisible = false;
-            }
-            if (o === 'whitelist' && r.type === 'attrName' && regex.test(props.attr)) {
-              isVisible = true;
-            }
-          } else {
-            throw new Error(
-              `sorry, you must include the type and regex_match in each of your blacklisting and whitelisting customConfig rules`
-            );
-          }
-        });
-      } else {
-        throw new Error(`sorry, you have an invalid key of ${o} in your customConfig prop`);
-      }
-    });
-  }
+  const isVisible = computeVisibility(props, fullValue, customConfig);
 
   let defaultValue = props.defaultValue;
   if (defaultValue === void 0 && defaultContainer) {