phmLabs / Smoke

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();

src/Rules/Html/CssSelectorExistsRule.php

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
         if ($error === true) {
             $allNotFoundSelectors = implode('", "', $snotFoundSelectors);
 
-            throw new ValidationFailedException('CSS Selector "' . $allNotFoundSelectors . '" not found in DOM.');
+            throw new ValidationFailedException('CSS Selector "'.$allNotFoundSelectors.'" not found in DOM.');
         }
     }
 }

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/Html/ClosingHtmlTagRule.php

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     {
         if (($response->getStatus() < 300 || $response->getStatus() >= 400) && $response->getContentType() === 'text/html') {
             if (stripos($response->getBody(), '</html>') === false) {
-                throw new ValidationFailedException('Closing html tag is missing (document lengh: ' . strlen($response->getBody()) . ').');
+                throw new ValidationFailedException('Closing html tag is missing (document lengh: '.strlen($response->getBody()).').');
             }
         }
     }

src/Extensions/CookieMaker/CookieMakerExtension.php

Spacing +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
         $this->sessionContainer = new SessionContainer();
 
         foreach ($sessions as $sessionName => $session) {
-            $command = $this->executable . " '" . json_encode($session) . "'";
+            $command = $this->executable." '".json_encode($session)."'";
 
             exec($command, $output, $return);
 

src/Rules/Seo/RobotsDisallowAllRule.php

Doc Comments +3 added lines

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

Spacing +4 added lines, -4 removed lines

@@ -20,12 +20,12 @@ 
 
     public function validate(Response $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;
         }
@@ -40,7 +40,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/LeankoalaReporter.php

Spacing +9 added lines, -9 removed lines

@@ -110,7 +110,7 @@ 
         foreach ($this->results as $results) {
             foreach ($results as $result) {
                 /* @var CheckResult $result */
-                $tool = 'Smoke' . $result->getRuleName();
+                $tool = 'Smoke'.$result->getRuleName();
                 $checks[$tool][] = $result;
             }
         }
@@ -120,19 +120,19 @@ 
                 continue;
             }
 
-            $message = 'The smoke test for #system_name# failed (Rule: ' . $toolName . ').<ul>';
+            $message = 'The smoke test for #system_name# failed (Rule: '.$toolName.').<ul>';
             $status = Event::STATUS_SUCCESS;
             $failureCount = 0;
-            $identifier = $toolName . '_' . $this->system;
+            $identifier = $toolName.'_'.$this->system;
 
             foreach ($results as $result) {
                 /** @var CheckResult $result */
                 if ($result->getStatus() === CheckResult::STATUS_FAILURE) {
                     $comingFrom = '';
                     if ($this->addComingFrom && $this->retriever->getComingFrom($result->getResponse()->getUri())) {
-                        $comingFrom = ', coming from: ' . $this->retriever->getComingFrom($result->getResponse()->getUri());
+                        $comingFrom = ', coming from: '.$this->retriever->getComingFrom($result->getResponse()->getUri());
                     }
-                    $message .= '<li>' . $result->getMessage() . ' (url: ' . (string) $result->getResponse()->getUri() . $comingFrom . ')</li>';
+                    $message .= '<li>'.$result->getMessage().' (url: '.(string) $result->getResponse()->getUri().$comingFrom.')</li>';
                     ++$failureCount;
                 }
             }
@@ -140,7 +140,7 @@ 
                 $status = Event::STATUS_FAILURE;
                 $message .= '</ul>';
             } else {
-                $message = 'All checks for system "#system_name#" succeeded [SmokeBasic:' . $toolName . '].';
+                $message = 'All checks for system "#system_name#" succeeded [SmokeBasic:'.$toolName.'].';
             }
 
             $this->send($identifier, $this->system, $message, $status, $failureCount, $this->tool, $this->system);
@@ -153,7 +153,7 @@ 
             foreach ($results as $result) {
                 /* @var CheckResult $result */
 
-                $identifier = '_' . $this->getIdentifier($result);
+                $identifier = '_'.$this->getIdentifier($result);
                 $tool = $this->getPrefix($result->getRuleName());
 
                 $component = $this->getComponent($result->getRuleName());
@@ -162,7 +162,7 @@ 
                 $this->send(
                     $identifier,
                     $system,
-                    $result->getMessage() . ' (url: ' . (string) $result->getResponse()->getUri() . ')',
+                    $result->getMessage().' (url: '.(string) $result->getResponse()->getUri().')',
                     $result->getStatus(),
                     $result->getValue(),
                     $tool,
@@ -174,7 +174,7 @@ 
 
     private function getIdentifier(CheckResult $result)
     {
-        return $this->tool . '_' . $result->getRuleName();
+        return $this->tool.'_'.$result->getRuleName();
     }
 
     private function getPrefix($string)

Doc Comments +5 added lines

@@ -182,6 +182,11 @@
         return substr($string, 0, strpos($string, '_'));
     }
 
+    /**
+     * @param string $identifier
+     * @param string $message
+     * @param string $tool
+     */
     private function send($identifier, $system, $message, $status, $value, $tool, $component)
     {
         if ($status !== CheckResult::STATUS_NONE) {