Initial commit

Author: phpfui

.gitignore

@@ -0,0 +1,8 @@
+results.csv
+results.md
+vendor
+composer.lock
+*.db
+config.php
+*.sqlite
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,14 @@
+<?php
+/*
+ * This document has been generated with
+ * https://mlocati.github.io/php-cs-fixer-configurator/#version:3.0.0-rc.1|configurator
+ * you can change this configuration by importing this file.
+ *
+ */
+
+$config = include 'vendor/phpfui/phpunit-syntax-coverage/PhpCsFixer.php';
+
+return $config->setFinder(PhpCsFixer\Finder::create()
+			->exclude('vendor')
+			->in(__DIR__.'/SOB')
+    );

SOB/BaseLine.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace SOB;
+
+class BaseLine
+	{
+	private int $memory = 0;
+
+	private \SebastianBergmann\Timer\Timer $timer;
+
+	public function __construct()
+		{
+		$this->memory = \memory_get_usage();
+		$this->timer = new \SebastianBergmann\Timer\Timer();
+		$this->timer->start();
+		}
+
+	public function getMemory() : int
+		{
+		return \memory_get_usage() - $this->memory;
+		}
+
+	public function stop() : float
+		{
+		return $this->timer->stop()->asSeconds();
+		}
+	}

SOB/CSV/FileReader.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * A simple CSV reader based on a file containing CSV data
+ *
+ * @inheritDoc
+ */
+class FileReader extends Reader
+	{
+	public function __construct(private readonly string $fileName, bool $headerRow = true, string $separator = ',', string $enclosure = '"', string $escape = '\\')
+		{
+		parent::__construct(null, $headerRow, $separator, $enclosure, $escape);
+		}
+
+	protected function open() : static
+		{
+		if (\file_exists($this->fileName))
+			{
+			if ($this->stream)
+				{
+				\fclose($this->stream);
+				$this->stream = null;
+				}
+			$this->stream = @\fopen($this->fileName, 'r');
+			}
+
+		return $this;
+		}
+	}

SOB/CSV/FileWriter.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * \PHPFUI\Tools\CSVWriter: a simple class to output a CSV file given data in an array
+ *
+ * Features:
+ *  - User specified delimiter (default: comma)
+ *  - Auto header row generation
+ *  - Sparse array output where emtpy columns are empty in the output
+ */
+class FileWriter extends Writer
+	{
+	/**
+	 * @var resource $out opened output file stream
+	 */
+	private $out;
+
+	/**
+	 * Make a \CSV\File\Writer.
+	 *
+	 * @param string $filename to be output. If $download is true then this is the name the user will see.  Avoid OS specific filespec conventions. If $download is false, then you can specify a directory or other OS specific filespec.
+	 */
+	public function __construct(string $filename, private readonly bool $download = true, string $separator = ',', string $enclosure = '"', string $escape = '\\', string $eol = "\n")
+
+		{
+		if ($this->download)
+			{
+			\header('Content-Type: application/csv');
+			\header('Content-Disposition: inline; filename="' . $filename . '"');
+			\header('Cache-Control: private, max-age=0, must-revalidate');
+			\header('Pragma: public');
+			$this->out = \fopen('php://output', 'w');
+			}
+		else
+			{
+			$this->out = \fopen($filename, 'w');
+			}
+		parent::__construct($this->out, $separator, $enclosure, $escape, $eol);
+		}
+
+	public function __destruct()
+		{
+		\fclose($this->out);
+
+		if ($this->download)
+			{
+			exit;
+			}
+		}
+	}

SOB/CSV/Reader.php

