Skip to content

Commit bd3f309

Browse files
westonruterwestonruter
committed
Remove class constants and address deprecated errors
1 parent 5edaddf commit bd3f309

File tree

4 files changed

+29
-39
lines changed

4 files changed

+29
-39
lines changed

‎plugins/image-prioritizer/helper.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,11 @@ function image_prioritizer_filter_rest_request_before_callbacks( $response, arra
298298
$request->get_method() !== 'POST'
299299
||
300300
// The strtolower() and outer trim are due to \WP_REST_Server::match_request_to_handler() using case-insensitive pattern match and using '$' instead of '\z'.
301-
OD_REST_API_NAMESPACE . OD_URL_METRICS_ROUTE !== rtrim( strtolower( ltrim( $request->get_route(), '/' ) ) )
301+
(
302+
OD_REST_API_NAMESPACE . OD_URL_METRICS_ROUTE // @phpstan-ignore constant.deprecated, constant.deprecated (To be replaced with class method calls in subsequent release.)
303+
!==
304+
rtrim( strtolower( ltrim( $request->get_route(), '/' ) ) )
305+
)
302306
) {
303307
return $response;
304308
}

‎plugins/image-prioritizer/tests/test-helper.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -727,7 +727,7 @@ public function data_provider_to_test_image_prioritizer_filter_rest_request_befo
727727
};
728728

