is_slug now allows multiple consecutive separator signs between words

daveoncode · daveoncode · commit ebae878a5cbe · 2020-03-04T15:35:45.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -67,6 +67,7 @@ importable as before (`from string_utils import xxx`). Similarly `tests.py` has
 with a module for each test case
 - `is_snake_case()` now considers as "snake case" strings with mixed upper and lower case characters, strings with 
 leading or trailing underscores and string containing multiple underscores in sequence
+- `is_slug()` now allows multiple consecutive separator signs between words
 
 ### Improvements:
 
diff --git a/string_utils/validation.py b/string_utils/validation.py
@@ -543,7 +543,7 @@ def is_isogram(input_string: Any) -> bool:
     return is_full_string(input_string) and len(set(input_string)) == len(input_string)
 
 
-def is_slug(input_string: Any, sign: str = '-') -> bool:
+def is_slug(input_string: Any, separator: str = '-') -> bool:
     """
     Checks if a given string is a slug (as created by `slugify()`).
 
@@ -554,14 +554,14 @@ def is_slug(input_string: Any, sign: str = '-') -> bool:
 
     :param input_string: String to check.
     :type input_string: str
-    :param sign: Join sign used by the slug.
-    :type sign: str
+    :param separator: Join sign used by the slug.
+    :type separator: str
     :return: True if slug, false otherwise.
     """
     if not is_full_string(input_string):
         return False
 
-    rex = r'^([a-z\d]+' + re.escape(sign) + r'?)*[a-z\d]$'
+    rex = r'^([a-z\d]+' + re.escape(separator) + r'*?)*[a-z\d]$'
 
     return re.match(rex, input_string) is not None
 
diff --git a/tests/test_is_slug.py b/tests/test_is_slug.py
@@ -29,6 +29,11 @@ def test_recognizes_slugs(self):
         self.assertTrue(is_slug('yep.i.am.a.slug', '.'))
         self.assertTrue(is_slug('yep_i_am_a_slug', '_'))
 
+    def test_slug_can_have_multiple_consecutive_separator_signs(self):
+        self.assertTrue(is_slug('oh-----yeah'))
+        self.assertTrue(is_slug('oh_____yeah', '_'))
+        self.assertTrue(is_slug('1----2'))
+
     def test_slug_cannot_contain_spaces(self):
         self.assertFalse(is_slug('not - a - slug'))
         self.assertFalse(is_slug('not- a - slug'))
@@ -37,6 +42,18 @@ def test_slug_cannot_contain_spaces(self):
         self.assertFalse(is_slug('not-a-slug '))
         self.assertFalse(is_slug(' not-a-slug'))
 
+    def test_slug_cannot_contain_non_ascii_chars(self):
+        self.assertFalse(is_slug('foò-bär'))
+
+    def test_slug_cannot_contain_punctuation(self):
+        self.assertFalse(is_slug('foo.-bar'))
+        self.assertFalse(is_slug('foo-bar.'))
+        self.assertFalse(is_slug('foo-bar,'))
+        self.assertFalse(is_slug('!foo-bar'))
+        self.assertFalse(is_slug('foo-bar?'))
+        self.assertFalse(is_slug('foo-bar:'))
+        self.assertFalse(is_slug('foo-bar;'))
+
     def test_exclude_invalid_slugs(self):
         self.assertFalse(is_slug(' nope'))
         self.assertFalse(is_slug('nope '))
@@ -46,3 +63,12 @@ def test_exclude_invalid_slugs(self):
         self.assertFalse(is_slug('-no-no-no-'))
         self.assertFalse(is_slug('100%no-slug!'))
         self.assertFalse(is_slug('NOT-AS-UPPERCASE'))
+
+    def test_slug_can_be_single_word(self):
+        self.assertTrue(is_slug('hello'))
+        self.assertTrue(is_slug('x'))
+        self.assertTrue(is_slug('42'))
+        self.assertTrue(is_slug('5'))
+
+    def test_slug_must_have_at_least_one_non_separator_char(self):
+        self.assertFalse(is_slug('-'))
