Ruff

standardize_test_format/__init__.py

@@ -6,18 +6,21 @@ Is capable of migrating from Javadoc based property specification to the
 `@DisplayName` specification and back.
 """
 
-import re
 import enum
 import hashlib
+import re
+
+from ._version import __version__
+
+__all__ = ['__version__', 'standardize_java_text', 'NamingScheme']
+
 
 class NamingScheme(enum.Enum):
     PRESERVE = 'preserve'
-    HASH_OF_DESC  = 'hash'
+    HASH_OF_DESC = 'hash'
     FROM_DESC = 'desc'
 
 
-
-
 PATTERN_JAVADOC = r'/\*\*(?P<javadoc>.*(\n\s*\*.*)*?)\s*\*/'
 PATTERN_DISPLAY_NAME_EXPRESSION = r'\s*(?:"[^"]*?")(?:\s*\+\s*"[^"]*?")*\s*'
 PATTERN_DISPLAY_NAME = (
@@ -47,7 +50,6 @@ IGNORABLE_WORDS_IN_NAME = frozenset(
         'the',
         'is',
         'are',
-
         'test',
         'tests',
     },
@@ -92,7 +94,7 @@ def to_camel_case(description: str) -> str:
         .replace('+', ' ')
         .replace('-', ' ')
         .replace(':', ' ')
-        .replace('\'', '')
+        .replace("'", '')
         .strip(' \t.')
     )
     words = description.split(' ')
@@ -110,7 +112,9 @@ def to_camel_case(description: str) -> str:
 
 def from_camel_case(name: str) -> str:
     return re.sub(
-        r'(^|[A-Z])[a-z]*', lambda x: ' ' + x.group(0).capitalize(), name,
+        r'(^|[A-Z])[a-z]*',
+        lambda x: ' ' + x.group(0).capitalize(),
+        name,
     ).strip()
 
 
@@ -136,9 +140,10 @@ def parse_display_name_to_description(text: str | None):
     return text
 
 
-
 def replace_test_pattern(
-    match: re.Match, with_javadoc: bool, with_display_name: bool,
+    match: re.Match,
+    with_javadoc: bool,
+    with_display_name: bool,
     naming_scheme: NamingScheme,
 ) -> str:
     javadoc = parse_javadoc_to_description(match.group('javadoc'))
@@ -158,7 +163,7 @@ def replace_test_pattern(
     elif naming_scheme == NamingScheme.HASH_OF_DESC:
         h = hashlib.sha256()
         h.update(description.encode('utf8'))
-        name = 'test'+h.hexdigest()
+        name = 'test' + h.hexdigest()
         del h
 
     return format_test_prefix(
@@ -174,9 +179,20 @@ def replace_test_pattern(
 IMPORT_DISPLAY_NAME = 'import org.junit.jupiter.api.DisplayName;'
 
 
-def standardize_java_text(text: str, with_javadoc: bool, with_display_name: bool, naming_scheme: NamingScheme):
+def standardize_java_text(
+    text: str,
+    with_javadoc: bool,
+    with_display_name: bool,
+    naming_scheme: NamingScheme,
+):
     text = TEST_PATTERN.sub(
-        lambda m: replace_test_pattern(m, with_javadoc, with_display_name, naming_scheme), text,
+        lambda m: replace_test_pattern(
+            m,
+            with_javadoc,
+            with_display_name,
+            naming_scheme,
+        ),
+        text,
     )
     if '@DisplayName' in text and IMPORT_DISPLAY_NAME not in text:
         lines = text.split('\n')

standardize_test_format/__main__.py

@@ -1,7 +1,7 @@
 import argparse
 import pathlib
 
-from . import standardize_java_text, NamingScheme
+from . import NamingScheme, standardize_java_text
 
 
 def test_files(repo: pathlib.Path) -> list[pathlib.Path]:
@@ -9,13 +9,21 @@ def test_files(repo: pathlib.Path) -> list[pathlib.Path]:
 
 
 def standardize_in_file(
-    path: pathlib.Path, inline: bool, with_javadoc: bool, with_display_name:
+    path: pathlib.Path,
-    bool, naming_scheme: NamingScheme,
+    inline: bool,
+    with_javadoc: bool,
+    with_display_name: bool,
+    naming_scheme: NamingScheme,
 ):
     with open(path) as f:
         text = f.read()
 
-    text_updated = standardize_java_text(text, with_javadoc, with_display_name, naming_scheme=naming_scheme)
+    text_updated = standardize_java_text(
+        text,
+        with_javadoc,
+        with_display_name,
+        naming_scheme=naming_scheme,
+    )
     if text_updated == text:
         return
 
@@ -32,7 +40,12 @@ def argument_parser():
     argparser.add_argument('-i', action='store_true')
     argparser.add_argument('--javadoc', action='store_true')
     argparser.add_argument('--displayname', action='store_true')
-    argparser.add_argument('--naming', type=NamingScheme, choices=list(NamingScheme), default=NamingScheme.FROM_DESC)
+    argparser.add_argument(
+        '--naming',
+        type=NamingScheme,
+        choices=list(NamingScheme),
+        default=NamingScheme.FROM_DESC,
+    )
     return argparser
 
 

test/test_parsing.py

@@ -0,0 +1,46 @@
+import re
+
+import pytest
+
+from standardize_test_format import (
+    PATTERN_DISPLAY_NAME,
+    PATTERN_DISPLAY_NAME_EXPRESSION,
+    PATTERN_JAVADOC,
+)
+
+VALID_JAVADOCS = [
+    '/** Hello World */',
+    '/** Hello\n  * World */',
+    '/**\n  * Hello World\n */',
+]
+
+
+VALID_DISPLAY_NAME_EXPRESSIONS = [
+    '"Hello"',
+    '   "Hello"  ',
+    '"Hello " + " World!"',
+]
+
+
+VALID_DISPLAY_NAMES = [
+    '@DisplayName("test")',
+    '@DisplayName(    "test"    )',
+    '@DisplayName(\n"test"\n)',
+    '@DisplayName("Hello " + " World!")',
+    '@DisplayName("Hello "\n+\n" World!")',
+]
+
+
+@pytest.mark.parametrize('text', VALID_JAVADOCS)
+def test_javadoc_parsing(text: str):
+    assert re.match(PATTERN_JAVADOC, text) is not None
+
+
+@pytest.mark.parametrize('text', VALID_DISPLAY_NAMES)
+def test_display_name_parsing(text: str):
+    assert re.match(PATTERN_DISPLAY_NAME, text) is not None
+
+
+@pytest.mark.parametrize('text', VALID_DISPLAY_NAME_EXPRESSIONS)
+def test_display_name_expressions(text: str):
+    assert re.match(PATTERN_DISPLAY_NAME_EXPRESSION, text) is not None