Skip to content

Commit 942b397

Browse files
westonruterwestonruter
committed
Remove the plural from URL Metrics in symbols
1 parent b515f87 commit 942b397

19 files changed

+181
-144
lines changed

‎plugins/embed-optimizer/class-embed-optimizer-tag-visitor.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function __invoke( OD_Tag_Visitor_Context $context ): bool {
4444
return false;
4545
}
4646

47-
$max_intersection_ratio = $context->url_metrics_group_collection->get_element_max_intersection_ratio( $processor->get_xpath() );
47+
$max_intersection_ratio = $context->url_metric_group_collection->get_element_max_intersection_ratio( $processor->get_xpath() );
4848

4949
if ( $max_intersection_ratio > 0 ) {
5050
/*

‎plugins/embed-optimizer/tests/test-cases/nested-figure-embed.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ static function ( OD_Tag_Visitor_Context $context ) use ( $test_case ): bool {
4949
} else {
5050
$test_case->assertTrue( $processor->has_bookmark( 'the_first_video' ) );
5151
}
52-
if ( $context->url_metrics_group_collection->get_element_max_intersection_ratio( $processor->get_xpath() ) > 0 ) {
52+
if ( $context->url_metric_group_collection->get_element_max_intersection_ratio( $processor->get_xpath() ) > 0 ) {
5353
$context->link_collection->add_link(
5454
array(
5555
'rel' => 'preload',

‎plugins/image-prioritizer/class-image-prioritizer-background-image-styled-tag-visitor.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public function __invoke( OD_Tag_Visitor_Context $context ): bool {
5555
$xpath = $processor->get_xpath();
5656

5757
// If this element is the LCP (for a breakpoint group), add a preload link for it.
58-
foreach ( $context->url_metrics_group_collection->get_groups_by_lcp_element( $xpath ) as $group ) {
58+
foreach ( $context->url_metric_group_collection->get_groups_by_lcp_element( $xpath ) as $group ) {
5959
$link_attributes = array(
6060
'rel' => 'preload',
6161
'fetchpriority' => 'high',

‎plugins/image-prioritizer/class-image-prioritizer-img-tag-visitor.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public function __invoke( OD_Tag_Visitor_Context $context ): bool {
5959
* fetchpriority=high, even though it won't really be needed because a preload link with fetchpriority=high
6060
* will also be added. Additionally, ensure that this common LCP element is never lazy-loaded.
6161
*/
62-
$common_lcp_element = $context->url_metrics_group_collection->get_common_lcp_element();
62+
$common_lcp_element = $context->url_metric_group_collection->get_common_lcp_element();
6363
if ( ! is_null( $common_lcp_element ) && $xpath === $common_lcp_element['xpath'] ) {
6464
if ( 'high' === $get_attribute_value( 'fetchpriority' ) ) {
6565
$processor->set_meta_attribute( 'fetchpriority-already-added', true );
@@ -70,9 +70,9 @@ public function __invoke( OD_Tag_Visitor_Context $context ): bool {
7070
is_string( $processor->get_attribute( 'fetchpriority' ) )
7171
&&
7272
// Temporary condition in case someone updates Image Prioritizer without also updating Optimization Detective.
73-
method_exists( $context->url_metrics_group_collection, 'is_any_group_populated' )
73+
method_exists( $context->url_metric_group_collection, 'is_any_group_populated' )
7474
&&
75-
$context->url_metrics_group_collection->is_any_group_populated()
75+
$context->url_metric_group_collection->is_any_group_populated()
7676
) {
7777
/*
7878
* At this point, the element is not the shared LCP across all viewport groups. Nevertheless, server-side
@@ -87,7 +87,7 @@ public function __invoke( OD_Tag_Visitor_Context $context ): bool {
8787
$processor->remove_attribute( 'fetchpriority' );
8888
}
8989

90-
$element_max_intersection_ratio = $context->url_metrics_group_collection->get_element_max_intersection_ratio( $xpath );
90+
$element_max_intersection_ratio = $context->url_metric_group_collection->get_element_max_intersection_ratio( $xpath );
9191

9292
// If the element was not found, we don't know if it was visible for not, so don't do anything.
9393
if ( is_null( $element_max_intersection_ratio ) ) {
@@ -122,7 +122,7 @@ public function __invoke( OD_Tag_Visitor_Context $context ): bool {
122122
}
123123

124124
// If this element is the LCP (for a breakpoint group), add a preload link for it.
125-
foreach ( $context->url_metrics_group_collection->get_groups_by_lcp_element( $xpath ) as $group ) {
125+
foreach ( $context->url_metric_group_collection->get_groups_by_lcp_element( $xpath ) as $group ) {
126126
$link_attributes = array_merge(
127127
array(
128128
'rel' => 'preload',

‎plugins/optimization-detective/class-od-tag-visitor-context.php

+46-10
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
*
1717
* @since 0.4.0
1818
* @access private
19+
*
20+
* @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection
1921
*/
2022
final class OD_Tag_Visitor_Context {
2123

@@ -28,12 +30,12 @@ final class OD_Tag_Visitor_Context {
2830
public $processor;
2931

3032
/**
31-
* URL metrics group collection.
33+
* URL metric group collection.
3234
*
33-
* @var OD_URL_Metrics_Group_Collection
35+
* @var OD_URL_Metric_Group_Collection
3436
* @readonly
3537
*/
36-
public $url_metrics_group_collection;
38+
public $url_metric_group_collection;
3739

3840
/**
3941
* Link collection.
@@ -46,13 +48,47 @@ final class OD_Tag_Visitor_Context {
4648
/**
4749
* Constructor.
4850
*
49-
* @param OD_HTML_Tag_Processor $processor HTML tag processor.
50-
* @param OD_URL_Metrics_Group_Collection $url_metrics_group_collection URL metrics group collection.
51-
* @param OD_Link_Collection $link_collection Link collection.
51+
* @param OD_HTML_Tag_Processor $processor HTML tag processor.
52+
* @param OD_URL_Metric_Group_Collection $url_metric_group_collection URL metric group collection.
53+
* @param OD_Link_Collection $link_collection Link collection.
54+
*/
55+
public function __construct( OD_HTML_Tag_Processor $processor, OD_URL_Metric_Group_Collection $url_metric_group_collection, OD_Link_Collection $link_collection ) {
56+
$this->processor = $processor;
57+
$this->url_metric_group_collection = $url_metric_group_collection;
58+
$this->link_collection = $link_collection;
59+
}
60+
61+
/**
62+
* Gets magic properties.
63+
*
64+
* @param string $name Property name.
65+
* @return OD_URL_Metric_Group_Collection URL metric group collection.
66+
*
67+
* @throws Error When property is unknown.
5268
*/
53-
public function __construct( OD_HTML_Tag_Processor $processor, OD_URL_Metrics_Group_Collection $url_metrics_group_collection, OD_Link_Collection $link_collection ) {
54-
$this->processor = $processor;
55-
$this->url_metrics_group_collection = $url_metrics_group_collection;
56-
$this->link_collection = $link_collection;
69+
public function __get( string $name ): OD_URL_Metric_Group_Collection {
70+
if ( 'url_metrics_group_collection' === $name ) {
71+
_doing_it_wrong(
72+
__CLASS__ . '::$url_metrics_group_collection',
73+
esc_html(
74+
sprintf(
75+
/* translators: %s is class member variable name */
76+
__( 'Use %s instead.', 'optimization-detective' ),
77+
__CLASS__ . '::$url_metric_group_collection'
78+
)
79+
),
80+
'optimization-detective n.e.x.t'
81+
);
82+
return $this->url_metric_group_collection;
83+
}
84+
throw new Error(
85+
esc_html(
86+
sprintf(
87+
/* translators: %s is class member variable name */
88+
__( 'Unknown property %s.', 'optimization-detective' ),
89+
__CLASS__ . '::$' . $name
90+
)
91+
)
92+
);
5793
}
5894
}

‎plugins/optimization-detective/class-od-url-metrics-group-collection.php ‎plugins/optimization-detective/class-od-url-metric-group-collection.php

+24-23
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* Optimization Detective: OD_URL_Metrics_Group_Collection class
3+
* Optimization Detective: OD_URL_Metric_Group_Collection class
44
*
55
* @package optimization-detective
66
* @since 0.1.0
@@ -16,24 +16,24 @@
1616
*
1717
* @phpstan-import-type ElementData from OD_URL_Metric
1818
*
19-
* @implements IteratorAggregate<int, OD_URL_Metrics_Group>
19+
* @implements IteratorAggregate<int, OD_URL_Metric_Group>
2020
*
2121
* @since 0.1.0
2222
* @access private
2323
*/
24-
final class OD_URL_Metrics_Group_Collection implements Countable, IteratorAggregate, JsonSerializable {
24+
final class OD_URL_Metric_Group_Collection implements Countable, IteratorAggregate, JsonSerializable {
2525

2626
/**
27-
* URL metrics groups.
27+
* URL metric groups.
2828
*
2929
* The number of groups corresponds to one greater than the number of
3030
* breakpoints. This is because breakpoints are the dividing line between
3131
* the groups of URL metrics with specific viewport widths. This extends
3232
* even to when there are zero breakpoints: there will still be one group
3333
* in this case, in which every single URL metric is added.
3434
*
35-
* @var OD_URL_Metrics_Group[]
36-
* @phpstan-var non-empty-array<OD_URL_Metrics_Group>
35+
* @var OD_URL_Metric_Group[]
36+
* @phpstan-var non-empty-array<OD_URL_Metric_Group>
3737
*/
3838
private $groups;
3939

@@ -74,11 +74,11 @@ final class OD_URL_Metrics_Group_Collection implements Countable, IteratorAggreg
7474
* Result cache.
7575
*
7676
* @var array{
77-
* get_group_for_viewport_width?: array<int, OD_URL_Metrics_Group>,
77+
* get_group_for_viewport_width?: array<int, OD_URL_Metric_Group>,
7878
* is_every_group_populated?: bool,
7979
* is_any_group_populated?: bool,
8080
* is_every_group_complete?: bool,
81-
* get_groups_by_lcp_element?: array<string, OD_URL_Metrics_Group[]>,
81+
* get_groups_by_lcp_element?: array<string, OD_URL_Metric_Group[]>,
8282
* get_common_lcp_element?: ElementData|null,
8383
* get_all_element_max_intersection_ratios?: array<string, float>
8484
* }
@@ -167,18 +167,18 @@ public function clear_cache(): void {
167167
/**
168168
* Create groups.
169169
*
170-
* @phpstan-return non-empty-array<OD_URL_Metrics_Group>
170+
* @phpstan-return non-empty-array<OD_URL_Metric_Group>
171171
*
172-
* @return OD_URL_Metrics_Group[] Groups.
172+
* @return OD_URL_Metric_Group[] Groups.
173173
*/
174174
private function create_groups(): array {
175175
$groups = array();
176176
$min_width = 0;
177177
foreach ( $this->breakpoints as $max_width ) {
178-
$groups[] = new OD_URL_Metrics_Group( array(), $min_width, $max_width, $this->sample_size, $this->freshness_ttl, $this );
178+
$groups[] = new OD_URL_Metric_Group( array(), $min_width, $max_width, $this->sample_size, $this->freshness_ttl, $this );
179179
$min_width = $max_width + 1;
180180
}
181-
$groups[] = new OD_URL_Metrics_Group( array(), $min_width, PHP_INT_MAX, $this->sample_size, $this->freshness_ttl, $this );
181+
$groups[] = new OD_URL_Metric_Group( array(), $min_width, PHP_INT_MAX, $this->sample_size, $this->freshness_ttl, $this );
182182
return $groups;
183183
}
184184

@@ -209,9 +209,9 @@ public function add_url_metric( OD_URL_Metric $new_url_metric ): void {
209209
* @throws InvalidArgumentException When there is no group for the provided viewport width. This would only happen if a negative width is provided.
210210
*
211211
* @param int $viewport_width Viewport width.
212-
* @return OD_URL_Metrics_Group URL metrics group for the viewport width.
212+
* @return OD_URL_Metric_Group URL metric group for the viewport width.
213213
*/
214-
public function get_group_for_viewport_width( int $viewport_width ): OD_URL_Metrics_Group {
214+
public function get_group_for_viewport_width( int $viewport_width ): OD_URL_Metric_Group {
215215
if ( array_key_exists( __FUNCTION__, $this->result_cache ) && array_key_exists( $viewport_width, $this->result_cache[ __FUNCTION__ ] ) ) {
216216
return $this->result_cache[ __FUNCTION__ ][ $viewport_width ];
217217
}
@@ -225,8 +225,8 @@ public function get_group_for_viewport_width( int $viewport_width ): OD_URL_Metr
225225
throw new InvalidArgumentException(
226226
esc_html(
227227
sprintf(
228-
/* translators: %d is viewport width */
229-
__( 'No URL metrics group found for viewport width: %d', 'optimization-detective' ),
228+
/* translators: %d is viewport width */
229+
__( 'No URL metric group found for viewport width: %d', 'optimization-detective' ),
230230
$viewport_width
231231
)
232232
)
@@ -268,7 +268,7 @@ public function is_any_group_populated(): bool {
268268
* should be contrasted with the `is_every_group_complete()`
269269
* method below.
270270
*
271-
* @see OD_URL_Metrics_Group_Collection::is_every_group_complete()
271+
* @see OD_URL_Metric_Group_Collection::is_every_group_complete()
272272
*
273273
* @return bool Whether all groups have some URL metrics.
274274
*/
@@ -293,7 +293,7 @@ public function is_every_group_populated(): bool {
293293
/**
294294
* Checks whether every group is complete.
295295
*
296-
* @see OD_URL_Metrics_Group::is_complete()
296+
* @see OD_URL_Metric_Group::is_complete()
297297
*
298298
* @return bool Whether all groups are complete.
299299
*/
@@ -319,10 +319,11 @@ public function is_every_group_complete(): bool {
319319
/**
320320
* Gets the groups with the provided LCP element XPath.
321321
*
322-
* @see OD_URL_Metrics_Group::get_lcp_element()
322+
* @see OD_URL_Metric_Group::get_lcp_element()
323323
*
324324
* @param string $xpath XPath for LCP element.
325-
* @return OD_URL_Metrics_Group[] Groups which have the LCP element.
325+
*
326+
* @return OD_URL_Metric_Group[] Groups which have the LCP element.
326327
*/
327328
public function get_groups_by_lcp_element( string $xpath ): array {
328329
if ( array_key_exists( __FUNCTION__, $this->result_cache ) && array_key_exists( $xpath, $this->result_cache[ __FUNCTION__ ] ) ) {
@@ -460,14 +461,14 @@ public function get_flattened_url_metrics(): array {
460461
/**
461462
* Returns an iterator for the groups of URL metrics.
462463
*
463-
* @return ArrayIterator<int, OD_URL_Metrics_Group> Array iterator for OD_URL_Metric_Group instances.
464+
* @return ArrayIterator<int, OD_URL_Metric_Group> Array iterator for OD_URL_Metric_Group instances.
464465
*/
465466
public function getIterator(): ArrayIterator {
466467
return new ArrayIterator( $this->groups );
467468
}
468469

469470
/**
470-
* Counts the URL metrics groups in the collection.
471+
* Counts the URL metric groups in the collection.
471472
*
472473
* @return int<0, max> Group count.
473474
*/
@@ -507,7 +508,7 @@ public function jsonSerialize(): array {
507508
'every_group_complete' => $this->is_every_group_complete(),
508509
'every_group_populated' => $this->is_every_group_populated(),
509510
'groups' => array_map(
510-
static function ( OD_URL_Metrics_Group $group ): array {
511+
static function ( OD_URL_Metric_Group $group ): array {
511512
$group_data = $group->jsonSerialize();
512513
// Remove redundant data.
513514
unset(

‎plugins/optimization-detective/class-od-url-metrics-group.php ‎plugins/optimization-detective/class-od-url-metric-group.php

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* Optimization Detective: OD_URL_Metrics_Group class
3+
* Optimization Detective: OD_URL_Metric_Group class
44
*
55
* @package optimization-detective
66
* @since 0.1.0
@@ -20,7 +20,7 @@
2020
* @since 0.1.0
2121
* @access private
2222
*/
23-
final class OD_URL_Metrics_Group implements IteratorAggregate, Countable, JsonSerializable {
23+
final class OD_URL_Metric_Group implements IteratorAggregate, Countable, JsonSerializable {
2424

2525
/**
2626
* URL metrics.
@@ -64,7 +64,7 @@ final class OD_URL_Metrics_Group implements IteratorAggregate, Countable, JsonSe
6464
/**
6565
* Collection that this instance belongs to.
6666
*
67-
* @var OD_URL_Metrics_Group_Collection|null
67+
* @var OD_URL_Metric_Group_Collection|null
6868
*/
6969
private $collection;
7070

@@ -83,14 +83,14 @@ final class OD_URL_Metrics_Group implements IteratorAggregate, Countable, JsonSe
8383
*
8484
* @throws InvalidArgumentException If arguments are invalid.
8585
*
86-
* @param OD_URL_Metric[] $url_metrics URL metrics to add to the group.
87-
* @param int $minimum_viewport_width Minimum possible viewport width for the group. Must be zero or greater.
88-
* @param int $maximum_viewport_width Maximum possible viewport width for the group. Must be greater than zero and the minimum viewport width.
89-
* @param int $sample_size Sample size for the maximum number of viewports in a group between breakpoints.
90-
* @param int $freshness_ttl Freshness age (TTL) for a given URL metric.
91-
* @param OD_URL_Metrics_Group_Collection|null $collection Collection that this instance belongs to. Optional.
86+
* @param OD_URL_Metric[] $url_metrics URL metrics to add to the group.
87+
* @param int $minimum_viewport_width Minimum possible viewport width for the group. Must be zero or greater.
88+
* @param int $maximum_viewport_width Maximum possible viewport width for the group. Must be greater than zero and the minimum viewport width.
89+
* @param int $sample_size Sample size for the maximum number of viewports in a group between breakpoints.
90+
* @param int $freshness_ttl Freshness age (TTL) for a given URL metric.
91+
* @param OD_URL_Metric_Group_Collection|null $collection Collection that this instance belongs to. Optional.
9292
*/
93-
public function __construct( array $url_metrics, int $minimum_viewport_width, int $maximum_viewport_width, int $sample_size, int $freshness_ttl, ?OD_URL_Metrics_Group_Collection $collection = null ) {
93+
public function __construct( array $url_metrics, int $minimum_viewport_width, int $maximum_viewport_width, int $sample_size, int $freshness_ttl, ?OD_URL_Metric_Group_Collection $collection = null ) {
9494
if ( $minimum_viewport_width < 0 ) {
9595
throw new InvalidArgumentException(
9696
esc_html__( 'The minimum viewport width must be at least zero.', 'optimization-detective' )
@@ -211,7 +211,7 @@ static function ( OD_URL_Metric $a, OD_URL_Metric $b ): int {
211211
}
212212

213213
/**
214-
* Determines whether the URL metrics group is complete.
214+
* Determines whether the URL metric group is complete.
215215
*
216216
* A group is complete if it has the full sample size of URL metrics
217217
* and all of these URL metrics are fresh.

0 commit comments

Comments
 (0)