Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce get_cursor_move_count() to use instead of get_seek_count() and get_next_token_count() #1478

Merged
merged 5 commits into from
Aug 21, 2024
Merged

Introduce get_cursor_move_count() to use instead of get_seek_count() and get_next_token_count() #1478

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed3a924
Introduce get_cursor_move_count() to use instead of get_seek_count() …
westonruter Aug 16, 2024
0eb7883
Eliminate unnecessary cursor_move_count increment in seek() since alr…
westonruter Aug 16, 2024
f4d0f8c
Remove deprecated code
westonruter Aug 20, 2024
48b06cc
Add missing since tags
westonruter Aug 20, 2024
5b683b5
Clarify comment for $cursor_move_count
westonruter Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions plugins/optimization-detective/class-od-html-tag-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,24 @@ final class OD_HTML_Tag_Processor extends WP_HTML_Tag_Processor {
private $buffered_text_replacements = array();

/**
* Count for the number of times next_token() was called
* Count for the number of times that the cursor was successfully moved.
*
* @since n.e.x.t
* @var int
* @see self::next_token()
* @see self::seek()
*/
private $cursor_move_count = 0;

/**
* Count for the number of times next_token() was called.
*
* The method that uses this is deprecated and it will be removed in a future release.
*
* @since 0.4.1
* @var int
* @see self::next_token()
* @see self::get_next_token_count()
*/
private $next_token_count = 0;

Expand Down Expand Up @@ -258,7 +271,8 @@ public function expects_closer( ?string $tag_name = null ): bool {
*/
public function next_token(): bool {
$this->current_xpath = null; // Clear cache.
++$this->next_token_count;
++$this->next_token_count; // TODO: Remove when the deprecated get_next_token_count() method is removed.
++$this->cursor_move_count;
if ( ! parent::next_token() ) {
$this->open_stack_tags = array();
$this->open_stack_indices = array();
Expand Down Expand Up @@ -338,15 +352,30 @@ public function next_token(): bool {
return true;
}

/**
* Gets the number of times the cursor has moved.
*
* @since n.e.x.t
* @see self::next_token()
* @see self::seek()
*
* @return int Count of times the cursor has moved.
*/
public function get_cursor_move_count(): int {
return $this->cursor_move_count;
}

/**
* Gets the number of times next_token() was called.
*
* @since 0.4.1
* @see self::next_token()
* @deprecated Use {@see self::get_cursor_move_count()} instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we deprecating this so dependent plugins don't break? If we don't explicitly call from outside the plugin, couldn't we just remove this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we could just remove it. I'm happy to do do if you think that's best. It's extremely unlikely anyone is using these deprecated methods.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in f4d0f8c

*
* @return int Count of next_token() calls.
*/
public function get_next_token_count(): int {
_deprecated_function( __METHOD__, 'Optimization Detective n.e.x.t', __CLASS__ . '::get_cursor_move_count()' );
return $this->next_token_count;
}

Expand Down Expand Up @@ -438,10 +467,12 @@ public function seek( $bookmark_name ): bool {
*
* @since 0.4.1
* @see self::seek()
* @deprecated Use {@see self::get_cursor_move_count()} instead.
*
* @return int Count of seek() calls.
*/
public function get_seek_count(): int {
_deprecated_function( __METHOD__, 'Optimization Detective n.e.x.t', __CLASS__ . '::get_cursor_move_count()' );
return $this->seek_count;
}

Expand Down
7 changes: 3 additions & 4 deletions plugins/optimization-detective/optimization.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,13 +219,12 @@ function od_optimize_template_output_buffer( string $buffer ): string {
$processor->set_bookmark( $current_tag_bookmark ); // TODO: Should we break if this returns false?

foreach ( $visitors as $visitor ) {
$seek_count = $processor->get_seek_count();
$next_token_count = $processor->get_next_token_count();
$did_visit = $visitor( $tag_visitor_context ) || $did_visit;
$cursor_move_count = $processor->get_cursor_move_count();
$did_visit = $visitor( $tag_visitor_context ) || $did_visit;

// If the visitor traversed HTML tags, we need to go back to this tag so that in the next iteration any
// relevant tag visitors may apply, in addition to properly setting the data-od-xpath on this tag below.
if ( $seek_count !== $processor->get_seek_count() || $next_token_count !== $processor->get_next_token_count() ) {
if ( $cursor_move_count !== $processor->get_cursor_move_count() ) {
$processor->seek( $current_tag_bookmark ); // TODO: Should this break out of the optimization loop if it returns false?
}
}
Expand Down
47 changes: 35 additions & 12 deletions plugins/optimization-detective/tests/test-class-od-html-tag-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,8 @@ public function test_html_tag_processor_wrapper_methods(): void {
*/
public function test_bookmarking_and_seeking(): void {
$processor = new OD_HTML_Tag_Processor(
'
trim(
'
<html>
<head></head>
<body>
Expand All @@ -507,14 +508,19 @@ public function test_bookmarking_and_seeking(): void {
<img src="https://example.com/foo.jpg">
</body>
</html>
'
'
)
);

$actual_figure_contents = array();
$this->assertSame( 0, $processor->get_seek_count() );
$last_cursor_move_count = $processor->get_cursor_move_count();
$this->assertSame( 0, $last_cursor_move_count );

$bookmarks = array();
while ( $processor->next_open_tag() ) {
$this_cursor_move_count = $processor->get_cursor_move_count();
$this->assertGreaterThan( $last_cursor_move_count, $this_cursor_move_count );
$last_cursor_move_count = $this_cursor_move_count;
if (
'FIGURE' === $processor->get_tag()
&&
Expand Down Expand Up @@ -573,7 +579,6 @@ public function test_bookmarking_and_seeking(): void {
'depth' => $processor->get_current_depth(),
);
}
$this->assertSame( count( $bookmarks ), $processor->get_seek_count() );

$this->assertSame( $expected_figure_contents, $sought_actual_contents );

Expand All @@ -597,11 +602,11 @@ public function test_bookmarking_and_seeking(): void {
}

/**
* Test get_seek_count.
* Test get_cursor_move_count().
*
* @covers ::get_seek_count
* @covers ::get_cursor_move_count
*/
public function test_get_next_token_count(): void {
public function test_get_cursor_move_count(): void {
$processor = new OD_HTML_Tag_Processor(
trim(
'
Expand All @@ -612,20 +617,38 @@ public function test_get_next_token_count(): void {
'
)
);
$this->assertSame( 0, $processor->get_next_token_count() );
$this->assertSame( 0, $processor->get_cursor_move_count() );
$this->assertTrue( $processor->next_tag() );
$this->assertSame( 'HTML', $processor->get_tag() );
$this->assertSame( 1, $processor->get_next_token_count() );
$this->assertTrue( $processor->set_bookmark( 'document_root' ) );
$this->assertSame( 1, $processor->get_cursor_move_count() );
$this->assertTrue( $processor->next_tag() );
$this->assertSame( 'HEAD', $processor->get_tag() );
$this->assertSame( 3, $processor->get_next_token_count() ); // Note that next_token() call #2 was for the whitespace between <html> and <head>.
$this->assertSame( 3, $processor->get_cursor_move_count() ); // Note that next_token() call #2 was for the whitespace between <html> and <head>.
$this->assertTrue( $processor->next_tag() );
$this->assertSame( 'HEAD', $processor->get_tag() );
$this->assertTrue( $processor->is_tag_closer() );
$this->assertSame( 4, $processor->get_next_token_count() );
$this->assertSame( 4, $processor->get_cursor_move_count() );
$this->assertTrue( $processor->next_tag() );
$this->assertSame( 'BODY', $processor->get_tag() );
$this->assertSame( 6, $processor->get_cursor_move_count() ); // Note that next_token() call #5 was for the whitespace between </head> and <body>.
$this->assertTrue( $processor->next_tag() );
$this->assertSame( 'BODY', $processor->get_tag() );
$this->assertSame( 6, $processor->get_next_token_count() ); // Note that next_token() call #5 was for the whitespace between </head> and <body>.
$this->assertTrue( $processor->is_tag_closer() );
$this->assertSame( 7, $processor->get_cursor_move_count() );
$this->assertTrue( $processor->next_tag() );
$this->assertSame( 'HTML', $processor->get_tag() );
$this->assertTrue( $processor->is_tag_closer() );
$this->assertSame( 9, $processor->get_cursor_move_count() ); // Note that next_token() call #8 was for the whitespace between </body> and <html>.
$this->assertFalse( $processor->next_tag() );
$this->assertSame( 10, $processor->get_cursor_move_count() );
$this->assertFalse( $processor->next_tag() );
$this->assertSame( 11, $processor->get_cursor_move_count() );
$this->assertTrue( $processor->seek( 'document_root' ) );
$this->assertSame( 12, $processor->get_cursor_move_count() );
$this->setExpectedIncorrectUsage( 'WP_HTML_Tag_Processor::seek' );
$this->assertFalse( $processor->seek( 'does_not_exist' ) );
$this->assertSame( 12, $processor->get_cursor_move_count() ); // The bookmark does not exist so no change.
}

/**
Expand Down