Issue #2901572 by Jo Fitzgerald, bluccas, mfernea, klausi: Fix...

Issue #2901572 by Jo Fitzgerald, bluccas, mfernea, klausi: Fix 'Drupal.Commenting.PostStatementComment' coding standard

core/includes/common.inc

@@ -252,7 +252,8 @@ function format_size($size, $langcode = NULL) {
     return \Drupal::translation()->formatPlural($size, '1 byte', '@count bytes', [], ['langcode' => $langcode]);
   }
   else {
-    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
+    // Convert bytes to kilobytes.
+    $size = $size / Bytes::KILOBYTE;
     $units = ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
     foreach ($units as $unit) {
       if (round($size, 2) >= Bytes::KILOBYTE) {

core/includes/file.inc

@@ -716,8 +716,10 @@ function file_munge_filename($filename, $extensions, $alerts = TRUE) {
     // Split the filename up by periods. The first part becomes the basename
     // the last part the final extension.
     $filename_parts = explode('.', $filename);
-    $new_filename = array_shift($filename_parts); // Remove file basename.
-    $final_extension = array_pop($filename_parts); // Remove final extension.
+    // Remove file basename.
+    $new_filename = array_shift($filename_parts);
+    // Remove final extension.
+    $final_extension = array_pop($filename_parts);
 
     // Loop through the middle parts of the name and add an underscore to the
     // end of each section that could be a file extension but isn't in the list

core/lib/Drupal/Component/Utility/Unicode.php

@@ -609,7 +609,8 @@ public static function strcasecmp($str1 , $str2) {
    */
   public static function mimeHeaderEncode($string) {
     if (preg_match('/[^\x20-\x7E]/', $string)) {
-      $chunk_size = 47; // floor((75 - strlen("=?UTF-8?B??=")) * 0.75);
+      // floor((75 - strlen("=?UTF-8?B??=")) * 0.75);
+      $chunk_size = 47;
       $len = strlen($string);
       $output = '';
       while ($len > 0) {

core/lib/Drupal/Core/FileTransfer/FileTransfer.php

@@ -231,7 +231,8 @@ final protected function checkPath($path) {
    */
   final protected function fixRemotePath($path, $strip_chroot = TRUE) {
     $path = $this->sanitizePath($path);
-    $path = preg_replace('|^([a-z]{1}):|i', '', $path); // Strip out windows driveletter if its there.
+    // Strip out windows driveletter if its there.
+    $path = preg_replace('|^([a-z]{1}):|i', '', $path);
     if ($strip_chroot) {
       if ($this->chroot && strpos($path, $this->chroot) === 0) {
         $path = ($path == $this->chroot) ? '' : substr($path, strlen($this->chroot));
@@ -250,7 +251,8 @@ final protected function fixRemotePath($path, $strip_chroot = TRUE) {
    *   The modified path.
    */
   public function sanitizePath($path) {
-    $path = str_replace('\\', '/', $path); // Windows path sanitization.
+    // Windows path sanitization.
+    $path = str_replace('\\', '/', $path);
     if (substr($path, -1) == '/') {
       $path = substr($path, 0, -1);
     }

core/lib/Drupal/Core/Routing/UrlGenerator.php

@@ -65,8 +65,10 @@ class UrlGenerator implements UrlGeneratorInterface {
     // the slash can be used to designate a hierarchical structure and we want allow using it with this meaning
     // some webservers don't allow the slash in encoded form in the path for security reasons anyway
     // see http://stackoverflow.com/questions/4069002/http-400-if-2f-part-of-get-url-in-jboss
-    '%2F', // Map from these encoded characters.
-    '/', // Map to these decoded characters.
+    // Map from these encoded characters.
+    '%2F',
+    // Map to these decoded characters.
+    '/',
   ];
 
   /**

core/modules/book/tests/src/Functional/BookTest.php

@@ -152,7 +152,8 @@ public function testBook() {
      *   |- Node 5
      *  |- Node 4
      */
-    $nodes[] = $this->createBookNode($book->id(), $nodes[3]->book['nid']); // Node 5.
+    // Node 5.
+    $nodes[] = $this->createBookNode($book->id(), $nodes[3]->book['nid']);
     $this->drupalLogout();
     $this->drupalLogin($this->webUser);
     // Verify the new outline - make sure we don't get stale cached data.

core/modules/book/tests/src/Functional/BookTestTrait.php

@@ -51,11 +51,16 @@ public function createBook($edit = []) {
      *  |- Node 4
      */
     $nodes = [];
-    $nodes[] = $this->createBookNode($book->id(), NULL, $edit); // Node 0.
-    $nodes[] = $this->createBookNode($book->id(), $nodes[0]->book['nid'], $edit); // Node 1.
-    $nodes[] = $this->createBookNode($book->id(), $nodes[0]->book['nid'], $edit); // Node 2.
-    $nodes[] = $this->createBookNode($book->id(), NULL, $edit); // Node 3.
-    $nodes[] = $this->createBookNode($book->id(), NULL, $edit); // Node 4.
+    // Node 0.
+    $nodes[] = $this->createBookNode($book->id(), NULL, $edit);
+    // Node 1.
+    $nodes[] = $this->createBookNode($book->id(), $nodes[0]->book['nid'], $edit);
+    // Node 2.
+    $nodes[] = $this->createBookNode($book->id(), $nodes[0]->book['nid'], $edit);
+    // Node 3.
+    $nodes[] = $this->createBookNode($book->id(), NULL, $edit);
+    // Node 4.
+    $nodes[] = $this->createBookNode($book->id(), NULL, $edit);
 
     $this->drupalLogout();
 
@@ -179,7 +184,8 @@ public function generateOutlinePattern($nodes) {
   public function createBookNode($book_nid, $parent = NULL, $edit = []) {
     // $number does not use drupal_static as it should not be reset
     // since it uniquely identifies each call to createBookNode().
-    static $number = 0; // Used to ensure that when sorted nodes stay in same order.
+    // Used to ensure that when sorted nodes stay in same order.
+    static $number = 0;
 
     $edit['title[0][value]'] = str_pad($number, 2, '0', STR_PAD_LEFT) . ' - SimpleTest test node ' . $this->randomMachineName(10);
     $edit['body[0][value]'] = 'SimpleTest test body ' . $this->randomMachineName(32) . ' ' . $this->randomMachineName(32);

core/modules/ckeditor/src/Plugin/CKEditorPlugin/Internal.php

@@ -101,7 +101,8 @@ public function getFile() {
   public function getConfig(Editor $editor) {
     // Reasonable defaults that provide expected basic behavior.
     $config = [
-      'customConfig' => '', // Don't load CKEditor's config.js file.
+      // Don't load CKEditor's config.js file.
+      'customConfig' => '',
       'pasteFromWordPromptCleanup' => TRUE,
       'resize_dir' => 'vertical',
       'justifyClasses' => ['text-align-left', 'text-align-center', 'text-align-right', 'text-align-justify'],

core/modules/comment/src/Tests/CommentPagerTest.php

@@ -266,12 +266,18 @@ public function testCommentNewPageIndicator() {
     $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
 
     $expected_pages = [
-      1 => 5, // Page of comment 5
-      2 => 4, // Page of comment 4
-      3 => 3, // Page of comment 3
-      4 => 2, // Page of comment 2
-      5 => 1, // Page of comment 1
-      6 => 0, // Page of comment 0
+      // Page of comment 5
+      1 => 5,
+      // Page of comment 4
+      2 => 4,
+      // Page of comment 3
+      3 => 3,
+      // Page of comment 2
+      4 => 2,
+      // Page of comment 1
+      5 => 1,
+      // Page of comment 0
+      6 => 0,
     ];
 
     $node = Node::load($node->id());
@@ -284,12 +290,18 @@ public function testCommentNewPageIndicator() {
     $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
 
     $expected_pages = [
-      1 => 5, // Page of comment 5
-      2 => 1, // Page of comment 4
-      3 => 1, // Page of comment 4
-      4 => 1, // Page of comment 4
-      5 => 1, // Page of comment 4
-      6 => 0, // Page of comment 0
+      // Page of comment 5
+      1 => 5,
+      // Page of comment 4
+      2 => 1,
+      // Page of comment 4
+      3 => 1,
+      // Page of comment 4
+      4 => 1,
+      // Page of comment 4
+      5 => 1,
+      // Page of comment 0
+      6 => 0,
     ];
 
     \Drupal::entityManager()->getStorage('node')->resetCache([$node->id()]);

core/modules/comment/src/Tests/CommentTestBase.php

@@ -166,7 +166,8 @@ public function postComment($entity, $comment, $subject = '', $contact = NULL, $
     preg_match('/#comment-([0-9]+)/', $this->getURL(), $match);
 
     // Get comment.
-    if ($contact !== TRUE) {// If true then attempting to find error message.
+    if ($contact !== TRUE) {
+      // If true then attempting to find error message.
       if ($subject) {
         $this->assertText($subject, 'Comment subject posted.');
       }

core/modules/comment/tests/src/Functional/CommentAdminTest.php

@@ -32,7 +32,8 @@ public function testApprovalAdminInterface() {
       'skip comment approval' => FALSE,
     ]);
     $this->drupalLogin($this->adminUser);
-    $this->setCommentAnonymous('0'); // Ensure that doesn't require contact info.
+    // Ensure that doesn't require contact info.
+    $this->setCommentAnonymous('0');
 
     // Test that the comments page loads correctly when there are no comments
     $this->drupalGet('admin/content/comment');
@@ -43,7 +44,8 @@ public function testApprovalAdminInterface() {
     // Post anonymous comment without contact info.
     $subject = $this->randomMachineName();
     $body = $this->randomMachineName();
-    $this->postComment($this->node, $body, $subject, TRUE); // Set $contact to true so that it won't check for id and message.
+    // Set $contact to true so that it won't check for id and message.
+    $this->postComment($this->node, $body, $subject, TRUE);
     $this->assertText(t('Your comment has been queued for review by site administrators and will be published after approval.'), 'Comment requires approval.');
 
     // Get unapproved comment id.
@@ -123,13 +125,15 @@ public function testApprovalNodeInterface() {
       'skip comment approval' => FALSE,
     ]);
     $this->drupalLogin($this->adminUser);
-    $this->setCommentAnonymous('0'); // Ensure that doesn't require contact info.
+    // Ensure that doesn't require contact info.
+    $this->setCommentAnonymous('0');
     $this->drupalLogout();
 
     // Post anonymous comment without contact info.
     $subject = $this->randomMachineName();
     $body = $this->randomMachineName();
-    $this->postComment($this->node, $body, $subject, TRUE); // Set $contact to true so that it won't check for id and message.
+    // Set $contact to true so that it won't check for id and message.
+    $this->postComment($this->node, $body, $subject, TRUE);
     $this->assertText(t('Your comment has been queued for review by site administrators and will be published after approval.'), 'Comment requires approval.');
 
     // Get unapproved comment id.
@@ -205,7 +209,8 @@ public function testEditComment() {
 
     // Post anonymous comment.
     $this->drupalLogin($this->adminUser);
-    $this->setCommentAnonymous('2'); // Ensure that we need email id before posting comment.
+    // Ensure that we need email id before posting comment.
+    $this->setCommentAnonymous('2');
     $this->drupalLogout();
 
     // Post comment with contact info (required).

core/modules/comment/tests/src/Functional/CommentNonNodeTest.php

@@ -157,7 +157,8 @@ public function postComment(EntityInterface $entity, $comment, $subject = '', $c
     preg_match('/#comment-([0-9]+)/', $this->getURL(), $match);
 
     // Get comment.
-    if ($contact !== TRUE) {// If true then attempting to find error message.
+    if ($contact !== TRUE) {
+      // If true then attempting to find error message.
       if ($subject) {
         $this->assertText($subject, 'Comment subject posted.');
       }

core/modules/comment/tests/src/Functional/CommentTestBase.php

@@ -160,7 +160,8 @@ public function postComment($entity, $comment, $subject = '', $contact = NULL, $
     preg_match('/#comment-([0-9]+)/', $this->getURL(), $match);
 
     // Get comment.
-    if ($contact !== TRUE) {// If true then attempting to find error message.
+    if ($contact !== TRUE) {
+      // If true then attempting to find error message.
       if ($subject) {
         $this->assertText($subject, 'Comment subject posted.');
       }

core/modules/editor/src/Tests/EditorSecurityTest.php

@@ -306,7 +306,8 @@ public function testSwitchingSecurity() {
     $expected = [
       [
         'node_id' => 1,
-        'value' => self::$sampleContent, // No text editor => no XSS filtering.
+        // No text editor => no XSS filtering.
+        'value' => self::$sampleContent,
         'format' => 'restricted_without_editor',
         'switch_to' => [
           'restricted_with_editor' => self::$sampleContentSecured,
@@ -319,7 +320,8 @@ public function testSwitchingSecurity() {
       ],
       [
         'node_id' => 2,
-        'value' => self::$sampleContentSecured, // Text editor => XSS filtering.
+        // Text editor => XSS filtering.
+        'value' => self::$sampleContentSecured,
         'format' => 'restricted_with_editor',
         'switch_to' => [
           // No text editor => no XSS filtering.
@@ -333,7 +335,8 @@ public function testSwitchingSecurity() {
       ],
       [
         'node_id' => 3,
-        'value' => self::$sampleContentSecuredEmbedAllowed, // Text editor => XSS filtering.
+        // Text editor => XSS filtering.
+        'value' => self::$sampleContentSecuredEmbedAllowed,
         'format' => 'restricted_plus_dangerous_tag_with_editor',
         'switch_to' => [
           // No text editor => no XSS filtering.
@@ -348,7 +351,8 @@ public function testSwitchingSecurity() {
       ],
       [
         'node_id' => 4,
-        'value' => self::$sampleContent, // No text editor => no XSS filtering.
+        // No text editor => no XSS filtering.
+        'value' => self::$sampleContent,
         'format' => 'unrestricted_without_editor',
         'switch_to' => [
           // No text editor => no XSS filtering.
@@ -364,7 +368,8 @@ public function testSwitchingSecurity() {
       ],
       [
         'node_id' => 5,
-        'value' => self::$sampleContentSecured, // Text editor => XSS filtering.
+        // Text editor => XSS filtering.
+        'value' => self::$sampleContentSecured,
         'format' => 'unrestricted_with_editor',
         'switch_to' => [
           // From editor, no security filters to security filters, no editor: no

core/modules/file/src/Tests/DownloadTest.php

@@ -91,9 +91,12 @@ public function testFileCreateUrl() {
     // Tilde (~) is excluded from this test because it is encoded by
     // rawurlencode() in PHP 5.2 but not in PHP 5.3, as per RFC 3986.
     // @see http://php.net/manual/function.rawurlencode.php#86506
-    $basename = " -._!$'\"()*@[]?&+%#,;=:\n\x00" . // "Special" ASCII characters.
-      "%23%25%26%2B%2F%3F" . // Characters that look like a percent-escaped string.
-      "éøïвβ中國書۞"; // Characters from various non-ASCII alphabets.
+    // "Special" ASCII characters.
+    $basename = " -._!$'\"()*@[]?&+%#,;=:\n\x00" .
+      // Characters that look like a percent-escaped string.
+      "%23%25%26%2B%2F%3F" .
+      // Characters from various non-ASCII alphabets.
+      "éøïвβ中國書۞";
     $basename_encoded = '%20-._%21%24%27%22%28%29%2A%40%5B%5D%3F%26%2B%25%23%2C%3B%3D%3A__' .
       '%2523%2525%2526%252B%252F%253F' .
       '%C3%A9%C3%B8%C3%AF%D0%B2%CE%B2%E4%B8%AD%E5%9C%8B%E6%9B%B8%DB%9E';

core/modules/file/src/Tests/FileFieldValidateTest.php

@@ -71,8 +71,10 @@ public function testFileMaxSize() {
     $field_name = strtolower($this->randomMachineName());
     $this->createFileField($field_name, 'node', $type_name, [], ['required' => '1']);
 
-    $small_file = $this->getTestFile('text', 131072); // 128KB.
-    $large_file = $this->getTestFile('text', 1310720); // 1.2MB
+    // 128KB.
+    $small_file = $this->getTestFile('text', 131072);
+    // 1.2MB
+    $large_file = $this->getTestFile('text', 1310720);
 
     // Test uploading both a large and small file with different increments.
     $sizes = [

core/modules/filter/filter.module

@@ -729,20 +729,28 @@ function _filter_autop($text) {
       }
     }
     elseif (!$ignore) {
-      $chunk = preg_replace('|\n*$|', '', $chunk) . "\n\n"; // just to make things a little easier, pad the end
+      // just to make things a little easier, pad the end
+      $chunk = preg_replace('|\n*$|', '', $chunk) . "\n\n";
       $chunk = preg_replace('|<br />\s*<br />|', "\n\n", $chunk);
-      $chunk = preg_replace('!(<' . $block . '[^>]*>)!', "\n$1", $chunk); // Space things out a little
-      $chunk = preg_replace('!(</' . $block . '>)!', "$1\n\n", $chunk); // Space things out a little
-      $chunk = preg_replace("/\n\n+/", "\n\n", $chunk); // take care of duplicates
+      // Space things out a little
+      $chunk = preg_replace('!(<' . $block . '[^>]*>)!', "\n$1", $chunk);
+      // Space things out a little
+      $chunk = preg_replace('!(</' . $block . '>)!', "$1\n\n", $chunk);
+      // take care of duplicates
+      $chunk = preg_replace("/\n\n+/", "\n\n", $chunk);
       $chunk = preg_replace('/^\n|\n\s*\n$/', '', $chunk);
-      $chunk = '<p>' . preg_replace('/\n\s*\n\n?(.)/', "</p>\n<p>$1", $chunk) . "</p>\n"; // make paragraphs, including one at the end
-      $chunk = preg_replace("|<p>(<li.+?)</p>|", "$1", $chunk); // problem with nested lists
+      // make paragraphs, including one at the end
+      $chunk = '<p>' . preg_replace('/\n\s*\n\n?(.)/', "</p>\n<p>$1", $chunk) . "</p>\n";
+      // problem with nested lists
+      $chunk = preg_replace("|<p>(<li.+?)</p>|", "$1", $chunk);
       $chunk = preg_replace('|<p><blockquote([^>]*)>|i', "<blockquote$1><p>", $chunk);
       $chunk = str_replace('</blockquote></p>', '</p></blockquote>', $chunk);
-      $chunk = preg_replace('|<p>\s*</p>\n?|', '', $chunk); // under certain strange conditions it could create a P of entirely whitespace
+      // under certain strange conditions it could create a P of entirely whitespace
+      $chunk = preg_replace('|<p>\s*</p>\n?|', '', $chunk);
       $chunk = preg_replace('!<p>\s*(</?' . $block . '[^>]*>)!', "$1", $chunk);
       $chunk = preg_replace('!(</?' . $block . '[^>]*>)\s*</p>!', "$1", $chunk);
-      $chunk = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $chunk); // make line breaks
+      // make line breaks
+      $chunk = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $chunk);
       $chunk = preg_replace('!(</?' . $block . '[^>]*>)\s*<br />!', "$1", $chunk);
       $chunk = preg_replace('!<br />(\s*</?(?:p|li|div|dl|dd|dt|th|pre|td|ul|ol)>)!', '$1', $chunk);
       $chunk = preg_replace('/&([^#])(?![A-Za-z0-9]{1,8};)/', '&amp;$1', $chunk);

core/modules/filter/tests/src/Kernel/FilterAPITest.php

@@ -124,7 +124,8 @@ public function testFilterFormatAPI() {
     $full_html_format = FilterFormat::load('full_html');
     $this->assertIdentical(
       $full_html_format->getHtmlRestrictions(),
-      FALSE, // Every tag is allowed.
+      // Every tag is allowed.
+      FALSE,
       'FilterFormatInterface::getHtmlRestrictions() works as expected for the full_html format.'
     );
     $this->assertIdentical(
@@ -141,7 +142,8 @@ public function testFilterFormatAPI() {
         'filter_html' => [
           'status' => 1,
           'settings' => [
-            'allowed_html' => '', // Nothing is allowed.
+            // Nothing is allowed.
+            'allowed_html' => '',
           ],
         ],
       ],
@@ -149,7 +151,8 @@ public function testFilterFormatAPI() {
     $stupid_filtered_html_format->save();
     $this->assertIdentical(
       $stupid_filtered_html_format->getHtmlRestrictions(),
-      ['allowed' => []], // No tag is allowed.
+      // No tag is allowed.
+      ['allowed' => []],
       'FilterFormatInterface::getHtmlRestrictions() works as expected for the stupid_filtered_html format.'
     );
     $this->assertIdentical(

core/modules/locale/locale.install

@@ -111,7 +111,8 @@ function locale_schema() {
       'customized' => [
         'type' => 'int',
         'not null' => TRUE,
-        'default' => 0, // LOCALE_NOT_CUSTOMIZED
+        // LOCALE_NOT_CUSTOMIZED
+        'default' => 0,
         'description' => 'Boolean indicating whether the translation is custom to this site.',
       ],
     ],

core/modules/node/src/Tests/NodeRevisionsTest.php

@@ -117,7 +117,8 @@ protected function setUp() {
 
       $node->save();
 
-      $node = Node::load($node->id()); // Make sure we get revision information.
+      // Make sure we get revision information.
+      $node = Node::load($node->id());
       $nodes[] = clone $node;
     }