Merge branch 'main' into copilot/enhance-table-format

swissspidy · web-flow · commit 22c6f6720273 · 2026-01-20T21:17:04.000+01:00
diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml
@@ -17,17 +17,17 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
 
       - name: Check existence of composer.json file
         id: check_composer_file
-        uses: andstor/file-existence-action@v3
+        uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3
         with:
           files: "composer.json"
 
       - name: Set up PHP environment
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1 # v2
         with:
           php-version: 'latest'
           ini-values: zend.assertions=1, error_reporting=-1, display_errors=On
@@ -38,7 +38,7 @@ jobs:
 
       - name: Install Composer dependencies & cache dependencies
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # v3
         env:
           COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }}
         with:
diff --git a/.github/workflows/issue-triage.yml b/.github/workflows/issue-triage.yml
@@ -13,6 +13,13 @@ name: Issue and PR Triage
         required: false
         type: string
 
+permissions:
+  issues: write
+  pull-requests: write
+  actions: write
+  contents: read
+  models: read
+
 jobs:
   issue-triage:
     uses: wp-cli/.github/.github/workflows/reusable-issue-triage.yml@main
diff --git a/.github/workflows/regenerate-readme.yml b/.github/workflows/regenerate-readme.yml
@@ -10,6 +10,10 @@ on:
       - "features/**"
       - "README.md"
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   regenerate-readme:
     uses: wp-cli/.github/.github/workflows/reusable-regenerate-readme.yml@main
diff --git a/.github/workflows/welcome-new-contributors.yml b/.github/workflows/welcome-new-contributors.yml
@@ -7,6 +7,9 @@ on:
       - main
       - master
 
+permissions:
+  pull-requests: write
+
 jobs:
   welcome:
     uses: wp-cli/.github/.github/workflows/reusable-welcome-new-contributors.yml@main
diff --git a/lib/cli/Colors.php b/lib/cli/Colors.php
@@ -280,4 +280,96 @@ static public function getStringCache() {
 	static public function clearStringCache() {
 		self::$_string_cache = array();
 	}
+
+	/**
+	 * Get the ANSI reset code.
+	 *
+	 * @return string The ANSI reset code.
+	 */
+	static public function getResetCode() {
+		return "\x1b[0m";
+	}
+
+	/**
+	 * Wrap a pre-colorized string at a specific width, preserving color codes.
+	 *
+	 * This function wraps text that contains ANSI color codes, ensuring that:
+	 * 1. Color codes are never split in the middle
+	 * 2. Active colors are properly terminated and restored across line breaks
+	 * 3. The wrapped segments maintain the correct display width
+	 *
+	 * Note: This implementation tracks only the most recent ANSI code and does not
+	 * support layered formatting (e.g., bold + color). When multiple formatting
+	 * codes are applied, only the last one will be preserved across line breaks.
+	 *
+	 * @param string      $string   The string to wrap (with ANSI codes).
+	 * @param int         $width    The maximum display width per line.
+	 * @param string|bool $encoding Optional. The encoding of the string. Default false.
+	 * @return array Array of wrapped string segments.
+	 */
+	static public function wrapPreColorized( $string, $width, $encoding = false ) {
+		$wrapped = array();
+		$current_line = '';
+		$current_width = 0;
+		$active_color = '';
+		
+		// Pattern to match ANSI escape sequences
+		$ansi_pattern = '/(\x1b\[[0-9;]*m)/';
+		
+		// Split the string into parts: ANSI codes and text
+		$parts = preg_split( $ansi_pattern, $string, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY );
+		
+		foreach ( $parts as $part ) {
+			// Check if this part is an ANSI code
+			if ( preg_match( $ansi_pattern, $part ) ) {
+				// It's an ANSI code, add it to current line without counting width
+				$current_line .= $part;
+				
+				// Track the active color - check for reset codes consistently
+				if ( preg_match( '/\x1b\[0m/', $part ) ) {
+					// Reset code (ESC[0m)
+					$active_color = '';
+				} elseif ( preg_match( '/\x1b\[([0-9;]+)m/', $part, $matches ) ) {
+					// Non-reset color/formatting code
+					$active_color = $part;
+				}
+			} else {
+				// It's text content, process it character by character
+				$text_length = \cli\safe_strlen( $part, $encoding );
+				$offset = 0;
+				
+				while ( $offset < $text_length ) {
+					$char = \cli\safe_substr( $part, $offset, 1, false, $encoding );
+					$char_width = \cli\strwidth( $char, $encoding );
+					
+					// Check if adding this character would exceed the width
+					if ( $current_width + $char_width > $width && $current_width > 0 ) {
+						// Need to wrap - finish current line
+						if ( $active_color ) {
+							$current_line .= self::getResetCode();
+						}
+						$wrapped[] = $current_line;
+						
+						// Start new line
+						$current_line = $active_color ? $active_color : '';
+						$current_width = 0;
+					}
+					
+					// Add the character
+					$current_line .= $char;
+					$current_width += $char_width;
+					$offset++;
+				}
+			}
+		}
+		
+		// Add the last line if there's any displayable content
+		$visible_content = preg_replace( $ansi_pattern, '', $current_line );
+		$visible_width = $visible_content !== null ? \cli\strwidth( $visible_content, $encoding ) : 0;
+		if ( $visible_width > 0 ) {
+			$wrapped[] = $current_line;
+		}
+		
+		return $wrapped;
+	}
 }
