feat(slugify): Add a slugify function (#121)

A function to slugify text input, trims whitespaces and multiple dashes

Closes #120

Author: codejockie

src/index.js

@@ -40,6 +40,7 @@ import isFunction from './is-function'
 import isOdd from './is-odd'
 import isNumeric from './is-numeric'
 import max from './max'
+import slugify from './slugify'
 
 export {
   isOdd,
@@ -84,4 +85,5 @@ export {
   subtraction,
   isNumeric,
   max,
+  slugify,
 }

src/slugify.js

@@ -0,0 +1,20 @@
+export default slugify
+
+/**
+ * Original Source: https://stackoverflow.com/questions/1053902/how-to-convert-a-title-to-a-url-slug-in-jquery
+ *
+ * This function will slugify text given to it.
+ *
+ * @param {string} text - The text to slugify
+ * @return {string} - The slugified string
+ */
+function slugify(text) {
+  return text.toString()
+    .toLowerCase()
+    .trim() // Trim whitespaces at start and end of text
+    .replace(/\s+/g, '-') // Replace whitespaces with dash (-)
+    .replace(/[^\w\-]+/g, '') // Remove all non-word chars
+    .replace(/\-\-+/g, '-') // Replace multiple dashes/hyphens with single dash (-)
+    .replace(/^-+/, '') // Remove dash (-) from start of text
+    .replace(/-+$/, '') // Remove dash (-) from end of text
+}

test/slugify.test.js

@@ -0,0 +1,37 @@
+import test from 'ava'
+import {slugify} from '../src'
+
+test('slugifies a text', t => {
+  const text = 'The world is spherical in shape'
+  const expected = 'the-world-is-spherical-in-shape'
+  const actual = slugify(text)
+  t.deepEqual(actual, expected)
+})
+
+test('trims whitespaces and slugifies the text', t => {
+  const text = '   The world is spherical in shape   '
+  const expected = 'the-world-is-spherical-in-shape'
+  const actual = slugify(text)
+  t.deepEqual(actual, expected)
+})
+
+test('it converts extra dashes to single dash', t => {
+  const text = 'The--world---is---- spherical-- in-- shape'
+  const expected = 'the-world-is-spherical-in-shape'
+  const actual = slugify(text)
+  t.deepEqual(actual, expected)
+})
+
+test('removes all none word characters', t => {
+  const text = 'The & world & is & spherical & in & shape'
+  const expected = 'the-world-is-spherical-in-shape'
+  const actual = slugify(text)
+  t.deepEqual(actual, expected)
+})
+
+test('removes dashes at the start and end of text', t => {
+  const text = '---The world is spherical in shape---'
+  const expected = 'the-world-is-spherical-in-shape'
+  const actual = slugify(text)
+  t.deepEqual(actual, expected)
+})