codeplain 0.3.8__py3-none-any.whl → 0.3.9__py3-none-any.whl

{codeplain-0.3.8.dist-info → codeplain-0.3.9.dist-info}/METADATA

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

{codeplain-0.3.8.dist-info → codeplain-0.3.9.dist-info}/RECORD

@@ -4,13 +4,14 @@ concept_utils.py,sha256=D4qVHFBRvfJZwiIq1AD_SV0Ev-RnOMg2yGWo6Cal7PM,7913
 diff_utils.py,sha256=AjiQlqo5pRos_8hVXZo5yBurl5BzSrTMGrQv4dCtRCg,1198
 event_bus.py,sha256=g5XLwRfjrvTIcB6urjREuCJzZj5TA93hy8lKXLGXuCE,650
 file_utils.py,sha256=MNZ5li1ofIMOYB6FCrMa_UkX6nkGCgSZuaqzhqVc1Ok,11682
-git_utils.py,sha256=LQQnL5DAFpH5fDBQgUZX2WfjWY4YC5OEGBPIXryTmnY,16896
-memory_management.py,sha256=nHNudgaOqp5UGkIMi62TRCc2nUeFOM0w-I1FfxBFaQE,6120
-module_renderer.py,sha256=DZCIo_QzvhFw8EqQTKeF3HUbvfumrV2O1sz-gUhWpIA,6752
+git_utils.py,sha256=gCUA6_9zg19f6k_0aVcRnIVlAJSBD0Vt6takx-0pKME,16547
+memory_management.py,sha256=SPoK0BXB9_yDyrrOKjFtOOlKkJIq0I5EXV7dE0OsE8g,5972
+metadata_utils.py,sha256=YO17o7IAma5TT1ZN0pTwrLVr_KxFQ8APv02KqKPpI5k,1641
+module_renderer.py,sha256=AUbjGiE6USMe-uTfbOs9gEQSEMzO9qLwGTxy3_tC_M4,6615
 partial_rendering.py,sha256=0ChOaGytogBUEGISpbWkbjT9Hqy8pnOkJdJXcitJDgk,12219
 path_resolution.py,sha256=0tMqU0a1g4DYhTOp7QjLVSEkv_cgasb4NI1mK809dUM,2233
-plain2code.py,sha256=YLwwzAvE0EWz51V9p8b_kbTltkPvhA2Q8J4JrYyMrAM,15327
-plain2code_arguments.py,sha256=3tAA9Haw-j97zztjXdhi6LxFtURP0Tfg9J_rvJDoXmw,17685
+plain2code.py,sha256=Hai5_Ho1nY0Hau7Y6QEGkYeg8NKVx5jDMtQV0UVHsLU,15706
+plain2code_arguments.py,sha256=knY7gqfpj2IKnPSl-dEdxBUpzrbohEQXamNYkFVC00Y,17426
 plain2code_console.py,sha256=Ifs8tmfNX31UujQ5_0sk9AJcajMG_6qhF-6QZcfbcEE,5773
 plain2code_events.py,sha256=rgDF5PDtNr_lEPvJmd1tIQXZrzwgzZW5b-_pykugqe4,1587
 plain2code_exceptions.py,sha256=wkkEXw2k4LCd09PIH3_Hu0HyZvtXYjFaA653Sfey4FA,2287
@@ -18,12 +19,12 @@ plain2code_logger.py,sha256=NRPLVIMnCHNVl6dII9gFoIzMdr8xa7icnL0T_Fx2XLw,4839
 plain2code_nodes.py,sha256=IwjQqJxRSJKgP6eEnkYGy3VQHIyoazgkFxAEkxkjfJ8,4426
 plain2code_read_config.py,sha256=D5CxnmTRjddupecWvstcUm0kIJWWzq5-Zmk6sU0wbIg,2235
 plain2code_state.py,sha256=uePQlC29Pbhm1yXfdCFebONYdy6jo13gTTmXSwC11cQ,3168
-plain2code_telemetry.py,sha256=7yuTH7mQE_wGVW2H1oiVZ3UJg98ArB5HcUUm9isnv9g,4354
+plain2code_telemetry.py,sha256=e4UCAoFklJMDWGQsL50i7nTLiOBy8gs86A0XO4WLgPo,4597
 plain2code_utils.py,sha256=unOxuqSQRpwG8YF6uoQhnZ3ZSTJRIUCPLdJ-1lRZR5M,1534
 plain_file.py,sha256=k2rcq53q0kOf9_8egrZILpkrVkZdfJt7HU0gHBFskU4,35116
-plain_modules.py,sha256=uvRPfxBJwstaWi5lgYKgtQdhhf0Naiy2mS41tLw_TjY,16186
+plain_modules.py,sha256=VgOwEWVhp7dyRs5NM-jVaC5GKn8KzT1sWuSNkM7YLIA,17375
 plain_spec.py,sha256=7nb5lLJKHZ3uu9THkSXyJ5brIKkbGW0ooVfRclLdlzA,16062
