feat: new rules for php-cs-fixer (GoogleCloudPlatform#1533)

Author: saranshdhingra

.kokoro/secrets-example.sh

@@ -60,6 +60,11 @@ export POSTGRES_DSN=
 export POSTGRES_DATABASE=
 export POSTGRES_USER=
 export POSTGRES_PASSWORD=
+export SQLSERVER_DSN=
+export SQLSERVER_DATABASE=
+export SQLSERVER_USER=
+export SQLSERVER_PASSWORD=
+export DB_SOCKET_DIR=
 
 # Datastore
 export CLOUD_DATASTORE_NAMESPACE=

.php-cs-fixer.dist.php

@@ -16,6 +16,22 @@
         'return_type_declaration' => [
             'space_before' => 'none'
         ],
+        // only converts simple strings in double quotes to single quotes
+        // ignores strings using variables, escape characters or single quotes inside
+        'single_quote' => true,
+        // there should be a single space b/w the cast and it's operand
+        'cast_spaces' => ['space' => 'single'],
+        // there shouldn't be any trailing whitespace at the end of a non-blank line
+        'no_trailing_whitespace' => true,
+        // there shouldn't be any trailing whitespace at the end of a blank line
+        'no_whitespace_in_blank_line' => true,
+        // there should be a space around binary operators like (=, => etc)
+        'binary_operator_spaces' => ['default' => 'single_space'],
+        // deals with rogue empty blank lines
+        'no_extra_blank_lines' => ['tokens' => ['extra']],
+        // reduces multi blank lines b/w phpdoc description and @param to a single line
+        // NOTE: Doesn't add a blank line if none exist
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
     ])
     ->setFinder(
         PhpCsFixer\Finder::create()

analyticsdata/quickstart_json_credentials.php

@@ -43,7 +43,6 @@
  */
 $property_id = 'YOUR-GA4-PROPERTY-ID';
 
-
 // [START analyticsdata_json_credentials_initialize]
 /* TODO(developer): Replace this variable with a valid path to the
  *  credentials.json file for your service account downloaded from the

appengine/flexible/datastore/app.php

@@ -72,7 +72,7 @@
             $entity['user_ip']);
     }
     # [END gae_flex_datastore_query]
-    array_unshift($visits, "Last 10 visits:");
+    array_unshift($visits, 'Last 10 visits:');
     $response->getBody()->write(implode("\n", $visits));
 
     return $response

appengine/flexible/datastore/test/DeployTest.php

@@ -30,6 +30,6 @@ public function testIndex()
         $this->assertEquals('200', $resp->getStatusCode(),
             'top page status code');
 
-        $this->assertStringContainsString("Last 10 visits:", (string) $resp->getBody());
+        $this->assertStringContainsString('Last 10 visits:', (string) $resp->getBody());
     }
 }

appengine/flexible/datastore/test/LocalTest.php

@@ -33,6 +33,6 @@ public function testIndex()
         $response = $app->handle($request);
         $this->assertEquals(200, $response->getStatusCode());
         $text = (string) $response->getBody();
-        $this->assertStringContainsString("Last 10 visits:", $text);
+        $this->assertStringContainsString('Last 10 visits:', $text);
     }
 }

appengine/flexible/logging/test/DeployTest.php

@@ -41,7 +41,7 @@ public function testIndex()
         $this->assertEquals('200', $resp->getStatusCode(),
             'top page status code');
 
-        $this->assertStringContainsString("Logs:", (string) $resp->getBody());
+        $this->assertStringContainsString('Logs:', (string) $resp->getBody());
     }
     public function testAsyncLog()
     {

appengine/flexible/logging/test/LocalTest.php

@@ -33,7 +33,7 @@ public function testSomeLogs()
 
         $this->assertEquals(200, $response->getStatusCode());
         $text = (string) $response->getBody();
-        $this->assertStringContainsString("Logs:", $text);
+        $this->assertStringContainsString('Logs:', $text);
     }
 
     public function testAsyncLog()

appengine/flexible/memcache/test/DeployTest.php

@@ -50,10 +50,10 @@ public function testIndex()
         $key = rand(0, 1000);
 
         // Test the /memcached REST API.
-        $this->put("/memcached/test$key", "sour");
-        $this->assertEquals("sour", $this->get("/memcached/test$key"));
-        $this->put("/memcached/test$key", "sweet");
-        $this->assertEquals("sweet", $this->get("/memcached/test$key"));
+        $this->put("/memcached/test$key", 'sour');
+        $this->assertEquals('sour', $this->get("/memcached/test$key"));
+        $this->put("/memcached/test$key", 'sweet');
+        $this->assertEquals('sweet', $this->get("/memcached/test$key"));
 
         // Make sure it handles a POST request too, which will increment the
         // counter.

appengine/flexible/memcache/test/LocalTest.php

@@ -62,26 +62,26 @@ public function testGetAndPut()
         // Use a random key to avoid colliding with simultaneous tests.
 
         // Test the /memcached REST API.
-        $request1 = (new RequestFactory)->createRequest('PUT', "/memcached/testkey1");
+        $request1 = (new RequestFactory)->createRequest('PUT', '/memcached/testkey1');
         $request1->getBody()->write('sour');
         $response1 = $app->handle($request1);
         $this->assertEquals(200, (string) $response1->getStatusCode());
 
         // Check that the key was written as expected
-        $request2 = (new RequestFactory)->createRequest('GET', "/memcached/testkey1");
+        $request2 = (new RequestFactory)->createRequest('GET', '/memcached/testkey1');
         $response2 = $app->handle($request2);
-        $this->assertEquals("sour", (string) $response2->getBody());
+        $this->assertEquals('sour', (string) $response2->getBody());
 
         // Test the /memcached REST API with a new value.
-        $request3 = (new RequestFactory)->createRequest('PUT', "/memcached/testkey2");
+        $request3 = (new RequestFactory)->createRequest('PUT', '/memcached/testkey2');
         $request3->getBody()->write('sweet');
         $response3 = $app->handle($request3);
         $this->assertEquals(200, (string) $response3->getStatusCode());
 
         // Check that the key was written as expected
-        $request4 = (new RequestFactory)->createRequest('GET', "/memcached/testkey2");
+        $request4 = (new RequestFactory)->createRequest('GET', '/memcached/testkey2');
         $response4 = $app->handle($request4);
-        $this->assertEquals("sweet", (string) $response4->getBody());
+        $this->assertEquals('sweet', (string) $response4->getBody());
     }
 }