diff --git a/lib/cli/Table.php b/lib/cli/Table.php
@@ -97,6 +97,17 @@ public function resetTable()
 		return $this;
 	}
 
+	/**
+	 * Resets only the rows in the table, keeping headers, footers, and width information.
+	 *
+	 * @return $this
+	 */
+	public function resetRows()
+	{
+		$this->_rows = array();
+		return $this;
+	}
+
 	/**
 	 * Sets the renderer used by this table.
 	 *
@@ -142,6 +153,33 @@ public function display() {
 		}
 	}
 
+	/**
+	 * Display a single row without headers or top border.
+	 *
+	 * This method is useful for adding rows incrementally to an already-rendered table.
+	 * It will display the row with side borders and a bottom border (if using Ascii renderer).
+	 *
+	 * @param array $row The row data to display.
+	 */
+	public function displayRow(array $row) {
+		// Update widths if this row has wider content
+		$row = $this->checkRow($row);
+		
+		// Recalculate widths for the renderer
+		$this->_renderer->setWidths($this->_width, false);
+		
+		$rendered_row = $this->_renderer->row($row);
+		$row_lines = explode( PHP_EOL, $rendered_row );
+		foreach ( $row_lines as $line ) {
+			Streams::line( $line );
+		}
+		
+		$border = $this->_renderer->border();
+		if (isset($border)) {
+			Streams::line( $border );
+		}
+	}
+
 	/**
 	 * Get the table lines to output.
 	 *
@@ -171,7 +209,8 @@ public function getDisplayLines() {
 			$out = array_merge( $out, $row );
 		}
 
-		if (isset($border)) {
+		// Only add final border if there are rows
+		if (!empty($this->_rows) && isset($border)) {
 			$out[] = $border;
 		}
 
diff --git a/lib/cli/table/Ascii.php b/lib/cli/table/Ascii.php
@@ -83,6 +83,8 @@ public function setWidths(array $widths, $fallback = false) {
 		}
 
 		$this->_widths = $widths;
+		// Reset border cache when widths change
+		$this->_border = null;
 	}
 
 	/**
@@ -146,14 +148,21 @@ public function row( array $row ) {
 
 					$wrapped_lines = [];
 					foreach ( $split_lines as $line ) {
-						do {
-							$wrapped_value = \cli\safe_substr( $line, 0, $col_width, true /*is_width*/, $encoding );
-							$val_width     = Colors::width( $wrapped_value, self::isPreColorized( $col ), $encoding );
-							if ( $val_width ) {
-								$wrapped_lines[] = $wrapped_value;
-								$line            = \cli\safe_substr( $line, \cli\safe_strlen( $wrapped_value, $encoding ), null /*length*/, false /*is_width*/, $encoding );
-							}
-						} while ( $line );
+						// Use the new color-aware wrapping for pre-colorized content
+						if ( self::isPreColorized( $col ) && Colors::width( $line, true, $encoding ) > $col_width ) {
+							$line_wrapped = Colors::wrapPreColorized( $line, $col_width, $encoding );
+							$wrapped_lines = array_merge( $wrapped_lines, $line_wrapped );
+						} else {
+							// For non-colorized content, use the original logic
+							do {
+								$wrapped_value = \cli\safe_substr( $line, 0, $col_width, true /*is_width*/, $encoding );
+								$val_width     = Colors::width( $wrapped_value, self::isPreColorized( $col ), $encoding );
+								if ( $val_width ) {
+									$wrapped_lines[] = $wrapped_value;
+									$line = \cli\safe_substr( $line, \cli\safe_strlen( $wrapped_value, $encoding ), null /*length*/, false /*is_width*/, $encoding );
+								}
+							} while ( $line );
+						}
 					}
 
 					$row[ $col ] = array_shift( $wrapped_lines );
