codeplain 0.2.3__py3-none-any.whl → 0.2.5__py3-none-any.whl

render_machine/render_context.py

@@ -327,7 +327,7 @@ class RenderContext:
     def start_refactoring_code(self):
 
         if self.frid_context.refactoring_iteration == 0:
-            console.info("[b]Refactoring the generated code...[/b]")
+            console.info("Refactoring the generated code...")
 
         self.frid_context.refactoring_iteration += 1
 
@@ -349,7 +349,7 @@ class RenderContext:
             self.machine.dispatch(triggers.MARK_TESTING_ENVIRONMENT_PREPARED)
 
     def start_conformance_tests_processing(self):
-        console.info("[b]Implementing conformance tests...[/b]")
+        console.info("Implementing conformance tests...")
         self.conformance_tests_running_context = ConformanceTestsRunningContext(
             current_testing_module_name=self.module_name,
             current_testing_frid=None,
@@ -444,5 +444,5 @@ class RenderContext:
     def finish_fixing_conformance_tests(self):
         if self.verbose:
             console.info(
-                f"[b]Running conformance tests attempt {self.conformance_tests_running_context.fix_attempts + 1}.[/b]"
+                f"Running conformance tests attempt {self.conformance_tests_running_context.fix_attempts + 1}."
             )

render_machine/render_utils.py

@@ -42,7 +42,7 @@ def print_inputs(render_context, existing_files_content, message):
 
 
 def execute_script(
-    script: str, scripts_args: list[str], verbose: bool, script_type: str
+    script: str, scripts_args: list[str], verbose: bool, script_type: str, frid: Optional[str] = None
 ) -> tuple[int, str, Optional[str]]:
     temp_file_path = None
     try:
@@ -68,14 +68,22 @@ def execute_script(
                     temp_file.write(f"{script_type} script {script} successfully passed.\n")
                 temp_file.write(f"{script_type} script execution time: {elapsed_time:.2f} seconds.\n")
 
-            console.info(f"[b]{script_type} script output stored in: {temp_file_path}[/b]")
+            console.info(f"[#888888]{script_type} script output stored in: {temp_file_path.strip()}[/#888888]")
 
             if result.returncode != 0:
-                console.info(
-                    f"[b]The {script_type} script has failed. Initiating the patching mode to automatically correct the discrepancies.[/b]"
-                )
+                if frid is not None:
+                    console.info(
+                        f"The {script_type} script for ID {frid} has failed. Initiating the patching mode to automatically correct the discrepancies."
+                    )
+                else:
+                    console.info(
+                        f"The {script_type} script has failed. Initiating the patching mode to automatically correct the discrepancies."
+                    )
             else:
-                console.info(f"[b]All {script_type} script passed successfully.[/b]")
+                if frid is not None:
+                    console.info(f"[#79FC96]The {script_type} script for ID {frid} has passed successfully.[/#79FC96]")
+                else:
+                    console.info(f"[#79FC96]All {script_type} script passed successfully.[/#79FC96]")
 
         return result.returncode, result.stdout, temp_file_path
     except subprocess.TimeoutExpired as e:

standard_template_library/golang-console-app-template.plain

@@ -7,14 +7,14 @@
 - :ConformanceTestsExecutableFile: is the main executable code file of :ConformanceTests:.
 
 
-***technical specs***
+***implementation reqs***
 
 - :Implementation: should be in Go lang.
 
 - :Implementation: should include unit tests using Go's built-in testing package.
 
 
-***test specs***
+***test reqs***
 
 - :ConformanceTests: should be implemented in Go lang.
 

standard_template_library/python-console-app-template.plain

@@ -7,13 +7,13 @@
 - :MainExecutableFile: is the main executable code file of :App:.
 
 
-***technical specs***
+***implementation reqs***
 
 - :Implementation: should be in Python.
 
 - :Implementation: should include :Unittests: using Unittest framework! If :Unittests: are put in the subfolder, make sure to include __init__.py to make them discoverable.
 
-***test specs***
+***test reqs***
 
 - :ConformanceTests: of :App: should be implemented in Python using Unittest framework. :ConformanceTests: will be run using "python -m unittest discover" command. Therefore, if :ConformanceTests: are put in the subfolder, make sure to include __init__.py to make them discoverable. 
 

standard_template_library/typescript-react-app-template.plain

@@ -3,7 +3,7 @@
 - :App: is a web application.
 
 
-***technical specs***
+***implementation reqs***
 
 - :App: should be implemented in TypeScript, using React as a web framework.
 
@@ -12,6 +12,6 @@
 - :App: should run on port 3000.
 
 
-***test specs***
+***test reqs***
 
 - :ConformanceTests: of :App: should be written in TypeScript, using Cypress as the framework for :ConformanceTests:.

system_config.py

@@ -1,5 +1,4 @@
 import importlib.resources
-import shutil
 import sys
 
 import yaml
@@ -12,12 +11,12 @@ class SystemConfig:
 
     def __init__(self):
         self.config = self._load_config()
-        if "system_requirements" not in self.config:
-            raise KeyError("Missing 'system_requirements' section in system_config.yaml")
+        if "client_version" not in self.config:
+            raise KeyError("Missing 'client_version' in system_config.yaml")
         if "error_messages" not in self.config:
             raise KeyError("Missing 'error_messages' section in system_config.yaml")
 
-        self.requirements = self.config["system_requirements"]
+        self.client_version = self.config["client_version"]
         self.error_messages = self.config["error_messages"]
 
     def _load_config(self):
@@ -31,13 +30,6 @@ class SystemConfig:
             console.error(f"Failed to load system configuration: {e}")
             sys.exit(69)
 
-    def verify_requirements(self):
-        """Verify all system requirements are met."""
-        for req_data in self.requirements.values():
-            if not shutil.which(req_data["command"]):
-                console.error(req_data["error_message"])
-                sys.exit(69)
-
     def get_error_message(self, message_key, **kwargs):
         """Get a formatted error message by its key."""
         if message_key not in self.error_messages:

tests/test_imports.py

@@ -27,13 +27,13 @@ def test_diamond_imports(load_test_data, get_test_data_path):
             {"markdown": "- :Import1Def: is a definition in diamond_import_1."},
             {"markdown": "- :Import2Def: is a definition in diamond_import_2."},
         ],
-        "technical specs": [
+        "implementation reqs": [
             {"markdown": "- :CommonImportDef: is used in diamond_import_common."},
             {"markdown": "- :Import1Def: is used in diamond_import_1."},
             {"markdown": "- :Import2Def: is used in diamond_import_2."},
             {"markdown": '- :MainExecutableFile: of :App: should be called "hello_world.py".'},
         ],
-        "test specs": [
+        "test reqs": [
             {"markdown": "- :CommonImportDef: is tested in diamond_import_common."},
             {"markdown": "- :Import1Def: is tested in diamond_import_1."},
             {"markdown": "- :Import2Def: is tested in diamond_import_2."},

tests/test_plainfile.py

@@ -107,7 +107,7 @@ def test_process_acceptance_tests_no_sections_direct_frs(mock_process_single):
     plain_source_tree = {
         plain_spec.FUNCTIONAL_REQUIREMENTS: mock_frs_top_level,
         "definitions": MagicMock(name="TopLevelDefs"),
-        "technical specs": MagicMock(name="TopLevelNFRs"),
+        "implementation reqs": MagicMock(name="TopLevelNFRs"),
     }
 
     process_acceptance_tests(plain_source_tree)
@@ -267,5 +267,5 @@ def test_psart_with_duplicate_acceptance_test_heading():
 
 
 def test_invalid_plain_file_extension():
-    with pytest.raises(plain_file.InvalidPlainFileExtension):
+    with pytest.raises(PlainSyntaxError):
         plain_file.plain_file_parser("test.txt", [])

tests/test_plainfileparser.py

@@ -19,7 +19,7 @@ def test_regular_plain_source(get_test_data_path):
     )
     assert plain_sections == {
         "definitions": [],
-        "technical specs": [
+        "implementation reqs": [
             {"markdown": "- First non-functional requirement."},
             {"markdown": "- Second non-functional requirement."},
         ],
@@ -36,7 +36,7 @@ def test_unknown_section():
     with pytest.raises(
         Exception,
         match=re.escape(
-            "Syntax error at line 3: Invalid specification heading (`Unknown Section:`). Allowed headings: definitions, technical specs, test specs, functional specs, acceptance tests"
+            "Syntax error at line 3: Invalid specification heading (`Unknown Section:`). Allowed headings: definitions, implementation reqs, test reqs, functional specs, acceptance tests"
         ),
     ):
         plain_file.parse_plain_source(plain_source, {}, [], [], [])
@@ -76,7 +76,7 @@ def test_plain_file_parser_with_comments(get_test_data_path):
     )
     assert plain_sections == {
         "definitions": [],
-        "technical specs": [{"markdown": "- Second non-functional requirement."}],
+        "implementation reqs": [{"markdown": "- Second non-functional requirement."}],
         "functional specs": [{"markdown": '- Display "hello, world"'}],
     }
 
@@ -88,7 +88,7 @@ def test_plain_file_parser_with_comments_indented(get_test_data_path):
     )
     assert plain_sections == {
         "definitions": [],
-        "technical specs": [
+        "implementation reqs": [
             {"markdown": "- First non-functional requirement."},
             {"markdown": "- Second non-functional requirement."},
         ],
@@ -202,7 +202,7 @@ def test_indented_include_tags():
 
 - This is a definition.
 
-***technical specs***
+***implementation reqs***
 - First non-functional requirement.
 - Second non-functional requirement.
 
@@ -230,7 +230,7 @@ def test_indented_include_tags():
 
 - This is a definition.
 
-***technical specs***
+***implementation reqs***
 - First non-functional requirement.
 - Second non-functional requirement.
 
@@ -288,7 +288,7 @@ def test_code_variables(load_test_data, get_test_data_path):
 
 - :concept: is a concept.
 
-***technical specs***
+***implementation reqs***
 - First non-functional requirement.
 - Second non-functional requirement.
 
@@ -303,7 +303,7 @@ def test_code_variables(load_test_data, get_test_data_path):
     _, plain_source, _ = plain_file.plain_file_parser("code_variables.plain", [get_test_data_path("data/templates")])
     expected_plain_source = {
         "definitions": [{"markdown": "- :concept: is a concept."}],
-        "technical specs": [
+        "implementation reqs": [
             {"markdown": "- First non-functional requirement."},
             {"markdown": "- Second non-functional requirement."},
         ],
@@ -330,7 +330,7 @@ def test_code_variables(load_test_data, get_test_data_path):
 
 - :concept: is a concept.
 
-***technical specs***
+***implementation reqs***
 - First non-functional requirement {keys[0]}.
 - Second non-functional requirement {keys[1]}.
 
@@ -345,7 +345,7 @@ def test_code_variables(load_test_data, get_test_data_path):
     _, plain_source, _ = plain_file.plain_file_parser("template_include.plain", [get_test_data_path("data/templates")])
     expected_plain_source = {
         "definitions": [{"markdown": "- :concept: is a concept."}],
-        "technical specs": [
+        "implementation reqs": [
             {
                 "markdown": "- First non-functional requirement {{ variable_name_1 }}.",
                 "code_variables": [{"name": "variable_name_1", "value": "nice_1"}],

tests/test_plainspec.py

@@ -61,7 +61,7 @@ def test_get_specifications_simple(get_test_data_path):
 
     assert specifications == {
         "definitions": [],
-        "technical specs": ["- Simple non-functional requirement"],
-        "test specs": [],
+        "implementation reqs": ["- Simple non-functional requirement"],
+        "test reqs": [],
         "functional specs": ["- Simple functional requirement"],
     }

tests/test_requires.py

@@ -1,10 +1,11 @@
 import pytest
 
 import plain_file
+from plain2code_exceptions import PlainSyntaxError
 
 
 def test_non_existent_require(get_test_data_path):
-    with pytest.raises(Exception, match="Required module not found"):
+    with pytest.raises(PlainSyntaxError, match="Module does not exist"):
         plain_file.plain_file_parser("non_existent_require.plain", [get_test_data_path("data/requires")])