feat: console prompts wrappers by loadinglucian · Pull Request #26 · loadinglucian/deployer-php

loadinglucian · 2025-10-04T11:50:51Z

Summary by CodeRabbit

New Features
- Expanded interactive CLI prompts: text, password, confirm, select, multiselect, suggest, search, pause, and spinner.
- Closure-based prompting when options aren’t provided for flexible non-interactive/interactive flows.
Refactor
- Streamlined output helpers and updated formatting for info, success, warning, error, headings, and command hints.
- Removed the plain single-line text helper.
Documentation
- Updated command usage examples and non-interactive guidance; removed an outdated section header guidance.
Tests
- Added and updated tests to cover new prompt wrappers, closure flows, and revised output formatting.

… trait

coderabbitai · 2025-10-04T11:51:12Z

Caution

Review failed

The pull request is closed.

Walkthrough

This PR refactors console I/O: removes legacy text()/note() helpers, changes several output method signatures/formatting, adds closure-driven getOptionOrPrompt and numerous prompt wrapper methods, updates docs, and adapts tests to use a mock command factory and expanded prompt/output coverage.

Changes

Cohort / File(s)	Summary
Rules docs `.cursor/rules/01-architecture.mdc`, `.cursor/rules/03-commands.mdc`	Removes a header-format guidance block; updates commands doc to drop `text()` examples, add closure-based `getOptionOrPrompt`, introduce prompt wrapper APIs and update example wording.
Console input trait `app/Traits/ConsoleInputTrait.php`	Adds `getOptionOrPrompt(string, Closure)`, a spacing-suppression helper, and prompt wrappers: `promptText`, `promptPassword`, `promptConfirm`, `promptPause`, `promptSelect`, `promptMultiselect`, `promptSuggest`, `promptSearch`, `promptSpin`; adds related imports and docblocks.
Console output trait `app/Traits/ConsoleOutputTrait.php`	Removes `text()` and note alias; updates `info`, `success`, `warning`, `error` formats (error signature now `error(string)`); `h1()` now emits a trailing blank line; `showCommandHint()` signature simplified and rendering changed to multi-line.
Test fixture and helpers `tests/Fixtures/TestConsoleCommand.php`, `tests/TestHelpers.php`	Adds `-y
Unit tests — BaseCommand and helpers `tests/Unit/Contracts/BaseCommandTest.php`, `tests/Unit/TestHelpersTest.php`	Replaces `text(...)` calls with `writeln(...)` in tests; adds test validating `mockTestConsoleCommand()` returns `TestConsoleCommand`.
Unit tests — traits `tests/Unit/Traits/ConsoleInputTraitTest.php`, `tests/Unit/Traits/ConsoleOutputTraitTest.php`	Refactors to use `mockTestConsoleCommand()`; expands input tests for option/closure/boolean/types and multiple prompt wrappers (including spinner); updates output tests to match new symbols, formats, h1/hr and command hint rendering.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Cmd as BaseCommand<br/>(ConsoleInputTrait)
  participant Prompts as Laravel Prompts

  User->>Cmd: execute()
  Cmd->>Cmd: getOptionOrPrompt(name, promptCb)
  alt option provided
    Cmd-->>User: return option value
  else option missing
    Cmd->>Prompts: prompt* wrapper via promptCb()
    Prompts-->>Cmd: user input
    Cmd-->>User: return prompted value
  end

sequenceDiagram
  autonumber
  actor User
  participant Cmd as BaseCommand<br/>(ConsoleOutputTrait)

  User->>Cmd: execute()
  Note over Cmd: Updated output helpers and formats
  Cmd->>User: info() → "<fg=cyan>ℹ message</>"
  Cmd->>User: success() → "✓ message"
  Cmd->>User: warning() → "⚠ message"
  Cmd->>User: error() → "✗ message"
  Cmd->>User: h1(), hr(), writeln()
  Cmd->>User: showCommandHint(cmd, options) → multi-line hint

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

bigpixelrocket/deployer-php#23 — Modifies the same console I/O traits and getOptionOrPrompt; strong code-level overlap.
bigpixelrocket/deployer-php#26 — Adds prompt wrappers and removes text() in the same traits; directly related changes.
bigpixelrocket/deployer-php#20 — Adjusts console output/prompt usage and deprecates text(); closely connected to this refactor.

Poem

A rabbit taps the terminal keys,
Swaps old text for prompts with nimble ease.
Closures hop where options fail,
Spinners whirl their cotton tail.
Hints now line up, neat and clear—
Console burrows, crisp to hear.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly and succinctly describes the main feature introduced by the pull request, namely the addition of console prompt wrapper methods, and follows a standard “feat:” prefix to indicate a new feature. It is concise, focused on the primary change, and easily understood by team members scanning the PR history.
Docstring Coverage	✅ Passed	Docstring coverage is 89.29% which is sufficient. The required threshold is 80.00%.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdf9ef5 and 3390a3f.

📒 Files selected for processing (2)

tests/Fixtures/TestConsoleCommand.php (3 hunks)
tests/Unit/Traits/ConsoleInputTraitTest.php (2 hunks)

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

tests/TestHelpers.php (1)
256-272: Complete the helper docblock.

The new helper needs the parameter and return annotations called out in our PHP guidelines. Please extend the docblock accordingly. As per coding guidelines
     /**
      * Create a TestConsoleCommand for testing with mocked dependencies.
+     *
+     * @param bool $envFileExists Whether the .env file should be treated as present.
+     * @param string $envContent Contents to expose through the mocked .env file.
+     * @param bool $inventoryFileExists Whether the inventory file should be treated as present.
+     * @param array|string $inventoryData Inventory structure or raw YAML to preload.
+     * @return TestConsoleCommand
      */
tests/Unit/Traits/ConsoleInputTraitTest.php (1)

120-139: Consider the trade-offs of regex-based verification.

This test verifies that each prompt wrapper calls suppressPromptSpacing() by reading and parsing the source file with regex. While this ensures the implementation detail is correct, it's potentially fragile if the method implementation is refactored (e.g., extracting helper methods, adding complexity).

However, given that this appears to be testing a critical requirement (consistent spacing suppression), the approach is acceptable for now.

Alternative approach to consider for the future: Mock the Laravel Prompts functions and verify that output has the expected ANSI escape sequences, which would test behavior rather than implementation.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ed2ceed and bdf9ef5.

📒 Files selected for processing (10)

.cursor/rules/01-architecture.mdc (0 hunks)
.cursor/rules/03-commands.mdc (8 hunks)
app/Traits/ConsoleInputTrait.php (2 hunks)
app/Traits/ConsoleOutputTrait.php (4 hunks)
tests/Fixtures/TestConsoleCommand.php (3 hunks)
tests/TestHelpers.php (2 hunks)
tests/Unit/Contracts/BaseCommandTest.php (1 hunks)
tests/Unit/TestHelpersTest.php (1 hunks)
tests/Unit/Traits/ConsoleInputTraitTest.php (2 hunks)
tests/Unit/Traits/ConsoleOutputTraitTest.php (2 hunks)

💤 Files with no reviewable changes (1)

.cursor/rules/01-architecture.mdc

🧰 Additional context used

📓 Path-based instructions (5)

**/*.php

📄 CodeRabbit inference engine (.cursor/rules/01-architecture.mdc)

**/*.php: Follow PSR-12 coding standard in all PHP files
Declare strict types in all PHP files (declare(strict_types=1);)
Use PHP 8.x features where appropriate (unions, match, attributes, readonly)
Use import statements (use ...) instead of fully qualified class names in code
All methods must declare explicit return types with proper generics (e.g., Collection<int, User>)
Prefer Dependency Injection over manual class resolution/instantiation
Use Symfony component classes (e.g., Filesystem, Process) instead of native PHP functions for easier mocking
All object creation must use $container->build(ClassName::class) except for value objects, DTOs, and pure data structures
Access the container via constructor injection in production code; tests may instantiate Container directly
Services must receive dependencies via constructor injection
Use SymfonyStyle consistently for all user-facing console output
Add DocBlock comments with minimalist descriptions, parameters, and return types for classes and functions
Use comments to separate sections and explain complex logic; avoid obvious or stale comments
Use the exact section header comment format with a single newline between headers/subheaders/paragraphs

**/*.php: Eliminate single-use private methods by inlining them directly
Cache expensive computed values by initializing them in the constructor instead of recomputing
Prefer direct property access over method calls when appropriate to avoid call overhead
Organize code into comment-separated sections; prefer alphabetical ordering when it does not conflict with logical grouping

Files:

tests/Unit/Traits/ConsoleOutputTraitTest.php
tests/Unit/Traits/ConsoleInputTraitTest.php
tests/TestHelpers.php
tests/Unit/TestHelpersTest.php
app/Traits/ConsoleOutputTrait.php
tests/Fixtures/TestConsoleCommand.php
app/Traits/ConsoleInputTrait.php
tests/Unit/Contracts/BaseCommandTest.php

{tests/**,test/**,**/*@(Test|Spec).php}

📄 CodeRabbit inference engine (.cursor/rules/00-main.mdc)

Do not run or edit tests unless explicitly instructed

Files:

tests/Unit/Traits/ConsoleOutputTraitTest.php
tests/Unit/Traits/ConsoleInputTraitTest.php
tests/TestHelpers.php
tests/Unit/TestHelpersTest.php
tests/Fixtures/TestConsoleCommand.php
tests/Unit/Contracts/BaseCommandTest.php

tests/**/*.php

📄 CodeRabbit inference engine (.cursor/rules/02-tests.mdc)

tests/**/*.php: Use Pest exclusively with it() syntax for tests
In unit tests, instantiate classes manually with explicit mocks; use the container only for integration tests
Keep individual test files under ~1.8x the size of the source they cover
Test core business logic; avoid testing the framework itself
Prefer dataset-driven testing with ->with([...]) for multiple scenarios
Eliminate overlapping tests; avoid two tests covering the same functionality
Consolidate assertions with expect(...)->and(...) when appropriate
Mock external dependencies only; do not mock internal behavior
Avoid performance tests unless performance is the primary concern
Do not sacrifice readability to hit size/ratio targets
Follow the AAA pattern (Arrange, Act, Assert) in tests; use ACT & ASSERT for exception tests when act triggers assertion
Organize tests with describe() blocks, beforeEach() setup, and extract helpers/traits for DRY
Forbid meaningless assertions (e.g., toBeTrue, not->toBeNull, type-only checks, sleep(...)); use time mocking instead of sleep
Prefer meaningful assertions on behavior and results, and proper mocks (e.g., expect domain outputs; mock->shouldReceive(...))
Unit tests: mock all external dependencies; test single units in isolation; execute in milliseconds
Integration tests: perform real file operations/external processes; cover CLI commands and full workflows
Ignore PHPStan issues in tests; avoid excessive PHPDoc added only to appease types

Files:

tests/Unit/Traits/ConsoleOutputTraitTest.php
tests/Unit/Traits/ConsoleInputTraitTest.php
tests/TestHelpers.php
tests/Unit/TestHelpersTest.php
tests/Fixtures/TestConsoleCommand.php
tests/Unit/Contracts/BaseCommandTest.php

app/Traits/ConsoleOutputTrait.php

📄 CodeRabbit inference engine (.cursor/rules/03-commands.mdc)

Add output/formatting methods in ConsoleOutputTrait that format and display text and operate via $this->io

Files:

app/Traits/ConsoleOutputTrait.php

app/Traits/ConsoleInputTrait.php

📄 CodeRabbit inference engine (.cursor/rules/03-commands.mdc)

Add input-gathering methods in ConsoleInputTrait that operate via $this->input (prompt helpers, validators, transformers)

Files:

app/Traits/ConsoleInputTrait.php

🧠 Learnings (10)