codeplain 0.3.6__tar.gz → 0.3.7__tar.gz

codeplain-0.3.7/.claude/settings.local.json

@@ -0,0 +1,66 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(gh pr:*)",
+      "Bash(git diff *)",
+      "Bash(mypy . --check-untyped-defs)",
+      "Bash(flake8 .)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/test_git_utils.py -v --no-header)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key python *)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/_sandbox_check.py -v -s)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/test_partial_rendering.py -v)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/test_plain_modules.py -v)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/ -v)",
+      "Bash(flake8 tests/)",
+      "Bash(git stash *)",
+      "Bash(flake8 tests/test_git_utils.py)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key coverage run -m pytest tests/ -v)",
+      "Bash(.venv/bin/coverage run *)",
+      "Bash(.venv/bin/coverage report *)",
+      "Bash(.venv/bin/python -m coverage run -m pytest tests/)",
+      "Bash(.venv/bin/python -m coverage report)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/)",
+      "Bash(flake8 tests/test_partial_rendering.py tests/test_plain_modules.py)",
+      "Bash(MASTER_KEY=test-master-key GOOGLE_API_KEY=test-google-api-key pytest tests/test_partial_rendering.py tests/test_plain_modules.py tests/test_git_utils.py)",
+      "Bash(pytest tests *)",
+      "Bash(pytest tests/test_git_utils.py::test_diff_without_previous_frid_and_no_base_folder -x -v)",
+      "Bash(git checkout *)",
+      "Bash(python -c ' *)",
+      "Bash(python3 -c ' *)",
+      "Bash(/opt/homebrew/opt/python@3.11/bin/python3.11 -c ' *)",
+      "Bash(pytest tests/test_git_utils.py -x -v)",
+      "Bash(pytest tests/test_git_utils.py -v)",
+      "Bash(pytest -x -v)",
+      "Bash(pytest tests/test_partial_rendering.py -v)",
+      "Bash(pytest -v)",
+      "Bash(pytest)",
+      "Bash(python -m pytest tests/test_partial_rendering.py -x -v)",
+      "Bash(python -m pytest -x -v)",
+      "Bash(python -m pytest tests/test_partial_rendering.py -v)",
+      "Bash(python -m pytest)",
+      "Bash(python -m pytest tests/test_plain_modules.py -q)",
+      "Bash(python3 -m pytest tests/test_plain_modules.py -q)",
+      "Bash(.venv/bin/pytest tests/test_plain_modules.py -q)",
+      "Bash(git -C /Users/zanjonke/Work/codeplain/codeplain log --oneline -5)",
+      "Bash(git -C /Users/zanjonke/Work/codeplain/codeplain branch --show-current)",
+      "Bash(python -m pytest tests/test_git_utils.py::test_get_last_finished_frid_empty_repo -x)",
+      "Bash(python3 -m pytest tests/test_git_utils.py::test_get_last_finished_frid_empty_repo -x)",
+      "Bash(.venv/bin/python -m pytest tests/test_git_utils.py::test_get_last_finished_frid_empty_repo -x)",
+      "Bash(.venv/bin/python -m pytest tests/test_git_utils.py::test_get_last_finished_frid_without_module_name tests/test_git_utils.py::test_get_last_finished_frid_empty_repo -x)",
+      "Bash(.venv/bin/python -m pytest tests/test_git_utils.py)",
+      "Bash(python -m pytest tests/test_partial_rendering.py -x)",
+      "Bash(python3 -m pytest tests/test_partial_rendering.py)",
+      "Bash(/Users/zanjonke/Work/codeplain/codeplain/.venv/bin/python -m pytest tests/test_partial_rendering.py)",
+      "Bash(/Users/zanjonke/Work/codeplain/codeplain/.venv/bin/python -m pytest tests/test_plain_modules.py tests/test_partial_rendering.py)",
+      "Bash(git *)",
+      "Bash(python -m pytest tests/test_plain_modules.py -x --tb=short)",
+      "Bash(python3 -m pytest tests/test_plain_modules.py -x --tb=short)",
+      "Bash(/Users/zanjonke/Work/codeplain/codeplain/venv/bin/python -m pytest tests/test_plain_modules.py --tb=short)",
+      "Bash(/Users/zanjonke/Work/codeplain/codeplain/.venv/bin/python -m pytest tests/test_plain_modules.py --tb=short)",
+      "Bash(/Users/zanjonke/Work/codeplain/codeplain/.venv/bin/python -m pytest tests/test_partial_rendering.py tests/test_git_utils.py --tb=short)",
+      "Bash(.venv/bin/python *)",
+      "Bash(python *)",
+      "Bash(python3 *)"
+    ]
+  }
+}

