Changeset 47122 for trunk/tests/phpunit/tests/feed/rss2.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/tests/feed/rss2.php (modified) (15 diffs)

trunk/tests/phpunit/tests/feed/rss2.php

@@ -19 +19 @@
      */
     public static function wpSetUpBeforeClass( $factory ) {
-        // Create a user
+        // Create a user.
         self::$user_id = $factory->user->create(
             array(
@@ -28 +28 @@
         );
 
-        // Create a taxonomy
+        // Create a taxonomy.
         self::$category = $factory->category->create_and_get(
             array(
@@ -42 +42 @@
 
         self::$posts = array();
-        // Create a few posts
+        // Create a few posts.
         for ( $i = 1; $i <= $count; $i++ ) {
             self::$posts[] = $factory->post->create(
@@ -55 +55 @@
         }
 
-        // Assign a category to those posts
+        // Assign a category to those posts.
         foreach ( self::$posts as $post ) {
             wp_set_object_terms( $post, self::$category->slug, 'category' );
@@ -69 +69 @@
         $this->post_count   = (int) get_option( 'posts_per_rss' );
         $this->excerpt_only = get_option( 'rss_use_excerpt' );
-        // this seems to break something
+        // This seems to break something.
         update_option( 'use_smilies', false );
 
@@ -114 +114 @@
         $this->assertEquals( 'http://purl.org/dc/elements/1.1/', $rss[0]['attributes']['xmlns:dc'] );
 
-        // rss should have exactly one child element (channel)
+        // RSS should have exactly one child element (channel).
         $this->assertEquals( 1, count( $rss[0]['child'] ) );
     }
@@ -128 +128 @@
         $xml  = xml_to_array( $feed );
 
-        // get the rss -> channel element
+        // Get the rss -> channel element.
         $channel = xml_find( $xml, 'rss', 'channel' );
 
-        // The channel should be free of attributes
+        // The channel should be free of attributes.
         $this->assertTrue( empty( $channel[0]['attributes'] ) );
 
-        // Verify the channel is present and contains a title child element
+        // Verify the channel is present and contains a title child element.
         $title = xml_find( $xml, 'rss', 'channel', 'title' );
         $this->assertEquals( get_option( 'blogname' ), $title[0]['content'] );
@@ -181 +181 @@
         $xml  = xml_to_array( $feed );
 
-        // Get all the <item> child elements of the <channel> element
+        // Get all the <item> child elements of the <channel> element.
         $items = xml_find( $xml, 'rss', 'channel', 'item' );
 
@@ -187 +187 @@
         $this->assertCount( $this->post_count, $items );
 
-        // We Really only need to test X number of items unless the content is different
+        // We really only need to test X number of items unless the content is different.
         $items = array_slice( $items, 1 );
 
-        // Check each of the desired entries against the known post data
+        // Check each of the desired entries against the known post data.
         foreach ( $items as $key => $item ) {
 
-            // Get post for comparison
+            // Get post for comparison.
             $guid = xml_find( $items[ $key ]['child'], 'guid' );
             preg_match( '/\?p=(\d+)/', $guid[0]['content'], $matches );
             $post = get_post( $matches[1] );
 
-            // Title
+            // Title.
             $title = xml_find( $items[ $key ]['child'], 'title' );
             $this->assertEquals( $post->post_title, $title[0]['content'] );
 
-            // Link
+            // Link.
             $link = xml_find( $items[ $key ]['child'], 'link' );
             $this->assertEquals( get_permalink( $post ), $link[0]['content'] );
 
-            // Comment link
+            // Comment link.
             $comments_link = xml_find( $items[ $key ]['child'], 'comments' );
             $this->assertEquals( get_permalink( $post ) . '#respond', $comments_link[0]['content'] );
 
-            // Pub date
+            // Pub date.
             $pubdate = xml_find( $items[ $key ]['child'], 'pubDate' );
             $this->assertEquals( strtotime( $post->post_date_gmt ), strtotime( $pubdate[0]['content'] ) );
 
-            // Author
+            // Author.
             $creator = xml_find( $items[ $key ]['child'], 'dc:creator' );
             $user    = new WP_User( $post->post_author );
             $this->assertEquals( $user->display_name, $creator[0]['content'] );
 
-            // Categories (perhaps multiple)
+            // Categories (perhaps multiple).
             $categories = xml_find( $items[ $key ]['child'], 'category' );
             $cats       = array();
@@ -233 +233 @@
             }
             $cats = array_filter( $cats );
-            // Should be the same number of categories
+            // Should be the same number of categories.
             $this->assertEquals( count( $cats ), count( $categories ) );
 
-            // ..with the same names
+            // ..with the same names.
             foreach ( $cats as $id => $cat ) {
                 $this->assertEquals( $cat, $categories[ $id ]['content'] );
             }
 
-            // GUID
+            // GUID.
             $guid = xml_find( $items[ $key ]['child'], 'guid' );
             $this->assertEquals( 'false', $guid[0]['attributes']['isPermaLink'] );
             $this->assertEquals( $post->guid, $guid[0]['content'] );
 
-            // Description / Excerpt
+            // Description / Excerpt.
             if ( ! empty( $post->post_excerpt ) ) {
                 $description = xml_find( $items[ $key ]['child'], 'description' );
@@ -252 +252 @@
             }
 
-            // Post content
+            // Post content.
             if ( ! $this->excerpt_only ) {
                 $content = xml_find( $items[ $key ]['child'], 'content:encoded' );
@@ -258 +258 @@
             }
 
-            // Comment rss
+            // Comment RSS.
             $comment_rss = xml_find( $items[ $key ]['child'], 'wfw:commentRss' );
             $this->assertEquals( html_entity_decode( get_post_comments_feed_link( $post->ID ) ), $comment_rss[0]['content'] );
@@ -274 +274 @@
         $xml  = xml_to_array( $feed );
 
-        // get all the rss -> channel -> item elements
+        // Get all the rss -> channel -> item elements.
         $items = xml_find( $xml, 'rss', 'channel', 'item' );
 
-        // check each of the items against the known post data
+        // Check each of the items against the known post data.
         foreach ( $items as $key => $item ) {
-            // Get post for comparison
+            // Get post for comparison.
             $guid = xml_find( $items[ $key ]['child'], 'guid' );
             preg_match( '/\?p=(\d+)/', $guid[0]['content'], $matches );
             $post = get_post( $matches[1] );
 
-            // comment link
+            // Comment link.
             $comments_link = xml_find( $items[ $key ]['child'], 'comments' );
             $this->assertEmpty( $comments_link );
 
-            // comment rss
+            // Comment RSS.
             $comment_rss = xml_find( $items[ $key ]['child'], 'wfw:commentRss' );
             $this->assertEmpty( $comment_rss );
@@ -359 +359 @@
      */
     function test_valid_main_comment_feed_endpoint() {
-        // Generate a bunch of comments
+        // Generate a bunch of comments.
         foreach ( self::$posts as $post ) {
             self::factory()->comment->create_post_comments( $post, 3 );
@@ -448 +448 @@
      */
     function test_valid_search_feed_endpoint() {
-        // An example of an valid search feed endpoint
+        // An example of an valid search feed endpoint.
         $this->go_to( '?s=Lorem&feed=rss' );