codeplain 0.3.11.dev13__tar.gz → 0.3.11.dev15__tar.gz

{codeplain-0.3.11.dev13 → codeplain-0.3.11.dev15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: codeplain
-Version: 0.3.11.dev13
+Version: 0.3.11.dev15
 Summary: Transform plain language specifications into working code
 License-File: LICENSE
 Classifier: Environment :: Console

{codeplain-0.3.11.dev13 → codeplain-0.3.11.dev15}/plain_file.py

@@ -615,15 +615,45 @@ def parse_plain_source(  # noqa: C901
                 f"Plain syntax error: Syntax error at line {nested_acceptance_test_heading.line_number}: {plain_spec.ACCEPTANCE_TEST_HEADING} heading should be nested under specific functional spec."
             )
 
+    defined_concepts = set[str]()
     if plain_source[plain_spec.DEFINITIONS] is not None:
         with PlainRenderer() as renderer:
             for token in plain_source[plain_spec.DEFINITIONS].children:
                 rendered_token = renderer.render(token)
                 new_concepts, _ = concept_utils.extract_concepts_from_definition(rendered_token)
+                defined_concepts.update(new_concepts)
                 for concept in new_concepts:
                     if concept in required_concepts:
                         required_concepts.remove(concept)
 
+    if EXPORTED_CONCEPTS_DIRECTIVE in plain_source_obj.metadata:
+        module_name = modules_trace[-1] if modules_trace else None
+        subject = f"Module '{module_name}'" if module_name else "Module"
+
+        for entry in plain_source_obj.metadata[EXPORTED_CONCEPTS_DIRECTIVE]:
+            exported_concepts, errors = concept_utils.extract_concepts_from_definition(entry)
+            if errors:
+                raise PlainSyntaxError(
+                    f"Plain syntax error: {subject} exports an invalid concept (`{entry}`). "
+                    f"Expected a concept token, e.g. :ConceptName:."
+                )
+
+            for exported_concept in exported_concepts:
+                if exported_concept in concept_utils.DEFAULT_CONCEPTS:
+                    raise PlainSyntaxError(
+                        f"Plain syntax error: {subject} cannot export default concept {exported_concept}. "
+                        f"Only user-defined concepts can be exported."
+                    )
+
+                if exported_concept not in defined_concepts:
+                    message = f"Plain syntax error: {subject} exports undefined concept {exported_concept}."
+                    if REQUIRES_DIRECTIVE in plain_source_obj.metadata:
+                        message += (
+                            " An exported concept must be defined in this module's definitions or in an "
+                            "imported module; a concept inherited through requires cannot be re-exported."
+                        )
+                    raise PlainSyntaxError(message)
+
     required_modules = []
     if REQUIRES_DIRECTIVE in plain_source_obj.metadata:
         required_modules = plain_source_obj.metadata[REQUIRES_DIRECTIVE]
@@ -710,15 +740,7 @@ def process_required_modules(
         if EXPORTED_CONCEPTS_DIRECTIVE in plain_file_parse_result.plain_source_obj.metadata:
             exported_concepts = list[str]()
             for concept in plain_file_parse_result.plain_source_obj.metadata[EXPORTED_CONCEPTS_DIRECTIVE]:
-                if concept in concept_utils.DEFAULT_CONCEPTS:
-                    raise PlainSyntaxError(
-                        f"Plain syntax error: Default concept cannot be exported: {concept}. Only user-defined concepts can be exported."
-                    )
-
-                if isinstance(concept, str):
-                    exported_concepts.extend(concept_utils.extract_concepts_from_definition(concept)[0])
-                else:
-                    raise PlainSyntaxError(f"Plain syntax error: Invalid exported concept: {concept}.")
+                exported_concepts.extend(concept_utils.extract_concepts_from_definition(concept)[0])
 
             with PlainRenderer() as renderer:
                 for exported_concept in exported_concepts:
@@ -737,6 +759,9 @@ def process_exported_definitions(plain_source: dict, exported_definitions: list[
     if len(exported_definitions) == 0:
         return
 
+    if plain_source[plain_spec.DEFINITIONS] is None:
+        plain_source[plain_spec.DEFINITIONS] = mistletoe.Document("")
+
     with PlainRenderer() as renderer:
         for exported_definition in exported_definitions:
             add_defintion = True

codeplain-0.3.11.dev15/tests/data/plainfileparser/cyclic_definitions.plain

@@ -0,0 +1,9 @@
+***definitions***
+- :A: relates to :B:.
+- :B: relates to :A:.
+
+***implementation reqs***
+- The :A: concept must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :A: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_defaults_exported.plain

@@ -0,0 +1,13 @@
+---
+exported_concepts:
+    - :UnitTests:
+---
+
+***definitions***
+- :NewConcept: is a new concept.
+
+***implementation reqs***
+- The :NewConcept: must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :NewConcept: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_imported_exported.plain

@@ -0,0 +1,12 @@
+---
+import:
+    - exported_concepts_base
+exported_concepts:
+    - :Concept:
+---
+
+***implementation reqs***
+- The :Concept: concept must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :Concept: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_inherited_reexported.plain

@@ -0,0 +1,15 @@
+---
+requires:
+    - exported_concepts
+exported_concepts:
+    - :Concept:
+---
+
+***definitions***
+- :DependantConcept: depends on the :Concept: concept.
+
+***implementation reqs***
+- The :DependantConcept: concept must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :DependantConcept: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_malformed.plain

@@ -0,0 +1,13 @@
+---
+exported_concepts:
+    - not a concept at all
+---
+
+***definitions***
+- :A: is a concept.
+
+***implementation reqs***
+- The :A: concept must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :A: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_missing_definition.plain

@@ -0,0 +1,14 @@
+---
+exported_concepts:
+    - :NewConcept:
+    - :Concept:
+---
+
+***definitions***
+- :NewConcept: is a new concept.
+
+***implementation reqs***
+- The :NewConcept: must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :NewConcept: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_missing_definition_example.plain

@@ -0,0 +1,13 @@
+---
+requires:
+    - exported_concepts_missing_definition
+---
+
+***definitions***
+- :AnotherConcept: is a new concept.
+
+***implementation reqs***
+- :AnotherConcept: must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :AnotherConcept: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_multiple_per_bullet.plain

@@ -0,0 +1,14 @@
+---
+exported_concepts:
+    - :NewConcept:, :OtherConcept:
+---
+
+***definitions***
+- :NewConcept: is a new concept.
+- :OtherConcept: is another concept.
+
+***implementation reqs***
+- The :NewConcept: and :OtherConcept: concepts must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :NewConcept: and :OtherConcept: concepts.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_multiple_per_bullet_undefined.plain

@@ -0,0 +1,13 @@
+---
+exported_concepts:
+    - :NewConcept:, :OtherConcept:
+---
+
+***definitions***
+- :NewConcept: is a new concept.
+
+***implementation reqs***
+- The :NewConcept: concept must be implemented.
+
+***functional specs***
+- Implement a wrapper for the :NewConcept: concept.

codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_no_definitions.plain

@@ -0,0 +1,10 @@
+---
+exported_concepts:
+    - :Concept:
+---
+
+***implementation reqs***
+- :Implementation: is a simple wrapper.
+
+***functional specs***
+- :Implementation: has an entry point.

codeplain-0.3.11.dev13/tests/data/plainfileparser/exported_concepts_missing_example.plain → codeplain-0.3.11.dev15/tests/data/plainfileparser/exported_concepts_not_declared_example.plain

@@ -1,6 +1,6 @@
 ---
 requires:
-    - exported_concepts_missing
+    - exported_concepts_not_declared
 ---
 
 ***definitions***

codeplain-0.3.11.dev15/tests/data/plainfileparser/requires_without_definitions_example.plain

@@ -0,0 +1,10 @@
+---
+requires:
+    - exported_concepts
+---
+
+***implementation reqs***
+- The :Concept: concept must be reused.
+
+***functional specs***
+- Implement a second wrapper for the :Concept: concept.

{codeplain-0.3.11.dev13 → codeplain-0.3.11.dev15}/tests/test_plainfileparser.py

@@ -632,6 +632,11 @@ def test_concept_validation_acceptance_tests(get_test_data_path):
         )
 
 
+def test_concept_validation_cyclic_definitions(get_test_data_path):
+    with pytest.raises(PlainSyntaxError, match="cycles in the concept graph"):
+        plain_file.plain_file_parser("cyclic_definitions.plain", [get_test_data_path("data/plainfileparser")])
+
+
 def test_required_concepts(get_test_data_path):
     plain_file.plain_file_parser(
         "required_concepts_example.plain",
@@ -661,28 +666,44 @@ def test_required_concepts(get_test_data_path):
         )
 
 
-def test_exported_concepts(get_test_data_path):
-    plain_file.plain_file_parser(
+@pytest.mark.parametrize(
+    "fixture",
+    [
         "exported_concepts_example.plain",
-        [get_test_data_path("data/plainfileparser")],
-    )
-
-    plain_file.plain_file_parser(
+        "exported_concepts_imported_exported.plain",
+        "exported_concepts_multiple_per_bullet.plain",
         "exported_concepts_nested_example.plain",
+    ],
+)
+def test_exported_concepts_valid(get_test_data_path, fixture):
+    plain_file.plain_file_parser(fixture, [get_test_data_path("data/plainfileparser")])
+
+
+@pytest.mark.parametrize(
+    ("fixture", "expected_word"),
+    [
+        ("exported_concepts_defaults_exported.plain", "cannot export default concept"),
+        ("exported_concepts_inherited_reexported.plain", "cannot be re-exported"),
+        ("exported_concepts_malformed.plain", "exports an invalid concept"),
+        ("exported_concepts_missing_definition_example.plain", "'exported_concepts_missing_definition' exports"),
+        ("exported_concepts_missing_definition.plain", "exports undefined concept"),
+        ("exported_concepts_multiple_per_bullet_undefined.plain", "exports undefined concept"),
+        ("exported_concepts_no_definitions.plain", "exports undefined concept"),
+        ("exported_concepts_not_declared_example.plain", "not defined"),
+        ("exported_concepts_transitive_example.plain", "not defined"),
+    ],
+)
+def test_exported_concepts_invalid(get_test_data_path, fixture, expected_word):
+    with pytest.raises(PlainSyntaxError, match=expected_word):
+        plain_file.plain_file_parser(fixture, [get_test_data_path("data/plainfileparser")])
+
+
+def test_requires_without_definitions(get_test_data_path):
+    _, plain_source, _ = plain_file.plain_file_parser(
+        "requires_without_definitions_example.plain",
         [get_test_data_path("data/plainfileparser")],
     )
-
-    with pytest.raises(PlainSyntaxError):
-        plain_file.plain_file_parser(
-            "exported_concepts_missing_example.plain",
-            [get_test_data_path("data/plainfileparser")],
-        )
-
-    with pytest.raises(PlainSyntaxError):
-        plain_file.plain_file_parser(
-            "exported_concepts_transitive_example.plain",
-            [get_test_data_path("data/plainfileparser")],
-        )
+    assert plain_source[plain_spec.DEFINITIONS] == [{"markdown": "- :Concept: is a concept."}]
 
 
 def test_topological_sort(get_test_data_path):