-system_config.py,sha256=VyE6MhXfi6agZvE02p_G4K8yCHkLh3eu890cBzPyDvs,2196
+system_config.py,sha256=nyeDS1WkyA-5m3TflB_XMDyhBvC-tVRAG3VgJaZYG_M,3694
 usage_summary.py,sha256=MA4WcVaAwz6IWCN4k_rgxVcwO4I157wN7BZlFi3h0R4,1282
 cli_output/__init__.py,sha256=MBKl0YbVpWE-tBa3V5_aVbB7vbaqlIK2NsHTjRUZqis,284
 cli_output/dry_run.py,sha256=6NKhNWPtD0CBK_QHSsSqIKLTzibTwxS9d8ltP9d1bgU,1473
@@ -35,11 +36,11 @@ docs/generate_cli.py,sha256=0FHVhICbM8g7ahdInTNih3hNKpty1wbV5rdGECMJj48,656
 examples/example_hello_world_python/harness_tests/hello_world_display/test_hello_world.py,sha256=dwTowrHiVKKbrDv21v8xJC30Q57AXZkQasdGOO5JsBE,470
 render_machine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 render_machine/code_renderer.py,sha256=-vp_ltU7e3ssX9hbS8IY4ETSp-39JAuoJ3ZltKpdt1M,3959
-render_machine/conformance_tests.py,sha256=MeEveEGJTClLGxWw04P4TR6U9kX9Qgz9qtxNrB9a8QI,7085
+render_machine/conformance_tests.py,sha256=jvdWRx-ZURSq4JMase1svKzYJ98Lc4svPvfHXglHeFE,7163
 render_machine/implementation_code_helpers.py,sha256=LdHNLoKgVtrDaGH2APX8C9vjNjLBUhu2V7OAaJvm4rM,2009
-render_machine/render_context.py,sha256=eoaO807LntIRYjLSpc3x7bvwBnFfzLlHmKkyKlIRrxs,25697
+render_machine/render_context.py,sha256=pdosCY7QMzfPy-cJxEsiM9m4I5K2CoNJ7N-5Fzg0NdU,25584
 render_machine/render_types.py,sha256=cT3D0lmxQ3enIo0jGp3LEGCY2t3X1Q1_tqwcadzSAv0,8761
-render_machine/render_utils.py,sha256=Jb9NJ73yV1qCfGy9S5A9zcnz0FGVt3MHG8Ofk-9A-aI,9355
+render_machine/render_utils.py,sha256=yA3X15E_Lebk_-MxkSz9rM_qy-Pes8EQ9Ye-smkHCDw,9320
 render_machine/state_machine_config.py,sha256=NnX5sBGkc6cNG8OOQ4PrJeJBCADRGZKJYQXV7ndR4bs,26789
 render_machine/states.py,sha256=niFXqayyA_rezCrlzo0hYeHAruErcPzQVF-BeIBGnL8,1968
 render_machine/triggers.py,sha256=VekNhHGR-u5JXIboqc_Eyqf73LNH7wezLK7r3WWtodk,1269
@@ -52,7 +53,7 @@ render_machine/actions/exit_with_error.py,sha256=W6TMULHJcHEaXE4WUnlELEu0_l7IZy9
 render_machine/actions/finish_functional_requirement.py,sha256=usQgPSg6PHpBOR1RhK7lPz9zjY-2VJJDqi3T0nlqdLw,841
 render_machine/actions/fix_conformance_test.py,sha256=EZLVjF4A8zSTmyqdgcLoz-2pLpeieq4M_Rb71pY3IKA,10095
 render_machine/actions/fix_unit_tests.py,sha256=hvwvCJDk_-8fHMpkNFyeBSG1IshIcufDpymF00ulPXY,2301
-render_machine/actions/prepare_repositories.py,sha256=eE-uU6H_K5IQMraVWSRi4TKk_XPrnA878T_JwtI9cWo,3410
+render_machine/actions/prepare_repositories.py,sha256=dnh4cYeTZS0snWEeD8gAxtW2ot3KBq4nStRG052qc9U,3124
 render_machine/actions/prepare_testing_environment.py,sha256=kIsXgV6-jOlqp-04cimPgTQoHPrVIu0zW-H_Jj-jowE,2106
 render_machine/actions/refactor_code.py,sha256=gyPsnqgHseL2bkENu4WeGCRyV0R18_GH3JOrPdoxKvg,2609
 render_machine/actions/render_conformance_tests.py,sha256=5gOQn-G1T9UWEI8sDfALcVdArk0ln9DgUprOPjccS-U,9268
@@ -66,34 +67,36 @@ standard_template_library/typescript-react-app-boilerplate.plain,sha256=6LFxhEOz
 standard_template_library/typescript-react-app-template.plain,sha256=DN5wEJcT8ZqQTf0vFKi9Z1isi9cin2UVNOZb3r28d3M,715
 tests/__init__.py,sha256=Wk73Io62J15BtlLVIzxmASDWaaJkQLevS4BLK5LDAQg,16
 tests/conftest.py,sha256=QZcp08htUlJGgmHDlRWFgsWXZ8o8IBWTD5QqJaUMlU8,790