729729
$create_request = static function ( array $url_metric_data ): WP_REST_Request {
730-
$request = new WP_REST_Request( 'POST', '/' . OD_REST_API_NAMESPACE . OD_URL_METRICS_ROUTE );
730+
$request = new WP_REST_Request( 'POST', '/' . OD_Rest_API::get_namespace() . OD_Rest_API::get_route() );
731731
$request->set_header( 'content-type', 'application/json' );
732732
$request->set_body( wp_json_encode( $url_metric_data ) );
733733
return $request;

‎plugins/optimization-detective/storage/class-od-rest-api.php

+10-28
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,6 @@
2020
*/
2121
class OD_Rest_API {
2222

23-
/**
24-
* Namespace for optimization-detective.
25-
*
26-
* @since 0.1.0
27-
* @access private
28-
* @var string
29-
*/
30-
const OD_REST_API_NAMESPACE = 'optimization-detective/v1';
31-
32-
/**
33-
* Route for storing a URL Metric.
34-
*
35-
* Note the `:store` art of the endpoint follows Google's guidance in AIP-136 for the use of the POST method in a way
36-
* that does not strictly follow the standard usage. Namely, submitting a POST request to this endpoint will either
37-
* create a new `od_url_metrics` post, or it will update an existing post if one already exists for the provided slug.
38-
*
39-
* @since 0.1.0
40-
* @access private
41-
* @link https://google.aip.dev/136
42-
* @var string
43-
*/
44-
const OD_URL_METRICS_ROUTE = '/url-metrics:store';
45-
4623
/**
4724
* Adds hooks.
4825
*
@@ -56,20 +33,25 @@ public static function add_hooks(): void {
5633
* Get the namespace for optimization-detective
5734
*
5835
* @since n.e.x.t
59-
* @access private
36+
* @return non-empty-string Namespace.
6037
*/
6138
public static function get_namespace(): string {
62-
return self::OD_REST_API_NAMESPACE;
39+
return OD_REST_API_NAMESPACE; // @phpstan-ignore constant.deprecated (To be replaced with string literal when constant is removed.)
6340
}
6441

6542
/**
66-
* Get the route for storing URL metric.
43+
* Gets the route for storing a URL Metric.
44+
*
45+
* Note the `:store` art of the endpoint follows Google's guidance in AIP-136 for the use of the POST method in a way
46+
* that does not strictly follow the standard usage. Namely, submitting a POST request to this endpoint will either
47+
* create a new `od_url_metrics` post, or it will update an existing post if one already exists for the provided slug.
6748
*
6849
* @since n.e.x.t
69-
* @access private
50+
* @link https://google.aip.dev/136
51+
* @return non-empty-string Route.
7052
*/
7153
public static function get_route(): string {
72-
return self::OD_URL_METRICS_ROUTE;
54+
return OD_URL_METRICS_ROUTE; // @phpstan-ignore constant.deprecated (To be replaced with string literal when constant is removed.)
7355
}
7456

7557
/**

‎plugins/optimization-detective/tests/storage/test-class-od-rest-api.php

+13-9
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ class Test_OD_REST_API extends WP_UnitTestCase {
1212
use Optimization_Detective_Test_Helpers;
1313

1414
/**
15-
* @var string
15+
* Gets the route.
16+
*
17+
* @return string Route.
1618
*/
17-
const ROUTE = '/' . OD_Rest_API::OD_REST_API_NAMESPACE . OD_Rest_API::OD_URL_METRICS_ROUTE;
19+
private function get_route(): string {
20+
return '/' . OD_Rest_API::get_namespace() . OD_Rest_API::get_route();
21+
}
1822

1923
/**
2024
* Test add_hooks().
@@ -518,7 +522,7 @@ public function test_rest_request_bad_params( array $params, int $expected_statu
518522
* @covers OD_Rest_API::od_is_allowed_http_origin
519523
*/
520524
public function test_rest_request_without_origin(): void {
521-
$request = new WP_REST_Request( 'POST', self::ROUTE );
525+
$request = new WP_REST_Request( 'POST', $this->get_route() );
522526
$request->set_body_params( $this->get_valid_params() ); // Valid and yet set as POST params and not as JSON body, so this is why it fails.
523527
$response = rest_get_server()->dispatch( $request );
524528
$this->assertSame( 403, $response->get_status(), 'Response: ' . wp_json_encode( $response ) );
@@ -534,7 +538,7 @@ public function test_rest_request_without_origin(): void {
534538
* @covers OD_Rest_API::od_is_allowed_http_origin
535539
*/
536540
public function test_rest_request_cross_origin(): void {
537-
$request = new WP_REST_Request( 'POST', self::ROUTE );
541+
$request = new WP_REST_Request( 'POST', $this->get_route() );
538542
$request->set_header( 'Origin', 'https://cross-origin.example.com' );
539543
$request->set_body_params( $this->get_valid_params() ); // Valid and yet set as POST params and not as JSON body, so this is why it fails.
540544
$response = rest_get_server()->dispatch( $request );
@@ -569,7 +573,7 @@ static function ( string $url ): string {
569573
* @covers OD_Rest_API::od_handle_rest_request
570574
*/
571575
public function test_rest_request_not_json_data(): void {
572-
$request = new WP_REST_Request( 'POST', self::ROUTE );
576+
$request = new WP_REST_Request( 'POST', $this->get_route() );
573577
$request->set_header( 'Origin', home_url() );
574578
$request->set_body_params( $this->get_valid_params() ); // Valid and yet set as POST params and not as JSON body, so this is why it fails.
575579
$response = rest_get_server()->dispatch( $request );
@@ -585,7 +589,7 @@ public function test_rest_request_not_json_data(): void {
585589
* @covers OD_Rest_API::od_handle_rest_request
586590
*/
587591
public function test_rest_request_not_json_content_type(): void {
588-
$request = new WP_REST_Request( 'POST', self::ROUTE );
592+
$request = new WP_REST_Request( 'POST', $this->get_route() );
589593
$request->set_body( wp_json_encode( $this->get_valid_params() ) );
590594
$request->set_header( 'Content-Type', 'text/plain' );
591595
$response = rest_get_server()->dispatch( $request );
@@ -601,7 +605,7 @@ public function test_rest_request_not_json_content_type(): void {
601605
* @covers OD_Rest_API::od_handle_rest_request
602606
*/
603607
public function test_rest_request_empty_array_json_body(): void {
604-
$request = new WP_REST_Request( 'POST', self::ROUTE );
608+
$request = new WP_REST_Request( 'POST', $this->get_route() );
605609
$request->set_body( '[]' );
606610
$request->set_header( 'Content-Type', 'application/json' );
607611
$response = rest_get_server()->dispatch( $request );
@@ -617,7 +621,7 @@ public function test_rest_request_empty_array_json_body(): void {
617621
* @covers OD_Rest_API::od_handle_rest_request
618622
*/
619623
public function test_rest_request_non_array_json_body(): void {
620-
$request = new WP_REST_Request( 'POST', self::ROUTE );
624+
$request = new WP_REST_Request( 'POST', $this->get_route() );
621625
$request->set_body( '"Hello World!"' );
622626
$request->set_header( 'Content-Type', 'application/json' );
623627
$response = rest_get_server()->dispatch( $request );
@@ -973,7 +977,7 @@ private function create_request( array $params ): WP_REST_Request {
973977
*
974978
* @var WP_REST_Request<array<string, mixed>> $request
975979
*/
976-
$request = new WP_REST_Request( 'POST', self::ROUTE );
980+
$request = new WP_REST_Request( 'POST', $this->get_route() );
977981
$request->set_header( 'Content-Type', 'application/json' );
978982
$request->set_query_params( wp_array_slice_assoc( $params, array( 'hmac', 'current_etag', 'slug', 'cache_purge_post_id' ) ) );
979983
$request->set_header( 'Origin', home_url() );

0 commit comments

Comments
 (0)