diff --git a/tests/Test_Table.php b/tests/Test_Table.php
@@ -379,5 +379,78 @@ public function test_alignment_before_headers() {
 		// Should be right-aligned - "Name" is 4 chars, "LongName" is 8 chars, so column width is 8
 		$this->assertStringContainsString( '|     Name |', $out[1] );
 		$this->assertStringContainsString( '| LongName |', $out[3] );
+	public function test_resetRows() {
+		$table = new cli\Table();
+		$table->setHeaders( array( 'Name', 'Age' ) );
+		$table->addRow( array( 'Alice', '30' ) );
+		$table->addRow( array( 'Bob', '25' ) );
+		
+		$this->assertEquals( 2, $table->countRows() );
+		
+		$table->resetRows();
+		
+		$this->assertEquals( 0, $table->countRows() );
+		
+		// Headers should still be intact
+		$out = $table->getDisplayLines();
+		$this->assertGreaterThan( 0, count( $out ) );
+	}
+
+	public function test_displayRow_ascii() {
+		$mockFile = tempnam( sys_get_temp_dir(), 'temp' );
+		$resource = fopen( $mockFile, 'wb' );
+
+		try {
+			\cli\Streams::setStream( 'out', $resource );
+			
+			$table    = new cli\Table();
+			$renderer = new cli\Table\Ascii();
+			$table->setRenderer( $renderer );
+			$table->setHeaders( array( 'Name', 'Age' ) );
+			
+			// Display a single row
+			$table->displayRow( array( 'Alice', '30' ) );
+			
+			$output = file_get_contents( $mockFile );
+			
+			// Should contain the row data
+			$this->assertStringContainsString( 'Alice', $output );
+			$this->assertStringContainsString( '30', $output );
+			
+			// Should contain borders
+			$this->assertStringContainsString( '|', $output );
+			$this->assertStringContainsString( '+', $output );
+		} finally {
+			if ( $mockFile && file_exists( $mockFile ) ) {
+				unlink( $mockFile );
+			}
+		}
+	}
+
+	public function test_displayRow_tabular() {
+		$mockFile = tempnam( sys_get_temp_dir(), 'temp' );
+		$resource = fopen( $mockFile, 'wb' );
+
+		try {
+			\cli\Streams::setStream( 'out', $resource );
+			
+			$table    = new cli\Table();
+			$renderer = new cli\Table\Tabular();
+			$table->setRenderer( $renderer );
+			$table->setHeaders( array( 'Name', 'Age' ) );
+			
+			// Display a single row
+			$table->displayRow( array( 'Alice', '30' ) );
+			
+			$output = file_get_contents( $mockFile );
+			
+			// Should contain the row data with tabs
+			$this->assertStringContainsString( 'Alice', $output );
+			$this->assertStringContainsString( '30', $output );
+		} finally {
+			if ( $mockFile && file_exists( $mockFile ) ) {
+				unlink( $mockFile );
+			}
+		}
 	}
 }
diff --git a/tests/Test_Table_Ascii.php b/tests/Test_Table_Ascii.php
@@ -114,6 +114,45 @@ public function testDrawOneColumnColorDisabledTable() {
 		$this->assertInOutEquals(array($headers, $rows), $output);
 	}
 
+	/**
+	 * Test that colorized text wraps correctly while maintaining color codes.
+	 */
+	public function testWrappedColorizedText() {
+		Colors::enable( true );
+		$headers = array('Column 1', 'Column 2');
+		$green_code = "\x1b\x5b\x33\x32\x3b\x31\x6d"; // Green + bright
+		$reset_code = "\x1b\x5b\x30\x6d"; // Reset
+		
+		// Create a long colorized string that will wrap
+		$long_text = Colors::colorize('%GThis is a long green text%n', true);
+		
+		$rows = array(
+			array('Short', $long_text),
+		);
+		
+		// Expected output with wrapped text maintaining colors
+		// The color codes are preserved across wrapped lines
+		$output = <<<OUT
++------------+--------------+
+| Column 1   | Column 2     |
++------------+--------------+
+| Short      | {$green_code}This is a lo{$reset_code} |
+|            | {$green_code}ng green tex{$reset_code} |
+|            | {$green_code}t{$reset_code}            |
++------------+--------------+
+
+OUT;
+		
+		$this->_instance->setHeaders($headers);
+		$this->_instance->setRows($rows);
+		$renderer = new Ascii([10, 12]);
+		$renderer->setConstraintWidth(30);
+		$this->_instance->setRenderer($renderer);
+		$this->_instance->setAsciiPreColorized(true);
+		$this->_instance->display();
+		$this->assertOutFileEqualsWith($output);
+	}
+
 	/**
 	 * Checks that spacing and borders are handled correctly in table
 	 */
@@ -249,7 +288,6 @@ public function testDrawWithHeadersNoData() {
 +----------+----------+
 | header 1 | header 2 |
 +----------+----------+
-+----------+----------+
 
 OUT;
 		$this->assertInOutEquals(array($headers, $rows), $output);
