wip

Author: lajosbencz

composer.json

@@ -10,7 +10,9 @@
         }
     ],
     "minimum-stability": "stable",
-    "require": {},
+    "require": {
+        "php": ">=7"
+    },
     "autoload": {
         "psr-4": {
             "LajosBencz\\StreamParseSql\\": "src/LajosBencz/StreamParseSql"

src/LajosBencz/StreamParseSql/Buffer.php

@@ -4,8 +4,8 @@
 namespace LajosBencz\StreamParseSql\Exception;
 
 
-use LajosBencz\StreamParseSql\Exception;
 use Throwable;
+use LajosBencz\StreamParseSql\Exception;
 
 class FileLockException extends Exception
 {

src/LajosBencz/StreamParseSql/Exception/FileLockException.php

@@ -4,8 +4,8 @@
 namespace LajosBencz\StreamParseSql\Exception;
 
 
-use LajosBencz\StreamParseSql\Exception;
 use Throwable;
+use LajosBencz\StreamParseSql\Exception;
 
 class FileReadException extends Exception
 {

src/LajosBencz/StreamParseSql/Exception/FileReadException.php

@@ -3,8 +3,8 @@
 namespace LajosBencz\StreamParseSql\Exception;
 
 
-use LajosBencz\StreamParseSql\Exception;
 use Throwable;
+use LajosBencz\StreamParseSql\Exception;
 
 class ParseException extends Exception
 {

src/LajosBencz/StreamParseSql/Exception/ParseException.php

@@ -12,25 +12,22 @@ class StreamParseSql
 
     const DEFAULT_CHUNK_SIZE = 4096;
 
+    /** @var string */
     protected $_filePath = '';
 
+    /** @var string */
     protected $_delimiter = self::DEFAULT_DELIMITER;
 
+    /** @var int */
     protected $_chunkSize = self::DEFAULT_CHUNK_SIZE;
 
-    public static function Assemble(Token ...$tokens): string
-    {
-        $sql = '';
-        foreach($tokens as $t) {
-            $sql.= $t->content;
-        }
-        $sql = preg_replace('/[\s\t]+/', ' ', $sql);
-        if(!preg_match('/;[\r\n\s]*$/', $sql)) {
-            $sql.= ';';
-        }
-        return $sql;
-    }
-
+    /**
+     * Parses commands from given file command-by-command
+     * @param string $filePath Path to large file with SQL commands
+     * @param string $delimiter Command delimiter used in the SQL file
+     * @param int $chunkSize Size of the read chunk
+     * @throws Exception\FileReadException
+     */
     public function __construct(string $filePath, string $delimiter = self::DEFAULT_DELIMITER, int $chunkSize = self::DEFAULT_CHUNK_SIZE)
     {
         $this->setDelimiter($delimiter);
@@ -41,24 +38,43 @@ public function __construct(string $filePath, string $delimiter = self::DEFAULT_
         $this->_chunkSize = $chunkSize;
     }
 
+    /**
+     * Path to the large SQL file
+     * @return string
+     */
     public function getFilePath(): string
     {
         return $this->_filePath;
     }
 
+    /**
+     * Sets the command delimiter used in the SQL file
+     * @param string $delimiter
+     */
     public function setDelimiter(string $delimiter = self::DEFAULT_DELIMITER): void
     {
         $this->_delimiter = $delimiter;
     }
 
+    /**
+     * Returns the command delimiter used in the SQL file
+     * @return string
+     */
     public function getDelimiter(): string
     {
         return $this->_delimiter;
     }
 
+    /**
+     * Will yield a single SQL command at a time until the file is read to the end
+     * @return string[]|Generator
+     * @throws Exception\FileLockException
+     * @throws Exception\FileReadException
+     * @throws Exception\ParseException
+     */
     public function parse(): Generator
     {
-        $tokenizer = new Tokenizer;
+        $tokenizer = new Tokenizer($this->getDelimiter());
         $tokens = [];
         $filePath = $this->getFilePath();
         $fh = fopen($filePath, 'r');
@@ -71,15 +87,15 @@ public function parse(): Generator
         while (!feof($fh)) {
             $line = fread($fh, $this->_chunkSize);
             foreach($tokenizer->append($line, feof($fh)) as $token) {
-                switch($token->pattern->name) {
+                switch($token->type) {
                     case 'COMMENT_SINGLE':
                     case 'COMMENT_MULTI':
                     case 'NEWLINE':
                         break;
                     default:
                         $tokens[] = $token;
-                        if($token->pattern->name == 'DELIMITER') {
-                            yield self::Assemble(...$tokens);
+                        if($token->type == 'DELIMITER') {
+                            yield Token::Assemble(...$tokens);
                             $tokens = [];
                         }
                         break;
@@ -89,7 +105,7 @@ public function parse(): Generator
         flock($fh, LOCK_UN);
         fclose($fh);
         if(count($tokens) > 0) {
-            yield self::Assemble(...$tokens);
+            yield Token::Assemble(...$tokens);
         }
     }
 }

src/LajosBencz/StreamParseSql/StreamParseSql.php

@@ -1,20 +1,43 @@
 <?php
+declare(strict_types=1);
 
 namespace LajosBencz\StreamParseSql;
 
 
 class Token
 {
-    public $pattern = null;
+    /**
+     * Assembles a list of tokens to an SQL command
+     * @param Token ...$tokens
+     * @return string
+     */
+    public static function Assemble(Token ...$tokens): string
+    {
+        $sql = '';
+        foreach($tokens as $t) {
+            $sql.= $t->content;
+        }
+        $sql = preg_replace('/[\s\t]+/', ' ', $sql);
+        if(!preg_match('/;[\r\n\s]*$/', $sql)) {
+            $sql.= ';';
+        }
+        return $sql;
+    }
+
+    /** @var string */
+    public $type = '';
+
+    /** @var string */
     public $content = '';
-    public $offset = 0;
-    public $length = 0;
 
-    public function __construct(TokenPattern $pattern, string $content, int $offset, int $length)
+    /**
+     * Represents a token in memory
+     * @param string $type
+     * @param string $content
+     */
+    public function __construct(string $type, string $content)
     {
-        $this->pattern = $pattern;
+        $this->type = $type;
         $this->content = $content;
-        $this->offset = $offset;
-        $this->length = $length;
     }
 }