phmLabs / Smoke

src/Rules/Html/RegExNotExistsRule.php

Doc Comments -1 removed lines

@@ -15,7 +15,6 @@
     protected $contentTypes = array('text/html');
 
     /**
-     * @param int $string The string that the document must contain
      */
     public function init(array $regExs)
     {

Spacing +2 added lines, -2 removed lines

@@ -25,8 +25,8 @@
     protected function doValidation(ResponseInterface $response)
     {
         foreach ($this->regExs as $regEx) {
-            $this->assert(preg_match('^' . $regEx . '^', (string)$response->getBody()) === 0,
-                'The given regular expression (' . $regEx . ') was found in this document.');
+            $this->assert(preg_match('^'.$regEx.'^', (string) $response->getBody()) === 0,
+                'The given regular expression ('.$regEx.') was found in this document.');
         }
     }
 }

src/Rules/Http/HttpsRule.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
         $sslOptions = stream_context_create(array('ssl' => array('capture_peer_cert' => true)));
 
         $request = stream_socket_client(
-            'ssl://' . $host . ':443',
+            'ssl://'.$host.':443',
             $errno,
             $errstr,
             30,

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace whm\Smoke\Rules\Http;
 
 use Psr\Http\Message\ResponseInterface;
-use whm\Smoke\Http\Response;
 use whm\Smoke\Rules\Rule;
 
 abstract class HttpsRule implements Rule

src/Rules/Xml/XmlCheckRule.php

Spacing +2 added lines, -2 removed lines

@@ -21,8 +21,8 @@
         if (!$success) {
             $lastError = libxml_get_last_error();
 
-            throw new ValidationFailedException('The xml file ' . $response->getUri() . ' is not well formed (last error: ' .
-                str_replace("\n", '', $lastError->message) . ').');
+            throw new ValidationFailedException('The xml file '.$response->getUri().' is not well formed (last error: '.
+                str_replace("\n", '', $lastError->message).').');
         }
     }
 }

src/Rules/Xml/Sitemap/ValidRule.php

Spacing +4 added lines, -4 removed lines

@@ -29,13 +29,13 @@ 
     private function getSchema($isIndex)
     {
         if ($isIndex) {
-            return __DIR__ . '/' . self::INDEX;
+            return __DIR__.'/'.self::INDEX;
         }
 
         if ($this->strictMode) {
-            return __DIR__ . '/' . self::SCHEMA;
+            return __DIR__.'/'.self::SCHEMA;
         } else {
-            return __DIR__ . '/' . self::NON_STRICT_SCHEMA;
+            return __DIR__.'/'.self::NON_STRICT_SCHEMA;
         }
     }
 
@@ -49,7 +49,7 @@ 
         if (!$valid) {
             $lastError = libxml_get_last_error();
             throw new ValidationFailedException(
-                'The given sitemap file (' . $filename . ') did not validate against the sitemap schema (last error: ' . str_replace("\n", '', $lastError->message) . ').');
+                'The given sitemap file ('.$filename.') did not validate against the sitemap schema (last error: '.str_replace("\n", '', $lastError->message).').');
         }
     }
 

Doc Comments +7 added lines

@@ -26,6 +26,9 @@ 
         $this->strictMode = $strictMode;
     }
 
+    /**
+     * @param boolean $isIndex
+     */
     private function getSchema($isIndex)
     {
         if ($isIndex) {
@@ -39,6 +42,10 @@ 
         }
     }
 
