From 0d32d31864eff4443c538f2ead8af5bc133eec7d Mon Sep 17 00:00:00 2001
From: Luke Ward <hello@lward.co.uk>
Date: Wed, 3 Jul 2019 08:20:57 +0000
Subject: [PATCH] Replace slugifyWithHyphens with improved slugify function

---
 app/assets/javascripts/group.js               |  4 ++--
 .../javascripts/lib/utils/text_utility.js     | 11 +++++++++--
 .../javascripts/projects/project_new.js       |  4 ++--
 changelogs/unreleased/slugify.yml             |  5 +++++
 spec/frontend/lib/utils/text_utility_spec.js  | 19 +++++++++++++++++--
 5 files changed, 35 insertions(+), 8 deletions(-)
 create mode 100644 changelogs/unreleased/slugify.yml

diff --git a/app/assets/javascripts/group.js b/app/assets/javascripts/group.js
index 903c838e266..460174caf4d 100644
--- a/app/assets/javascripts/group.js
+++ b/app/assets/javascripts/group.js
@@ -1,5 +1,5 @@
 import $ from 'jquery';
-import { slugifyWithHyphens } from './lib/utils/text_utility';
+import { slugify } from './lib/utils/text_utility';
 
 export default class Group {
   constructor() {
@@ -14,7 +14,7 @@ export default class Group {
   }
 
   update() {
-    const slug = slugifyWithHyphens(this.groupName.val());
+    const slug = slugify(this.groupName.val());
     this.groupPath.val(slug);
   }
 
diff --git a/app/assets/javascripts/lib/utils/text_utility.js b/app/assets/javascripts/lib/utils/text_utility.js
index cc1d85fd97d..d38f59b5861 100644
--- a/app/assets/javascripts/lib/utils/text_utility.js
+++ b/app/assets/javascripts/lib/utils/text_utility.js
@@ -44,11 +44,18 @@ export const pluralize = (str, count) => str + (count > 1 || count === 0 ? 's' :
 export const dasherize = str => str.replace(/[_\s]+/g, '-');
 
 /**
- * Replaces whitespaces with hyphens and converts to lower case
+ * Replaces whitespaces with hyphens, convert to lower case and remove non-allowed special characters
  * @param {String} str
  * @returns {String}
  */
-export const slugifyWithHyphens = str => str.toLowerCase().replace(/\s+/g, '-');
+export const slugify = str => {
+  const slug = str
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-zA-Z0-9_.-]+/g, '-');
+
+  return slug === '-' ? '' : slug;
+};
 
 /**
  * Replaces whitespaces with underscore and converts to lower case
diff --git a/app/assets/javascripts/projects/project_new.js b/app/assets/javascripts/projects/project_new.js
index ea82ff4e340..9066844f687 100644
--- a/app/assets/javascripts/projects/project_new.js
+++ b/app/assets/javascripts/projects/project_new.js
@@ -1,6 +1,6 @@
 import $ from 'jquery';
 import { addSelectOnFocusBehaviour } from '../lib/utils/common_utils';
-import { slugifyWithHyphens } from '../lib/utils/text_utility';
+import { slugify } from '../lib/utils/text_utility';
 import { s__ } from '~/locale';
 
 let hasUserDefinedProjectPath = false;
@@ -34,7 +34,7 @@ const deriveProjectPathFromUrl = $projectImportUrl => {
 };
 
 const onProjectNameChange = ($projectNameInput, $projectPathInput) => {
-  const slug = slugifyWithHyphens($projectNameInput.val());
+  const slug = slugify($projectNameInput.val());
   $projectPathInput.val(slug);
 };
 
diff --git a/changelogs/unreleased/slugify.yml b/changelogs/unreleased/slugify.yml
new file mode 100644
index 00000000000..853e90b8bed
--- /dev/null
+++ b/changelogs/unreleased/slugify.yml
@@ -0,0 +1,5 @@
+---
+title: Replace slugifyWithHyphens with improved slugify function
+merge_request: 30172
+author: Luke Ward
+type: fixed
diff --git a/spec/frontend/lib/utils/text_utility_spec.js b/spec/frontend/lib/utils/text_utility_spec.js
index 9e920d59093..dc886d0db3b 100644
--- a/spec/frontend/lib/utils/text_utility_spec.js
+++ b/spec/frontend/lib/utils/text_utility_spec.js
@@ -55,9 +55,24 @@ describe('text_utility', () => {
     });
   });
 
-  describe('slugifyWithHyphens', () => {
+  describe('slugify', () => {
+    it('should remove accents and convert to lower case', () => {
+      expect(textUtils.slugify('João')).toEqual('jo-o');
+    });
     it('should replaces whitespaces with hyphens and convert to lower case', () => {
-      expect(textUtils.slugifyWithHyphens('My Input String')).toEqual('my-input-string');
+      expect(textUtils.slugify('My Input String')).toEqual('my-input-string');
+    });
+    it('should remove trailing whitespace and replace whitespaces within string with a hyphen', () => {
+      expect(textUtils.slugify(' a new project ')).toEqual('a-new-project');
+    });
+    it('should only remove non-allowed special characters', () => {
+      expect(textUtils.slugify('test!_pro-ject~')).toEqual('test-_pro-ject-');
+    });
+    it('should squash multiple hypens', () => {
+      expect(textUtils.slugify('test!!!!_pro-ject~')).toEqual('test-_pro-ject-');
+    });
+    it('should return empty string if only non-allowed characters', () => {
+      expect(textUtils.slugify('здрасти')).toEqual('');
     });
   });