Changeset 47122 for trunk/tests/phpunit/tests/media.php

Timestamp:

01/29/2020 12:43:23 AM (6 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/media.php (modified) (25 diffs)

trunk/tests/phpunit/tests/media.php

@@ -273 +273 @@
         return array(
 
-            // Should embed
+            // Should embed.
             array(
                 'https://w.org',
@@ -309 +309 @@
             ),
 
-            // Should NOT embed
+            // Should NOT embed.
             array(
                 'test https://w.org</p>',
@@ -337 +337 @@
 
     function test_wp_prepare_attachment_for_js() {
-        // Attachment without media
+        // Attachment without media.
         $id   = wp_insert_attachment(
             array(
@@ -354 +354 @@
         $this->assertEquals( '', $prepped['type'] );
         $this->assertEquals( '', $prepped['subtype'] );
-        // #21963, there will be a guid always, so there will be a URL
+        // #21963, there will be a GUID always, so there will be a URL.
         $this->assertNotEquals( '', $prepped['url'] );
         $this->assertEquals( site_url( 'wp-includes/images/media/default.png' ), $prepped['icon'] );
 
-        // Fake a mime
+        // Fake a mime.
         $post->post_mime_type = 'image/jpeg';
         $prepped              = wp_prepare_attachment_for_js( $post );
@@ -365 +365 @@
         $this->assertEquals( 'jpeg', $prepped['subtype'] );
 
-        // Fake a mime without a slash. See #WP22532
+        // Fake a mime without a slash. See #WP22532.
         $post->post_mime_type = 'image';
         $prepped              = wp_prepare_attachment_for_js( $post );
@@ -427 +427 @@
         $tb = $gb * 1024;
 
-        // test if boundaries are correct
+        // Test if boundaries are correct.
         $this->assertEquals( '1TB', wp_convert_bytes_to_hr( $tb ) );
         $this->assertEquals( '1GB', wp_convert_bytes_to_hr( $gb ) );
@@ -438 +438 @@
         $this->assertEquals( '1 KB', size_format( $kb ) );
 
-        // now some values around
+        // Now some values around.
         $hr = wp_convert_bytes_to_hr( $tb + $tb / 2 + $mb );
         $this->assertEquals( 1.50000095367, (float) str_replace( ',', '.', $hr ), 'The values should be equal', 0.0001 );
@@ -451 +451 @@
         $this->assertEquals( 1022.99902344, (float) str_replace( ',', '.', $hr ), 'The values should be equal', 0.0001 );
 
-        // edge
+        // Edge.
         $this->assertEquals( '-1B', wp_convert_bytes_to_hr( -1 ) );
         $this->assertEquals( '0B', wp_convert_bytes_to_hr( 0 ) );
@@ -613 +613 @@
         $galleries = get_post_galleries( $post_id_two, false );
 
-        // Set the global $post context
+        // Set the global $post context.
         $GLOBALS['post']               = get_post( $post_id_two );
         $galleries_with_global_context = get_post_galleries( $post_id_two, false );
 
-        // Check that the global post state doesn't affect the results
+        // Check that the global post state doesn't affect the results.
         $this->assertSame( $galleries, $galleries_with_global_context );
 
@@ -1012 +1012 @@
         $sizes = wp_get_additional_image_sizes();
 
-        // Clean up
+        // Clean up.
         remove_image_size( 'test-size' );
 
@@ -1037 +1037 @@
         $this->assertTrue( has_image_size( 'test-size' ) );
 
-        // Clean up
+        // Clean up.
         remove_image_size( 'test-size' );
     }
@@ -1142 +1142 @@
         $iptc_file = DIR_TESTDATA . '/images/test-image-iptc.jpg';
 
-        // Make a copy of this file as it gets moved during the file upload
+        // Make a copy of this file as it gets moved during the file upload.
         $tmp_name = wp_tempnam( $iptc_file );
 
@@ -1181 +1181 @@
         $test_file = DIR_TESTDATA . '/images/test-image.jpg';
 
-        // Make a copy of this file as it gets moved during the file upload
+        // Make a copy of this file as it gets moved during the file upload.
         $tmp_name = wp_tempnam( $test_file );
 
@@ -1497 +1497 @@
         $_wp_additional_image_sizes = wp_get_additional_image_sizes();
 
-        // Disable date organized uploads
+        // Disable date organized uploads.
         add_filter( 'upload_dir', '_upload_dir_no_subdir' );
 
@@ -1535 +1535 @@
         }
 
-        // Remove the attachment
+        // Remove the attachment.
         wp_delete_attachment( $id );
         remove_filter( 'upload_dir', '_upload_dir_no_subdir' );
@@ -1555 +1555 @@
         $filename_base = wp_basename( $image_meta['file'], '.png' );
 
-        // Add the hash to the image URL
+        // Add the hash to the image URL.
         $image_url = str_replace( $filename_base, $filename_base . '-' . $hash, $image_url );
 
@@ -1605 +1605 @@
         $expected .= $uploads_dir_url . $image_meta['file'] . ' ' . $image_meta['width'] . 'w';
 
-        // Prepend an absolute path to simulate a pre-2.7 upload
+        // Prepend an absolute path to simulate a pre-2.7 upload.
         $image_meta['file'] = 'H:\home\wordpress\trunk/wp-content/uploads/' . $image_meta['file'];
 
@@ -1622 +1622 @@
         $sizes = wp_calculate_image_srcset( array( 400, 300 ), 'file.png', array() );
 
-        // For canola.jpg we should return
+        // For canola.jpg we should return.
         $this->assertFalse( $sizes );
     }
@@ -1777 +1777 @@
         );
 
-        // No sizes array
+        // No sizes array.
         $image_meta1 = $image_meta;
         unset( $image_meta1['sizes'] );
@@ -1787 +1787 @@
         $this->assertFalse( wp_calculate_image_srcset( $size_array, $image_src, $image_meta2 ) );
 
-        // File name is incorrect
+        // File name is incorrect.
         $image_meta3         = $image_meta;
         $image_meta3['file'] = '/';
         $this->assertFalse( wp_calculate_image_srcset( $size_array, $image_src, $image_meta3 ) );
 
-        // File name is incorrect
+        // File name is incorrect.
         $image_meta4 = $image_meta;
         unset( $image_meta4['file'] );
@@ -1856 +1856 @@
 
         $image_meta = wp_get_attachment_metadata( self::$large_id );
-        $size_array = array( 1600, 1200 ); // full size
+        $size_array = array( 1600, 1200 ); // Full size.
 
         $srcset = wp_get_attachment_image_srcset( self::$large_id, $size_array, $image_meta );
@@ -1982 +1982 @@
         $img_html5            = str_replace( ' />', '>', $img );
 
-        // Manually add srcset and sizes to the markup from get_image_tag();
+        // Manually add srcset and sizes to the markup from get_image_tag().
         $respimg                  = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img );
         $respimg_no_size_in_class = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_no_size_in_class );
@@ -2032 +2032 @@
         $image = get_image_tag( self::$large_id, '', '', '', 'medium' );
 
-        // Replace the src URL
+        // Replace the src URL.
         $image_wrong_src = preg_replace( '|src="[^"]+"|', 'src="http://' . WP_TESTS_DOMAIN . '/wp-content/uploads/foo.jpg"', $image );
 
@@ -2433 +2433 @@
         $iptc_file = DIR_TESTDATA . '/images/test-image-iptc.jpg';
 
-        // Make a copy of this file as it gets moved during the file upload
+        // Make a copy of this file as it gets moved during the file upload.
         $tmp_name = wp_tempnam( $iptc_file );
 
@@ -2479 +2479 @@
         $iptc_file = DIR_TESTDATA . '/images/test-image-iptc.jpg';
 
-        // Make a copy of this file as it gets moved during the file upload
+        // Make a copy of this file as it gets moved during the file upload.
         $tmp_name = wp_tempnam( $iptc_file );