<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58739] trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPIFunctions.php: Tests: Use data provider in Tests_Interactivity_API_wpInteractivityAPIFunctions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58739">58739</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58739","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-16 18:37:46 +0000 (Tue, 16 Jul 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Tests: Use data provider in Tests_Interactivity_API_wpInteractivityAPIFunctions.
Refactors the following tests to use a data provider with named test cases:
* `test_wp_interactivity_data_wp_context_with_different_arrays()`
* `test_wp_interactivity_data_wp_context_with_different_arrays_and_a_namespace()`
* `test_wp_interactivity_data_wp_context_with_json_flags()`
This is better as:
1. One failing test will not block the other tests from running.
2. Each test is now referenced by name in any error message, making it more straight forward to see which test failed.
3. The test no longer contains multiple assertions.
3. It makes it more straight forward to add additional tests.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/58594">[58594]</a>, <a href="https://core.trac.wordpress.org/changeset/58234">[58234]</a>, <a href="https://core.trac.wordpress.org/changeset/57762">[57762]</a>, <a href="https://core.trac.wordpress.org/changeset/57743">[57743]</a>, <a href="https://core.trac.wordpress.org/changeset/57742">[57742]</a>, <a href="https://core.trac.wordpress.org/changeset/57563">[57563]</a>.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/61530">#61530</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsinteractivityapiwpInteractivityAPIFunctionsphp">trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPIFunctions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsinteractivityapiwpInteractivityAPIFunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPIFunctions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPIFunctions.php 2024-07-16 18:20:43 UTC (rev 58738)
+++ trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPIFunctions.php 2024-07-16 18:37:46 UTC (rev 58739)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,28 +354,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 60356
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers wp_interactivity_data_wp_context
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers wp_interactivity_data_wp_context
+ * @dataProvider data_wp_interactivity_data_wp_context_with_different_arrays
+ *
+ * @param array $context Context to encode.
+ * @param string $expected Expected function output.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_wp_interactivity_data_wp_context_with_different_arrays() {
- $this->assertSame( 'data-wp-context=\'{}\'', wp_interactivity_data_wp_context( array() ) );
- $this->assertSame(
- 'data-wp-context=\'{"a":1,"b":"2","c":true}\'',
- wp_interactivity_data_wp_context(
- array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_interactivity_data_wp_context_with_different_arrays( $context, $expected ) {
+ $this->assertSame( $expected, wp_interactivity_data_wp_context( $context ) );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_wp_interactivity_data_wp_context_with_different_arrays() {
+ return array(
+ 'empty array' => array(
+ 'context' => array(),
+ 'expected' => 'data-wp-context=\'{}\'',
+ ),
+ 'associative array with mixed values' => array(
+ 'context' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'a' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'b' => '2',
</span><span class="cx" style="display: block; padding: 0 10px"> 'c' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- )
- )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ),
+ 'expected' => 'data-wp-context=\'{"a":1,"b":"2","c":true}\'',
+ ),
+ 'associative array with nested array as value' => array(
+ 'context' => array( 'a' => array( 1, 2 ) ),
+ 'expected' => 'data-wp-context=\'{"a":[1,2]}\'',
+ ),
+ 'array without keys, integer values' => array(
+ 'context' => array( 1, 2 ),
+ 'expected' => 'data-wp-context=\'[1,2]\'',
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame(
- 'data-wp-context=\'{"a":[1,2]}\'',
- wp_interactivity_data_wp_context( array( 'a' => array( 1, 2 ) ) )
- );
- $this->assertSame(
- 'data-wp-context=\'[1,2]\'',
- wp_interactivity_data_wp_context( array( 1, 2 ) )
- );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -384,29 +400,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 60356
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers wp_interactivity_data_wp_context
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers wp_interactivity_data_wp_context
+ * @dataProvider data_wp_interactivity_data_wp_context_with_different_arrays_and_a_namespace
+ *
+ * @param array $context Context to encode.
+ * @param string $store Store namespace.
+ * @param string $expected Expected function output.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_wp_interactivity_data_wp_context_with_different_arrays_and_a_namespace() {
- $this->assertSame( 'data-wp-context=\'myPlugin::{}\'', wp_interactivity_data_wp_context( array(), 'myPlugin' ) );
- $this->assertSame(
- 'data-wp-context=\'myPlugin::{"a":1,"b":"2","c":true}\'',
- wp_interactivity_data_wp_context(
- array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_interactivity_data_wp_context_with_different_arrays_and_a_namespace( $context, $store, $expected ) {
+ $this->assertSame( $expected, wp_interactivity_data_wp_context( $context, $store ) );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_wp_interactivity_data_wp_context_with_different_arrays_and_a_namespace() {
+ return array(
+ 'empty array' => array(
+ 'context' => array(),
+ 'store' => 'myPlugin',
+ 'expected' => 'data-wp-context=\'myPlugin::{}\'',
+ ),
+ 'associative array with mixed values' => array(
+ 'context' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'a' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'b' => '2',
</span><span class="cx" style="display: block; padding: 0 10px"> 'c' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'myPlugin'
- )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'store' => 'myPlugin',
+ 'expected' => 'data-wp-context=\'myPlugin::{"a":1,"b":"2","c":true}\'',
+ ),
+ 'associative array with nested array as value' => array(
+ 'context' => array( 'a' => array( 1, 2 ) ),
+ 'store' => 'myPlugin',
+ 'expected' => 'data-wp-context=\'myPlugin::{"a":[1,2]}\'',
+ ),
+ 'array without keys, integer values' => array(
+ 'context' => array( 1, 2 ),
+ 'store' => 'myPlugin',
+ 'expected' => 'data-wp-context=\'myPlugin::[1,2]\'',
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame(
- 'data-wp-context=\'myPlugin::{"a":[1,2]}\'',
- wp_interactivity_data_wp_context( array( 'a' => array( 1, 2 ) ), 'myPlugin' )
- );
- $this->assertSame(
- 'data-wp-context=\'myPlugin::[1,2]\'',
- wp_interactivity_data_wp_context( array( 1, 2 ), 'myPlugin' )
- );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -417,16 +453,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 60356
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers wp_interactivity_data_wp_context
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers wp_interactivity_data_wp_context
+ * @dataProvider data_wp_interactivity_data_wp_context_with_json_flags
+ *
+ * @param array $context Context to encode.
+ * @param string $expected Expected function output.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_wp_interactivity_data_wp_context_with_json_flags() {
- $this->assertSame( 'data-wp-context=\'{"tag":"\u003Cfoo\u003E"}\'', wp_interactivity_data_wp_context( array( 'tag' => '<foo>' ) ) );
- $this->assertSame( 'data-wp-context=\'{"apos":"\u0027bar\u0027"}\'', wp_interactivity_data_wp_context( array( 'apos' => "'bar'" ) ) );
- $this->assertSame( 'data-wp-context=\'{"quot":"\u0022baz\u0022"}\'', wp_interactivity_data_wp_context( array( 'quot' => '"baz"' ) ) );
- $this->assertSame( 'data-wp-context=\'{"amp":"T\u0026T"}\'', wp_interactivity_data_wp_context( array( 'amp' => 'T&T' ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_interactivity_data_wp_context_with_json_flags( $context, $expected ) {
+ $this->assertSame( $expected, wp_interactivity_data_wp_context( $context ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_wp_interactivity_data_wp_context_with_json_flags() {
+ return array(
+ 'value contains <> brackets' => array(
+ 'context' => array( 'tag' => '<foo>' ),
+ 'expected' => 'data-wp-context=\'{"tag":"\u003Cfoo\u003E"}\'',
+ ),
+ 'value contains single quote chars' => array(
+ 'context' => array( 'apos' => "'bar'" ),
+ 'expected' => 'data-wp-context=\'{"apos":"\u0027bar\u0027"}\'',
+ ),
+ 'value contains double quote chars' => array(
+ 'context' => array( 'quot' => '"baz"' ),
+ 'expected' => 'data-wp-context=\'{"quot":"\u0022baz\u0022"}\'',
+ ),
+ 'value contains & ampersand' => array(
+ 'context' => array( 'amp' => 'T&T' ),
+ 'expected' => 'data-wp-context=\'{"amp":"T\u0026T"}\'',
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests that directives processing of tags that don't visit closer tag work.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 60746
</span></span></pre>
</div>
</div>
</body>
</html>