+    /**
+     * @param \Psr\Http\Message\StreamInterface $body
+     * @param string $filename
+     */
     private function validateBody($body, $filename, $isIndex = true)
     {
         $dom = new \DOMDocument();

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace whm\Smoke\Rules\Xml\Sitemap;
 
 use Psr\Http\Message\ResponseInterface;
-use whm\Smoke\Http\Response;
 use whm\Smoke\Rules\StandardRule;
 use whm\Smoke\Rules\ValidationFailedException;
 

src/Extensions/SmokeReporter/Reporter/KoalamonReporter.php

Spacing +16 added lines, -16 removed lines

@@ -95,7 +95,7 @@ 
 
     public function finish()
     {
-        $this->output->writeln('Sending results to ' . $this->server . " ... \n");
+        $this->output->writeln('Sending results to '.$this->server." ... \n");
 
         if ($this->groupBy === 'prefix') {
             $this->sendGroupedByPrefix();
@@ -126,7 +126,7 @@ 
 
         foreach ($this->getRuleKeys() as $rule) {
             foreach ($systems as $system) {
-                $identifier = $this->tool . '_' . $this->getPrefix($rule) . '_' . $system;
+                $identifier = $this->tool.'_'.$this->getPrefix($rule).'_'.$system;
                 $failureMessages[$identifier]['message'] = '';
                 $failureMessages[$identifier]['system'] = $system;
                 $failureMessages[$identifier]['tool'] = $this->getPrefix($rule);
@@ -143,15 +143,15 @@ 
                         $system = $this->retriever->getSystem(($result->getUrl()));
                     }
 
-                    $identifer = $this->tool . '_' . $this->getPrefix($ruleLKey) . '_' . $system;
+                    $identifer = $this->tool.'_'.$this->getPrefix($ruleLKey).'_'.$system;
 
                     if ($failureMessages[$identifer]['message'] === '') {
-                        $failureMessages[$identifer]['message'] = 'The ' . $this->getPrefix($ruleLKey) . ' test for #system_name# failed.<ul>';
+                        $failureMessages[$identifer]['message'] = 'The '.$this->getPrefix($ruleLKey).' test for #system_name# failed.<ul>';
                     }
                     ++$counter[$identifer];
-                    $message = '<li>' . $message . '<br>url: ' . $result->getUrl();
+                    $message = '<li>'.$message.'<br>url: '.$result->getUrl();
                     if ($this->addComingFrom) {
-                        $message .= ', coming from: ' . $this->retriever->getComingFrom($result->getUrl());
+                        $message .= ', coming from: '.$this->retriever->getComingFrom($result->getUrl());
                     }
                     $message .= '</li>';
                     $failureMessages[$identifer]['message'] .= $message;
@@ -161,9 +161,9 @@ 
 
         foreach ($failureMessages as $key => $failureMessage) {
             if ($failureMessage['message'] !== '') {
-                $this->send($this->identifier . '_' . $key, $failureMessage['system'], $failureMessage['message'] . '</ul>', self::STATUS_FAILURE, '', $counter[$key], $failureMessage['tool']);
+                $this->send($this->identifier.'_'.$key, $failureMessage['system'], $failureMessage['message'].'</ul>', self::STATUS_FAILURE, '', $counter[$key], $failureMessage['tool']);
             } else {
-                $this->send($this->identifier . '_' . $key, $failureMessage['system'], '', self::STATUS_SUCCESS, '', 0, $failureMessage['tool']);
+                $this->send($this->identifier.'_'.$key, $failureMessage['system'], '', self::STATUS_SUCCESS, '', 0, $failureMessage['tool']);
             }
         }
     }
@@ -175,7 +175,7 @@ 
             $failedTests = array();
             if ($result->isFailure()) {
                 foreach ($result->getMessages() as $ruleLKey => $message) {
-                    $identifier = 'smoke_' . $ruleLKey . '_' . $result->getUrl();
+                    $identifier = 'smoke_'.$ruleLKey.'_'.$result->getUrl();
 
                     if ($this->system === '') {
                         $system = str_replace('http://', '', $result->getUrl());
@@ -188,7 +188,7 @@ 
             }
             foreach ($rules as $rule) {
                 if (!in_array($rule, $failedTests, true)) {
-                    $identifier = 'smoke_' . $rule . '_' . $result->getUrl();
+                    $identifier = 'smoke_'.$rule.'_'.$result->getUrl();
 
                     if ($this->systemUseRetriever) {
                         $system = $this->retriever->getSystem($result->getUrl());
@@ -197,7 +197,7 @@ 
                     } else {
                         $system = $this->system;
                     }
-                    $this->send($identifier, $system, 'smoke_' . $rule . '_' . $result->getUrl(), self::STATUS_SUCCESS, (string) $result->getUrl());
+                    $this->send($identifier, $system, 'smoke_'.$rule.'_'.$result->getUrl(), self::STATUS_SUCCESS, (string) $result->getUrl());
                 }
             }
         }
@@ -221,17 +221,17 @@ 
                         $system = $this->retriever->getSystem(new Uri($result->getUrl()));
                     }
                     if ($failureMessages[$ruleLKey] === '') {
-                        $failureMessages[$ruleLKey]['message'] = '    The smoke test for #system_name# failed (Rule: ' . $ruleLKey . ').<ul>';
+                        $failureMessages[$ruleLKey]['message'] = '    The smoke test for #system_name# failed (Rule: '.$ruleLKey.').<ul>';
                     }
                     ++$counter[$ruleLKey];
 
                     $comingFrom = '';
 
                     if ($this->addComingFrom && $this->retriever->getComingFrom($result->getUrl())) {
-                        $comingFrom = ', coming from: ' . $this->retriever->getComingFrom($result->getUrl());
+                        $comingFrom = ', coming from: '.$this->retriever->getComingFrom($result->getUrl());
                     }
 
-                    $failureMessages[$ruleLKey]['message'] .= '<li>' . $message . ' (url: ' . $result->getUrl() . $comingFrom . ')</li > ';
+                    $failureMessages[$ruleLKey]['message'] .= '<li>'.$message.' (url: '.$result->getUrl().$comingFrom.')</li > ';
                     $failureMessages[$ruleLKey]['system'] = $system;
                 }
             }
@@ -239,9 +239,9 @@ 
 
         foreach ($failureMessages as $key => $failureMessage) {
             if ($failureMessage !== '') {
-                $this->send($this->identifier . '_' . $key, $this->system, $failureMessage['message'] . ' </ul > ', self::STATUS_FAILURE, '', $counter[$key]);
+                $this->send($this->identifier.'_'.$key, $this->system, $failureMessage['message'].' </ul > ', self::STATUS_FAILURE, '', $counter[$key]);
             } else {
-                $this->send($this->identifier . '_' . $key, $this->system, '', self::STATUS_SUCCESS, '', 0);
+                $this->send($this->identifier.'_'.$key, $this->system, '', self::STATUS_SUCCESS, '', 0);
             }
         }
     }

