From de04845e556364ac2273b1c7197e5346f5136fe8 Mon Sep 17 00:00:00 2001
From: sam-m-m <sam@dassana.io>
Date: Fri, 5 Mar 2021 11:44:58 -0800
Subject: [PATCH] feat #243 - Refac utils

---
 src/components/Table/utils.tsx |  5 ++-
 src/components/utils.ts        | 80 ++++++++++++++++++----------------
 2 files changed, 47 insertions(+), 38 deletions(-)

diff --git a/src/components/Table/utils.tsx b/src/components/Table/utils.tsx
index 305b8831..f0dcd563 100644
--- a/src/components/Table/utils.tsx
+++ b/src/components/Table/utils.tsx
@@ -3,6 +3,7 @@ import bytes from 'bytes'
 import { CellWithTooltip } from './CellWithTooltip'
 import { ColoredDot } from 'components/ColoredDot'
 import { EditableCell } from './EditableCell'
+import { isJSONPath } from 'components/utils'
 import isUndefined from 'lodash/isUndefined'
 import { JSONPath } from 'jsonpath-plus'
 import moment from 'moment'
@@ -73,6 +74,8 @@ export function processColumns<TableData extends DataId>(
 	})
 }
 
+// ------------------------------------------------
+
 type ProcessedData<T> = T & {
 	_FORMATTED_DATA: (string | null)[]
 	key: Key
@@ -99,7 +102,7 @@ export function processData<TableData extends DataId>(
 		columns.forEach(col => {
 			const { dataIndex } = col
 
-			if (dataIndex[0] === '$') {
+			if (isJSONPath(dataIndex)) {
 				const value = JSONPath({
 					json: item,
 					path: dataIndex
diff --git a/src/components/utils.ts b/src/components/utils.ts
index cadfd3aa..a888c0bd 100644
--- a/src/components/utils.ts
+++ b/src/components/utils.ts
@@ -4,19 +4,6 @@ import { PopupContainerProps } from './types'
 import { TooltipPlacement } from 'antd/es/tooltip'
 import { useEffect, useState } from 'react'
 
-export const TAG = 'data-test'
-
-export const fakeApiCallSuccess: () => Promise<void> = async (
-	timeoutDuration = 1000
-) => await new Promise(resolve => setTimeout(resolve, timeoutDuration))
-
-export const getDataTestAttributeProp = (
-	cmpName: string,
-	dataTag?: string
-): { [TAG]: string } => ({
-	[TAG]: dataTag ? `${cmpName}-${dataTag}` : cmpName
-})
-
 export const placementOptions: TooltipPlacement[] = [
 	'bottom',
 	'bottomLeft',
@@ -32,30 +19,9 @@ export const placementOptions: TooltipPlacement[] = [
 	'topRight'
 ]
 
-export const generatePopupSelector = (
-	popupContainerSelector: string
-) => (): HTMLElement =>
-	document.querySelector(popupContainerSelector) as HTMLElement
-
-type RGB = {
-	r: number
-	g: number
-	b: number
-}
-
-export const getPopupContainerProps = (
-	popupContainerSelector = ''
-): PopupContainerProps => {
-	let popupContainerProps = {}
-
-	if (popupContainerSelector) {
-		popupContainerProps = {
-			getPopupContainer: generatePopupSelector(popupContainerSelector)
-		}
-	}
+export const TAG = 'data-test'
 
-	return popupContainerProps
-}
+/* ------------ Utilities related to colors ------------ */
 
 const rgbToHex = (rgb: RGB) => Color(rgb).hex()
 
@@ -76,7 +42,6 @@ export enum ColorManipulationTypes {
 	tint = 'tint'
 }
 
-/* eslint-disable sort-keys */
 export const manipulateColor = (
 	color: string,
 	percent: number,
@@ -111,6 +76,47 @@ export const manipulateColor = (
 	}
 }
 
+/* ---------------------------------------------------- */
+
+export const fakeApiCallSuccess: () => Promise<void> = async (
+	timeoutDuration = 1000
+) => await new Promise(resolve => setTimeout(resolve, timeoutDuration))
+
+export const getDataTestAttributeProp = (
+	cmpName: string,
+	dataTag?: string
+): { [TAG]: string } => ({
+	[TAG]: dataTag ? `${cmpName}-${dataTag}` : cmpName
+})
+
+export const generatePopupSelector = (
+	popupContainerSelector: string
+) => (): HTMLElement =>
+	document.querySelector(popupContainerSelector) as HTMLElement
+
+type RGB = {
+	r: number
+	g: number
+	b: number
+}
+
+export const getPopupContainerProps = (
+	popupContainerSelector = ''
+): PopupContainerProps => {
+	let popupContainerProps = {}
+
+	if (popupContainerSelector) {
+		popupContainerProps = {
+			getPopupContainer: generatePopupSelector(popupContainerSelector)
+		}
+	}
+
+	return popupContainerProps
+}
+
+// TODO: implement JSONPath validator? For now, a string that starts with '$' will be considered a JSONPath
+export const isJSONPath = (path: string): boolean => path[0] === '$'
+
 // Appends a div to the document, usually for use with React portals
 // Optional popup container function can be provided as an argument. Otherwise, it defaults to appending the div to document.body
 export const useCreateDomElement = (