Line-separator fixes

Fixed an (unlikely) minor bug risk in an while loop at the CleanParam render

Author: JanPetterMG

docs/methods/RenderClient.md

@@ -11,6 +11,7 @@
 
 ### compatibility
 ```php
+@param string $lineSeparator
 @return string
 ```
 Generates an robots.txt optimized for parsing by custom 3rd party parsers, witch do not follow the standards.

src/Client/Cache/MySQL/Manager.php

@@ -179,7 +179,7 @@ private function push(UriClient $client, $worker = 0)
             return true;
         }
         $validUntil = $client->validUntil();
-        $content = $client->render()->compressed("\n");
+        $content = $client->render()->compressed(PHP_EOL);
         $query = $this->pdo->prepare(<<<SQL
 INSERT INTO robotstxt__cache1 (base, content, statusCode, validUntil, nextUpdate, effective)
 VALUES (:base, :content, :statusCode, :validUntil, :nextUpdate, :effective)

src/Client/RenderClient.php

@@ -43,11 +43,12 @@ public function __construct(RootDirectiveHandler $handler)
      * - Byte consuming, may be multiple times larger (depending on the number of user-agents)
      * - Maximum compatibility, optimized for badly written 3rd party parsers with limited specification support
      *
+     * @param string $lineSeparator
      * @return string
      */
-    public function compatibility()
+    public function compatibility($lineSeparator = "\r\n")
     {
-        return $this->generate(3, "\r\n") . "\r\n";
+        return $this->generate(3, $lineSeparator) . $lineSeparator;
     }
 
     /**
@@ -113,7 +114,7 @@ public function normal($lineSeparator = "\r\n")
      * @param string $lineSeparator
      * @return string
      */
-    public function compressed($lineSeparator = "\r\n")
+    public function compressed($lineSeparator = PHP_EOL)
     {
         return $this->generate(0, $lineSeparator);
     }

src/Parser/Directives/CleanParamParserCore.php

@@ -92,9 +92,9 @@ private function renderExtensive(RenderHandler $handler)
     private function renderCompressed(RenderHandler $handler)
     {
         $pair = $this->cleanParam;
-        while (!empty($pair)) {
-            $equalParams = array_keys($pair, current($pair));
-            foreach (current($pair) as $path) {
+        while (($currentPair = current($pair)) !== false) {
+            $equalParams = array_keys($pair, $currentPair);
+            foreach ($currentPair as $path) {
                 $handler->add(self::DIRECTIVE_CLEAN_PARAM, implode('&', $equalParams) . ' ' . $path);
             }
             foreach ($equalParams as $param) {

tests/AllowTest.php

@@ -88,7 +88,7 @@ public function testDisAllow($robotsTxtContent, $rendered)
         $this->assertFalse($parser->userAgent('crawlerZ')->isAllowed("/public"));
 
         if ($rendered !== false) {
-            $this->assertEquals($rendered, $parser->render()->normal());
+            $this->assertEquals($rendered, $parser->render()->normal("\n"));
             $this->testDisAllow($rendered, false);
         }
     }
@@ -102,7 +102,7 @@ public function testDisAllowIsListed($robotsTxtContent, $rendered)
     {
         $parser = new RobotsTxtParser\TxtClient('http://example.com', 200, $robotsTxtContent);
         $this->assertInstanceOf('vipnytt\RobotsTxtParser\TxtClient', $parser);
-        $this->assertEquals($rendered, $parser->render()->normal());
+        $this->assertEquals($rendered, $parser->render()->normal("\n"));
 
         $this->assertTrue($parser->userAgent('*')->disallow()->isListed('/admin'));
         $this->assertTrue($parser->userAgent('agentV')->allow()->isListed('/bar'));

tests/AtSymbolTest.php

@@ -35,7 +35,7 @@ public function testAtSymbol($robotsTxtContent, $rendered)
         $this->assertFalse($parser->userAgent()->isAllowed("/url_containing_@_symbol"));
 
         if ($rendered !== false) {
-            $this->assertEquals($rendered, $parser->render()->normal());
+            $this->assertEquals($rendered, $parser->render()->normal("\n"));
             $this->testAtSymbol($rendered, false);
         }
     }

tests/CacheDelayTest.php

@@ -34,7 +34,7 @@ public function testCacheDelay($robotsTxtContent, $rendered)
         $this->assertEquals(9.2, $parser->userAgent('BingBot')->cacheDelay()->getValue());
 
         if ($rendered !== false) {
-            $this->assertEquals($rendered, $parser->render()->normal());
+            $this->assertEquals($rendered, $parser->render()->normal("\n"));
             $this->testCacheDelay($rendered, false);
         }
     }

tests/CaseSensitiveTest.php

@@ -74,7 +74,7 @@ public function testCaseSensitive($robotsTxtContent, $rendered)
         $this->assertFalse($parser->userAgent()->isDisallowed("/"));
 
         if ($rendered !== false) {
-            $this->assertEquals($rendered, $parser->render()->normal());
+            $this->assertEquals($rendered, $parser->render()->normal("\n"));
             $this->testCaseSensitive($rendered, false);
         }
     }

tests/CleanParamTest.php

@@ -42,7 +42,7 @@ public function testCleanParam($robotsTxtContent, $result, $rendered)
         $this->assertEquals($result['Allow'], $parser->userAgent()->allow()->cleanParam()->export());
 
         if ($rendered !== false) {
-            $this->assertEquals($rendered, $parser->render()->normal());
+            $this->assertEquals($rendered, $parser->render()->normal("\n"));
             $this->testCleanParam($rendered, $result, false);
         }
     }

tests/CommentTest.php

@@ -34,7 +34,7 @@ public function testComment($robotsTxtContent, $result, $rendered)
         $this->assertFalse($parser->userAgent('receiver')->isAllowed("/"));
 
         if ($rendered !== false) {
-            $this->assertEquals($rendered, $parser->render()->normal());
+            $this->assertEquals($rendered, $parser->render()->normal("\n"));
             $this->testComment($rendered, $result, false);
         }
     }