Minor refactoring

Author: JanPetterMG

docs/methods/RenderClient.md

@@ -11,7 +11,7 @@
 
 ### compatibility
 ```php
-@param string $lineSeparator
+@param string $eol
 @return string
 ```
 Generates an robots.txt optimized for parsing by custom 3rd party parsers, witch do not follow the standards.
@@ -23,7 +23,7 @@ Differences compared to [minimal](#minimal):
 
 ### compressed
 ```php
-@param string $lineSeparator
+@param string $eol
 @return string
 ```
 Generates an robots.txt compressed to a absolute minimum.
@@ -32,7 +32,7 @@ Best suited for parsing purposes and storage in databases.
 
 ### normal
 ```php
-@param string $lineSeparator
+@param string $eol
 @return string
 ```
 Generates an normal looking robots.txt.
@@ -44,7 +44,7 @@ Differences compared to [compressed](#compressed):
 
 ### minimal
 ```php
-@param string $lineSeparator
+@param string $eol
 @return string
 ```
 Generates an minimal but normal looking robots.txt.

src/Client/Directives/AllowClient.php

@@ -20,7 +20,7 @@
  */
 class AllowClient implements ClientInterface, RobotsTxtInterface
 {
-    use DirectiveClientCommons;
+    use DirectiveClientTrait;
 
     /**
      * Paths

…nt/Directives/DirectiveClientCommons.php …ient/Directives/DirectiveClientTrait.phpsrc/Client/Directives/DirectiveClientCommons.php renamed to src/Client/Directives/DirectiveClientTrait.php src/Client/Directives/DirectiveClientCommons.php renamed to src/Client/Directives/DirectiveClientTrait.php

@@ -12,11 +12,11 @@
 use DateTimeZone;
 
 /**
- * Trait DirectiveClientCommons
+ * Trait DirectiveClientTrait
  *
  * @package vipnytt\RobotsTxtParser\Client\Directives
  */
-trait DirectiveClientCommons
+trait DirectiveClientTrait
 {
     /**
      * Is time between

src/Client/Directives/InlineCleanParamClient.php

@@ -16,7 +16,7 @@
  */
 class InlineCleanParamClient implements ClientInterface
 {
-    use DirectiveClientCommons;
+    use DirectiveClientTrait;
 
     /**
      * Clean-param

src/Client/Directives/RequestRateClient.php

@@ -16,7 +16,7 @@
  */
 class RequestRateClient extends DelayCore implements ClientInterface, DelayInterface
 {
-    use DirectiveClientCommons;
+    use DirectiveClientTrait;
 
     /**
      * Rates

src/Client/Directives/VisitTimeClient.php

@@ -16,7 +16,7 @@
  */
 class VisitTimeClient implements ClientInterface
 {
-    use DirectiveClientCommons;
+    use DirectiveClientTrait;
 
     /**
      * Times

src/Client/RenderClient.php

@@ -43,24 +43,24 @@ 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
+     * @param string $eol
      * @return string
      */
-    public function compatibility($lineSeparator = "\r\n")
+    public function compatibility($eol = "\r\n")
     {
-        return $this->generate(3, $lineSeparator) . $lineSeparator;
+        return $this->generate(3, $eol) . $eol;
     }
 
     /**
      * Generate an rule string array
      *
      * @param int $level
-     * @param string $lineSeparator
+     * @param string $eol
      * @return string
      */
-    private function generate($level, $lineSeparator)
+    private function generate($level, $eol)
     {
-        $handler = new RenderHandler($level, $lineSeparator);
+        $handler = new RenderHandler($level, $eol);
         if ($level === 3) {
             $this->root->userAgent()->render($handler);
         }
@@ -80,13 +80,13 @@ private function generate($level, $lineSeparator)
      * - The directives first character is uppercase
      * - Whitespace between the directive and it's value
      *
-     * @param string $lineSeparator
+     * @param string $eol
      * @return string
      */
-    public function minimal($lineSeparator = "\r\n")
+    public function minimal($eol = "\r\n")
     {
 
-        return $this->generate(1, $lineSeparator);
+        return $this->generate(1, $eol);
     }
 
     /**
@@ -97,12 +97,12 @@ public function minimal($lineSeparator = "\r\n")
      * - Easy to edit
      * - User-agent groups are separated with blank lines
      *
-     * @param string $lineSeparator
+     * @param string $eol
      * @return string
      */
-    public function normal($lineSeparator = "\r\n")
+    public function normal($eol = "\r\n")
     {
-        return $this->generate(2, $lineSeparator);
+        return $this->generate(2, $eol);
     }
 
     /**
@@ -111,11 +111,11 @@ public function normal($lineSeparator = "\r\n")
      * Generates an robots.txt compressed to a absolute minimum.
      * Best suited for parsing purposes and storage in databases.
      *
-     * @param string $lineSeparator
+     * @param string $eol
      * @return string
      */
-    public function compressed($lineSeparator = PHP_EOL)
+    public function compressed($eol = PHP_EOL)
     {
-        return $this->generate(0, $lineSeparator);
+        return $this->generate(0, $eol);
     }
 }

src/Handler/RenderHandler.php

@@ -19,16 +19,16 @@
 class RenderHandler implements RobotsTxtInterface
 {
     /**
-     * Mode
+     * Render level
      * @var int
      */
-    private $mode;
+    private $level;
 
     /**
      * Line separator
      * @var string
      */
-    private $separator;
+    private $eol;
 
     /**
      * Rule strings
@@ -57,42 +57,42 @@ class RenderHandler implements RobotsTxtInterface
     /**
      * RenderHandler constructor.
      *
-     * @param int $mode
+     * @param int $level
      * @param string $lineSeparator
      */
-    public function __construct($mode, $lineSeparator = "\r\n")
+    public function __construct($level, $lineSeparator = "\r\n")
     {
-        $this->mode = $mode;
+        $this->level = $level;
         $this->separatorCheck($lineSeparator);
     }
 
     /**
      * Line separator check
      *
-     * @param string $lineSeparator
+     * @param string $eol
      * @throws ClientException
      */
-    private function separatorCheck($lineSeparator)
+    private function separatorCheck($eol)
     {
-        if (!in_array($lineSeparator, [
+        if (!in_array($eol, [
             "\r\n",
             "\n",
             "\r",
         ])
         ) {
             throw new ClientException('Invalid line separator');
         }
-        $this->separator = $lineSeparator;
+        $this->eol = $eol;
     }
 
     /**
      * Get mode
      *
      * @return int
      */
-    public function getMode()
+    public function getLevel()
     {
-        return $this->mode;
+        return $this->level;
     }
 
     /**
@@ -104,8 +104,9 @@ public function getMode()
      */
     public function addInline($directive, RenderHandler $handler)
     {
-        foreach ($handler->export() as $line) {
-            $this->add($directive, trim($line));
+        $lines = array_map('trim', $handler->export());
+        foreach ($lines as $line) {
+            $this->add($directive, $line);
         }
         return true;
     }
@@ -131,7 +132,7 @@ public function add($directive, $line)
     {
         $this->previous = $this->directive;
         $this->directive = $directive;
-        if ($this->mode >= 2) {
+        if ($this->level >= 2) {
             $this->strings[] = $this->advanced() . $line;
             return true;
         }
@@ -147,11 +148,11 @@ public function add($directive, $line)
     private function advanced()
     {
         $result = '';
-        if ($this->boolInsertSeparatorMode3() ||
+        if ($this->boolInsertSeparatorLevel3() ||
             $this->previous !== self::DIRECTIVE_USER_AGENT &&
             $this->directive === self::DIRECTIVE_USER_AGENT
         ) {
-            $result = $this->separator;
+            $result = $this->eol;
             $this->previousRoot = $this->directive;
         }
         $result .= $this->basic();
@@ -163,9 +164,9 @@ private function advanced()
      *
      * @return bool
      */
-    private function boolInsertSeparatorMode3()
+    private function boolInsertSeparatorLevel3()
     {
-        return $this->mode >= 3 &&
+        return $this->level >= 3 &&
         $this->previousRoot !== $this->directive &&
         in_array($this->directive, [
             self::DIRECTIVE_HOST,
@@ -182,7 +183,7 @@ private function boolInsertSeparatorMode3()
     private function basic()
     {
         $result = $this->directive . ':';
-        if ($this->mode === 0) {
+        if ($this->level === 0) {
             return $result;
         }
         return ucfirst($result) . ' ';
@@ -195,6 +196,6 @@ private function basic()
      */
     public function generate()
     {
-        return trim(implode($this->separator, $this->strings));
+        return trim(implode($this->eol, $this->strings));
     }
 }

src/Parser/Directives/AllowParser.php

@@ -158,7 +158,7 @@ private function removeOverlapping()
     public function render(RenderHandler $handler)
     {
         sort($this->path);
-        $inline = new RenderHandler($handler->getMode());
+        $inline = new RenderHandler($handler->getLevel());
         $this->host->render($inline);
         $this->cleanParam->render($inline);
         $handler->addInline($this->directive, $inline);

src/Parser/Directives/CleanParamParserCore.php

@@ -64,7 +64,7 @@ public function add($line)
     public function render(RenderHandler $handler)
     {
         ksort($this->cleanParam);
-        return $handler->getMode() >= 3 ? $this->renderExtensive($handler) : $this->renderCompressed($handler);
+        return $handler->getLevel() >= 3 ? $this->renderExtensive($handler) : $this->renderCompressed($handler);
     }
 
     /**