Changeset 13235

Timestamp:

02/22/2024 05:46:59 AM (2 years ago)

Author:

dd32

Message:

Plugin Directory: Introduce a maximum length to the readme sections.

See #7477.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme

Files:

• class-parser.php (modified) (8 diffs)
• class-validator.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php

@@ -100 +100 @@
      * @var array
      */
-    private $expected_sections = array(
+    public $expected_sections = array(
         'description',
         'installation',
@@ -115 +115 @@
      * @var array
      */
-    private $alias_sections = array(
+    public $alias_sections = array(
         'frequently_asked_questions' => 'faq',
         'change_log'                 => 'changelog',
@@ -126 +126 @@
      * @var array
      */
-    private $valid_headers = array(
+    public $valid_headers = array(
         'tested'            => 'tested',
         'tested up to'      => 'tested',
@@ -149 +149 @@
         'wordpress',
     );
+
+    /**
+     * 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 = '';
 
     /**
@@ -197 +214 @@
      */
     protected function parse_readme_contents( $contents ) {
+        $this->raw_contents = $contents;
+
         if ( preg_match( '!!u', $contents ) ) {
             $contents = preg_split( '!\R!u', $contents );
@@ -411 +430 @@
         }
 
+        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;
+            }
+        }
+
         // Display FAQs as a definition list.
         if ( isset( $this->sections['faq'] ) ) {
@@ -432 +459 @@
         $this->short_description = $this->parse_markdown( $this->short_description );
         $this->short_description = wp_strip_all_tags( $this->short_description );
-        $short_description       = $this->trim_length( $this->short_description, 150 );
+        $short_description       = $this->trim_length( $this->short_description, 'short_description' );
         if ( $short_description !== $this->short_description ) {
             if ( empty( $this->warnings['no_short_description_present'] ) ) {
@@ -506 +533 @@
      * @param string $desc
      * @param int    $length
+     * @param string $type   The type of the length, 'char' or 'words'.
      * @return string
      */
-    protected function trim_length( $desc, $length = 150 ) {
+    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, ' …' );
+        }
+
         // Apply the length restriction without counting html entities.
         $str_length = mb_strlen( html_entity_decode( $desc ) ?: $desc );

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php

@@ -181 +181 @@
             );
         } elseif( isset( $readme->warnings['trimmed_short_description'] ) ) {
-            $notes[] = sprintf(
+            $warnings[] = sprintf(
                 /* translators: %s: section title */
                 __( 'The %s section is too long and was truncated. A maximum of 150 characters is supported.', 'wporg-plugins' ),
-                '<code>Short Description</code>'
+                '<code>Short Description</code>',
+                number_format_i18n( $readme->maximum_field_lengths['short_description'] )
+            );
+        }
+
+        $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' ] )
             );
         }