<!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>[13235] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme: Plugin Directory: Introduce a maximum length to the readme sections.</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/13235">13235</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/13235","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-22 05:46:59 +0000 (Thu, 22 Feb 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'>Plugin Directory: Introduce a maximum length to the readme sections.
See <a href="http://meta.trac.wordpress.org/ticket/7477">#7477</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp"></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/plugin-directory/readme/class-parser.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/plugin-directory/readme/class-parser.php 2024-02-22 05:30:26 UTC (rev 13234)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php 2024-02-22 05:46:59 UTC (rev 13235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,7 +99,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private $expected_sections = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $expected_sections = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'description',
</span><span class="cx" style="display: block; padding: 0 10px"> 'installation',
</span><span class="cx" style="display: block; padding: 0 10px"> 'faq',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,7 +114,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private $alias_sections = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $alias_sections = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'frequently_asked_questions' => 'faq',
</span><span class="cx" style="display: block; padding: 0 10px"> 'change_log' => 'changelog',
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot' => 'screenshots',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,7 +125,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private $valid_headers = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $valid_headers = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'tested' => 'tested',
</span><span class="cx" style="display: block; padding: 0 10px"> 'tested up to' => 'tested',
</span><span class="cx" style="display: block; padding: 0 10px"> 'requires' => 'requires',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -150,6 +150,23 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The maximum field lengths for the readme.
+ *
+ * @var array
+ */
+ public $maximum_field_lengths = array(
+ 'short_description' => 150,
+ 'section' => 1500,
+ );
+
+ /**
+ * The raw contents of the readme file.
+ *
+ * @var string
+ */
+ public $raw_contents = '';
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Parser constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string A Filepath, URL, or contents of a readme to parse.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,6 +213,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function parse_readme_contents( $contents ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->raw_contents = $contents;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( preg_match( '!!u', $contents ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $contents = preg_split( '!\R!u', $contents );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,6 +429,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $this->sections['upgrade_notice'] );
</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">+ foreach ( $this->sections as $section => $content ) {
+ $this->sections[ $section ] = $this->trim_length( $content, 'section', 'words' );
+
+ if ( $content !== $this->sections[ $section ] ) {
+ $this->warnings["trimmed_section_{$section}"] = true;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Display FAQs as a definition list.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $this->sections['faq'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->faq = $this->parse_section( $this->sections['faq'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -431,7 +458,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = $this->sanitize_text( $this->short_description );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = $this->parse_markdown( $this->short_description );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = wp_strip_all_tags( $this->short_description );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $short_description = $this->trim_length( $this->short_description, 150 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $short_description = $this->trim_length( $this->short_description, 'short_description' );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $short_description !== $this->short_description ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $this->warnings['no_short_description_present'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->warnings['trimmed_short_description'] = true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -505,9 +532,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $desc
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $length
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $type The type of the length, 'char' or 'words'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function trim_length( $desc, $length = 150 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function trim_length( $desc, $length = 150, $type = 'char' ) {
+ if ( is_string( $length ) ) {
+ $length = $this->maximum_field_lengths[ $length ] ?? $length;
+ }
+
+ if ( 'words' === $type ) {
+ return wp_trim_words( $desc, $length, ' …' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Apply the length restriction without counting html entities.
</span><span class="cx" style="display: block; padding: 0 10px"> $str_length = mb_strlen( html_entity_decode( $desc ) ?: $desc );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassvalidatorphp"></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/plugin-directory/readme/class-validator.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/plugin-directory/readme/class-validator.php 2024-02-22 05:30:26 UTC (rev 13234)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php 2024-02-22 05:46:59 UTC (rev 13235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,13 +180,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '<code>Short Description</code>'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif( isset( $readme->warnings['trimmed_short_description'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $notes[] = sprintf(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $warnings[] = sprintf(
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: section title */
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'The %s section is too long and was truncated. A maximum of 150 characters is supported.', 'wporg-plugins' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<code>Short Description</code>'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<code>Short Description</code>',
+ number_format_i18n( $readme->maximum_field_lengths['short_description'] )
</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">+ $trimmed_sections = array_filter( $readme->warnings, function( $warning ) {
+ return str_contains( $warning, 'trimmed_section_' );
+ }, ARRAY_FILTER_USE_KEY );
+ foreach ( $trimmed_sections as $section_name => $dummy ) {
+ $section_name = str_replace( 'trimmed_section_', '', $section_name );
+ $warnings[] = sprintf(
+ /* translators: %s: section title */
+ __( 'The %s section is too long and was truncated. A maximum of %s words is supported.', 'wporg-plugins' ),
+ '<code>' . esc_html( ucwords( str_replace( '_', ' ', $section_name ) ) ) . '</code>',
+ number_format_i18n( $readme->maximum_field_lengths[ 'section' ] )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $readme->sections['faq'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $notes[] = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: section title */
</span></span></pre>
</div>
</div>
</body>
</html>