codeplain 0.3.10.dev5__tar.gz → 0.3.11.dev7__tar.gz

{codeplain-0.3.10.dev5 → codeplain-0.3.11.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: codeplain
-Version: 0.3.10.dev5
+Version: 0.3.11.dev7
 Summary: Transform plain language specifications into working code
 License-File: LICENSE
 Classifier: Environment :: Console

codeplain-0.3.11.dev7/install/bash/examples.sh

@@ -0,0 +1,175 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Brand Colors (use exported colors if available, otherwise define them)
+YELLOW="${YELLOW:-\033[38;2;224;255;110m}"
+GREEN="${GREEN:-\033[38;2;121;252;150m}"
+WHITE="${WHITE:-\033[38;2;255;255;255m}"
+RED="${RED:-\033[38;2;239;68;68m}"
+GRAY="${GRAY:-\033[38;2;128;128;128m}"
+BOLD="${BOLD:-\033[1m}"
+NC="${NC:-\033[0m}"
+
+# Examples configuration
+EXAMPLES_FOLDER_NAME="plainlang-examples"
+EXAMPLES_DOWNLOAD_URL="https://codeplain.ai/examples/unix"
+
+# Prompt the user, reading from the terminal when there is one. Falling back to
+# stdin keeps the script usable in non-interactive environments instead of
+# dying on an unreadable /dev/tty.
+prompt_user() {
+    local prompt="$1"
+    local varname="$2"
+
+    # Test that /dev/tty can actually be opened: it exists but fails to open
+    # when the process has no controlling terminal.
+    if { : < /dev/tty; } 2>/dev/null; then
+        read -r -p "$prompt" "$varname" < /dev/tty || true
+    else
+        read -r -p "$prompt" "$varname" || true
+    fi
+}
+
+# Make the user acknowledge that the examples were not installed. The
+# installation continues either way, but the failure must not scroll past
+# unseen - the installer clears the screen in its next step.
+confirm_continue_after_failure() {
+    echo ""
+    echo -e "  ${YELLOW}The examples were not installed.${NC} ${GRAY}The installation will continue.${NC}"
+    echo ""
+    prompt_user "$(printf '%b' "  Continue? Press ${WHITE}[Enter]${NC} to acknowledge: ")" _ACKNOWLEDGED
+    echo ""
+}
+
+# Tell the user how to get unzip on their system, then let the installer move on.
+report_missing_unzip_tool() {
+    echo -e "  ${RED}✗ Cannot extract the examples: no 'unzip' command found.${NC}"
+    echo ""
+    echo -e "  ${GRAY}Install unzip and re-run the installer to get the examples:${NC}"
+    echo ""
+    case "$OSTYPE" in
+        darwin*)
+            echo -e "  ${WHITE}${BOLD}brew install unzip${NC}"
+            ;;
+        *)
+            echo -e "  ${WHITE}${BOLD}apt-get install unzip${NC}   ${GRAY}(Debian/Ubuntu)${NC}"
+            echo -e "  ${WHITE}${BOLD}dnf install unzip${NC}       ${GRAY}(Fedora/RHEL)${NC}"
+            echo -e "  ${WHITE}${BOLD}apk add unzip${NC}           ${GRAY}(Alpine)${NC}"
+            ;;
+    esac
+    echo ""
+    echo -e "  ${GRAY}The examples are also available at:${NC}"
+    echo -e "  ${WHITE}https://github.com/Codeplain-ai/plainlang-examples${NC}"
+    echo ""
+}
+
+# Checked before anything is downloaded, so a missing unzip is reported up
+# front instead of leaving the user with an installer that just stops.
+if ! command -v unzip &> /dev/null; then
+    report_missing_unzip_tool
+    confirm_continue_after_failure
+    exit 0
+fi
+
+# Show current directory and ask for extraction path
+CURRENT_DIR=$(pwd)
+echo -e "  Current folder: ${WHITE}${CURRENT_DIR}${NC}"
+echo ""
+echo -e "  Extract examples here, or enter a different path:"
+echo ""
+prompt_user "  [Enter for current, or type path]: " EXTRACT_PATH
+echo ""
+
+# Use current directory if empty
+if [ -z "${EXTRACT_PATH:-}" ]; then
+    EXTRACT_PATH="$CURRENT_DIR"
+fi
+
+# Expand ~ to home directory
+EXTRACT_PATH="${EXTRACT_PATH/#\~/$HOME}"
+
+SKIP_DOWNLOAD=false
+
+# Check if directory exists, create if not
+if [ ! -d "$EXTRACT_PATH" ]; then
+    echo -e "  ${GRAY}Creating directory...${NC}"
+    if ! mkdir -p "$EXTRACT_PATH" 2>/dev/null; then
+        echo -e "  ${RED}✗ Failed to create directory: ${EXTRACT_PATH}${NC}"
+        confirm_continue_after_failure
+        SKIP_DOWNLOAD=true
+    fi
+fi
+
+EXAMPLES_INSTALLED=false
+
+if [ "$SKIP_DOWNLOAD" = false ]; then
+    echo -e "  ${GRAY}Downloading examples...${NC}"
+
+    # Download the zip file
+    TEMP_ZIP=$(mktemp)
+    DOWNLOAD_OK=false
+    DOWNLOAD_ERROR="Could not download ${EXAMPLES_DOWNLOAD_URL}"
+    if curl -L -s -o "$TEMP_ZIP" "$EXAMPLES_DOWNLOAD_URL" && [ -s "$TEMP_ZIP" ]; then
+        DOWNLOAD_OK=true
+    fi
+
+    # A server error page is a successful download of the wrong thing, so check
+    # for the zip magic bytes rather than handing unzip an HTML page.
+    if [ "$DOWNLOAD_OK" = true ] && [ "$(head -c 2 "$TEMP_ZIP")" != "PK" ]; then
+        DOWNLOAD_OK=false
+        DOWNLOAD_ERROR="The downloaded file is not a zip archive."
+    fi
+
+    if [ "$DOWNLOAD_OK" = true ]; then
+        echo -e "  ${GRAY}Extracting to ${EXTRACT_PATH}...${NC}"
+
+        # Extract the zip file (contents are at the zip root, so extract into the target folder)
+        EXTRACTED_DIR="${EXTRACT_PATH}/${EXAMPLES_FOLDER_NAME}"
+        rm -rf "$EXTRACTED_DIR" 2>/dev/null || true  # Remove existing if present
+
+        # Keep the extractor's own error output: it is the only clue about why
+        # extraction failed (corrupt download, no disk space, no permissions).
+        if EXTRACT_OUTPUT=$(unzip -q -o "$TEMP_ZIP" -d "$EXTRACTED_DIR" 2>&1); then
+            # Remove the .gitignore file from the root of the extracted directory
+            if [ -f "${EXTRACTED_DIR}/.gitignore" ]; then
+                rm -f "${EXTRACTED_DIR}/.gitignore"
+            fi
+
+            clear || true
+            echo ""
+            echo -e "  ${GREEN}✓ Examples downloaded successfully!${NC}"
+            echo ""
+            echo -e "  ${GRAY}Examples are in: ${EXTRACTED_DIR}${NC}"
+            echo ""
+            echo -e "  ${WHITE}${BOLD}Try the hello, world example:${NC}"
+            echo ""
+            echo -e "  ${GRAY}Example folder:${NC} ${WHITE}cd ${EXTRACTED_DIR}/hello-world/python${NC}"
+            echo ""
+            echo -e "  ${GRAY}Render the example:${NC} ${WHITE}codeplain hello-world-python.plain${NC}"
+            echo ""
+            echo -e "  ${GRAY}See hello-world/python/README.md for details.${NC}"
+            echo ""
+            EXAMPLES_INSTALLED=true
+        else
+            echo -e "  ${RED}✗ Failed to extract examples.${NC}"
+            if [ -n "$EXTRACT_OUTPUT" ]; then
+                echo -e "  ${GRAY}$(echo "$EXTRACT_OUTPUT" | tail -n 3)${NC}"
+            fi
+        fi
+
+        # Clean up temp file
+        rm -f "$TEMP_ZIP"
+    else
+        echo -e "  ${RED}✗ Failed to download examples.${NC}"
+        echo -e "  ${GRAY}${DOWNLOAD_ERROR}${NC}"
+        rm -f "$TEMP_ZIP"
+    fi
+
+    if [ "$EXAMPLES_INSTALLED" = true ]; then
+        echo ""
+        prompt_user "$(printf '%b' "  Press ${WHITE}[Enter]${NC} to continue...")" _CONTINUE
+    else
+        confirm_continue_after_failure
+    fi
+fi