Doc Comments +4 added lines

@@ -246,6 +246,10 @@
         }
     }
 
+    /**
+     * @param string $identifier
+     * @param string $message
+     */
     private function send($identifier, $system, $message, $status, $url = '', $value = 0, $tool = null)
     {
         if (is_null($tool)) {

src/Rules/Xml/XmlValidXsdRule.php

Spacing +2 added lines, -2 removed lines

@@ -39,12 +39,12 @@
                 $error = true;
                 $lastError = libxml_get_last_error();
 
-                $messageParts[] = $xsdFile['xsdfilename'] . ' - ' . $xsdFile['xsdfileurl'] . '(last error: ' . str_replace("\n", '', $lastError->message) . ').';
+                $messageParts[] = $xsdFile['xsdfilename'].' - '.$xsdFile['xsdfileurl'].'(last error: '.str_replace("\n", '', $lastError->message).').';
             }
         }
 
         if ($error === true) {
-            $message = 'XML file (' . $filename . ')  does not validate against the following XSD files: ' . implode(', ', $messageParts);
+            $message = 'XML file ('.$filename.')  does not validate against the following XSD files: '.implode(', ', $messageParts);
             throw new ValidationFailedException($message);
         }
     }

src/Rules/Seo/RobotsDisallowAllRule.php

Doc Comments +3 added lines

@@ -49,6 +49,9 @@
         }
     }
 
