<!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>[37299] trunk/tests/phpunit/includes/factory: Tests: Use the same incrementor for all fields belonging to a given text fixture.</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 { 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/37299">37299</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/37299","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-04-22 14:35:52 +0000 (Fri, 22 Apr 2016)</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 the same incrementor for all fields belonging to a given text fixture.

<a href="https://core.trac.wordpress.org/changeset/35244">[35244]</a> changed the way that `WP_UnitTest_Generator_Sequence()` created an
incrementor for object fields (like 'post_name' and 'user_email'), by making
incrementor static across the entire run of the test suite. While this helped
to enforce uniqueness across the tests, it has the side effect of bumping the
incrementor between fields on the same object (so that, eg, the same post might
have `post_name` "post-12" but `post_title` "Post 13". By switching to a
technique that uses the same incrementor for each field belonging to a given
fixture, we conform better to the expectations of developers using
`WP_UnitTest_Factory`.

Fixes <a href="https://core.trac.wordpress.org/ticket/35199">#35199</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforthingphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestgeneratorsequencephp">trunk/tests/phpunit/includes/factory/class-wp-unittest-generator-sequence.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforthingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php      2016-04-22 07:07:03 UTC (rev 37298)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php        2016-04-22 14:35:52 UTC (rev 37299)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,19 +62,25 @@
</span><span class="cx" style="display: block; padding: 0 10px">                if ( is_null( $generation_definitions ) )
</span><span class="cx" style="display: block; padding: 0 10px">                        $generation_definitions = $this->default_generation_definitions;
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                // Use the same incrementor for all fields belonging to this object.
+               $gen  = new WP_UnitTest_Generator_Sequence();
+               $incr = $gen->get_incr();
+
</ins><span class="cx" style="display: block; padding: 0 10px">                 foreach( array_keys( $generation_definitions ) as $field_name ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        if ( !isset( $args[$field_name] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">                                $generator = $generation_definitions[$field_name];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                if ( is_scalar( $generator ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         if ( is_scalar( $generator ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                                         $args[$field_name] = $generator;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                elseif ( is_object( $generator ) && method_exists( $generator, 'call' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         } elseif ( is_object( $generator ) && method_exists( $generator, 'call' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                                         $callbacks[$field_name] = $generator;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                } elseif ( is_object( $generator ) )
-                                       $args[$field_name] = $generator->next();
-                               else
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         } elseif ( is_object( $generator ) ) {
+                                       $args[ $field_name ] = sprintf( $generator->get_template_string(), $incr );
+                               } else {
</ins><span class="cx" style="display: block; padding: 0 10px">                                         return new WP_Error( 'invalid_argument', 'Factory default value should be either a scalar or an generator object.' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                }
</ins><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">+
</ins><span class="cx" style="display: block; padding: 0 10px">                 return $args;
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestgeneratorsequencephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-generator-sequence.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-generator-sequence.php     2016-04-22 07:07:03 UTC (rev 37298)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-generator-sequence.php       2016-04-22 14:35:52 UTC (rev 37299)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,4 +20,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">                $this->next++;
</span><span class="cx" style="display: block; padding: 0 10px">                return $generated;
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * Get the incrementor.
+        *
+        * @since 4.6.0
+        *
+        * @return int
+        */
+       public function get_incr() {
+               return self::$incr;
+       }
+
+       /**
+        * Get the template string.
+        *
+        * @since 4.6.0
+        *
+        * @return string
+        */
+       public function get_template_string() {
+               return $this->template_string;
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>

</body>
</html>