feat: csv file helper

Author: yajra

src/CsvFile.php

@@ -0,0 +1,112 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yajra\SQLLoader;
+
+final class CsvFile
+{
+    /**
+     * @param  resource  $stream
+     */
+    private function __construct(public string $file, public $stream)
+    {
+    }
+
+    public static function make(string $filename, string $mode): CsvFile
+    {
+        if (! file_exists($filename)) {
+            $filename = self::create($filename);
+        }
+
+        $stream = fopen($filename, $mode);
+
+        if ($stream === false) {
+            throw new \RuntimeException("Failed to open file [{$filename}].");
+        }
+
+        return new self($filename, $stream);
+    }
+
+    public static function create(string $file): string
+    {
+        $stream = fopen($file, 'w');
+        if ($stream === false) {
+            throw new \RuntimeException('Could not open file for writing: '.$file);
+        }
+        fclose($stream);
+
+        return $file;
+    }
+
+    public static function blank(string $file): string
+    {
+        if (file_exists($file)) {
+            unlink($file);
+        }
+
+        return self::create($file);
+    }
+
+    public function close(): void
+    {
+        $this->__destruct();
+    }
+
+    public function __destruct()
+    {
+        if (is_resource($this->stream)) {
+            fclose($this->stream);
+        }
+    }
+
+    public function headers(array $fields): CsvFile
+    {
+        if ($this->isEmpty()) {
+            $this->append(array_keys($fields));
+        }
+
+        $this->append($fields);
+
+        return $this;
+    }
+
+    public function isEmpty(): bool
+    {
+        clearstatcache(true, $this->file);
+
+        return filesize($this->file) === 0;
+    }
+
+    public function append(
+        array $fields,
+        string $separator = ',',
+        string $enclosure = '"',
+        string $escape = '\\',
+        string $eol = PHP_EOL
+    ): CsvFile {
+        fputcsv($this->stream, $fields, $separator, $enclosure, $escape, $eol);
+
+        return $this;
+    }
+
+    public function insert(array $updates): CsvFile
+    {
+        foreach ($updates as $row) {
+            $this->append($row);
+        }
+
+        return $this;
+    }
+
+    public function get(): string
+    {
+        $contents = file_get_contents($this->file);
+
+        if ($contents === false) {
+            return '';
+        }
+
+        return $contents;
+    }
+}

tests/Feature/CsvFileTest.php

@@ -0,0 +1,57 @@
+<?php
+
+use Yajra\SQLLoader\CsvFile;
+
+test('it can create a blank csv file', function () {
+    $file = CsvFile::blank(storage_path('test.csv'));
+
+    expect($file)->toBeString()
+        ->and($file)->toBe(storage_path('test.csv'))
+        ->and(file_exists($file))->toBeTrue();
+});
+
+test('it can create a csv file', function () {
+    $file = CsvFile::create(storage_path('test.csv'));
+
+    expect($file)->toBeString()
+        ->and($file)->toBe(storage_path('test.csv'))
+        ->and(file_exists($file))->toBeTrue();
+});
+
+test('it can make a csv file with array content', function () {
+    $file = CsvFile::make(storage_path('test.csv'), 'w');
+    $file->append(['id', 'name', 'email']);
+
+    expect($file)->toBeInstanceOf(CsvFile::class)
+        ->and($file->isEmpty())->toBeFalse()
+        ->and($file->get())->toContain('id,name,email'.PHP_EOL);
+});
+
+test('it can have a csv header', function () {
+    $file = CsvFile::make(storage_path('test.csv'), 'w');
+    $file->headers(['id', 'name', 'email']);
+
+    expect($file)->toBeInstanceOf(CsvFile::class)
+        ->and($file->isEmpty())->toBeFalse()
+        ->and($file->get())->toContain('id,name,email'.PHP_EOL);
+});
+
+test('it can insert data using array', function () {
+    $file = CsvFile::make(storage_path('test.csv'), 'w');
+    $file->headers(['id', 'name', 'email']);
+    $file->insert([
+        ['1', 'John Doe', '[email protected]'],
+        ['2', 'Jane Doe', 'e'],
+        ['3', 'Jane, Doe', '3'],
+        ['3', 'Jane" Doe', '3'],
+    ]);
+
+    $content = $file->get();
+
+    expect($file)->toBeInstanceOf(CsvFile::class)
+        ->and($file->isEmpty())->toBeFalse()
+        ->and($content)->toContain('1,"John Doe",[email protected]'.PHP_EOL)
+        ->and($content)->toContain('2,"Jane Doe",e'.PHP_EOL)
+        ->and($content)->toContain('3,"Jane, Doe",3'.PHP_EOL)
+        ->and($content)->toContain('3,"Jane"" Doe",3'.PHP_EOL);
+});