plain-parser 0.1.2.dev4__tar.gz → 0.1.2.dev5__tar.gz

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: plain-parser
-Version: 0.1.2.dev4
+Version: 0.1.2.dev5
 Summary: Parser for ***plain specification files
 License-Expression: MIT
 License-File: LICENSE

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/src/plain_parser/concept_utils.py

@@ -200,14 +200,14 @@ def sort_definitions(definitions: list[dict]) -> list[dict]:
             concept_graph.add_node(node)
 
     if not nx.is_directed_acyclic_graph(concept_graph):
-        msg = "Found cycles in the concept graph. Cycles are not allowed."
+        msg = "Found cycles in the concept graph. Cycles are not allowed. "
         all_cycles = list(nx.simple_cycles(concept_graph))
 
         for cycle in all_cycles:
             cyclic_definitions = []
             cyclic_definitions.append(concept_definitions[cycle[0]]["markdown"])
             cyclic_definitions.append(concept_definitions[cycle[1]]["markdown"])
-            msg += "Cyclic definitons:\n"
+            msg += "Cyclic definitions:\n"
             msg += "\n".join(cyclic_definitions)
             msg += "\n"
 

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/src/plain_parser/loaders.py

@@ -3,10 +3,10 @@ import re
 from typing import Optional
 
 from liquid2 import Environment, FileSystemLoader, StrictUndefined
-from liquid2.exceptions import UndefinedError
+from liquid2.exceptions import LiquidSyntaxError, UndefinedError
 
 from plain_parser import plain_spec
-from plain_parser.exceptions import UnsupportedBase64Content, UnsupportedResourceType
+from plain_parser.exceptions import PlainSyntaxError, UnsupportedBase64Content, UnsupportedResourceType
 from plain_parser.liquid_nodes import Plain2CodeIncludeTag, Plain2CodeLoaderMixin
 
 MAX_BASE64_BLOB_LENGTH = 8192
@@ -95,7 +95,20 @@ class TrackingFileSystemLoader(Plain2CodeLoaderMixin, FileSystemLoader):
         return source
 
 
-def get_loaded_templates(source_path, plain_source):
+def liquid_error_message(error: LiquidSyntaxError) -> str:
+    # Built from attributes: str() of some liquid2 syntax errors (e.g. an unterminated `{{ x`) raises ValueError.
+    template_name = error.template_name or None
+    token = error.token
+    if token is None or token.start < 0:
+        where = f" in {template_name}" if template_name else ""
+    else:
+        line = token.source[: token.start].count("\n") + 1
+        column = token.start - (token.source.rfind("\n", 0, token.start) + 1)
+        where = f" at {template_name}:{line}:{column}" if template_name else f" at {line}:{column}"
+    return f"Plain syntax error: Invalid Liquid{where}: {error.message}"
+
+
+def get_loaded_templates(source_path, plain_source, template_name=None):
     # Render the plain source with Liquid templating engine
     # to identify the templates that are being loaded
 
@@ -106,9 +119,11 @@ def get_loaded_templates(source_path, plain_source):
     liquid_env.filters["code_variable"] = plain_spec.code_variable_liquid_filter
     liquid_env.filters["prohibited_chars"] = plain_spec.prohibited_chars_liquid_filter
 
-    plain_source_template = liquid_env.from_string(plain_source)
     try:
+        plain_source_template = liquid_env.from_string(plain_source, name=template_name or "")
         plain_source = plain_source_template.render()
+    except LiquidSyntaxError as e:
+        raise PlainSyntaxError(liquid_error_message(e))
     except UndefinedError as e:
         raise Exception(f"Undefined liquid variable: {str(e)}")
 

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/src/plain_parser/plain_file.py

@@ -240,7 +240,7 @@ def _is_acceptance_test_heading(token) -> tuple[bool, str | None]:
     content = strong_children[0].content.strip()
     if content == plain_spec.ACCEPTANCE_TEST_HEADING:
         return True, None
