From aeb337440646716c25f5730f8d3162d1ca516ae3 Mon Sep 17 00:00:00 2001
From: Jos de Jong <wjosdejong@gmail.com>
Date: Sun, 23 Aug 2020 16:47:11 +0200
Subject: [PATCH] Move sortArray and sortObjectKeys into a separate file

---
 src/components/modals/SortModal.svelte | 46 +-------------------
 src/logic/sort.js                      | 59 ++++++++++++++++++++++++++
 2 files changed, 60 insertions(+), 45 deletions(-)
 create mode 100644 src/logic/sort.js

diff --git a/src/components/modals/SortModal.svelte b/src/components/modals/SortModal.svelte
index 5e68d4d..4cd6e5d 100644
--- a/src/components/modals/SortModal.svelte
+++ b/src/components/modals/SortModal.svelte
@@ -2,13 +2,12 @@
 
 <script>
   import { getContext } from 'svelte'
-  import naturalSort from 'javascript-natural-sort'
   import Select from 'svelte-select'
   import Header from './Header.svelte'
   import { getNestedPaths } from '../../utils/arrayUtils.js'
-  import { getIn } from '../../utils/immutabilityHelpers.js'
   import { isObject } from '../../utils/typeUtils.js'
   import { stringifyPath } from '../../utils/pathUtils.js'
+  import { sortArray, sortObjectKeys } from '../../logic/sort.js'
 
   export let json
   export let path
@@ -48,49 +47,6 @@
     }
   }
 
-  function sortArray (array, property, direction) {
-    function comparator (a, b) {
-      const valueA = getIn(a, property)
-      const valueB = getIn(b, property)
-
-      if (valueA === undefined) {
-        return direction
-      }
-      if (valueB === undefined) {
-        return -direction
-      }
-
-      if (typeof valueA !== 'string' && typeof valueB !== 'string') {
-        // both values are a number, boolean, or null -> use simple, fast sorting
-        return valueA > valueB 
-          ? direction 
-          : valueA < valueB 
-            ? -direction 
-            : 0
-      }
-
-      return direction * naturalSort(valueA, valueB)
-    }
-
-    // TODO: use lodash orderBy, split comparator and direction?
-    const sortedArray = array.slice()
-    sortedArray.sort(comparator)
-
-    return sortedArray
-  }
-
-  function sortObjectKeys (object, direction) {
-    const keys = Object.keys(object)
-    keys.sort((keyA, keyB) => {
-      return direction * naturalSort(keyA, keyB)
-    })
-    
-    const sortedObject = {}
-    keys.forEach(key => sortedObject[key] = object[key])
-
-    return sortedObject
-  }
-
   function handleSort () {
     // TODO: create a sortBy which returns a JSONPatch document containing move operations
 
diff --git a/src/logic/sort.js b/src/logic/sort.js
new file mode 100644
index 0000000..73ed026
--- /dev/null
+++ b/src/logic/sort.js
@@ -0,0 +1,59 @@
+import { getIn } from '../utils/immutabilityHelpers.js'
+
+/**
+ * Sort the items of an array
+ * @param {Array} array       The array to be sorted
+ * @param {Path} path         Nested path to the property on which to sort the contents
+ * @param {1 | -1} direction  Pass 1 to sort ascending, -1 to sort descending
+ * @return {Array} Returns a sorted shallow copy of the array
+ */
+// TODO: write unit tests for sortArray
+export function sortArray (array, path, direction) {
+  function comparator (a, b) {
+    const valueA = getIn(a, path)
+    const valueB = getIn(b, path)
+
+    if (valueA === undefined) {
+      return direction
+    }
+    if (valueB === undefined) {
+      return -direction
+    }
+
+    if (typeof valueA !== 'string' && typeof valueB !== 'string') {
+      // both values are a number, boolean, or null -> use simple, fast sorting
+      return valueA > valueB 
+        ? direction 
+        : valueA < valueB 
+          ? -direction 
+          : 0
+    }
+
+    return direction * naturalSort(valueA, valueB)
+  }
+
+  // TODO: use lodash orderBy, split comparator and direction?
+  const sortedArray = array.slice()
+  sortedArray.sort(comparator)
+
+  return sortedArray
+}
+
+/**
+ * Sort the keys of an object
+ * @param {Object} object     The object to be sorted
+ * @param {1 | -1} direction  Pass 1 to sort ascending, -1 to sort descending
+ * @return {Object} Returns a sorted shallow copy of the object
+ */
+// TODO: write unit tests for sortObjectKeys
+export function sortObjectKeys (object, direction) {
+  const keys = Object.keys(object)
+  keys.sort((keyA, keyB) => {
+    return direction * naturalSort(keyA, keyB)
+  })
+  
+  const sortedObject = {}
+  keys.forEach(key => sortedObject[key] = object[key])
+
+  return sortedObject
+}