Fix load-order issue that could cause overrides to error (#384)

Author: afischer

server/docs.js

@@ -8,7 +8,7 @@ const cache = require('./cache')
 const formatter = require('./formatter')
 const log = require('./logger')
 const {getAuth} = require('./auth')
-const {slugify} = require('./utils')
+const {slugify} = require('./text')
 
 const supportedTypes = new Set(['document', 'spreadsheet', 'text/html'])
 

server/list.js

@@ -8,7 +8,7 @@ const cache = require('./cache')
 const log = require('./logger')
 const {getAuth} = require('./auth')
 const {isSupported} = require('./utils')
-const {slugify, cleanName} = require('./utils')
+const {cleanName, slugify} = require('./text')
 
 const driveType = process.env.DRIVE_TYPE
 const driveId = process.env.DRIVE_ID

server/routes/categories.js

@@ -5,8 +5,8 @@ const router = require('express-promise-router')()
 const log = require('../logger')
 const {getMeta} = require('../list')
 const {fetchDoc} = require('../docs')
-const {cleanName} = require('../utils')
 const {getTemplates, sortDocs, stringTemplate, formatUrl, pathPrefix} = require('../utils')
+const {cleanName} = require('../text')
 const {parseUrl} = require('../urlParser')
 
 router.get('*', handleCategory)

server/routes/playlists.js

@@ -5,7 +5,8 @@ const router = require('express-promise-router')()
 const log = require('../logger')
 const {getMeta, getPlaylist} = require('../list')
 const {fetchDoc} = require('../docs')
-const {stringTemplate, formatUrl, pathPrefix, cleanName} = require('../utils')
+const {stringTemplate, formatUrl, pathPrefix} = require('../utils')
+const {cleanName} = require('../text')
 const {parseUrl} = require('../urlParser')
 
 router.get('*', handlePlaylist)

server/text.js

@@ -0,0 +1,18 @@
+const slugify = require('slugify')
+
+exports.cleanName = (name = '') => {
+  return name
+    .trim()
+    // eslint-disable-next-line no-useless-escape
+    .replace(/^(\d+[-–—_\s]*)([^\d\/\-^\s]+)/, '$2') // remove leading numbers and delimiters
+    .replace(/\s*\|\s*([^|]+)$/i, '') // remove trailing pipe and tags
+    .replace(/\.[^.]+$/, '') // remove file extensions
+}
+
+exports.slugify = (text = '') => {
+  // convert non alpha numeric into whitespace, rather than removing
+  const alphaNumeric = text.replace(/[^\p{L}\p{N}]+/ug, ' ')
+  return slugify(alphaNumeric, {
+    lower: true
+  })
+}

server/utils.js

@@ -2,7 +2,6 @@
 const fs = require('fs')
 const path = require('path')
 const {promisify} = require('util')
-const slugify = require('slugify')
 const yaml = require('js-yaml')
 const {get: deepProp} = require('lodash')
 const merge = require('deepmerge')
@@ -46,23 +45,6 @@ exports.sortDocs = (a, b) => {
   return b.resourceType === 'folder' ? 1 : -1
 }
 
-exports.cleanName = (name = '') => {
-  return name
-    .trim()
-    // eslint-disable-next-line no-useless-escape
-    .replace(/^(\d+[-–—_\s]*)([^\d\/\-^\s]+)/, '$2') // remove leading numbers and delimiters
-    .replace(/\s*\|\s*([^|]+)$/i, '') // remove trailing pipe and tags
-    .replace(/\.[^.]+$/, '') // remove file extensions
-}
-
-exports.slugify = (text = '') => {
-  // convert non alpha numeric into whitespace, rather than removing
-  const alphaNumeric = text.replace(/[^\p{L}\p{N}]+/ug, ' ')
-  return slugify(alphaNumeric, {
-    lower: true
-  })
-}
-
 // attempts to require from attemptPath. If file isn't present, looks for a
 // file of the same name in the server dir
 exports.requireWithFallback = (attemptPath) => {

test/unit/utils.test.js renamed to test/unit/text.test.js

@@ -2,9 +2,9 @@
 
 const {expect} = require('chai')
 
-const {cleanName, slugify} = require('../../server/utils')
+const {cleanName, slugify} = require('../../server/text')
 
-describe('Utils', () => {
+describe('Text Utils', () => {
   describe('Name Cleaner', () => {
     it('should remove leading numbers and delimeters', () => {
       expect(cleanName('0000123abc12345')).equals('abc12345')