-tests/test_arg_provenance.py,sha256=Vp-ZtNbTlSNOE8iiHOin3YI9sobbN0tRPUIfrYjxttQ,3459
+tests/test_arg_provenance.py,sha256=d_J7aCeHMXBpctBWTt60WU-I8pEKN7XRXRTJZZGCdo0,3441
 tests/test_change_detection.py,sha256=jH8SEhndX400DNqIKmcYLzxHqq9WFdgmuvY3XPq-ZFc,13534
 tests/test_cli_output.py,sha256=iKS1Li4yhoIL0ezJ58o4oEf9V8TiKcQkvQLVtJpdM4c,18420
 tests/test_console_log_styles.py,sha256=63DQWiwWNhe_rMP70bW9DAB6-EPaqU3Wpwyh8eR09pc,4080
 tests/test_file_utils.py,sha256=R_ZIhrTtwlhHxgmbBtA8PFEU5-QB4Fi5skJ7PS2KzdU,3614
-tests/test_folder_path_resolution.py,sha256=_ZvVFu5m2-AH8iQNn0fCYkA0flVxVwdh1oQiWcPNIxw,6611
+tests/test_folder_path_resolution.py,sha256=K9v684xkPE0HOAsovg8uDixpZmaIk7ho-Wd3rTjKLF0,6560
 tests/test_git_utils.py,sha256=h3rWhhs4XVRYqzVzdmj51siF_AYD-GkbZiefK2iGfWo,15614
 tests/test_imports.py,sha256=1ncbqQhtQW237kIjyV-Ufl7-R-PuduvoYFj2iS-DXW4,2608
 tests/test_log_file_name_resolution.py,sha256=99g9NgPF-BZ98CvNyqDcltBAx4sLBE8gpQPAAieKiPc,3619
 tests/test_logging_config_path_resolution.py,sha256=avz_ehRd18INwIXvAy1AwVzNNUz0vS8eu1nRe0bra8g,2650
 tests/test_partial_rendering.py,sha256=r0RUUd1pI4-2ZkRrM1j8_kUqv-70hrOGjuKBhZoRmH0,22758
 tests/test_path_resolution.py,sha256=yQpd-Unq1lwNv0wkRPwVs5pDT8JmyyDgbpiTQsyt--Y,2615
-tests/test_plain2code.py,sha256=DQYFc0JVSkMI8LZCNaQ__2Nph-DcZZW17rprJA54eyw,3851
+tests/test_plain2code.py,sha256=lyb7iYK8XHu1dmTFh9Q31YgX0faNlCHiyI5M35VQwOg,3780
 tests/test_plain2code_state.py,sha256=cowPZS9oRbv9J49CE4P3Rc47Q5oQOby4bTf2OlnRlBI,1217
 tests/test_plain2code_utils.py,sha256=-W8a7FquMJQ_pTdBoBF1XprzNL2G555QhdtXCy6BDyQ,1237
-tests/test_plain_modules.py,sha256=S7sd4ZYNotXOgCyZzmBd714QFLih69nlZ3tV8WNtVPo,13766
+tests/test_plain_modules.py,sha256=jDjPv1JyKCgIMaoy3GYpjxTSQkfkI2ppmJgqzHdQ6E4,21592
 tests/test_plainfile.py,sha256=wZ_PN4GULPWIpl_AK_r_6jkgtX0Ch8EHmN5IhX7huOE,11027
 tests/test_plainfileparser.py,sha256=xd9P0KqZJlJPn3RKT510IQbfBotk6nQ9O8p9iLwJiQk,22815
 tests/test_plainspec.py,sha256=ng55E8ajrH2-gPC1p_QDIe_zXplPvoqHJ-d57UWKFTw,3577
+tests/test_prepare_repositories_layout.py,sha256=9T9lf92HhZC_ziUZxiyogbbeqJfmg131FZS81BuUNfs,4751
 tests/test_requires.py,sha256=6tnHYaKudxN-RiQjSFoi9nHe_x0ze3QF-f-j67zAE74,1250
 tests/test_resolve_config_file.py,sha256=b87tDOvyzbsnE-QRWbZ97ou7NuyaAgskv-dbYBum31c,2830
 tests/test_script_path_resolution.py,sha256=tiEqMevQRXr9YpfHN0xldOOQpLAUgnSqTzeZWkKHaUY,4156
-tests/test_telemetry.py,sha256=hjm81aRQQZcZ0RB6aVbS3WO46_nIAii_csmbbtnUh74,7110
+tests/test_system_config.py,sha256=poH6eviXqAxAzTcvdP0TeS0wBp6CW1IW5irqto7FNyI,1784
+tests/test_telemetry.py,sha256=LINvx1_Oz1OJ3ho2RcIcAA29IsNfUbkVVCbFaQcrBaA,8133
 tests/test_tui_usage.py,sha256=sfiAGTpRrT3MRr0-8DH3qjuECSxjODVgwzrK_K3iPXs,7959
 tests/test_usage_summary.py,sha256=Ps0kVzvmdZYeXrBR-cqkn3szTV5neYKs1PmmURngeIc,1079
 tests/e2e/conftest.py,sha256=5Dm67UTOE-M6hMb-mqZvwa6Ek_wmZgsR7fUv9ZEqCwY,4164