@@ -0,0 +1,131 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * Base class for a simple CSV reader supporting files, string or streams as input
+ *
+ * Emulates an array of records (arrays), implimented as an Iterator, so can be used in a foreach statements.
+ *
+ * - If your CSV has headers (the default), then the keys of the returned array will be the header values.
+ * - You can also specify a different field separator, for example ("\t") for tabs.
+ * - Use rewind to reset to the top of the file.
+ * - The header record is NEVER returned as a record.  The first iteration will be the first record in the file, excluding the header record if specified.
+ * - An empty stream will return -1 as the current index.
+ *
+ * @implements \Iterator<array<string, string>>
+ */
+abstract class Reader implements \Iterator
+	{
+	/** @var array<string, string> */
+	private array $current = [];
+
+	/** @var array<string> */
+	private array $headers = [];
+
+	private int $index = 0;
+
+	/**
+	 * @param ?resource $stream
+	 */
+	public function __construct(protected $stream, private readonly bool $headerRow, private readonly string $separator, private string $enclosure, private string $escape)
+		{
+		$this->rewind();
+		}
+
+	/** @return array<string, string> */
+	public function current() : array
+		{
+		return $this->current;
+		}
+
+	/**
+	 * @return int index of the record in the CSV stream. Zero is index of first data record. -1 means the CSV stream is empty
+	 */
+	public function key() : int
+		{
+		return $this->index;
+		}
+
+	/**
+	 * Load the next record in the stream
+	 */
+	public function next() : void
+		{
+		$this->current = [];
+
+		if ($this->stream)
+			{
+			$array = \fgetcsv($this->stream, 0, $this->separator, $this->enclosure, $this->escape);
+
+			if ($array)
+				{
+				++$this->index;
+
+				if ($this->headers)
+					{
+					foreach ($this->headers as $index => $header)
+						{
+						if (isset($array[$index]))
+							{
+							$this->current[$header] = $array[$index];
+							}
+						else
+							{
+							break;
+							}
+						}
+					}
+				else
+					{
+					$this->current = $array;
+					}
+				}
+			}
+		}
+
+	/**
+	 * rewind the reader to the first record
+	 */
+	public function rewind() : void
+		{
+		$this->index = -1;
+		$this->open();
+
+		if ($this->stream)
+			{
+			\rewind($this->stream);
+
+			if ($this->headerRow)
+				{
+				$this->headers = \fgetcsv($this->stream, 0, $this->separator, $this->enclosure, $this->escape);
+				}
+			}
+		$this->next();
+		}
+
+	/**
+	 * You can specify headers if your file does not include them.  The headers will be used as the key in the returned associative array for each record.
+	 *
+	 * @param array<string> $headers of strings
+	 */
+	public function setHeaders(array $headers) : static
+		{
+		$this->headers = $headers;
+
+		return $this;
+		}
+
+	public function valid() : bool
+		{
+		return $this->current && $this->stream;
+		}
+
+	/**
+	 * Override the open method to support your data type
+	 */
+	protected function open() : static
+		{
+		return $this;
+		}
+	}

SOB/CSV/StreamReader.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * A simple CSV reader based on an already open stream
+ *
+ * @inheritDoc
+ */
+class StreamReader extends Reader
+	{
+	/**
+	 * @param ?resource $stream
+	 */
+	public function __construct(protected $stream, bool $headerRow = true, string $separator = ',', string $enclosure = '"', string $escape = '\\')
+		{
+		parent::__construct($stream, $headerRow, $separator, $enclosure, $escape);
+		$this->rewind();
+		}
+	}

SOB/CSV/StreamWriter.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * Since the \CSV\Writer works perfectly for streams, just make a new type since we can't make instantiate an abstract class
+ *
+ * User is responsible for opening and closing the stream.
+ */
+class StreamWriter extends Writer
+	{
+	}

SOB/CSV/StringReader.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * A simple CSV reader based on CSV data in a string
+ *
+ * @inheritDoc
+ */
+class StringReader extends Reader
+	{
+	public function __construct(private readonly string $data, bool $headerRow = true, string $separator = ',', string $enclosure = '"', string $escape = '\\')
+		{
+		parent::__construct(null, $headerRow, $separator, $enclosure, $escape);
+		}
+
+	protected function open() : static
+		{
+		if ($this->stream)
+			{
+			\fclose($this->stream);
+			}
+		$this->stream = \fopen('php://memory', 'r+');
+		\fwrite($this->stream, $this->data);
+
+		return $this;
+		}
+	}

SOB/CSV/StringWriter.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace SOB\CSV;
+
+/**
+ * \CSV\StringWriter
+ *
+ * uses __toString for output of CSV data
+ */
+class StringWriter extends Writer implements \Stringable
+	{
+	/**
+	 * @var resource $out stream for output
+	 */
+	private $out;
+
+	/**
+	 * Create a \CSV\StringWriter
+	 */
+	public function __construct(string $separator = ',', string $enclosure = '"', string $escape = '\\', string $eol = "\n")
+		{
+		$this->out = \fopen('php://memory', 'w');
+		parent::__construct($this->out, $separator, $enclosure, $escape, $eol);
+		}
+
+	public function __toString() : string
+		{
+		\rewind($this->out);
+
+		return \stream_get_contents($this->out);
+		}
+	}