codeplain-0.3.7/.zed/settings.json

@@ -0,0 +1,46 @@
+// Zed project-local settings, converted from .vscode/settings.json.
+// Docs: https://zed.dev/docs/configuring-zed
+{
+  "format_on_save": "on",
+  "languages": {
+    "Python": {
+      "tab_size": 4,
+      "hard_tabs": false,
+      "preferred_line_length": 120,
+      "wrap_guides": [120],
+      "format_on_save": "on",
+      // Run isort first (organize imports), then black (format).
+      // Matches `source.organizeImports: explicit` + black-formatter from VS Code.
+      "formatter": [
+        {
+          "external": {
+            "command": "isort",
+            "arguments": ["--profile", "black", "--filename", "{buffer_path}", "-"]
+          }
+        },
+        {
+          "external": {
+            "command": "black",
+            "arguments": ["--quiet", "--stdin-filename", "{buffer_path}", "-"]
+          }
+        }
+      ]
+    }
+  },
+  // Treat fixture files under tests/data as plain text (matches files.associations).
+  "file_types": {
+    "Plain Text": ["tests/data/**"]
+  },
+  // python.analysis.extraPaths -> Pyright (Zed's default Python LSP).
+  "lsp": {
+    "pyright": {
+      "settings": {
+        "python": {
+          "analysis": {
+            "extraPaths": ["."]
+          }
+        }
+      }
+    }
+  }
+}