{codeplain-0.3.10.dev5 → codeplain-0.3.11.dev7}/install/bash/install.sh

@@ -425,9 +425,11 @@ else
     echo ""
 fi
 
-# Run examples download if user agrees
+# Run examples download if user agrees. The examples are a nice-to-have, so a
+# failure there must never abort the installation (set -e would otherwise take
+# the whole installer down without printing anything).
 if [[ ! "${DOWNLOAD_EXAMPLES:-}" =~ ^[Nn]$ ]]; then
-    run_script "examples.sh"
+    run_script "examples.sh" || echo -e "${GRAY}Example download did not complete. Continuing with the installation.${NC}"
 fi
 
 # Final verification: make sure the installed codeplain can actually run and

{codeplain-0.3.10.dev5 → codeplain-0.3.11.dev7}/install/powershell/examples.ps1

@@ -19,6 +19,39 @@ $CROSS = [char]0x2717
 $EXAMPLES_FOLDER_NAME = "plainlang-examples"
 $EXAMPLES_DOWNLOAD_URL = "https://codeplain.ai/examples/windows"
 
+# Make the user acknowledge that the examples were not installed. The
+# installation continues either way, but the failure must not scroll past
+# unseen - the installer clears the screen in its next step.
+function Confirm-ContinueAfterFailure {
+    Write-Host ""
+    Write-Host "  ${YELLOW}The examples were not installed.${NC} ${GRAY}The installation will continue.${NC}"
+    Write-Host ""
+    Read-Host "  Continue? Press ${WHITE}[Enter]${NC} to acknowledge"
+    Write-Host ""
+}
+
+# Expand-Archive lives in the Microsoft.PowerShell.Archive module, shipped with
+# PowerShell 5.0 and later. Checked before anything is downloaded, so a machine
+# without it is told what to do instead of just seeing an extraction failure.
+function Show-MissingArchiveCmdletMessage {
+    Write-Host "  ${RED}${CROSS} Cannot extract the examples: Expand-Archive is not available.${NC}"
+    Write-Host ""
+    Write-Host "  ${GRAY}Expand-Archive requires PowerShell 5.0 or later. Install a newer${NC}"
+    Write-Host "  ${GRAY}PowerShell and re-run the installer to get the examples:${NC}"
+    Write-Host ""
+    Write-Host "  ${WHITE}${BOLD}https://aka.ms/powershell${NC}"
+    Write-Host ""
+    Write-Host "  ${GRAY}The examples are also available at:${NC}"
+    Write-Host "  ${WHITE}https://github.com/Codeplain-ai/plainlang-examples${NC}"
+    Write-Host ""
+}
+
+if (-not (Get-Command Expand-Archive -ErrorAction SilentlyContinue)) {
+    Show-MissingArchiveCmdletMessage
+    Confirm-ContinueAfterFailure
+    exit 0
+}
+
 # Show current directory and ask for extraction path
 $CURRENT_DIR = Get-Location
 Write-Host "  Current folder: ${WHITE}${CURRENT_DIR}${NC}"
