Changeset 47122 for trunk/tests/phpunit/tests/post/attachments.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/post/attachments.php (modified) (16 diffs)

trunk/tests/phpunit/tests/post/attachments.php

@@ -24 +24 @@
     function test_insert_image_no_thumb() {
 
-        // this image is smaller than the thumbnail size so it won't have one
+        // This image is smaller than the thumbnail size so it won't have one.
         $filename = ( DIR_TESTDATA . '/images/test-image.jpg' );
         $contents = file_get_contents( $filename );
@@ -33 +33 @@
         $id = $this->_make_attachment( $upload );
 
-        // intermediate copies should not exist
+        // Intermediate copies should not exist.
         $this->assertFalse( image_get_intermediate_size( $id, 'thumbnail' ) );
         $this->assertFalse( image_get_intermediate_size( $id, 'medium' ) );
         $this->assertFalse( image_get_intermediate_size( $id, 'medium_large' ) );
 
-        // medium, medium_large, and full size will both point to the original
+        // medium, medium_large, and full size will both point to the original.
         $downsize = image_downsize( $id, 'medium' );
         $this->assertEquals( wp_basename( $upload['file'] ), wp_basename( $downsize[0] ) );
@@ -72 +72 @@
         $id = $this->_make_attachment( $upload );
 
-        // intermediate copies should exist: thumbnail only
+        // Intermediate copies should exist: thumbnail only.
         $thumb = image_get_intermediate_size( $id, 'thumbnail' );
         $this->assertEquals( 'a2-small-150x150.jpg', $thumb['file'] );
@@ -82 +82 @@
         $this->assertFalse( image_get_intermediate_size( $id, 'medium_large' ) );
 
-        // the thumb url should point to the thumbnail intermediate
+        // The thumb url should point to the thumbnail intermediate.
         $this->assertEquals( $thumb['url'], wp_get_attachment_thumb_url( $id ) );
 
-        // image_downsize() should return the correct images and sizes
+        // image_downsize() should return the correct images and sizes.
         $downsize = image_downsize( $id, 'thumbnail' );
         $this->assertEquals( 'a2-small-150x150.jpg', wp_basename( $downsize[0] ) );
@@ -91 +91 @@
         $this->assertEquals( 150, $downsize[2] );
 
-        // medium, medium_large, and full will both point to the original
+        // medium, medium_large, and full will both point to the original.
         $downsize = image_downsize( $id, 'medium' );
         $this->assertEquals( 'a2-small.jpg', wp_basename( $downsize[0] ) );
@@ -129 +129 @@
         $uploads = wp_upload_dir();
 
-        // intermediate copies should exist: thumbnail and medium
+        // Intermediate copies should exist: thumbnail and medium.
         $thumb = image_get_intermediate_size( $id, 'thumbnail' );
         $this->assertEquals( '2007-06-17DSC_4173-150x150.jpg', $thumb['file'] );
@@ -142 +142 @@
         $this->assertTrue( is_file( $uploads['basedir'] . DIRECTORY_SEPARATOR . $medium_large['path'] ) );
 
-        // the thumb url should point to the thumbnail intermediate
+        // The thumb url should point to the thumbnail intermediate.
         $this->assertEquals( $thumb['url'], wp_get_attachment_thumb_url( $id ) );
 
-        // image_downsize() should return the correct images and sizes
+        // image_downsize() should return the correct images and sizes.
         $downsize = image_downsize( $id, 'thumbnail' );
         $this->assertEquals( '2007-06-17DSC_4173-150x150.jpg', wp_basename( $downsize[0] ) );
@@ -188 +188 @@
         $uploads = wp_upload_dir();
 
-        // check that the file and intermediates exist
+        // Check that the file and intermediates exist.
         $thumb = image_get_intermediate_size( $id, 'thumbnail' );
         $this->assertEquals( '2007-06-17DSC_4173-150x150.jpg', $thumb['file'] );
@@ -205 +205 @@
         $this->assertTrue( is_file( $uploads['basedir'] . DIRECTORY_SEPARATOR . $original ) );
 
-        // now delete the attachment and make sure all files are gone
+        // Now delete the attachment and make sure all files are gone.
         wp_delete_attachment( $id );
 
@@ -221 +221 @@
      */
     function test_insert_image_without_guid() {
-        // this image is smaller than the thumbnail size so it won't have one
+        // This image is smaller than the thumbnail size so it won't have one.
         $filename = ( DIR_TESTDATA . '/images/test-image.jpg' );
         $contents = file_get_contents( $filename );
@@ -273 +273 @@
         $attachment_id = $this->_make_attachment( $upload );
 
-        // Assert that the attachment is an orphan
+        // Assert that the attachment is an orphan.
         $attachment = get_post( $attachment_id );
         $this->assertEquals( $attachment->post_parent, 0 );
@@ -284 +284 @@
         );
 
-        // Assert that the attachment has a parent
+        // Assert that the attachment has a parent.
         wp_insert_attachment( $attachment, '', $post_id );
         $attachment = get_post( $attachment_id );
@@ -353 +353 @@
         $this->assertTrue( empty( $upload['error'] ) );
 
-        // Set attachment ID
+        // Set attachment ID.
         $attachment_id = $this->_make_attachment( $upload );
 
@@ -409 +409 @@
         $this->assertTrue( empty( $upload['error'] ) );
 
-        // Set attachment ID
+        // Set attachment ID.
         $attachment_id = $this->_make_attachment( $upload );
 
@@ -427 +427 @@
      */
     public function test_wp_get_attachment_url_should_force_https_when_administering_over_https_and_siteurl_is_https() {
-        // Set https upload URL
+        // Set https upload URL.
         add_filter( 'upload_dir', '_upload_dir_https' );
 
@@ -436 +436 @@
         $this->assertTrue( empty( $upload['error'] ) );
 
-        // Set attachment ID
+        // Set attachment ID.
         $attachment_id = $this->_make_attachment( $upload );