<!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>[10757] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit: Handbooks, Unit tests: Extract `reinit_handbooks()` from the template tags tests into general unit testing utility function.</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="http://meta.trac.wordpress.org/changeset/10757">10757</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10757","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-03-04 23:14:53 +0000 (Thu, 04 Mar 2021)</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'>Handbooks, Unit tests: Extract `reinit_handbooks()` from the template tags tests into general unit testing utility function.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookphpunitbootstrapphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/bootstrap.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookphpunitteststemplatetagsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/template-tags.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/includes/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookphpunitincludesutilsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/includes/utils.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookphpunitbootstrapphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/bootstrap.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/bootstrap.php 2021-03-04 23:07:04 UTC (rev 10756)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/bootstrap.php 2021-03-04 23:14:53 UTC (rev 10757)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,3 +39,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Start up the WP testing environment.
</span><span class="cx" style="display: block; padding: 0 10px"> require $_tests_dir . '/includes/bootstrap.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+// Include utility functions.
+require __DIR__ . '/includes/utils.php';
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookphpunitincludesutilsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/includes/utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/includes/utils.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/includes/utils.php 2021-03-04 23:14:53 UTC (rev 10757)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,25 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Reinitializes handbooks.
+ *
+ * Necessary when defining new handbooks.
+ *
+ * @param array $data Data for defining handbooks.
+ * @param string $type Optional. The type of info provided in $data. Either
+ * 'config' (for 'handbooks_config' filter) or 'post_types'
+ * (for 'handbook_post_types').
+ */
+function reinit_handbooks( $data, $type = 'config' ) {
+ WPorg_Handbook_Init::reset( true );
+
+ $hook = 'config' === $type ? 'handbooks_config' : 'handbook_post_types';
+
+ add_filter( $hook, function( $x ) use ( $data ) { return $data; } );
+
+ WPorg_Handbook_Init::init();
+
+ foreach ( WPorg_Handbook_Init::get_handbook_objects() as $handbook ) {
+ $handbook->register_post_type();
+ }
+}
</ins></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookphpunitteststemplatetagsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/template-tags.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/template-tags.php 2021-03-04 23:07:04 UTC (rev 10756)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/template-tags.php 2021-03-04 23:14:53 UTC (rev 10757)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,27 +4,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> class WPorg_Handbook_Template_Tags_Test extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- //
- //
- // HELPERS
- //
- //
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- /**
- * Reinitializes handbooks.
- *
- * Necessary when defining new handbooks.
- */
- protected function reinit_handbooks() {
- WPorg_Handbook_Init::init();
-
- foreach ( WPorg_Handbook_Init::get_handbook_objects() as $handbook ) {
- $handbook->register_post_type();
- }
- }
-
-
</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"> // TESTS
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -41,7 +21,7 @@
</span><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"> public function test_wporg_get_handbook_post_types_custom_post_types() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_post_types', function( $post_types ) { return [ 'plugin', 'theme' ]; } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ reinit_handbooks( [ 'plugin', 'theme' ], 'post_types' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( [ 'plugin-handbook', 'theme-handbook' ], wporg_get_handbook_post_types() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,7 +125,7 @@
</span><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"> public function test_wporg_is_handbook_post_type_with_custom_post_types() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_post_types', function( $post_types ) { return [ 'plugin', 'theme' ]; } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ reinit_handbooks( [ 'plugin', 'theme' ], 'post_types' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( wporg_is_handbook_post_type( 'handbook' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( wporg_is_handbook_post_type( 'plugin-handbook' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -172,10 +152,8 @@
</span><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"> public function test_wporg_get_current_handbook_for_multi_handbook() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_post_types', function( $post_types ) { return [ 'plugin', 'theme' ]; } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ reinit_handbooks( [ 'plugin', 'theme' ], 'post_types' );
</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->reinit_handbooks();
-
</del><span class="cx" style="display: block; padding: 0 10px"> $post_id1 = $this->factory()->post->create( [ 'post_type' => 'plugin-handbook' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id2 = $this->factory()->post->create( [ 'post_type' => 'theme-handbook' ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -210,10 +188,8 @@
</span><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"> public function test_wporg_get_current_handbook_home_url_for_multi_handbook() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_post_types', function( $post_types ) { return [ 'plugin', 'theme' ]; } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ reinit_handbooks( [ 'plugin', 'theme' ], 'post_types' );
</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->reinit_handbooks();
-
</del><span class="cx" style="display: block; padding: 0 10px"> $post_id1 = $this->factory()->post->create( [ 'post_type' => 'plugin-handbook', 'post_name' => 'something' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id2 = $this->factory()->post->create( [ 'post_type' => 'theme-handbook', 'post_name' => 'example' ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,8 +237,7 @@
</span><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"> public function test_wporg_get_current_handbook_name_multi_handbook_with_names_set() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_post_types', function( $post_types ) { return [ 'custom', 'example' ]; } );
- $this->reinit_handbooks();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ reinit_handbooks( [ 'custom', 'example' ], 'post_types' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id1 = $this->factory()->post->create( [ 'post_type' => 'custom-handbook' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'custom-handbook_name', 'My Custom Handbook' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -278,8 +253,7 @@
</span><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"> public function test_wporg_get_current_handbook_name_multi_handbook_with_no_names_set() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'handbook_post_types', function( $post_types ) { return [ 'custom', 'example' ]; } );
- $this->reinit_handbooks();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ reinit_handbooks( [ 'custom', 'example' ], 'post_types' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id1 = $this->factory()->post->create( [ 'post_type' => 'custom-handbook' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id2 = $this->factory()->post->create( [ 'post_type' => 'example-handbook' ] );
</span></span></pre>
</div>
</div>
</body>
</html>