-    problem = f"Syntax error at line {token.line_number}: Invalid acceptance test heading (`{content}`). Expected: `{plain_spec.ACCEPTANCE_TEST_HEADING}.`"
+    problem = f"Syntax error at line {token.line_number}: Invalid acceptance test heading (`{content}`). Expected: `{plain_spec.ACCEPTANCE_TEST_HEADING}`."
     return False, problem
 
 
@@ -508,6 +508,7 @@ def parse_plain_source(  # noqa: C901
     template_dirs: list[str],
     imported_modules: list[str],
     modules_trace: list[str],
+    module_name: str | None = None,
 ) -> PlainFileParseResult:
     plain_source_text = normalize_line_endings(plain_source_text)
 
@@ -527,7 +528,7 @@ def parse_plain_source(  # noqa: C901
     else:
         required_concepts = list[str]()
 
-    [_, loaded_templates] = loaders.get_loaded_templates(template_dirs, plain_source_text)
+    [_, loaded_templates] = loaders.get_loaded_templates(template_dirs, plain_source_text, module_name)
 
     plain_source_content = restore_stripped_lines(plain_source_text, plain_source_obj.content)
 
@@ -585,7 +586,7 @@ def parse_plain_source(  # noqa: C901
 
             if specification_heading == plain_spec.DEFINITIONS and current_specification_heading is not None:
                 raise PlainSyntaxError(
-                    f"Plain syntax error: Syntax error at line {token.line_number}: Definitions specification must be the first specification in the section  (`{token_text}`)"
+                    f"Plain syntax error: Syntax error at line {token.line_number}: Definitions specification must be the first specification in the section (`{token_text}`)"
                 )
 
             current_specification_heading = specification_heading
@@ -602,7 +603,7 @@ def parse_plain_source(  # noqa: C901
 
         else:
             raise PlainSyntaxError(
-                f"Plain syntax error: Syntax error at line {token.line_number}: Invalid source structure  (`{token_text}`)"
+                f"Plain syntax error: Syntax error at line {token.line_number}: Invalid source structure (`{token_text}`)"
             )
 
     # Acceptance tests are only allowed nested under functional specs. Reject them when
@@ -681,8 +682,8 @@ def read_module_plain_source(module_name: str, template_dirs: list[str]) -> str:
     if blob is not None:
         raise UnsupportedBase64Content(
             f"Module '{module_name}' contains a base64-encoded blob ({len(blob)} characters) "
-            "inlined in the specification. This is not supported."
-            "Remove the base64 data from the .plain file or if necessary,"
+            "inlined in the specification. This is not supported. "
+            "Remove the base64 data from the .plain file or if necessary, "
             "include the binary file path in the specification."
         )
 
@@ -704,6 +705,7 @@ def parse_plain_file(
         template_dirs,
         imported_modules,
         modules_trace + [module_name],
+        module_name=module_name,
     )
 
 

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/src/plain_parser/plain_spec.py

@@ -126,7 +126,7 @@ def collect_linked_resources(
 ):
 
     if not isinstance(plain_source_tree, dict):
-        raise ValueError("[plain_source_tree must be a dictionary.")
+        raise ValueError("plain_source_tree must be a dictionary.")
 
     if frid is not None:
         functional_requirements = get_frids(plain_source_tree)

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/tests/data/plainfileparser/concept_validation_noconcepts.plain

@@ -1,4 +1,3 @@
-# "hello, world" in Plain (Python version)
 
 ***definitions***
 

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/tests/data/plainfileparser/concept_validation_redefinition.plain

@@ -1,4 +1,3 @@
-# "hello, world" in Plain (Python version)
 
 ***definitions***
 

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/tests/data/plainfileparser/required_concepts_example.plain

@@ -1,5 +1,5 @@
 ---
-import 
+import:
     - required_concepts
 ---
 

plain_parser-0.1.2.dev5/tests/data/templates/malformed_tag.plain

@@ -0,0 +1,4 @@
+***functional specs***
+
+{% if %}
+- A :User: can add a :Task:.

plain_parser-0.1.2.dev5/tests/data/templates/unterminated_output.plain

@@ -0,0 +1,3 @@
+***functional specs***
+
+- A :User: can add a {{ task_name

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/tests/test_loaders.py

@@ -1,4 +1,5 @@
 import os
+import re
 import tempfile
 
 import pytest
@@ -137,3 +138,47 @@ def test_resolve_linked_resource_directory_in_first_dir_shadows_file_in_second()
             f.write("x")
 
         assert resolve_linked_resource([first, second], "notes.md") == os.path.join(first, "notes.md")
+
+
+def _load_template_fixture(name):
+    path = os.path.join(os.path.dirname(__file__), "data", "templates", f"{name}.plain")
+    with open(path, encoding="utf-8") as f:
+        return os.path.dirname(path), f.read()
+
+
+def test_get_loaded_templates_malformed_tag_raises_plain_syntax_error():
+    from plain_parser.exceptions import PlainSyntaxError
+    from plain_parser.loaders import get_loaded_templates
+
+    directory, source = _load_template_fixture("malformed_tag")
+
+    with pytest.raises(
+        PlainSyntaxError,
+        match=re.escape("Plain syntax error: Invalid Liquid at malformed_tag:3:0: "),
+    ):
+        get_loaded_templates([directory], source, "malformed_tag")
+
+
+def test_get_loaded_templates_unterminated_output_raises_plain_syntax_error():
+    from plain_parser.exceptions import PlainSyntaxError
+    from plain_parser.loaders import get_loaded_templates
+
+    directory, source = _load_template_fixture("unterminated_output")
+
+    with pytest.raises(
+        PlainSyntaxError,
+        match=re.escape("Plain syntax error: Invalid Liquid at unterminated_output:4:0: "),
+    ):
+        get_loaded_templates([directory], source, "unterminated_output")
+
+
+def test_liquid_error_message_without_position():
+    from liquid2.exceptions import LiquidSyntaxError
+
+    from plain_parser.loaders import liquid_error_message
+
+    error = LiquidSyntaxError("missing expression", token=None, template_name="header")
+    assert liquid_error_message(error) == "Plain syntax error: Invalid Liquid in header: missing expression"
+
+    error = LiquidSyntaxError("missing expression", token=None)
+    assert liquid_error_message(error) == "Plain syntax error: Invalid Liquid: missing expression"

{plain_parser-0.1.2.dev4 → plain_parser-0.1.2.dev5}/tests/test_plainfileparser.py

@@ -62,7 +62,7 @@ code block
 """
     with pytest.raises(
         Exception,
-        match=re.escape("Syntax error at line 3: Invalid source structure  (`code block`)"),
+        match=re.escape("Syntax error at line 3: Invalid source structure (`code block`)"),
     ):
         plain_file.parse_plain_source(plain_source, {}, [], [], [])
 
@@ -602,7 +602,7 @@ def test_concept_validation_definitions(get_test_data_path):
         [get_test_data_path("data/plainfileparser")],
     )
 
-    with pytest.raises(PlainSyntaxError):
+    with pytest.raises(PlainSyntaxError, match=re.escape("Invalid definition specification text")):
         plain_file.plain_file_parser(
             "concept_validation_noconcepts.plain",
             [get_test_data_path("data/plainfileparser")],
@@ -635,7 +635,7 @@ def test_concept_validation_usage(get_test_data_path):
 
 
 def test_concept_validation_redefinition(get_test_data_path):
-    with pytest.raises(PlainSyntaxError):
+    with pytest.raises(PlainSyntaxError, match=re.escape("Concepts were defined multiple times")):
         plain_file.plain_file_parser(
             "concept_validation_redefinition.plain",
             [get_test_data_path("data/plainfileparser")],
@@ -771,3 +771,11 @@ def test_topological_sort(get_test_data_path):
         {"markdown": "- :Concept4: is a concept that depends on the :Concept3: concept."},
         {"markdown": "- :Concept6: is a concept that depends on the :Concept1: and :Concept4: concepts."},
     ]
+
+
+def test_liquid_syntax_error_names_module(get_test_data_path):
+    with pytest.raises(
+        PlainSyntaxError,
+        match=re.escape("Plain syntax error: Invalid Liquid at unterminated_output:4:0: "),
+    ):
+        plain_file.plain_file_parser("unterminated_output.plain", [get_test_data_path("data/templates")])