forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WIP: HTML API: Extract previous text and HTML chunks while processing.
The HTML API should be able to provide the ability to generate excerpts from HTMl documents given a specific maximum length. In this patch we're exploring the addition of text and HTML chunks that can be extracted while processing in order to do just this. The text chunks are similar to `.textContent` on the DOM while the HTML chunks contain raw and unprocessed HTML. These functions should likely remain low-level in the Tag Processor and be exposed from the HTML Processor to ensure that proper semantics are heeded when extracting this information, such as how `PRE` tags ignore a leading newline inside their content or how `SCRIPT` and `STYLE` content isn't part of what we want with something like `strip_tags()`. In the process of this work it's evident again that the Tag Processor ought to expose the ability to visit every token and non-tag tokens should be classified. This has already been explored in #7.
- Loading branch information
Showing
2 changed files
with
203 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
tests/phpunit/tests/html-api/wpHtmlProcessor-stringBuilder.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| <?php | ||
| /** | ||
| * Unit tests covering WP_HTML_Processor string building functionality. | ||
| * | ||
| * @package WordPress | ||
| * @subpackage HTML-API | ||
| */ | ||
|
|
||
| /** | ||
| * @group html-api | ||
| * | ||
| * @coversDefaultClass WP_HTML_Processor | ||
| */ | ||
| class Tests_HtmlApi_WpHtmlProcessor_StringBuilder extends WP_UnitTestCase { | ||
| /** | ||
| * @ticket {TICKET_NUMBER} | ||
| * | ||
| * @dataProvider data_html_and_associated_text_content | ||
| * | ||
| * @param string $html HTML containing text that should be extracted. | ||
| * @param string $text_content Plaintext content represented inside the given HTML. | ||
| */ | ||
| public function test_extracts_text_chunks_properly( $html, $text_content ) { | ||
| $processor = new WP_HTML_Tag_Processor( $html ); | ||
|
|
||
| $extracted_text_content = ''; | ||
| while ( $processor->next_tag( array( 'tag_closers' => 'visit' ) ) ) { | ||
| $extracted_text_content .= $processor->get_previous_text_chunk(); | ||
| } | ||
| $extracted_text_content .= $processor->get_previous_text_chunk(); | ||
|
|
||
| $this->assertEquals( $text_content, $extracted_text_content, 'Extracted unexpected text content.' ); | ||
| } | ||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @return array[]. | ||
| */ | ||
| public function data_html_and_associated_text_content() { | ||
| return array( | ||
| 'Basic text without HTML.' => array( 'This is plain text.', 'This is plain text.' ), | ||
| 'Basic text with a character reference.' => array( 'A < B', 'A < B' ), | ||
| 'Text before tag.' => array( 'Before<img>', 'Before' ), | ||
| 'Text after tag.' => array( '<img>After', 'After' ), | ||
| 'Text inside tag.' => array( '<div>Inside</div>', 'Inside' ), | ||
| 'Text around tag.' => array( 'In <em>the</em> jungle.', 'In the jungle.' ), | ||
| 'Text interrupted by many tags.' => array( 'A <em>wild <a><img><span>adventure</span></a> awaits.', 'A wild adventure awaits.' ), | ||
| 'Text with comment inside it.' => array( 'Ignore <!-- everything inside this --> comment.', 'Ignore comment.' ), | ||
| 'Text with empty comment inside it.' => array( 'Ignore <!--> comment.', 'Ignore comment.' ), | ||
| 'Text with invalid comment inside it.' => array( 'Ignore </^$%> comment.', 'Ignore comment.' ), | ||
| 'Skipping SCRIPT content.' => array( '<div>This <script>does not exist</script> in the output.', 'This in the output.' ), | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @ticket {TICKET_NUMBER} | ||
| * | ||
| * @dataProvider data_html_and_associated_html_content | ||
| * | ||
| * @param string $html HTML containing text that should be extracted. | ||
| * @param int $max_code_points Stop iterating after this many code points have been extracted. | ||
| * @param string $html_content Full HTML containing text of max code point length from input. | ||
| */ | ||
| public function test_extracts_html_chunks_properly( $html, $max_code_points, $html_content ) { | ||
| $processor = new WP_HTML_Tag_Processor( $html ); | ||
|
|
||
| $code_points = 0; | ||
| $extracted_html_content = ''; | ||
| while ( $processor->next_tag( array( 'tag_closers' => 'visit' ) ) ) { | ||
| $text_chunk = $processor->get_previous_text_chunk(); | ||
| $chunk_cps = mb_strlen( $text_chunk ); | ||
| list( $html, $text ) = $processor->get_previous_html_chunk(); | ||
| $extracted_html_content .= $html; | ||
| if ( 0 === $max_code_points || $code_points + $chunk_cps <= $max_code_points ) { | ||
| $extracted_html_content .= $text; | ||
| $code_points += $chunk_cps; | ||
| } else { | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| $text_chunk = $processor->get_previous_text_chunk(); | ||
| $chunk_cps = mb_strlen( $text_chunk ); | ||
| list( $html, $text ) = $processor->get_previous_html_chunk(); | ||
| $extracted_html_content .= $html; | ||
| if ( 0 === $max_code_points || $code_points + $chunk_cps <= $max_code_points ) { | ||
| $extracted_html_content .= $text; | ||
| } | ||
|
|
||
| $this->assertEquals( $html_content, $extracted_html_content, 'Extracted unexpected HTML content.' ); | ||
| } | ||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @return array[]. | ||
| */ | ||
| public function data_html_and_associated_html_content() { | ||
| return array( | ||
| 'Basic text without HTML.' => array( 'This is plain text.', 0, 'This is plain text.' ), | ||
| 'Basic text without HTML (too long).' => array( 'This is plain text.', 8, '' ), | ||
| 'Basic text with a character reference.' => array( 'A < B', 0, 'A < B' ), | ||
| 'Character reference wider than text' => array( 'A < B', 5, 'A < B' ), | ||
| 'Text before tag.' => array( 'Before<img>', 0, 'Before<img>' ), | ||
| 'Text after tag.' => array( '<img>After', 0, '<img>After' ), | ||
| 'Text inside tag.' => array( '<div>Inside</div>', 0, '<div>Inside</div>' ), | ||
| 'Text around tag.' => array( 'In <em>the</em> jungle.', 0, 'In <em>the</em> jungle.' ), | ||
| 'Text interrupted by many tags.' => array( 'A <em>wild <a><img><span>adventure</span></a> awaits.', 0, 'A <em>wild <a><img><span>adventure</span></a> awaits.' ), | ||
| 'Text interrupted by many tags (long).' => array( 'A <em>wild <a><img><span>adventure</span></a> awaits.', 16, 'A <em>wild <a><img><span>adventure</span></a>' ), | ||
| 'Text with comment inside it.' => array( 'Ignore <!-- everything inside this --> comment.', 0, 'Ignore <!-- everything inside this --> comment.' ), | ||
| ); | ||
| } | ||
| } |