@@ -47,11 +80,13 @@ if (-not (Test-Path $EXTRACT_PATH -PathType Container)) {
         New-Item -ItemType Directory -Path $EXTRACT_PATH -Force | Out-Null
     } catch {
         Write-Host "  ${RED}${CROSS} Failed to create directory: ${EXTRACT_PATH}${NC}"
-        Write-Host "  ${GRAY}Skipping example download.${NC}"
+        Confirm-ContinueAfterFailure
         $SKIP_DOWNLOAD = $true
     }
 }
 
+$EXAMPLES_INSTALLED = $false
+
 if (-not $SKIP_DOWNLOAD) {
     Write-Host "  ${GRAY}Downloading examples...${NC}"
 
@@ -60,7 +95,26 @@ if (-not $SKIP_DOWNLOAD) {
     try {
         Invoke-WebRequest -Uri $EXAMPLES_DOWNLOAD_URL -OutFile $TEMP_ZIP -UseBasicParsing
 
+        # Check for the zip magic bytes rather than handing Expand-Archive a
+        # server error page. Read via a stream: 'Get-Content -Encoding Byte' is
+        # Windows PowerShell 5.1 only, '-AsByteStream' is PowerShell 6+ only.
+        $IS_ZIP = $false
         if (Test-Path $TEMP_ZIP) {
+            $HEADER = New-Object byte[] 2
+            $STREAM = [System.IO.File]::OpenRead($TEMP_ZIP)
+            try {
+                $BYTES_READ = $STREAM.Read($HEADER, 0, 2)
+            } finally {
+                $STREAM.Close()
+            }
+            $IS_ZIP = ($BYTES_READ -eq 2 -and $HEADER[0] -eq 0x50 -and $HEADER[1] -eq 0x4B)
+        }
+
+        if (-not $IS_ZIP -and (Test-Path $TEMP_ZIP)) {
+            Write-Host "  ${RED}${CROSS} Failed to download examples.${NC}"
+            Write-Host "  ${GRAY}The downloaded file is not a zip archive.${NC}"
+            Remove-Item -Path $TEMP_ZIP -Force -ErrorAction SilentlyContinue
+        } elseif ($IS_ZIP) {
             Write-Host "  ${GRAY}Extracting to ${EXTRACT_PATH}...${NC}"
 
             try {
@@ -91,8 +145,12 @@ if (-not $SKIP_DOWNLOAD) {
                 Write-Host ""
                 Write-Host "  ${GRAY}See hello-world/python/README.md for details.${NC}"
                 Write-Host ""
+                $EXAMPLES_INSTALLED = $true
             } catch {
+                # Keep the cmdlet's own message: it is the only clue about why
+                # extraction failed (corrupt download, no space, no permissions).
                 Write-Host "  ${RED}${CROSS} Failed to extract examples.${NC}"
+                Write-Host "  ${GRAY}$($_.Exception.Message)${NC}"
             }
 
             Remove-Item -Path $TEMP_ZIP -Force -ErrorAction SilentlyContinue
@@ -104,6 +162,10 @@ if (-not $SKIP_DOWNLOAD) {
         Remove-Item -Path $TEMP_ZIP -Force -ErrorAction SilentlyContinue
     }
 
-    Write-Host ""
-    Read-Host "  Press ${WHITE}[Enter]${NC} to continue..."
+    if ($EXAMPLES_INSTALLED) {
+        Write-Host ""
+        Read-Host "  Press ${WHITE}[Enter]${NC} to continue..."
+    } else {
+        Confirm-ContinueAfterFailure
+    }
 }

{codeplain-0.3.10.dev5 → codeplain-0.3.11.dev7}/install/powershell/install.ps1

@@ -526,9 +526,16 @@ if ($nonInteractive) {
     Write-Host ""
 }
 
-# Run examples download if user agrees
+# Run examples download if user agrees. The examples are a nice-to-have, so a
+# failure there must never abort the installation: examples.ps1 runs in this
+# runspace via the call operator, so a terminating error inside it would
+# otherwise propagate here and take the whole installer down.
 if ($downloadExamples -notmatch '^[Nn]$') {
-    Invoke-SubScript "examples.ps1"
+    try {
+        Invoke-SubScript "examples.ps1"
+    } catch {
+        Write-Host "${GRAY}Example download did not complete. Continuing with the installation.${NC}"
+    }
 }
 
 # Final verification: make sure the installed codeplain can actually run and

{codeplain-0.3.10.dev5 → codeplain-0.3.11.dev7}/plain2code_console.py

@@ -27,7 +27,7 @@ class Plain2CodeConsole(Console):
     DEBUG_STYLE = Style(color="purple")
 
     def __init__(self):
-        super().__init__()
+        super().__init__(emoji=False)
         try:
             import tiktoken
 
@@ -66,9 +66,10 @@ class Plain2CodeConsole(Console):
         """
         logger.log(level, " ".join(map(str, args)), extra={"log_color": color})
         style = base_style + Style(color=color) if color else base_style
-        # Log messages must render exactly as logged: don't interpret square brackets
-        # in interpolated content (error texts, file names) as Rich markup, and don't
-        # let the repr highlighter restyle brackets and numbers inside them.
+        # Messages must render exactly as logged and not pick its own styling:
+        # -- no Rich markup (via square brackets) in interpolated content (error texts, file names)
+        # -- no repr highlighter restyling brackets and numbers inside them.
+        # -- no emoji substitution, but it's set False in __init__, otherwise it won't reach renderables like Trees
         kwargs.setdefault("markup", False)
         kwargs.setdefault("highlight", False)
         super().print(*args, **kwargs, style=style)

{codeplain-0.3.10.dev5 → codeplain-0.3.11.dev7}/tests/test_console_log_styles.py

@@ -70,14 +70,70 @@ class TestConsoleColorParam:
 
         assert handler.records[0].log_color is None
 
-    def test_bracketed_error_text_prints_verbatim(self):
-        console, handler = make_console_with_capture()
-        console.quiet = False
+
+class TestTerminalTextRendersVerbatim:
+    """
+    Message text must reach the terminal unchanged, and must not influence its own
+    styling. Colors are still applied but they are chosen by the call, never parsed
+    out of the text:
+     - Rich markup tags must not be interpreted
+     - the repr highlighter must not restyle brackets and numbers
+     - emoji shortcodes must not be substituted by glyphs
+    """
+
+    def test_markup_closing_tag_prints_verbatim(self):
+        console = Plain2CodeConsole()
         with console.capture() as capture:
-            console.info("Error: [Errno 8] failed [/closing] tag", color=RETRY_COLOR)
-        assert "[Errno 8]" in capture.get()
+            console.error("Error: [/closing] tag")
+        # markup=True raises MarkupError on an unmatched closing tag
         assert "[/closing]" in capture.get()
 
+    def test_markup_style_tag_prints_verbatim(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.error("Error: [bold]important text")
+        # markup=True silently consumes the tag and styles the rest
+        assert "[bold]" in capture.get()
+
+    def test_bracketed_number_prints_verbatim(self, monkeypatch):
+        # Rich emits no ANSI unless it believes it is writing to a colored terminal
+        # (FORCE_COLOR alone is not enough: TERM=dumb still resolves to no colors)
+        monkeypatch.setenv("FORCE_COLOR", "1")
+        monkeypatch.setenv("TERM", "xterm-256color")
+        console = Plain2CodeConsole()
+        assert console.color_system is not None  # should fail test immediately if no colors
+
+        with console.capture() as capture:
+            console.error("Error: [Errno 8] failed")
+        # highlight=True breaks this up with colour codes
+        assert "[Errno 8]" in capture.get()
+
+    def test_concept_name_matching_emoji_prints_verbatim(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.error("Syntax error: Invalid concept: :Package:")
+        assert ":Package:" in capture.get()
+        assert "📦" not in capture.get()
+
+
+class TestPrintHelpersDoNotSubstituteEmoji:
+    """
+    Same rule as TestTerminalTextRendersVerbatim, for the two helpers that bypass _log_and_print.
+    Only emoji is covered here, markup and highlighting still apply to them.
+    """
+
+    def test_print_list_does_not_substitute_emoji(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.print_list(["The :Package: is a concept"])
+        assert ":Package:" in capture.get()
+
+    def test_print_files_does_not_substitute_emoji_in_tree_labels(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.print_files("Files added:", "build", {":Package:.py": "x"})
+        assert ":Package:" in capture.get()
+
 
 class TestLoggingHandlerForwardsColor:
     """LoggingHandler must forward the log_color record attribute into LogMessageEmitted."""

codeplain-0.3.10.dev5/install/bash/examples.sh

@@ -1,97 +0,0 @@
-#!/bin/bash
-
-set -euo pipefail
-
-# Brand Colors (use exported colors if available, otherwise define them)
-YELLOW="${YELLOW:-\033[38;2;224;255;110m}"
-GREEN="${GREEN:-\033[38;2;121;252;150m}"
-WHITE="${WHITE:-\033[38;2;255;255;255m}"
-RED="${RED:-\033[38;2;239;68;68m}"
-GRAY="${GRAY:-\033[38;2;128;128;128m}"
-BOLD="${BOLD:-\033[1m}"
-NC="${NC:-\033[0m}"
-
-# Examples configuration
-EXAMPLES_FOLDER_NAME="plainlang-examples"
-EXAMPLES_DOWNLOAD_URL="https://codeplain.ai/examples/unix"
-
-# Show current directory and ask for extraction path
-CURRENT_DIR=$(pwd)
-echo -e "  Current folder: ${WHITE}${CURRENT_DIR}${NC}"
-echo ""
-echo -e "  Extract examples here, or enter a different path:"
-echo ""
-read -r -p "  [Enter for current, or type path]: " EXTRACT_PATH < /dev/tty
-echo ""
-
-# Use current directory if empty
-if [ -z "${EXTRACT_PATH:-}" ]; then
-    EXTRACT_PATH="$CURRENT_DIR"
-fi
-
-# Expand ~ to home directory
-EXTRACT_PATH="${EXTRACT_PATH/#\~/$HOME}"
-
-SKIP_DOWNLOAD=false
-
-# Check if directory exists, create if not
-if [ ! -d "$EXTRACT_PATH" ]; then
-    echo -e "  ${GRAY}Creating directory...${NC}"
-    mkdir -p "$EXTRACT_PATH" 2>/dev/null
-    if [ $? -ne 0 ]; then
-        echo -e "  ${RED}✗ Failed to create directory: ${EXTRACT_PATH}${NC}"
-        echo -e "  ${GRAY}Skipping example download.${NC}"
-        SKIP_DOWNLOAD=true
-    fi
-fi
-
-if [ "$SKIP_DOWNLOAD" = false ]; then
-    echo -e "  ${GRAY}Downloading examples...${NC}"
-
-    # Download the zip file
-    TEMP_ZIP=$(mktemp)
-    curl -L -s -o "$TEMP_ZIP" "$EXAMPLES_DOWNLOAD_URL"
-
-    if [ $? -eq 0 ] && [ -s "$TEMP_ZIP" ]; then
-        echo -e "  ${GRAY}Extracting to ${EXTRACT_PATH}...${NC}"
-
-        # Extract the zip file (contents are at the zip root, so extract into the target folder)
-        EXTRACTED_DIR="${EXTRACT_PATH}/${EXAMPLES_FOLDER_NAME}"
-        rm -rf "$EXTRACTED_DIR" 2>/dev/null  # Remove existing if present
-        unzip -q -o "$TEMP_ZIP" -d "$EXTRACTED_DIR" 2>/dev/null
-
-        if [ $? -eq 0 ]; then
-            # Remove the .gitignore file from the root of the extracted directory
-            if [ -f "${EXTRACTED_DIR}/.gitignore" ]; then
-                rm -f "${EXTRACTED_DIR}/.gitignore"
-            fi
-
-            clear
-            echo ""
-            echo -e "  ${GREEN}✓ Examples downloaded successfully!${NC}"
-            echo ""
-            echo -e "  ${GRAY}Examples are in: ${EXTRACTED_DIR}${NC}"
-            echo ""
-            echo -e "  ${WHITE}${BOLD}Try the hello, world example:${NC}"
-            echo ""
-            echo -e "  ${GRAY}Example folder:${NC} ${WHITE}cd ${EXTRACTED_DIR}/hello-world/python${NC}"
-            echo ""
-            echo -e "  ${GRAY}Render the example:${NC} ${WHITE}codeplain hello-world-python.plain${NC}"
-            echo ""
-            echo -e "  ${GRAY}See hello-world/python/README.md for details.${NC}"
-            echo ""
-        else
-            echo -e "  ${RED}✗ Failed to extract examples.${NC}"
-        fi
-
-        # Clean up temp file
-        rm -f "$TEMP_ZIP"
-    else
-        echo -e "  ${RED}✗ Failed to download examples.${NC}"
-        rm -f "$TEMP_ZIP"
-    fi
-
-    echo ""
-    PROMPT=$(printf '%b' "  Press ${WHITE}[Enter]${NC} to continue...")
-    read -r -p "$PROMPT" < /dev/tty
-fi