-tests/e2e/test_hello_world_python.py,sha256=PQy4elzB7WvpiWLKa6_HFO0K8HA6_6hGLaAqRi0J3OU,1627
-tests/e2e/test_hello_world_python_windows.py,sha256=kJQZIuzj8OEEtgBVxnzFvyQJ_wvP2oBu9L-E9geg8sE,2010
+tests/e2e/test_hello_world_python.py,sha256=2Cgs3-79dtQh5gVab257tFDHXTznefZeYqbTjlM4Nng,1632
+tests/e2e/test_hello_world_python_windows.py,sha256=ggynH_Wm4011M500zoPNNgvD-s4vZ3hvlorf1yARgQQ,2019
 tui/__init__.py,sha256=_fy7FowY0RkWdn4kC7XV2jgvQPCj-2gE8fNUb-Mny0A,60
 tui/components.py,sha256=XkC4Aq6VyTnFnBQs8PEHwVdAOczhm0ebKN92kiYMbq0,25791
 tui/models.py,sha256=KMjlWubmPD41GA-BjgiqkaV9v7tLJ0fuWKBDPmZj4JA,1493
@@ -103,8 +106,8 @@ tui/spinner.py,sha256=Ro6Gd9Przf-whuHqPRY6HwI0T57yJjyNPbhDbigZKZE,2471
 tui/state_handlers.py,sha256=4r_6m5YMcprQtgiTP0De3XFfGAF8VzgaWXHxPweYPbQ,16325
 tui/styles.css,sha256=kiC7Og_2G1E7owoiZgV95-3_dSeQnsNj3qzaY04xkDg,6727
 tui/widget_helpers.py,sha256=ToO9MV2bF2Rp-XMNcjIYclnB_qmgO5sLw4UtQ2CyTMg,6652
-codeplain-0.3.8.dist-info/METADATA,sha256=nfj-9PV0EN0MS1W9ILf1GyOnSfcB-YSyEXW04UY9vHQ,6351
-codeplain-0.3.8.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-codeplain-0.3.8.dist-info/entry_points.txt,sha256=oDZkBqu9WhtZApb_K6ia8-fn9aojwmAsgnKELceX5T4,46
-codeplain-0.3.8.dist-info/licenses/LICENSE,sha256=pCeKgQ1mXE5OmNUuKOfOZh1T1vqkeCUxghE7N8qgnzc,11345
-codeplain-0.3.8.dist-info/RECORD,,
+codeplain-0.3.9.dist-info/METADATA,sha256=v3UbwneHulzIUZMJI9ZHf032CyyhAef-BBmn-RRsq14,6351
+codeplain-0.3.9.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+codeplain-0.3.9.dist-info/entry_points.txt,sha256=oDZkBqu9WhtZApb_K6ia8-fn9aojwmAsgnKELceX5T4,46
+codeplain-0.3.9.dist-info/licenses/LICENSE,sha256=pCeKgQ1mXE5OmNUuKOfOZh1T1vqkeCUxghE7N8qgnzc,11345
+codeplain-0.3.9.dist-info/RECORD,,

git_utils.py

@@ -64,7 +64,6 @@ def init_git_repo(
     path_to_repo: Union[str, os.PathLike],
     module_name: Optional[str] = None,
     render_id: Optional[str] = None,
-    initial_files: Optional[dict[str, str]] = None,
 ) -> Repo:
     """
     Initializes a new git repository in the given path.
@@ -79,10 +78,6 @@ def init_git_repo(
     repo = Repo.init(path_to_repo)
     _ensure_git_config(repo)
 
-    if initial_files:
-        file_utils.store_response_files(path_to_repo, initial_files, [])
-        repo.git.add(".")
-
     repo.git.commit(
         "--allow-empty", "-m", _get_full_commit_message(INITIAL_COMMIT_MESSAGE, module_name, None, render_id)
     )
@@ -95,14 +90,9 @@ def clone_repo(
     new_repo_path: str,
     module_name: Optional[str] = None,
     render_id: Optional[str] = None,
-    initial_files: Optional[dict[str, str]] = None,
 ) -> Repo:
     repo = Repo.clone_from(source_repo_path, new_repo_path)
 
-    if initial_files:
-        file_utils.store_response_files(new_repo_path, initial_files, [])
-        repo.git.add(".")
-
     repo.git.commit(
         "--allow-empty", "-m", _get_full_commit_message(INITIAL_COMMIT_MESSAGE, module_name, None, render_id)
     )

memory_management.py

@@ -3,7 +3,6 @@ import os
 
 import file_utils
 from plain2code_console import console
-from plain_modules import CODEPLAIN_MEMORY_SUBFOLDER
 from render_machine.implementation_code_helpers import ImplementationCodeHelpers
 from render_machine.render_context import RenderContext
 
@@ -24,9 +23,9 @@ class MemoryManager:
         console.debug(f"Loaded {len(memory_files_content)} memory files.")
         return memory_files, memory_files_content
 
-    def __init__(self, codeplain_api, module_name: str, conformance_tests_folder: str):
+    def __init__(self, codeplain_api, memory_folder: str):
         self.codeplain_api = codeplain_api
-        self.memory_folder = os.path.join(conformance_tests_folder, module_name, CODEPLAIN_MEMORY_SUBFOLDER)
+        self.memory_folder = memory_folder
 
     def create_conformance_tests_memory(
         self, render_context: RenderContext, exit_code: int, conformance_tests_issue: str

metadata_utils.py

@@ -0,0 +1,46 @@
+"""Read/write helpers for the per-module metadata file (``module_metadata.json``).
+
+These helpers operate purely on a metadata path or a plain dict. Module-specific
+logic — computing the hashes, assembling the payload from the spec and required
+modules — stays on :class:`plain_modules.PlainModule`.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+
+MODULE_METADATA_FILENAME = "module_metadata.json"
+MODULE_FUNCTIONALITIES = "functionalities"
+REQUIRED_MODULES_FUNCTIONALITIES = "required_modules_functionalities"
+
+
+def load_metadata(metadata_path: str) -> dict | None:
+    """Return the parsed metadata dict, or None if the file does not exist."""
+    if not os.path.exists(metadata_path):
+        return None
+
+    with open(metadata_path, "r", encoding="utf-8") as f:
+        return json.load(f)
+
+
+def write_metadata(metadata_path: str, metadata: dict) -> None:
+    """Write metadata as indented JSON, creating the parent folder if needed."""
+    os.makedirs(os.path.dirname(metadata_path), exist_ok=True)
+
+    with open(metadata_path, "w", encoding="utf-8") as f:
+        json.dump(metadata, f, indent=4)
+
+
+def truncate_functionalities(metadata: dict, keep_count: int) -> bool:
+    """Trim the functionalities list in ``metadata`` in place to ``keep_count`` entries.
+
+    Returns True if the list was shortened, False if it was already short enough
+    (in which case ``metadata`` is left untouched).
+    """
+    functionalities = metadata.get(MODULE_FUNCTIONALITIES, [])
+    if len(functionalities) <= keep_count:
+        return False
+
+    metadata[MODULE_FUNCTIONALITIES] = functionalities[:keep_count]
+    return True