{codeplain-0.3.6 → codeplain-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeplain
-Version: 0.3.6
+Version: 0.3.7
 Summary: Transform plain language specifications into working code
 License-File: LICENSE
 Classifier: Environment :: Console
@@ -9,7 +9,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Code Generators
 Requires-Python: ==3.11.*
 Requires-Dist: gitpython==3.1.50
-Requires-Dist: mistletoe==1.3.0
+Requires-Dist: mistletoe==1.5.1
 Requires-Dist: networkx==3.6.1
 Requires-Dist: python-frontmatter==1.3.0
 Requires-Dist: python-liquid2==0.4.0
@@ -21,9 +21,9 @@ Requires-Dist: textual>=7.5.0
 Requires-Dist: tiktoken==0.13.0
 Requires-Dist: transitions==0.9.3
 Provides-Extra: dev
-Requires-Dist: black==26.3.1; extra == 'dev'
+Requires-Dist: black==26.5.1; extra == 'dev'
 Requires-Dist: flake8==7.3.0; extra == 'dev'
-Requires-Dist: isort==5.13.2; extra == 'dev'
+Requires-Dist: isort==8.0.1; extra == 'dev'
 Requires-Dist: mypy==2.1.0; extra == 'dev'
 Requires-Dist: pytest==9.1.1; extra == 'dev'
 Description-Content-Type: text/markdown

codeplain-0.3.7/_version.py

@@ -0,0 +1 @@
+__version__ = "0.3.7"

codeplain-0.3.7/docs/plain2code_cli.md

@@ -0,0 +1,133 @@
+# Plain2Code CLI Reference
+
+```text
+usage: generate_cli.py [-h] [--verbose] [--base-folder BASE_FOLDER]
+                       [--build-folder BUILD_FOLDER]
+                       [--log-to-file | --no-log-to-file]
+                       [--log-file-name LOG_FILE_NAME]
+                       [--config-name CONFIG_NAME]
+                       [--render-range RENDER_RANGE |
+                       --render-from RENDER_FROM] [--force-render]
+                       [--unittests-script UNITTESTS_SCRIPT]
+                       [--conformance-tests-folder CONFORMANCE_TESTS_FOLDER]
+                       [--conformance-tests-script CONFORMANCE_TESTS_SCRIPT]
+                       [--prepare-environment-script PREPARE_ENVIRONMENT_SCRIPT]
+                       [--test-script-timeout TEST_SCRIPT_TIMEOUT]
+                       [--api [API]] [--api-key API_KEY] [--full-plain]
+                       [--dry-run] [--replay-with REPLAY_WITH]
+                       [--template-dir TEMPLATE_DIR] [--copy-build]
+                       [--build-dest BUILD_DEST] [--copy-conformance-tests]
+                       [--conformance-tests-dest CONFORMANCE_TESTS_DEST]
+                       [--render-machine-graph]
+                       [--logging-config-path LOGGING_CONFIG_PATH]
+                       [--headless]
+                       filename
+
+Render plain code to target code. Path arguments resolve based on where they
+were written: values given on the command line are resolved against the
+current working directory, values read from config.yaml are resolved against
+the config file's directory, and defaults are resolved against the directory
+containing the plain file. Absolute paths (and paths starting with '~') are
+used as-is.
+
+positional arguments:
+  filename              Path to the plain file to render. The directory
+                        containing this file has highest precedence for
+                        template loading, so you can place custom templates
+                        here to override the defaults. See --template-dir for
+                        more details about template loading.
+
+options:
+  -h, --help            show this help message and exit
+  --verbose, -v         Enable verbose output
+  --base-folder BASE_FOLDER
+                        Base folder for the build files
+  --build-folder BUILD_FOLDER
+                        Folder for build files
+  --log-to-file, --no-log-to-file
+                        Enable logging to a file. Defaults to True. Set to
+                        False to disable.
+  --log-file-name LOG_FILE_NAME
+                        Name of the log file. Defaults to 'codeplain.log'. If
+                        a file already exists at the resolved path, it will be
+                        overwritten by the current logs.
+  --render-range RENDER_RANGE
+                        Specify a range of functionalities to render (e.g. `1`
+                        , `2`, `3`). Use comma to separate start and end IDs.
+                        If only one functionality ID is provided, only that
+                        functionality is rendered. Range is inclusive of both
+                        start and end IDs.
+  --render-from RENDER_FROM
+                        Continue generation starting from this specific
+                        functionality (e.g. `2`). The functionality with this
+                        ID will be included in the output. The functionality
+                        ID must match one of the functionalities in your plain
+                        file.
+  --force-render        Force re-render of all the required modules.
+  --unittests-script UNITTESTS_SCRIPT
+                        Shell script to run unit tests on generated code.
+                        Receives the build folder path as its first argument
+                        (default: 'plain_modules').
+  --conformance-tests-folder CONFORMANCE_TESTS_FOLDER
+                        Folder for conformance test files
+  --conformance-tests-script CONFORMANCE_TESTS_SCRIPT
+                        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.
+  --prepare-environment-script PREPARE_ENVIRONMENT_SCRIPT
+                        Path to a shell script that prepares the testing
+                        environment. The script should accept the source code
+                        folder path as its first argument.
+  --test-script-timeout TEST_SCRIPT_TIMEOUT
+                        Timeout for test scripts in seconds. If not provided,
+                        the default timeout of 120 seconds is used.
+  --api [API]           Alternative base URL for the API. Default:
+                        `https://api.codeplain.ai`
+  --api-key API_KEY     API key used to access the API. If not provided, the
+                        `CODEPLAIN_API_KEY` environment variable is used.
+  --full-plain          Full preview ***plain specification before code
+                        generation.Use when you want to preview context of all
+                        ***plain primitives that are going to be included in
+                        order to render the given module.
+  --dry-run             Dry run preview of the code generation (without
+                        actually making any changes).
+  --replay-with REPLAY_WITH
+  --template-dir TEMPLATE_DIR
+                        Path to a custom template directory. Templates are
+                        searched in the following order: 1) Directory
+                        containing the plain file, 2) Custom template
+                        directory (if provided through this argument), 3)
+                        Built-in standard_template_library directory
+  --copy-build          If set, copy the rendered contents of code in `--base-
+                        folder` folder to `--build-dest` folder after
+                        successful rendering.
+  --build-dest BUILD_DEST
+                        Target folder to copy rendered contents of code to
+                        (used only if --copy-build is set).
+  --copy-conformance-tests
+                        If set, copy the conformance tests of code in
+                        `--conformance-tests-folder` folder to `--conformance-
+                        tests-dest` folder successful rendering. Requires
+                        --conformance-tests-script.
+  --conformance-tests-dest CONFORMANCE_TESTS_DEST
+                        Target folder to copy conformance tests of code to
+                        (used only if --copy-conformance-tests is set).
+  --render-machine-graph
+                        If set, render the state machine graph.
+  --logging-config-path LOGGING_CONFIG_PATH
+                        Path to the logging configuration file.
+  --headless            Run in headless mode: no TUI, no terminal output
+                        except a single render-started message. All logs are
+                        written to the log file.
+
+configuration:
+  --config-name CONFIG_NAME
+                        Name of the config file to look for. Looked up in the
+                        plain file directory and the current working
+                        directory. Defaults to config.yaml.
+
+```

{codeplain-0.3.6 → codeplain-0.3.7}/file_utils.py

@@ -293,7 +293,7 @@ def get_template_directories(plain_file_path, custom_template_dir=None, default_
     3. Default template directory - for standard/fallback templates
     """
     template_dirs = [
-        os.path.dirname(plain_file_path),  # Highest precedence - directory containing plain file
+        os.path.dirname(os.path.abspath(plain_file_path)),  # Highest precedence - directory containing plain file
     ]
 
     if custom_template_dir:

{codeplain-0.3.6 → codeplain-0.3.7}/module_renderer.py

@@ -158,13 +158,14 @@ class ModuleRenderer:
                     module.wipe_module()
 
         self.loaded_modules = list[PlainModule]()
+
         _, rendering_failed = self._render_module(self.plain_module, self.render_range, True)
+
         if not rendering_failed:
-            # Get the last module that completed rendering
             if self.args.copy_build:
                 rendered_code_path = f"{self.args.build_dest}/"
             else:
-                rendered_code_path = f"{os.path.join(self.args.build_folder, self.plain_module.module_name)}/"
+                rendered_code_path = self.args.build_folder
 
             self.run_state.set_render_generated_code_path(rendered_code_path)
             self.event_bus.publish(RenderCompleted(rendered_code_path=rendered_code_path))

codeplain-0.3.7/path_resolution.py

@@ -0,0 +1,64 @@
+"""Path resolution for CLI / config / default path arguments.
+
+The rule, in one sentence: the resolution base for a relative path is determined
+by *where the value was written*, not by which option key it sets.
+
+- Values supplied on the command line resolve against the current working
+  directory (so they match what shell tab completion just produced).
+- Values read from ``config.yaml`` resolve against the directory containing
+  that config file.
+- Values left at their default (not supplied anywhere) resolve against the
+  directory containing the spec file.
+
+Paths are expanded for ``~`` and returned as absolute paths. Canonicalization
+(symlink resolution) is left to the caller, to be done just before I/O that
+needs it (writing output, executing scripts) so we don't accidentally
+dereference links the user wanted preserved.
+"""
+
+import os
+from typing import Literal, Optional
+
+PathSource = Literal["cli", "config", "default"]
+
+
+def resolve_path(
+    value: str,
+    source: PathSource,
+    *,
+    cwd: str,
+    config_dir: Optional[str] = None,
+    spec_dir: str,
+) -> str:
+    """Resolve *value* to an absolute path using the base anchor for *source*.
+
+    Args:
+        value: The path string as written by the user. May be absolute, relative,
+            or contain a leading ``~``.
+        source: Where the value came from -- ``"cli"``, ``"config"``, or
+            ``"default"``.
+        cwd: Base directory for ``"cli"`` values.
+        config_dir: Base directory for ``"config"`` values. Must be provided
+            whenever ``source == "config"``.
+        spec_dir: Base directory for ``"default"`` values.
+
+    Returns:
+        Absolute path with ``~`` expanded. Symlinks are not resolved.
+    """
+    expanded = os.path.expanduser(value)
+
+    if os.path.isabs(expanded):
+        return os.path.normpath(expanded)
+
+    if source == "cli":
+        base = cwd
+    elif source == "config":
+        if config_dir is None:
+            raise ValueError("config_dir must be provided when source == 'config'")
+        base = config_dir
+    elif source == "default":
+        base = spec_dir
+    else:
+        raise ValueError(f"Unknown path source: {source!r}")
+
+    return os.path.normpath(os.path.join(base, expanded))

{codeplain-0.3.6 → codeplain-0.3.7}/plain2code.py

@@ -48,7 +48,6 @@ from plain2code_logger import (
     IndentedFormatter,
     LoggingHandler,
     dump_crash_logs,
-    get_log_file_path,
 )
 from plain2code_state import RunState
 from plain2code_telemetry import capture_crash, initialize_telemetry
@@ -89,8 +88,7 @@ def setup_logging(
     event_bus: EventBus,
     run_state: RunState,
     log_to_file: bool,
-    log_file_name: str,
-    plain_file_path: Optional[str],
+    log_file_path: str,
     headless: bool = False,
 ):
     default_level = logging.DEBUG if args.verbose else logging.INFO
@@ -101,10 +99,9 @@ def setup_logging(
     logging.getLogger("transitions").setLevel(logging.ERROR)
     logging.getLogger("transitions.extensions.diagrams").setLevel(logging.ERROR)
 
-    log_file_path = get_log_file_path(plain_file_path, log_file_name)
-
     # Try to load logging configuration from YAML file (takes precedence over --verbose)
     config_loaded = False
+
     if args.logging_config_path and os.path.exists(args.logging_config_path):
         try:
             with open(args.logging_config_path, "r") as f:
@@ -127,7 +124,7 @@ def setup_logging(
         handler.setFormatter(formatter)
         root_logger.addHandler(handler)
 
-    if log_to_file and log_file_path:
+    if log_to_file:
         try:
             file_handler = logging.FileHandler(log_file_path, mode="w", encoding="utf-8")
             file_handler.setFormatter(file_formatter)
@@ -356,7 +353,7 @@ def main():  # noqa: C901
     # Parse the plain file (and its required modules) once; reused by dry-run and rendering.
     try:
         plain_module = plain_modules.PlainModule(
-            args.filename,
+            os.path.basename(args.filename),
             args.build_folder,
             args.conformance_tests_folder,
             template_dirs,
@@ -383,9 +380,7 @@ def main():  # noqa: C901
         # Suppress Rich console output.
         console.quiet = True
 
-    default_log_level = setup_logging(
-        args, event_bus, run_state, args.log_to_file, args.log_file_name, args.filename, args.headless
-    )
+    default_log_level = setup_logging(args, event_bus, run_state, args.log_to_file, args.log_file_name, args.headless)
 
     initialize_telemetry()