Merge pull request #19 from gscscnd/employ-phpcs

Employ PHP_CodeSniffer
paragonie · Nov 8, 2017 · 146fd5e · 146fd5e
2 parents 2bf754f + a2f2303
commit 146fd5e
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 17 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -16,3 +16,4 @@ install:
 script:
     - vendor/bin/phpunit
     - vendor/bin/psalm
+    - vendor/bin/phpcs
diff --git a/composer.json b/composer.json
@@ -36,6 +36,7 @@
     "require-dev": {
         "psr/http-message": "^1",
         "phpunit/phpunit": "4.*|5.*",
+        "squizlabs/php_codesniffer": "^3",
         "vimeo/psalm": "^0.3"
     },
     "suggest": {

diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<ruleset>
+    <rule ref="PSR2"/>
+
+    <arg name="colors"/>
+
+    <file>bin</file>
+    <file>src</file>
+    <file>test</file>
+</ruleset>
diff --git a/src/CSPBuilder.php b/src/CSPBuilder.php
@@ -89,7 +89,7 @@ public function compile(): string
 
         $compiled = [];
 
-        foreach(self::$directives as $dir) {
+        foreach (self::$directives as $dir) {
             if (\in_array($dir, $ruleKeys)) {
                 if (empty($ruleKeys)) {
                     if ($dir === 'base-uri') {
@@ -278,7 +278,7 @@ public static function fromData($data = ''): self
     {
         $array = \json_decode($data, true);
 
-        if(!\is_array($array)) {
+        if (!\is_array($array)) {
             throw new \Exception('Is not array valid');
         }
 
@@ -369,7 +369,7 @@ public function preHash(
      * @param bool $legacy
      * @return \Psr\Http\Message\MessageInterface
      */
-    function injectCSPHeader(MessageInterface $message, bool $legacy = false): MessageInterface
+    public function injectCSPHeader(MessageInterface $message, bool $legacy = false): MessageInterface
     {
         if ($this->needsCompile) {
             $this->compile();
@@ -596,15 +596,17 @@ protected function compileSubgroup(string $directive, $policies = []): string
                 if ($url !== false) {
                     if ($this->supportOldBrowsers) {
                         if (\strpos($url, '://') === false) {
-                            if (($this->isHTTPSConnection() && $this->httpsTransformOnHttpsConnections) || !empty($this->policies['upgrade-insecure-requests'])) {
+                            if (($this->isHTTPSConnection() && $this->httpsTransformOnHttpsConnections)
+                                || !empty($this->policies['upgrade-insecure-requests'])) {
                                 // We only want HTTPS connections here.
                                 $ret .= 'https://'.$url.' ';
                             } else {
                                 $ret .= 'https://'.$url.' http://'.$url.' ';
                             }
                         }
                     }
-                    if (($this->isHTTPSConnection() && $this->httpsTransformOnHttpsConnections) || !empty($this->policies['upgrade-insecure-requests'])) {
+                    if (($this->isHTTPSConnection() && $this->httpsTransformOnHttpsConnections)
+                        || !empty($this->policies['upgrade-insecure-requests'])) {
                         $ret .= \str_replace('http://', 'https://', $url).' ';
                     } else {
                         $ret .= $url.' ';

diff --git a/test/BasicTest.php b/test/BasicTest.php
@@ -1,9 +1,10 @@
 <?php
+
+namespace ParagonIE\CSPBuilderTest;
+
 use ParagonIE\CSPBuilder\CSPBuilder;
+use PHPUnit_Framework_TestCase;
 
-/**
- * 
- */
 class BasicTest extends PHPUnit_Framework_TestCase
 {
     public function testBasicFromFile()
@@ -14,7 +15,7 @@ public function testBasicFromFile()
             file_get_contents(__DIR__.'/vectors/basic-csp.out'),
             $basic->getCompiledHeader()
         );
-        
+
         $noOld = file_get_contents(__DIR__.'/vectors/basic-csp-no-old.out');
         // We expect different output for ytimg.com when we disable legacy
         // browser support (i.e. Safari):
@@ -24,7 +25,7 @@ public function testBasicFromFile()
                 ->disableOldBrowserSupport()
                 ->getCompiledHeader()
         );
-        
+
         $array = $basic->getHeaderArray();
         $this->assertEquals(
             $array,
@@ -34,8 +35,8 @@ public function testBasicFromFile()
                 'X-Webkit-CSP' => $noOld
             ]
         );
-        
-        
+
+
         $array2 = $basic->getHeaderArray(false);
         $this->assertEquals(
             $array2,
@@ -48,7 +49,7 @@ public function testBasicFromFile()
     public function testBasicFromData()
     {
         $data = file_get_contents(__DIR__.'/vectors/basic-csp.json');
-        
+
         $basic = CSPBuilder::fromData($data);
         $basic->addSource('img-src', 'ytimg.com');
 
@@ -57,7 +58,7 @@ public function testBasicFromData()
             $basic->getCompiledHeader()
         );
     }
-    
+
     public function testHash()
     {
         $basic = CSPBuilder::fromFile(__DIR__.'/vectors/basic-csp.json');
@@ -67,7 +68,7 @@ public function testHash()
             $basic->getCompiledHeader()
         );
     }
-    
+
     public function testPreHash()
     {
         $basic = CSPBuilder::fromFile(__DIR__.'/vectors/basic-csp.json');
@@ -87,7 +88,8 @@ public function testPreHash()
     public function testSourceHttpsConversion()
     {
         /** @var CSPBuilder|\PHPUnit_Framework_MockObject_MockObject $cspHttp */
-        $cspHttp = $this->getMockBuilder(CSPBuilder::class)->setMethods(['isHTTPSConnection'])->disableOriginalConstructor()->getMock();
+        $cspHttp = $this->getMockBuilder(CSPBuilder::class)->setMethods(['isHTTPSConnection'])
+            ->disableOriginalConstructor()->getMock();
         $cspHttp->method('isHTTPSConnection')->willReturn(false);
 
         $cspHttp->addSource('form', 'http://example.com');
@@ -98,7 +100,8 @@ public function testSourceHttpsConversion()
         $this->assertContains('http://another.com', $compiledCspHttp);
 
         /** @var CSPBuilder|\PHPUnit_Framework_MockObject_MockObject $cspHttps */
-        $cspHttps = $this->getMockBuilder(CSPBuilder::class)->setMethods(['isHTTPSConnection'])->disableOriginalConstructor()->getMock();
+        $cspHttps = $this->getMockBuilder(CSPBuilder::class)->setMethods(['isHTTPSConnection'])
+            ->disableOriginalConstructor()->getMock();
         $cspHttps->method('isHTTPSConnection')->willReturn(true);
 
         $cspHttps->addSource('form', 'http://example.com');