module_renderer.py

@@ -1,5 +1,4 @@
 import argparse
-import os
 import threading
 
 from event_bus import EventBus
@@ -48,9 +47,8 @@ class ModuleRenderer:
             self.codeplainAPI,
             memory_manager,
             plain_module,
-            build_folder=os.path.join(self.args.build_folder, plain_module.module_name),
+            build_folder=plain_module.module_build_folder,
             build_dest=self.args.build_dest,
-            conformance_tests_folder=self.args.conformance_tests_folder,
             conformance_tests_dest=self.args.conformance_tests_dest,
             unittests_script=self.args.unittests_script,
             conformance_tests_script=self.args.conformance_tests_script,
@@ -115,8 +113,7 @@ class ModuleRenderer:
 
         memory_manager = MemoryManager(
             self.codeplainAPI,
-            plain_module.module_name,
-            self.args.conformance_tests_folder,
+            plain_module.module_memory_folder,
         )
         render_context = self._build_render_context_for_module(
             plain_module,
@@ -165,7 +162,7 @@ class ModuleRenderer:
             if self.args.copy_build:
                 rendered_code_path = f"{self.args.build_dest}/"
             else:
-                rendered_code_path = self.args.build_folder
+                rendered_code_path = self.plain_module.module_build_folder
 
             self.run_state.set_render_generated_code_path(rendered_code_path)
             self.event_bus.publish(RenderCompleted(rendered_code_path=rendered_code_path))

plain2code.py

@@ -212,6 +212,12 @@ def render(  # noqa: C901
 
     warn_if_acceptance_tests_without_conformance_script(plain_module, args)
 
+    # The module_metadata file lives outside the code git repo. That means that a crash mid-render can leave it
+    # claiming a functionality was implemented even thought it wasn't yet committed (because of the crash).
+    # Out of precaution, this reconciles every module_metadata against the code repo.
+    for module in plain_module.all_required_modules + [plain_module]:
+        module.reconcile_metadata_with_git()
+
     render_choice = None
     if render_range is None:
         plain_module_render_state = get_plain_module_render_state(plain_module)
@@ -356,7 +362,6 @@ def main():  # noqa: C901
         plain_module = plain_modules.PlainModule(
             os.path.basename(args.filename),
             args.build_folder,
-            args.conformance_tests_folder,
             template_dirs,
         )
     except Exception as e:

plain2code_arguments.py

@@ -16,7 +16,6 @@ CODEPLAIN_API_KEY = os.getenv("CODEPLAIN_API_KEY")
 
 
 DEFAULT_BUILD_FOLDER = "plain_modules"
-DEFAULT_CONFORMANCE_TESTS_FOLDER = "conformance_tests"
 DEFAULT_BUILD_DEST = "dist"
 DEFAULT_CONFORMANCE_TESTS_DEST = "dist_conformance_tests"
 
@@ -299,23 +298,15 @@ def create_parser():
         parser,
         "--unittests-script",
         type=str,
-        help="Shell script to run unit tests on generated code. Receives the build folder path as its first argument (default: 'plain_modules').",
-    )
-    _add_arg(
-        parser,
-        "--conformance-tests-folder",
-        type=non_empty_string,
-        default=DEFAULT_CONFORMANCE_TESTS_FOLDER,
-        help="Folder for conformance test files",
-        path=True,
+        help="Shell script to run unit tests on generated code. Receives the module's code folder path as its first argument (e.g. `plain_modules/module_name/code`).",
     )
     _add_arg(
         parser,
         "--conformance-tests-script",
         type=str,
         help="Path to conformance tests shell script. Every conformance test script should accept two arguments: "
-        "1) Path to a folder (e.g. `plain_modules/module_name`) containing generated source code, "
-        "2) Path to a subfolder of the conformance tests folder (e.g. `conformance_tests/subfoldername`) containing test files.",
+        "1) Path to a folder (e.g. `plain_modules/module_name/code`) containing generated source code, "
+        "2) Path to a subfolder of the module's tests folder (e.g. `plain_modules/module_name/tests/subfoldername`) containing test files.",
     )
 
     _add_arg(
@@ -400,7 +391,7 @@ def create_parser():
         "--copy-conformance-tests",
         action="store_true",
         default=False,
-        help="If set, copy the conformance tests of code in `--conformance-tests-folder` folder to `--conformance-tests-dest` folder successful rendering. Requires --conformance-tests-script.",
+        help="If set, copy the module's conformance tests (from `<build-folder>/<module>/tests`) to `--conformance-tests-dest` folder after successful rendering. Requires --conformance-tests-script.",
     )
     _add_arg(
         parser,
@@ -490,8 +481,8 @@ def parse_arguments(command_line: Optional[Sequence[str]] = None):
 
     if args.build_folder == args.build_dest:
         parser.error("--build-folder and --build-dest cannot be the same")
-    if args.conformance_tests_folder == args.conformance_tests_dest:
-        parser.error("--conformance-tests-folder and --conformance-tests-dest cannot be the same")
+    if args.conformance_tests_dest == args.build_folder:
+        parser.error("--conformance-tests-dest and --build-folder cannot be the same")
 
     args.render_conformance_tests = args.conformance_tests_script is not None
 

plain2code_telemetry.py

@@ -1,9 +1,10 @@
 """Crash reporting via Sentry.
 
 Only unexpected exceptions are reported (the caller decides which exceptions are
-expected; see EXPECTED_EXCEPTIONS in plain2code.py). Reporting is on by default
-and can be disabled by setting the CODEPLAIN_NO_TELEMETRY environment variable
-to any non-empty value.
+expected; see EXPECTED_EXCEPTIONS in plain2code.py). In production, reporting is
+on by default and can be disabled by setting CODEPLAIN_TELEMETRY to 0, false or
+off. In any other environment it is off unless CODEPLAIN_TELEMETRY is explicitly
+set to 1, true or on.
 """
 
 import os
@@ -20,9 +21,7 @@ from system_config import system_config
 
 SENTRY_DSN = "https://64d0d86b50b34e2dede3e4eaf5142282@o4510793955934208.ingest.us.sentry.io/4511540621213696"
 
-NO_TELEMETRY_ENV_VAR = "CODEPLAIN_NO_TELEMETRY"
-ENVIRONMENT_ENV_VAR = "CODEPLAIN_ENV"
-DEFAULT_ENVIRONMENT = "production"
+TELEMETRY_ENV_VAR = "CODEPLAIN_TELEMETRY"
 
 FLUSH_TIMEOUT_SECONDS = 2
 
@@ -50,10 +49,17 @@ SCRUB_DENYLIST = DEFAULT_DENYLIST + [
 
 
 def telemetry_enabled() -> bool:
-    """Return True if crash reporting should be active."""
-    if os.environ.get(NO_TELEMETRY_ENV_VAR):
-        return False
-    return True
+    """Return True if crash reporting should be active.
+
+    In production it is on unless CODEPLAIN_TELEMETRY disables it.
+    Anywhere else it is off unless CODEPLAIN_TELEMETRY enables it.
+    """
+    setting = os.environ.get(TELEMETRY_ENV_VAR, "").strip().lower()
+
+    if system_config.environment == "production":
+        return setting not in {"0", "false", "off"}
+
+    return setting in {"1", "true", "on"}
 
 
 def initialize_telemetry(**init_overrides: Any) -> bool:
@@ -65,7 +71,7 @@ def initialize_telemetry(**init_overrides: Any) -> bool:
         init_kwargs: dict[str, Any] = dict(
             dsn=SENTRY_DSN,
             release=system_config.client_version,
-            environment=os.environ.get(ENVIRONMENT_ENV_VAR, DEFAULT_ENVIRONMENT),
+            environment=system_config.environment,
             send_default_pii=False,
             server_name="",  # hostname is identifying; don't send it
             default_integrations=False,

plain_modules.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import json
 import os
 import shutil
 from functools import cached_property
@@ -13,16 +12,29 @@ except ImportError:
     raise GitNotInstalledError("git is not installed. Please install git and try again.")
 
 import git_utils
+import metadata_utils
 import plain_file
 import plain_spec
+from metadata_utils import (
+    MODULE_FUNCTIONALITIES,
+    MODULE_METADATA_FILENAME,
+    REQUIRED_MODULES_FUNCTIONALITIES,
+)
 from plain2code_console import console
 from render_machine.implementation_code_helpers import ImplementationCodeHelpers
 
 CODEPLAIN_MEMORY_SUBFOLDER = ".memory"
 CODEPLAIN_METADATA_FOLDER = ".codeplain"
-MODULE_METADATA_FILENAME = "module_metadata.json"
-MODULE_FUNCTIONALITIES = "functionalities"
-REQUIRED_MODULES_FUNCTIONALITIES = "required_modules_functionalities"
+MODULE_CODE_SUBFOLDER = "code"
+MODULE_TESTS_SUBFOLDER = "tests"
+
+
+def get_module_code_folder(modules_base_folder: str, module_name: str) -> str:
+    return os.path.join(modules_base_folder, module_name, MODULE_CODE_SUBFOLDER)
+
+
+def get_module_tests_folder(modules_base_folder: str, module_name: str) -> str:
+    return os.path.join(modules_base_folder, module_name, MODULE_TESTS_SUBFOLDER)
 
 
 def _strip_functional_requirements(plain_source_tree: dict) -> dict:
@@ -33,10 +45,9 @@ def _strip_functional_requirements(plain_source_tree: dict) -> dict:
 
 
 class PlainModule:
-    def __init__(self, filename: str, build_folder: str, conformance_tests_folder: str, template_dirs: list[str]):
+    def __init__(self, filename: str, build_folder: str, template_dirs: list[str]):
         self.filename = filename
         self.build_folder = build_folder
-        self.conformance_tests_folder = conformance_tests_folder
         self.template_dirs = template_dirs
         module_name, plain_source, required_modules_names = plain_file.plain_file_parser(
             self.filename, self.template_dirs
@@ -53,7 +64,6 @@ class PlainModule:
                 PlainModule(
                     plain_file.get_filename_from_module_name(module_name),
                     self.build_folder,
-                    self.conformance_tests_folder,
                     self.template_dirs,
                 )
                 for module_name in required_modules_names
@@ -70,16 +80,24 @@ class PlainModule:
 
         return all_required_modules
 
+    @property
+    def module_folder(self):
+        return os.path.join(self.build_folder, self.module_name)
+
     @property
     def module_conformance_tests_folder(self):
-        return os.path.join(self.conformance_tests_folder, self.module_name)
+        return get_module_tests_folder(self.build_folder, self.module_name)
 
     @property
     def module_build_folder(self):
-        return os.path.join(self.build_folder, self.module_name)
+        return get_module_code_folder(self.build_folder, self.module_name)
+
+    @property
+    def module_memory_folder(self):
+        return os.path.join(self.module_folder, CODEPLAIN_MEMORY_SUBFOLDER)
 
     def get_codeplain_folder(self):
-        return os.path.join(self.module_build_folder, CODEPLAIN_METADATA_FOLDER)
+        return os.path.join(self.module_folder, CODEPLAIN_METADATA_FOLDER)
 
     def get_module_render_status(self) -> tuple[str | None, str | None]:
         module_name, frid = git_utils.get_last_rendered_functionality(self.module_build_folder)
@@ -104,16 +122,7 @@ class PlainModule:
         return repo
 
     def load_module_metadata(self) -> dict | None:
-        codeplain_folder = self.get_codeplain_folder()
-        if not os.path.exists(codeplain_folder):
-            return None
-
-        metadata_path = os.path.join(codeplain_folder, MODULE_METADATA_FILENAME)
-        if not os.path.exists(metadata_path):
-            return None
-
-        with open(metadata_path, "r", encoding="utf-8") as f:
-            return json.load(f)
+        return metadata_utils.load_metadata(self.module_metadata_path())
 
     def update_frid_in_module_metadata(self, frid: str) -> None:
         # Store the raw FR markdown (with any {{ code_variable }} placeholders intact), exactly
@@ -130,10 +139,7 @@ class PlainModule:
             functionalities.append(frid_text)
         metadata[MODULE_FUNCTIONALITIES] = functionalities
 
-        codeplain_folder = self.get_codeplain_folder()
-        os.makedirs(codeplain_folder, exist_ok=True)
-        with open(self.module_metadata_path(), "w", encoding="utf-8") as f:
-            json.dump(metadata, f, indent=4)
+        metadata_utils.write_metadata(self.module_metadata_path(), metadata)
 
     def get_module_source_hash(self) -> str:
         return plain_spec.get_hash_value([self.plain_source] + self.resources_list)
@@ -186,10 +192,7 @@ class PlainModule:
 
         return functionalities
 
-    def module_metadata_path(self, for_git_repo: bool = False) -> str:
-        if for_git_repo:
-            return os.path.join(CODEPLAIN_METADATA_FOLDER, MODULE_METADATA_FILENAME)
-
+    def module_metadata_path(self) -> str:
         return os.path.join(self.get_codeplain_folder(), MODULE_METADATA_FILENAME)
 
     def get_hashes(self) -> dict[str, str]:
@@ -201,12 +204,46 @@ class PlainModule:
             hashes["required_modules_code_hash"] = self.required_modules[-1].get_module_code_hash()
         return hashes
 
-    def save_module_metadata(self):
-        codeplain_folder = self.get_codeplain_folder()
-        os.makedirs(codeplain_folder, exist_ok=True)
+    def seed_module_metadata(self) -> None:
+        """Write a fresh metadata file containing only the module hashes.
 
+        Called at the start of a full render, before any functionality is
+        rendered, so change detection has a clean baseline.
+        """
+        metadata_utils.write_metadata(self.module_metadata_path(), self.get_hashes())
+
+    def truncate_metadata_functionalities(self, frid: str | None) -> None:
+        """Trim the stored functionalities list to the first int(frid) entries.
+
+        The metadata file is not tracked in the module's git repo, so when the
+        code repo is reverted to an earlier functionality the stored list must
+        be trimmed to match the reverted code. A frid of None means no
+        functionality is implemented (empty list).
+        """
+        metadata = self.load_module_metadata()
+        if metadata is None:
+            return
+
+        keep_count = int(frid) if frid is not None else 0
+        if metadata_utils.truncate_functionalities(metadata, keep_count):
+            metadata_utils.write_metadata(self.module_metadata_path(), metadata)
+
+    def revert_code_to_frid(self, frid: str | None) -> None:
+        """Revert the code repo to the commit for frid and keep metadata in sync."""
+        git_utils.revert_to_commit_with_frid(self.module_build_folder, frid)
+        self.truncate_metadata_functionalities(frid)
+
+    def reconcile_metadata_with_git(self) -> None:
+        """
+        Trim the metadata functionalities list to what the code repo actually committed.
+        """
+        module_name, frid = git_utils.get_last_rendered_functionality(self.module_build_folder)
+        own_frid = frid if module_name == self.module_name else None
+
+        self.truncate_metadata_functionalities(own_frid)
+
+    def save_module_metadata(self):
         module_metadata = self.get_hashes()
-        metadata_path = self.module_metadata_path()
         module_metadata[MODULE_FUNCTIONALITIES] = self._get_module_functional_requirements()
 
         required_modules_functionalities = {}
@@ -216,8 +253,7 @@ class PlainModule:
         if required_modules_functionalities:
             module_metadata[REQUIRED_MODULES_FUNCTIONALITIES] = required_modules_functionalities
 
-        with open(metadata_path, "w", encoding="utf-8") as f:
-            json.dump(module_metadata, f, indent=4)
+        metadata_utils.write_metadata(self.module_metadata_path(), module_metadata)
 
     def _ensure_module_folders_exist(self, first_render_frid: str, render_conformance_tests: bool):
         """
@@ -372,10 +408,6 @@ class PlainModule:
         return False
 
     def wipe_module(self) -> None:
-        if os.path.exists(self.module_build_folder):
-            console.warning(f"Wiping module {self.module_build_folder}...")
-            shutil.rmtree(self.module_build_folder)
-
-        if os.path.exists(self.module_conformance_tests_folder):
-            console.warning(f"Wiping conformance tests for module {self.module_conformance_tests_folder}...")
-            shutil.rmtree(self.module_conformance_tests_folder)
+        if os.path.exists(self.module_folder):
+            console.warning(f"Wiping module {self.module_folder}...")
+            shutil.rmtree(self.module_folder)

render_machine/actions/prepare_repositories.py

@@ -1,4 +1,3 @@
-import json
 from typing import Any
 
 import file_utils
@@ -24,7 +23,7 @@ class PrepareRepositories(BaseAction):
 
             console.debug(f"Reverting code to version implemented for {previous_frid}.")
 
-            git_utils.revert_to_commit_with_frid(render_context.build_folder, previous_frid)
+            render_context.plain_module.revert_code_to_frid(previous_frid)
             # conformance tests are still not fully implemented
             if render_context.render_conformance_tests:
                 git_utils.revert_to_commit_with_frid(
@@ -33,22 +32,18 @@ class PrepareRepositories(BaseAction):
                 )
 
         else:
-            module_hashes = render_context.plain_module.get_hashes()
-            initial_files = {
-                render_context.plain_module.module_metadata_path(for_git_repo=True): json.dumps(module_hashes)
-            }
+            file_utils.delete_folder(render_context.plain_module.module_folder)
+            render_context.plain_module.seed_module_metadata()
 
             if render_context.required_modules:
                 previous_module = render_context.required_modules[-1]
                 console.debug(f"Cloning git repo from module {previous_module.module_name}.")
 
-                file_utils.delete_folder(render_context.build_folder)
                 git_utils.clone_repo(
                     previous_module.module_build_folder,
                     render_context.build_folder,
                     render_context.module_name,
                     render_context.run_state.render_id,
-                    initial_files,
                 )
             else:
                 console.debug("Initializing git repositories for the render folders.")
@@ -57,7 +52,6 @@ class PrepareRepositories(BaseAction):
                     render_context.build_folder,
                     render_context.module_name,
                     render_context.run_state.render_id,
-                    initial_files,
                 )
 
                 if render_context.base_folder:
@@ -75,7 +69,6 @@ class PrepareRepositories(BaseAction):
                     render_context.conformance_tests.get_module_conformance_tests_folder(render_context.module_name),
                     render_context.module_name,
                     render_context.run_state.render_id,
-                    initial_files,
                 )
 
         return self.SUCCESSFUL_OUTCOME, None