strictdoc 0.0.42a3__tar.gz → 0.0.42a5__tar.gz

{strictdoc-0.0.42a3 → strictdoc-0.0.42a5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.42a3
+Version: 0.0.42a5
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/

{strictdoc-0.0.42a3 → strictdoc-0.0.42a5}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.42a3"
+__version__ = "0.0.42a5"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.42a3 → strictdoc-0.0.42a5}/strictdoc/core/project_config.py

@@ -6,6 +6,7 @@ from typing import List
 import toml
 
 from strictdoc.helpers.auto_described import auto_described
+from strictdoc.helpers.path_filter import validate_mask
 
 
 class ProjectFeature(str, Enum):
@@ -167,18 +168,57 @@ class ProjectConfigLoader:
                 "include_doc_paths", include_doc_paths
             )
             assert isinstance(include_doc_paths, list)
+            for include_doc_path in include_doc_paths:
+                try:
+                    validate_mask(include_doc_path)
+                except SyntaxError as exception:
+                    print(  # noqa: T201
+                        f"error: strictdoc.toml: 'include_doc_paths': "
+                        f"{exception} Provided string: '{include_doc_path}'."
+                    )
+                    sys.exit(1)
+
             exclude_doc_paths = project_content.get(
                 "exclude_doc_paths", exclude_doc_paths
             )
             assert isinstance(exclude_doc_paths, list)
+            for exclude_doc_path in exclude_doc_paths:
+                try:
+                    validate_mask(exclude_doc_path)
+                except SyntaxError as exception:
+                    print(  # noqa: T201
+                        f"error: strictdoc.toml: 'exclude_doc_paths': "
+                        f"{exception} Provided string: '{exclude_doc_path}'."
+                    )
+                    sys.exit(1)
+
             include_source_paths = project_content.get(
                 "include_source_paths", include_source_paths
             )
             assert isinstance(include_source_paths, list)
+            for include_source_path in include_source_paths:
+                try:
+                    validate_mask(include_source_path)
+                except SyntaxError as exception:
+                    print(  # noqa: T201
+                        f"error: strictdoc.toml: 'include_source_paths': "
+                        f"{exception} Provided string: '{include_source_path}'."
+                    )
+                    sys.exit(1)
+
             exclude_source_paths = project_content.get(
                 "exclude_source_paths", exclude_source_paths
             )
             assert isinstance(exclude_source_paths, list)
+            for exclude_source_path in exclude_source_paths:
+                try:
+                    validate_mask(exclude_source_path)
+                except SyntaxError as exception:
+                    print(  # noqa: T201
+                        f"error: strictdoc.toml: 'exclude_source_paths': "
+                        f"{exception} Provided string: '{exclude_source_path}'."
+                    )
+                    sys.exit(1)
 
         if "server" in config_dict:
             # FIXME: Introduce at least a basic validation for the host/port.

{strictdoc-0.0.42a3 → strictdoc-0.0.42a5}/strictdoc/helpers/path_filter.py

@@ -11,18 +11,33 @@ REGEX_DOUBLE_WILDCARD = (
     rf"(\\|\/)?({REGEX_NAME_PART})?((\\|\/){REGEX_NAME_PART})*(\\|\/)?"
 )
 
+REGEX_MASK_VALIDATION = rf"[^(\\|\/)]{REGEX_DOUBLE_WILDCARD}"
+
+MOST_COMMON_CHARACTERS = ("[", "]", "(", ")", "{", "}", "?", "+", "!")
+
 
 def validate_mask(mask: str):
-    assert not mask.startswith("/")
-    assert "***" not in mask
-    assert "//" not in mask
-    assert "\\" not in mask
-    assert "?" not in mask
-    assert "[" not in mask
-    assert "]" not in mask
-    assert "(" not in mask
-    assert ")" not in mask
-    assert "+" not in mask
+    if mask == "":
+        raise SyntaxError("Path mask must not be empty.")
+
+    if not mask[0].isalnum() and mask[0] != "*":
+        raise SyntaxError(
+            "Path mask must start with an alphanumeric character or "
+            "a wildcard symbol '*'."
+        )
+
+    if "//" in mask or "\\\\" in mask:
+        raise SyntaxError("Path mask must not contain double slashes.")
+
+    if "***" in mask:
+        raise SyntaxError("Invalid wildcard: '***'.")
+
+    for regex_symbol in MOST_COMMON_CHARACTERS:
+        if regex_symbol in mask:
+            raise SyntaxError(
+                f"Path mask must not contain any of the special characters: "
+                f"{MOST_COMMON_CHARACTERS}."
+            )
 
 
 def compile_regex_mask(path_mask: str) -> str:
@@ -52,8 +67,9 @@ class PathFilter:
         if len(self.filtered_paths) == 0:
             return self.positive_or_negative
 
+        portable_found_path = found_path.replace("\\", "/")
         for regex_mask in self.compiled_regex_masks:
-            regex_match = re.match(regex_mask, found_path)
+            regex_match = re.match(regex_mask, portable_found_path)
             if regex_match is not None:
                 return True