+    /**
+     * @param string $content
+     */
     private function normalizeContent($content)
     {
         $normalizedContent = strtolower($content);

Unused Use Statements -2 removed lines

@@ -4,8 +4,6 @@
 
 use Ivory\HttpAdapter\HttpAdapterInterface;
 use Psr\Http\Message\ResponseInterface;
-use whm\Smoke\Http\ClientAware;
-use whm\Smoke\Http\Response;
 use whm\Smoke\Rules\Rule;
 use whm\Smoke\Rules\ValidationFailedException;
 

Spacing +4 added lines, -4 removed lines

@@ -21,12 +21,12 @@ 
 
     public function validate(ResponseInterface $response)
     {
-        $url = $response->getUri()->getScheme() . '://' . $response->getUri()->getHost();
+        $url = $response->getUri()->getScheme().'://'.$response->getUri()->getHost();
 
         if (substr_count($url, '/') === 2) {
-            $filename = $robotsUrl = $url . '/robots.txt';
+            $filename = $robotsUrl = $url.'/robots.txt';
         } elseif (substr_count($url, '/') === 3) {
-            $filename = $robotsUrl = $url . 'robots.txt';
+            $filename = $robotsUrl = $url.'robots.txt';
         } else {
             return;
         }
@@ -39,7 +39,7 @@ 
 
         $normalizedContent = $this->normalizeContent($content);
 
-        if (strpos($normalizedContent, 'user-agent:* disallow:/' . PHP_EOL) !== false) {
+        if (strpos($normalizedContent, 'user-agent:* disallow:/'.PHP_EOL) !== false) {
             throw new ValidationFailedException('The robots.txt contains disallow all (Disallow: /)');
         }
 

src/Extensions/SmokeReporter/Reporter/StandardCliReporter.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
         $this->output->writeln('');
     }
 
+    /**
+     * @param integer $ruleKey
+     */
     private function getFailedUrls($ruleKey)
     {
         $failedUrls = array();

Spacing +6 added lines, -6 removed lines

@@ -81,11 +81,11 @@ 
                 /** @var CheckResult $result */
                 if ($result->getStatus() === CheckResult::STATUS_FAILURE) {
                     if ($ruleKey === $key) {
-                        $failedUrls[] = (string) $result->getResponse()->getUri() . ' - ' . $result->getMessage();
+                        $failedUrls[] = (string) $result->getResponse()->getUri().' - '.$result->getMessage();
                         ++$count;
                     }
                     if ($count > $this->maxResults) {
-                        $failedUrls[] = '... only the first ' . $this->maxResults . ' elements are shown.';
+                        $failedUrls[] = '... only the first '.$this->maxResults.' elements are shown.';
                         break;
                     }
                 }
@@ -104,15 +104,15 @@ 
             $failedUrls = $this->getFailedUrls($ruleKey);
 
             if (count($failedUrls) > 0) {
-                $this->output->writeln('  <error> ' . get_class($rule) . ' </error>');
+                $this->output->writeln('  <error> '.get_class($rule).' </error>');
             } else {
-                $this->output->writeln('  <info> ' . get_class($rule) . ' </info>');
+                $this->output->writeln('  <info> '.get_class($rule).' </info>');
             }
 
-            $this->output->writeln('   ' . str_replace("\n", "\n   ", $info['documentation']) . "\n");
+            $this->output->writeln('   '.str_replace("\n", "\n   ", $info['documentation'])."\n");
 
             foreach ($failedUrls as $failedUrl) {
-                $this->output->writeln('   - ' . $failedUrl);
+                $this->output->writeln('   - '.$failedUrl);
             }
 
             $this->output->writeln('');

src/Extensions/SmokeReporter/Reporter/CliReporter.php

Spacing +3 added lines, -3 removed lines

@@ -30,13 +30,13 @@
 
     protected function renderFailure(CheckResult $result)
     {
-        $this->output->writeln('   <error> ' . (string) $result->getResponse()->getUri() . ' </error> coming from ' . (string) $this->retriever->getComingFrom($result->getResponse()->getUri()));
-        $this->output->writeln('    - ' . $result->getMessage() . ' [rule: ' . $result->getRuleName() . ']');
+        $this->output->writeln('   <error> '.(string) $result->getResponse()->getUri().' </error> coming from '.(string) $this->retriever->getComingFrom($result->getResponse()->getUri()));
+        $this->output->writeln('    - '.$result->getMessage().' [rule: '.$result->getRuleName().']');
         $this->output->writeln('');
     }
 
     protected function renderSuccess(CheckResult $result)
     {
-        $this->output->writeln('   <info> ' . (string) $result->getResponse()->getUri() . ' </info> all tests passed');
+        $this->output->writeln('   <info> '.(string) $result->getResponse()->getUri().' </info> all tests passed');
     }
 }