feat: add INTERPUNCT boundary and MIDDOT case (#11)

* feat: add `INTERPUNCT` boundary

* feat: add `MIDDOT` case

* feat: add `MIDDOT` case to `textcase.case.__all__`

* docs: fix typo in `INTERPUNCT` boundary docstring

* feat: add `INTERPUNCT` boundary to `textcase.boundary.__all__`

* test: add `INTERPUNCT` boundary test case

* test: add `MIDDOT` case convert test case

* test: add `MIDDOT` case is_case test case

* docs: add `MIDDOT` case examples

* docs: add `INTERPUNCT` boundary as an example to `Boundary.from_delimiter` docstring

* test: fix `MIDDOT` case test cases

Author: zobweyt

README.md

@@ -72,6 +72,7 @@ from textcase import case, convert
 print(convert("ronnie james dio", case.SNAKE))     # ronnie_james_dio
 print(convert("Ronnie_James_dio", case.CONSTANT))  # RONNIE_JAMES_DIO
 print(convert("RONNIE_JAMES_DIO", case.KEBAB))     # ronnie-james-dio
+print(convert("ronnie james dio", case.MIDDOT))    # ronnie·james·dio
 print(convert("RONNIE-JAMES-DIO", case.CAMEL))     # ronnieJamesDio
 print(convert("ronnie-james-dio", case.PASCAL))    # RonnieJamesDio
 print(convert("RONNIE JAMES DIO", case.LOWER))     # ronnie james dio

docs/.snippets/index/convert.py

@@ -3,6 +3,7 @@
 print(convert("ronnie james dio", case.SNAKE))
 print(convert("Ronnie_James_dio", case.CONSTANT))
 print(convert("RONNIE_JAMES_DIO", case.KEBAB))
+print(convert("ronnie james dio", case.MIDDOT))
 print(convert("RONNIE-JAMES-DIO", case.CAMEL))
 print(convert("ronnie-james-dio", case.PASCAL))
 print(convert("RONNIE JAMES DIO", case.LOWER))

tests/boundary/test_boundaries.py

@@ -13,6 +13,10 @@ def test_space() -> None:
     assert (boundary.SPACE,) == tuple(boundary.get_boundaries(" "))
 
 
+def test_interpunct() -> None:
+    assert 0 == len(tuple(boundary.get_boundaries("·")))
+
+
 def test_lower_upper() -> None:
     assert (boundary.LOWER_UPPER,) == tuple(boundary.get_boundaries("aA"))
 

tests/convert/test_cases.py

@@ -13,6 +13,10 @@ def test_kebab() -> None:
     assert convert("RONNIE_JAMES_DIO", case.KEBAB) == "ronnie-james-dio"
 
 
+def test_middot() -> None:
+    assert convert("ronnie james dio", case.MIDDOT) == "ronnie·james·dio"
+
+
 def test_camel() -> None:
     assert convert("RONNIE-JAMES-DIO", case.CAMEL) == "ronnieJamesDio"
 

tests/is_case/test_cases.py

@@ -16,6 +16,11 @@ def test_kebab() -> None:
     assert is_case("RONNIE_JAMES_DIO", case.KEBAB) is False
 
 
+def test_middot() -> None:
+    assert is_case("ronnie·james·dio", case.MIDDOT) is True
+    assert is_case("RONNIE_JAMES_DIO", case.MIDDOT) is False
+
+
 def test_camel() -> None:
     assert is_case("ronnieJamesDio", case.CAMEL) is True
     assert is_case("RONNIE-JAMES-DIO", case.CAMEL) is False

textcase/boundary.py

@@ -8,6 +8,7 @@
     "UNDERSCORE",
     "HYPHEN",
     "SPACE",
+    "INTERPUNCT",
     "LOWER_UPPER",
     "UPPER_LOWER",
     "ACRONYM",
@@ -69,7 +70,7 @@ def from_delimiter(delimiter: str) -> "Boundary":
 
         This is a helper method that can be used to create simple boundaries such as
         [`UNDERSCORE`][textcase.boundary.UNDERSCORE], [`HYPHEN`][textcase.boundary.HYPHEN],
-        or [`SPACE`][textcase.boundary.SPACE].
+        [`SPACE`][textcase.boundary.SPACE], or [`INTERPUNCT`][textcase.boundary.INTERPUNCT].
 
         **Unreleased.**
 
@@ -105,11 +106,17 @@ def from_delimiter(delimiter: str) -> "Boundary":
 """
 
 SPACE: Final[Boundary] = Boundary.from_delimiter(" ")
-"""Splits on space, consuming the character on segmentation.
+"""Splits on ` `, consuming the character on segmentation.
 
 **Added in version:** [`0.2.0`](https://zobweyt.github.io/textcase/changelog/#020-2025-04-01)
 """
 
+INTERPUNCT: Final[Boundary] = Boundary.from_delimiter("·")
+"""Splits on `·`, consuming the character on segmentation.
+
+**Unreleased**.
+"""
+
 LOWER_UPPER: Final[Boundary] = Boundary(
     satisfies=lambda text: text[0:1].islower() and text[1:2].isupper(),
     start=1,

textcase/case.py

@@ -8,6 +8,7 @@
     "SNAKE",
     "CONSTANT",
     "KEBAB",
+    "MIDDOT",
     "CAMEL",
     "PASCAL",
     "LOWER",
@@ -25,6 +26,7 @@
     DIGIT_LOWER,
     DIGIT_UPPER,
     HYPHEN,
+    INTERPUNCT,
     LOWER_DIGIT,
     LOWER_UPPER,
     SPACE,
@@ -99,6 +101,16 @@ class Case:
 **Added in version:** [`0.2.0`](https://zobweyt.github.io/textcase/changelog/#020-2025-04-01)
 """
 
+MIDDOT: Final[Case] = Case(
+    boundaries=(INTERPUNCT,),
+    pattern=lower,
+    delimiter="·",
+)
+"""Middot case strings are delimited by interpuncts `·` and are all lowercase.
+
+**Unreleased.**
+"""
+
 CAMEL: Final[Case] = Case(
     boundaries=(
         LOWER_UPPER,