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

{codeplain-0.2.3.dist-info → codeplain-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeplain
-Version: 0.2.3
+Version: 0.2.4
 Summary: Transform plain language specifications into working code
 License-File: LICENSE
 Classifier: Environment :: Console

{codeplain-0.2.3.dist-info → codeplain-0.2.4.dist-info}/RECORD

@@ -1,25 +1,25 @@
-codeplain_REST_api.py,sha256=qfzUw9v0-NKII4ibw3vqSBrCeU2WP4RcrrEti43F3zs,18400
+codeplain_REST_api.py,sha256=NJVOwlsnDFhEySeEds4q2GUKdexTfYGp7FIW0yJqL-A,18026
 concept_utils.py,sha256=vwSY4-FmxyqaDBxhntYzqG8t9pXvAWwiULP0DYQI32o,7905
 diff_utils.py,sha256=AjiQlqo5pRos_8hVXZo5yBurl5BzSrTMGrQv4dCtRCg,1198
 event_bus.py,sha256=sduIR3bgIbxAbLhwKd8Gx9YN9gzaeqy9-mNupS04aKw,1759
 file_utils.py,sha256=4BIxzsteZQOaK-efkvQcoaIfYydsQNFR6elpsxJgXLQ,11591
-git_utils.py,sha256=gTRps6RIzJJkyy9amaDxP38FPoxYulZViBWr9V0IPQg,12414
+git_utils.py,sha256=7JFHQRzxsO7GoVzP1BO7px2cgrlqyFequbOozHDV8ig,12353
 hash_key.py,sha256=lMKgKpOhPeC4UpFf9e7eCNK20FEaDsXTCJ8j3eCWidE,837
 memory_management.py,sha256=ABrM6PhOsalP_PBq2hCazQvQX9C5rpPHhgT35l68RM4,4357
 module_renderer.py,sha256=LLjLb34phSJlF2YblwGDy5HKWVdi9mo57rr7s-Hj3RA,6261
-plain2code.py,sha256=cIxPkxfxZkPlen5RG5H_rvo22sSGYQ9PnqSlw3ECVkY,9841
+plain2code.py,sha256=vErZtqioqiIN3U3I9U2jUeL7ti_Z38RPcGT0Wuz0xeE,9632
 plain2code_arguments.py,sha256=PdQjd3orklrtlEyz7-Qdz_m2SvjZtZp6dmbkqXgglSU,11826
 plain2code_console.py,sha256=-QorOFimS1AWYK7dmFqI3uhjc51cPtEWsaK4DhFibIw,4139
 plain2code_events.py,sha256=5fPhpRzgJ02xWh0MXqrMv9A4curr2UOE68Y1uKlAcqQ,1347
-plain2code_exceptions.py,sha256=Y_2Jmv9rLE5xMqlzp_mDcAIIYsIfS0yR1U3scXUzUng,760
+plain2code_exceptions.py,sha256=eFvJvFeClFR1MY68zHwPKbNy89ya4iaYSaFRE2GWkTE,929
 plain2code_logger.py,sha256=xSDGN8QAWpA4J6YKyj-kfNWSO-jBl0sfUCFRs7Tflf0,4067
 plain2code_nodes.py,sha256=Om624mfb5MB1Z09c0Zqtb9G1gGkUY9x-v2hzAf3A2gw,3818
 plain2code_read_config.py,sha256=QnpbW_Bi9LzDIOubM5x7fVXH1HgiFL3-5Oa_O1EUoE4,2449
 plain2code_state.py,sha256=InLXdytMXnm9YC4o8MSTbtB1TmqYYUs6rASGBlyA_YY,1274
 plain2code_utils.py,sha256=3xPXWci5yVdpdK_WrNcbinSV94XSeMQDW5UzDuBMaUM,1767
-plain_file.py,sha256=OXbWvErVTVhaeRFUu9f0bzi16P01DShW_jLhNI-tmeA,28931
-plain_modules.py,sha256=iDqqamtix5KahMC_v-vfQ7yndugmqtBW1z6XxTB4x6w,4876
-plain_spec.py,sha256=zC-VOb_UJOs8OxtEiwQJuonw7Lkmbi7YHyFvvCvUZNo,13529
+plain_file.py,sha256=lF0ZwK_Hycc4rdaHPxJSfe7mfkRYo5QgMngv50AsF74,28430
+plain_modules.py,sha256=6gteJeiK-WvUZDrIt_kJK0MFiptq63rEVpYvV5yYFXc,4881
+plain_spec.py,sha256=jU4dMVoWumkTK-IBdgXsH4-EnAdyRWxR9dI-lHreEyM,13535
 spinner.py,sha256=Ro6Gd9Przf-whuHqPRY6HwI0T57yJjyNPbhDbigZKZE,2471
 system_config.py,sha256=mgHLn-CRHLO9Y9vKyI_eFBreY_YhFad-ctZgBYp-rIg,1777
 config/__init__.py,sha256=beYSsJWmBNHDP5rYmVDouqgEeP3t1lkkepbXJ-oq0F8,37
@@ -63,10 +63,10 @@ tests/__init__.py,sha256=Wk73Io62J15BtlLVIzxmASDWaaJkQLevS4BLK5LDAQg,16
 tests/conftest.py,sha256=QZcp08htUlJGgmHDlRWFgsWXZ8o8IBWTD5QqJaUMlU8,790
 tests/test_git_utils.py,sha256=Knc4R2ZkHYVj9iPFKhb0_ewaad_mxPrakOn6gpziHMc,13138
 tests/test_imports.py,sha256=cdw7u93xNFD064sjwwEWy4oLHhJNlt1-DRDYhHjymFw,2078
-tests/test_plainfile.py,sha256=N3f59hpxOO5zULdBtmXZM6KO2PKADoOL5d3WxNTUYXg,11106
+tests/test_plainfile.py,sha256=gUw58XP3PUCDrZxXkrIUNPszlnqY4yW2io3xg6F3ySQ,11086
 tests/test_plainfileparser.py,sha256=9B9r2jEeUKDMhqb4TJEPK7aatYl1op1z92GDAD4fJ20,18685
 tests/test_plainspec.py,sha256=ouS899oejStu8u1D3399y5NAxcKlNbLcinNoxZUp59M,2437
-tests/test_requires.py,sha256=u8wY-UI7Ryat84htaI0yFXpl-PjX7G90EnMKM35S6No,1182
+tests/test_requires.py,sha256=BwlZeLXIs4m-FGnjLjO4vHkxfEX_QgjYoomb3oIu7Vs,1236
 tui/__init__.py,sha256=_fy7FowY0RkWdn4kC7XV2jgvQPCj-2gE8fNUb-Mny0A,60
 tui/components.py,sha256=l7f-jLk0sj9WM8z2IpaHksmSyytXe_bl2GBdHASoIg4,13901
 tui/models.py,sha256=KMjlWubmPD41GA-BjgiqkaV9v7tLJ0fuWKBDPmZj4JA,1493
@@ -74,8 +74,8 @@ tui/plain2code_tui.py,sha256=7agVU0NnaCuF1LuOSEmjx-XfEOQ6HHr1HlWe_b1Tses,11695
 tui/state_handlers.py,sha256=HbjgaV-9xGhp3E-3X114zOqPkeNcCjT-R1PbVRxVdso,12674
 tui/styles.css,sha256=Umm2TLePmywizZGV4Nd8UezZRiK5pFyibYRbpRvGqbs,3056
 tui/widget_helpers.py,sha256=VJorEM2PjRBzN-jIDmKJPolFgo2d8-2NmTumgC5xeNo,5229
-codeplain-0.2.3.dist-info/METADATA,sha256=8GLBTQ7B-NEivsGSRPlOqsTvnFnvkAsF6qyjAAQ0yRc,4278
-codeplain-0.2.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-codeplain-0.2.3.dist-info/entry_points.txt,sha256=oDZkBqu9WhtZApb_K6ia8-fn9aojwmAsgnKELceX5T4,46
-codeplain-0.2.3.dist-info/licenses/LICENSE,sha256=wsFi5dpbJurnRNfBj8q2RCcF3ryrmdRIfxc3lPcmc4c,1069
-codeplain-0.2.3.dist-info/RECORD,,
+codeplain-0.2.4.dist-info/METADATA,sha256=HTXpXKt_9V_qDoBoOuuGi-bDsWQ-nGQeItUOOWCaSxQ,4278
+codeplain-0.2.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+codeplain-0.2.4.dist-info/entry_points.txt,sha256=oDZkBqu9WhtZApb_K6ia8-fn9aojwmAsgnKELceX5T4,46
+codeplain-0.2.4.dist-info/licenses/LICENSE,sha256=wsFi5dpbJurnRNfBj8q2RCcF3ryrmdRIfxc3lPcmc4c,1069
+codeplain-0.2.4.dist-info/RECORD,,

codeplain_REST_api.py

@@ -65,12 +65,6 @@ class CodeplainAPI:
                     if response_json["error_code"] == "PlainSyntaxError":
                         raise plain2code_exceptions.PlainSyntaxError(response_json["message"])
 
-                    if response_json["error_code"] == "OnlyRelativeLinksAllowed":
-                        raise plain2code_exceptions.OnlyRelativeLinksAllowed(response_json["message"])
-
-                    if response_json["error_code"] == "LinkMustHaveTextSpecified":
-                        raise plain2code_exceptions.LinkMustHaveTextSpecified(response_json["message"])
-
                     if response_json["error_code"] == "NoRenderFound":
                         raise plain2code_exceptions.NoRenderFound(response_json["message"])
 

git_utils.py

@@ -4,6 +4,7 @@ from typing import Optional, Union
 from git import Repo
 
 import file_utils
+from plain2code_exceptions import InvalidGitRepositoryError
 
 FUNCTIONAL_REQUIREMENT_IMPLEMENTED_COMMIT_MESSAGE = (
     "[Codeplain] Implemented code and unit tests for functional requirement {}"
@@ -25,12 +26,6 @@ MODULE_NAME_MESSAGE = "Module name: {}"
 RENDER_ID_MESSAGE = "Render ID: {}"
 
 
-class InvalidGitRepositoryError(Exception):
-    """Raised when the git repository is in an invalid state."""
-
-    pass
-
-
 def _get_full_commit_message(message, module_name, frid, render_id) -> str:
     full_message = message
 

plain2code.py

@@ -17,7 +17,7 @@ from event_bus import EventBus
 from module_renderer import ModuleRenderer
 from plain2code_arguments import parse_arguments
 from plain2code_console import console
-from plain2code_exceptions import MissingAPIKey, PlainSyntaxError
+from plain2code_exceptions import InvalidFridArgument, MissingAPIKey, PlainSyntaxError
 from plain2code_logger import (
     CrashLogHandler,
     IndentedFormatter,
@@ -46,10 +46,6 @@ UNRECOVERABLE_ERROR_EXIT_CODES = [69]
 TIMEOUT_ERROR_EXIT_CODE = 124
 
 
-class InvalidFridArgument(Exception):
-    pass
-
-
 def get_render_range(render_range, plain_source):
     render_range = render_range.split(",")
     range_end = render_range[1] if len(render_range) == 2 else render_range[0]
@@ -227,23 +223,20 @@ def main():
 
         render(args, run_state, codeplain_api, event_bus)
     except InvalidFridArgument as e:
-        console.error(f"Error rendering plain code: {str(e)}.\n")
+        console.error(f"Invalid FRID argument: {str(e)}.\n")
         # No need to print render ID since this error is going to be thrown at the very start so user will be able to
         # see the render ID that's printed at the very start of the rendering process.
         dump_crash_logs(args)
     except FileNotFoundError as e:
-        console.error(f"Error rendering plain code: {str(e)}\n")
+        console.error(f"File not found: {str(e)}\n")
         console.debug(f"Render ID: {run_state.render_id}")
         dump_crash_logs(args)
-    except plain_file.InvalidPlainFileExtension as e:
-        console.error(f"Error rendering plain code: {str(e)}\n")
-        dump_crash_logs(args)
     except TemplateNotFoundError as e:
-        console.error(f"Error: Template not found: {str(e)}\n")
+        console.error(f"Template not found: {str(e)}\n")
         console.error(system_config.get_error_message("template_not_found"))
         dump_crash_logs(args)
     except PlainSyntaxError as e:
-        console.error(f"Error rendering plain code: {str(e)}\n")
+        console.error(f"Plain syntax error: {str(e)}\n")
         dump_crash_logs(args)
     except KeyboardInterrupt:
         console.error("Keyboard interrupt")

plain2code_exceptions.py

@@ -25,25 +25,35 @@ class PlainSyntaxError(Exception):
     pass
 
 
-class OnlyRelativeLinksAllowed(Exception):
+class NoRenderFound(Exception):
     pass
 
 
-class LinkMustHaveTextSpecified(Exception):
+class MultipleRendersFound(Exception):
     pass
 
 
-class NoRenderFound(Exception):
+class UnexpectedState(Exception):
     pass
 
 
-class MultipleRendersFound(Exception):
+class MissingAPIKey(Exception):
     pass
 
 
-class UnexpectedState(Exception):
+class InvalidFridArgument(Exception):
     pass
 
 
-class MissingAPIKey(Exception):
+class InvalidGitRepositoryError(Exception):
+    """Raised when the git repository is in an invalid state."""
+
+    pass
+
+
+class InvalidLiquidVariableName(Exception):
+    pass
+
+
+class ModuleDoesNotExistError(Exception):
     pass

plain_file.py

@@ -44,22 +44,6 @@ class PlainFileParseResult:
     required_concepts: list[str]
 
 
-class OnlyRelativeLinksAllowed(Exception):
-    pass
-
-
-class LinkMustHaveTextSpecified(Exception):
-    pass
-
-
-class InvalidPlainFileExtension(Exception):
-    pass
-
-
-class PlainModuleNotFound(Exception):
-    pass
-
-
 class PlainRenderer(MarkdownRenderer):
     def render_link(self, token: Link) -> Iterable[Fragment]:
         yield from self.embed_span(
@@ -95,12 +79,12 @@ def check_section_for_linked_resources(section):
     for link in traverse(section, klass=Link):
         parsed_url = urlparse(link.node.target)
         if parsed_url.scheme != "" or os.path.isabs(link.node.target):
-            raise OnlyRelativeLinksAllowed(
+            raise PlainSyntaxError(
                 f"Only relative links are allowed (text: {link.node.children[0].content}, target: {link.node.target})."
             )
 
         if len(link.node.children) != 1:
-            raise LinkMustHaveTextSpecified(f"Link must have text specified (link: {link.node.target}).")
+            raise PlainSyntaxError(f"Link must have text specified (link: {link.node.target}).")
 
         linked_resources.append({"text": link.node.children[0].content, "target": link.node.target})
 
@@ -529,7 +513,7 @@ def parse_plain_source(  # noqa: C901
 def read_module_plain_source(module_name: str, template_dirs: list[str]) -> str:
     plain_source_text = file_utils.open_from(template_dirs, module_name + PLAIN_SOURCE_FILE_EXTENSION)
     if plain_source_text is None:
-        raise PlainModuleNotFound(f"Module does not exist ({module_name}).")
+        raise PlainSyntaxError(f"Module does not exist ({module_name}).")
     return plain_source_text
 
 
@@ -566,12 +550,9 @@ def process_required_modules(
         if len(all_required_modules) > 0 and module_name == all_required_modules[-1]:
             continue
 
-        try:
-            plain_file_parse_result = parse_plain_file(
-                module_name, code_variables, template_dirs, imported_modules=[], modules_trace=[]
-            )
-        except PlainModuleNotFound:
-            raise PlainSyntaxError(f"Required module not found ({module_name}).")
+        plain_file_parse_result = parse_plain_file(
+            module_name, code_variables, template_dirs, imported_modules=[], modules_trace=[]
+        )
 
         if len(plain_file_parse_result.required_modules) == 0:
             if len(all_required_modules) > 0:
@@ -644,7 +625,7 @@ def plain_file_parser(  # noqa: C901
     # and we need to pass them to the marshalled_plain_source_tree after it's rendered
     plain_source_file_path = Path(plain_source_file_name)
     if plain_source_file_path.suffix != PLAIN_SOURCE_FILE_EXTENSION:
-        raise InvalidPlainFileExtension(
+        raise PlainSyntaxError(
             f"Invalid plain file extension: {plain_source_file_path.suffix}. Expected: {PLAIN_SOURCE_FILE_EXTENSION}."
         )
 
@@ -652,16 +633,13 @@ def plain_file_parser(  # noqa: C901
 
     code_variables = {}
 
-    try:
-        plain_file_parse_result = parse_plain_file(
-            module_name,
-            code_variables,
-            template_dirs,
-            imported_modules=[],
-            modules_trace=[],
-        )
-    except PlainModuleNotFound as e:
-        raise PlainSyntaxError(e.message)
+    plain_file_parse_result = parse_plain_file(
+        module_name,
+        code_variables,
+        template_dirs,
+        imported_modules=[],
+        modules_trace=[],
+    )
 
     if len(plain_file_parse_result.required_concepts) > 0:
         missing_required_concepts_msg = "Missing required concepts: "

plain_modules.py

@@ -7,6 +7,7 @@ from git.exc import NoSuchPathError
 
 import git_utils
 import plain_spec
+from plain2code_exceptions import ModuleDoesNotExistError
 from render_machine.implementation_code_helpers import ImplementationCodeHelpers
 
 CODEPLAIN_MEMORY_SUBFOLDER = ".memory"
@@ -16,10 +17,6 @@ MODULE_FUNCTIONALITIES = "functionalities"
 REQUIRED_MODULES_FUNCTIONALITIES = "required_modules_functionalities"
 
 
-class ModuleDoesNotExistError(Exception):
-    pass
-
-
 class PlainModule:
     def __init__(self, name: str, build_folder: str):
         self.name = name

plain_spec.py

@@ -5,6 +5,8 @@ from typing import Optional
 
 from liquid2.filter import with_context
 
+from plain2code_exceptions import InvalidLiquidVariableName
+
 DEFINITIONS = "definitions"
 NON_FUNCTIONAL_REQUIREMENTS = "technical specs"
 TEST_REQUIREMENTS = "test specs"
@@ -23,10 +25,6 @@ ALLOWED_SPECIFICATION_HEADINGS = [
 ALLOWED_IMPORT_SPECIFICATION_HEADINGS = [DEFINITIONS, NON_FUNCTIONAL_REQUIREMENTS, TEST_REQUIREMENTS]
 
 
-class InvalidLiquidVariableName(Exception):
-    pass
-
-
 def collect_specification_linked_resources(specification, specification_heading, linked_resources_list):
     linked_resources = []
     if "linked_resources" in specification:

tests/test_plainfile.py

@@ -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_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")])