codeplain 0.2.3__tar.gz → 0.2.4__tar.gz

{codeplain-0.2.3 → codeplain-0.2.4}/.gitignore

@@ -27,4 +27,6 @@ build
 dist
 *.egg-info
 
-.env
+.env
+
+.coverage

{codeplain-0.2.3 → codeplain-0.2.4}/PKG-INFO

@@ -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 → codeplain-0.2.4}/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"])
 

{codeplain-0.2.3 → codeplain-0.2.4}/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
 

{codeplain-0.2.3 → codeplain-0.2.4}/install.sh

@@ -61,7 +61,7 @@ echo -e "${GREEN}✓${NC} the latest version of *codeplain CLI is now installed.
 echo ""
 echo -e "go to ${YELLOW}https://platform.codeplain.ai${NC} and sign up to get your API key."
 echo ""
-read -p "paste your API key here: " API_KEY
+read -r -p "paste your API key here: " API_KEY < /dev/tty
 echo ""
 
 if [ -z "$API_KEY" ]; then

{codeplain-0.2.3 → codeplain-0.2.4}/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")

{codeplain-0.2.3 → codeplain-0.2.4}/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

{codeplain-0.2.3 → codeplain-0.2.4}/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: "

{codeplain-0.2.3 → codeplain-0.2.4}/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

{codeplain-0.2.3 → codeplain-0.2.4}/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:

{codeplain-0.2.3 → codeplain-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codeplain"
-version = "0.2.3"
+version = "0.2.4"
 description = "Transform plain language specifications into working code"
 readme = "README.md"
 requires-python = ">=3.11"

{codeplain-0.2.3 → codeplain-0.2.4}/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", [])

{codeplain-0.2.3 → codeplain-0.2.4}/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")])