Add Tribe__Cache::has method by lucatume · Pull Request #2061 · the-events-calendar/tribe-common

lucatume · 2024-03-15T14:13:54Z

🎫 Ticket

Innovation Day work, Cookbook

🗒️ Description

For back-compatibility purposes, I've not modified existing methods like offsetGet.
This add a $found flag, set by reference, to the get method similarly to the one set by the wp_cache_get function.
To just check on a value, I've added the has method.

✔️ Checklist

Changelog entry in the readme.txt file.
Code is covered by NEW wpunit or integration tests.
Code is covered by EXISTING wpunit or integration tests.
Are all the required tests passing?
Automated code review comments are addressed.
Have you added Artifacts?
Check the base branch for your PR.
Add your PR to the project board for the release.

For back-compatibility purposes, I've not modified existing methods like `offsetGet`. This add a `$found` flag, set by reference, to the `get` method similarly to the one set by the `wp_cache_get` function. To just check on a value, I've added the `has` method.

tec-bot · 2024-03-15T14:14:36Z

 	 * @return mixed
 	 */
-	public function get( $id, $expiration_trigger = '', $default = false, $expiration = 0, $args = [] ) {
+	public function get( $id, $expiration_trigger = '', $default = false, $expiration = 0, $args = [], ?bool &$found = false ) {


[phpcs] _{reported by reviewdog 🐶}
Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound
It is recommended not to use reserved keyword "default" as function parameter name. Found: $default

tec-bot · 2024-03-15T14:14:36Z

+
+		$cache->set( 'foo-bar', 'bar' );
+		$this->assertTrue( $cache->has( 'foo-bar' ) );
+		$this->assertEquals('bar', $cache->get( 'foo-bar','', false, 0, [], $found ) );


[phpcs] _{reported by reviewdog 🐶}
PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket
Expected 1 spaces after opening parenthesis; 0 found

tec-bot · 2024-03-15T14:14:36Z

+
+		$cache->set( 'foo-bar', 'bar' );
+		$this->assertTrue( $cache->has( 'foo-bar' ) );
+		$this->assertEquals('bar', $cache->get( 'foo-bar','', false, 0, [], $found ) );


[phpcs] _{reported by reviewdog 🐶}
Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterComma
No space found after comma in argument list

tec-bot · 2024-03-15T14:14:36Z

+
+		$cache->set( 'foo-bar-save-post', 'bar', 0, Triggers::TRIGGER_SAVE_POST );
+		$this->assertTrue( $cache->has( 'foo-bar-save-post', Triggers::TRIGGER_SAVE_POST ) );
+		$this->assertEquals('bar', $cache->get( 'foo-bar-save-post', Triggers::TRIGGER_SAVE_POST, false, 0, [], $found ) );


[phpcs] _{reported by reviewdog 🐶}
PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket
Expected 1 spaces after opening parenthesis; 0 found

tec-bot · 2024-03-15T14:14:36Z

+
+		$cache->set( 'foo-bar-updated-option', 'bar', 0, Triggers::TRIGGER_UPDATED_OPTION );
+		$this->assertTrue( $cache->has( 'foo-bar-updated-option', Triggers::TRIGGER_UPDATED_OPTION ) );
+		$this->assertEquals('bar', $cache->get( 'foo-bar-updated-option', Triggers::TRIGGER_UPDATED_OPTION, false, 0, [], $found ) );


[phpcs] _{reported by reviewdog 🐶}
PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket
Expected 1 spaces after opening parenthesis; 0 found

tec-bot · 2024-03-15T14:14:36Z

+
+		$cache->set( 'foo-bar-generate-rewrite-rules', 'bar', 0, Triggers::TRIGGER_GENERATE_REWRITE_RULES );
+		$this->assertTrue( $cache->has( 'foo-bar-generate-rewrite-rules', Triggers::TRIGGER_GENERATE_REWRITE_RULES ) );
+		$this->assertEquals('bar', $cache->get( 'foo-bar-generate-rewrite-rules', Triggers::TRIGGER_GENERATE_REWRITE_RULES, false, 0, [], $found ) );


[phpcs] _{reported by reviewdog 🐶}
PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket
Expected 1 spaces after opening parenthesis; 0 found

tec-bot

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

phpcs

tests/unit/Tribe/Utils/ArrayTest.php|404 col 100| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|406 col 17| NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.
tests/unit/Tribe/Utils/ArrayTest.php|406 col 17| SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.
tests/unit/Tribe/Utils/ArrayTest.php|408 col 80| WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow
Expected 1 space between "'non-empty array, closure shape, all key pass, strict'" and double arrow; 13 found.
tests/unit/Tribe/Utils/ArrayTest.php|409 col 54| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|410 col 100| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|412 col 17| NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.
tests/unit/Tribe/Utils/ArrayTest.php|412 col 17| SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.
tests/unit/Tribe/Utils/ArrayTest.php|414 col 80| WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow
Expected 1 space between "'non-empty array, closure shape, all key pass, non-strict '" and double arrow; 8 found.
tests/unit/Tribe/Utils/ArrayTest.php|415 col 54| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|416 col 100| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|418 col 17| NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.
tests/unit/Tribe/Utils/ArrayTest.php|418 col 17| SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.
tests/unit/Tribe/Utils/ArrayTest.php|420 col 80| WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow
Expected 1 space between "'non-empty array, closure shape, some key pass, strict'" and double arrow; 12 found.
tests/unit/Tribe/Utils/ArrayTest.php|421 col 49| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|422 col 100| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|424 col 17| NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.
tests/unit/Tribe/Utils/ArrayTest.php|424 col 17| SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.
tests/unit/Tribe/Utils/ArrayTest.php|426 col 80| WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow
Expected 1 space between "'non-empty array, closure shape, some key pass, non-strict'" and double arrow; 8 found.
tests/unit/Tribe/Utils/ArrayTest.php|427 col 49| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|428 col 100| WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.
tests/unit/Tribe/Utils/ArrayTest.php|430 col 17| NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.
tests/unit/Tribe/Utils/ArrayTest.php|430 col 17| SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.

tec-bot · 2024-03-15T16:31:58Z

+		 *                                          The callable must have the signature `fn( mixed $value ) :bool`.
+		 *
+		 * @return bool
+		 */


[phpcs] _{reported by reviewdog 🐶}
Squiz.Commenting.FunctionCommentThrowTag.Missing
Missing @throws tag in function comment

tec-bot · 2024-03-15T16:31:58Z

+		 *
+		 * @return bool
+		 */
+		public static function has_shape( $array, array $shape ): bool {


[phpcs] _{reported by reviewdog 🐶}
Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
It is recommended not to use reserved keyword "array" as function parameter name. Found: $array

tec-bot · 2024-03-15T16:31:58Z

+
+	public function has_shape_data_provider(): array {
+		return [
+			'not an array'                                                     => [ 'foo', [], true, false ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned
Array double arrow not aligned correctly; expected 29 space(s) between "'not an array'" and double arrow, but found 53.

tec-bot · 2024-03-15T16:31:58Z

+	public function has_shape_data_provider(): array {
+		return [
+			'not an array'                                                     => [ 'foo', [], true, false ],
+			'empty array, empty shape'                                         => [ [], [], true, true ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned
Array double arrow not aligned correctly; expected 17 space(s) between "'empty array, empty shape'" and double arrow, but found 41.

tec-bot · 2024-03-15T16:31:58Z

+		return [
+			'not an array'                                                     => [ 'foo', [], true, false ],
+			'empty array, empty shape'                                         => [ [], [], true, true ],
+			'empty array, non-empty shape, strict'                             => [


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned
Array double arrow not aligned correctly; expected 5 space(s) between "'empty array, non-empty shape, strict'" and double arrow, but found 29.

tec-bot · 2024-03-15T16:32:00Z

+				true
+			],
+			'non-empty array, closure shape, all key fail failure, strict'     => [
+				[ 'foo' => 23, 'bar' => 89 ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:32:00Z

+			],
+			'non-empty array, closure shape, all key fail failure, strict'     => [
+				[ 'foo' => 23, 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:32:00Z

+				[ 'foo' => 23, 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				true,
+				false


[phpcs] _{reported by reviewdog 🐶}
NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.

tec-bot · 2024-03-15T16:32:00Z

+				[ 'foo' => 23, 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				true,
+				false


[phpcs] _{reported by reviewdog 🐶}
SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.

tec-bot · 2024-03-15T16:32:00Z

+				false
+			],
+			'non-empty array, closure shape, all key fail failure, non-strict' => [
+				[ 'foo' => 23, 'bar' => 89 ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:37:22Z

+			],
+			'non-empty array, closure shape, all key fail failure, non-strict' => [
+				[ 'foo' => 23, 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:37:23Z

+				[ 'foo' => 23, 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				false,
+				false


[phpcs] _{reported by reviewdog 🐶}
NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.

tec-bot · 2024-03-15T16:37:23Z

+				[ 'foo' => 23, 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				false,
+				false


[phpcs] _{reported by reviewdog 🐶}
SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.

tec-bot · 2024-03-15T16:37:23Z

+				false,
+				false
+			],
+			'non-empty array, closure shape, all key pass, strict'             => [


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow
Expected 1 space between "'non-empty array, closure shape, all key pass, strict'" and double arrow; 13 found.

tec-bot · 2024-03-15T16:37:23Z

+				false
+			],
+			'non-empty array, closure shape, all key pass, strict'             => [
+				[ 'foo' => 'hello', 'bar' => 'world' ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:37:24Z

+				true,
+				false
+			],
+			'non-empty array, closure shape, some key pass, non-strict'        => [


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow
Expected 1 space between "'non-empty array, closure shape, some key pass, non-strict'" and double arrow; 8 found.

tec-bot · 2024-03-15T16:37:24Z

+				false
+			],
+			'non-empty array, closure shape, some key pass, non-strict'        => [
+				[ 'foo' => 'hello', 'bar' => 89 ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:37:24Z

+			],
+			'non-empty array, closure shape, some key pass, non-strict'        => [
+				[ 'foo' => 'hello', 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],


[phpcs] _{reported by reviewdog 🐶}
WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
When a multi-item array uses associative keys, each value should start on a new line.

tec-bot · 2024-03-15T16:37:24Z

+				[ 'foo' => 'hello', 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				false,
+				true


[phpcs] _{reported by reviewdog 🐶}
NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.

tec-bot · 2024-03-15T16:37:24Z

+				[ 'foo' => 'hello', 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				false,
+				true


[phpcs] _{reported by reviewdog 🐶}
SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.

tec-bot · 2024-03-15T16:56:55Z

+		 *
+		 * @return bool Whether the array has the specified shape.
+		 */
+		public static function has_shape( $array, array $shape, bool $strict = false ): bool {


[phpcs] _{reported by reviewdog 🐶}
Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
It is recommended not to use reserved keyword "array" as function parameter name. Found: $array

tec-bot · 2024-03-15T16:56:55Z

+				[],
+				[ 'foo' => 'is_string' ],
+				false,
+				false


[phpcs] _{reported by reviewdog 🐶}
NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.

tec-bot · 2024-03-15T16:56:55Z

+				[],
+				[ 'foo' => 'is_string' ],
+				false,
+				false


[phpcs] _{reported by reviewdog 🐶}
SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.

tec-bot · 2024-03-15T16:56:55Z

+				[ 'foo' => 'hello', 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				false,
+				false


[phpcs] _{reported by reviewdog 🐶}
NormalizedArrays.Arrays.CommaAfterLast.MissingMultiLine
There should be a comma after the last array item in a multi-line array.

tec-bot · 2024-03-15T16:56:56Z

+				[ 'foo' => 'hello', 'bar' => 89 ],
+				[ 'foo' => fn( $foo ) => $foo === 'hello', 'bar' => fn( $bar ) => $bar === 'world' ],
+				false,
+				false


[phpcs] _{reported by reviewdog 🐶}
SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
Multi-line arrays must have a trailing comma after the last element.

lucatume self-assigned this Mar 15, 2024

tec-bot reviewed Mar 15, 2024

View reviewed changes

style(phpcs) apply fixes

7856f1e

tec-bot reviewed Mar 15, 2024

View reviewed changes

lucatume force-pushed the feat/tribe-cache-has branch from 7032a98 to a9bc11e Compare March 15, 2024 16:36

tec-bot reviewed Mar 15, 2024

View reviewed changes

feat(Arr) add the has_shape method

fa40956

lucatume force-pushed the feat/tribe-cache-has branch from a9bc11e to fa40956 Compare March 15, 2024 16:56

tec-bot reviewed Mar 15, 2024

View reviewed changes

style(phpcs) fix style, update class name

043fe0f

Uh oh!

Conversation

lucatume commented Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎫 Ticket

🗒️ Description

✔️ Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tec-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

lucatume commented Mar 15, 2024 •

edited

Loading