Merge pull request #6 from ellgreen/loads-files-model-trait

Add LoadsFiles Trait for Models

Author: ellgreen

README.md

@@ -102,6 +102,43 @@ LoadFile::connection('mysql')
     ->load();
 ```
 
+## Loading data into Eloquent Models
+
+Simply add the `LoadsFiles` trait to your model like so:
+
+```php
+use EllGreen\LaravelLoadFile\Laravel\Traits\LoadsFiles;
+
+class User extends Model
+{
+    use LoadsFiles;
+}
+```
+
+Then you can use the following method to load a file into that table:
+
+```php
+User::loadFile('/path/to/users.csv', $local = true);
+```
+
+### Need to specify options to load the file with?
+
+Add the following method to your Model
+
+```php
+class User extends Model
+{
+    use LoadsFiles;
+
+    public function loadFileOptions(Builder $builder): void
+    {
+        $builder
+            ->fieldsTerminatedBy(',')
+            ->ignoreLines(1);
+    }
+}
+```
+
 ## Development
 
 ### Unit tests

src/Builder/Builder.php

@@ -10,7 +10,7 @@
 
 class Builder
 {
-    use Concerns\LoadsFiles;
+    use Concerns\HasFile;
     use Concerns\ReplacesOrIgnores;
     use Concerns\HasColumns;
     use Concerns\HasFields;

src/Builder/Concerns/LoadsFiles.php renamed to src/Builder/Concerns/HasFile.php

@@ -2,7 +2,7 @@
 
 namespace EllGreen\LaravelLoadFile\Builder\Concerns;
 
-trait LoadsFiles
+trait HasFile
 {
     private ?string $file = null;
     private bool $local = false;

src/Laravel/Traits/LoadsFiles.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace EllGreen\LaravelLoadFile\Laravel\Traits;
+
+use EllGreen\LaravelLoadFile\Builder\Builder;
+use EllGreen\LaravelLoadFile\Exceptions\CompilationException;
+
+trait LoadsFiles
+{
+    /**
+     * @throws CompilationException
+     */
+    public static function loadFile(string $file, ?bool $local = null): bool
+    {
+        return static::loadFileBuilder($file, $local)->load();
+    }
+
+    public static function loadFileBuilder(string $file, ?bool $local = null): Builder
+    {
+        /** @var Builder $builder */
+        $builder = app(Builder::class);
+
+        $model = app(static::class);
+        $builder->file($file, $local)->into($model->getTable());
+
+        $model->loadFileOptions($builder);
+
+        return $builder;
+    }
+
+    public function loadFileOptions(Builder $builder): void
+    {
+        //
+    }
+
+    abstract public function getTable();
+}

tests/Feature/LoadsFilesTraitTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Tests\Feature;
+
+use EllGreen\LaravelLoadFile\Builder\Builder;
+use Tests\Feature\Models\TestUser;
+use Tests\Feature\Models\TestUserNoOptions;
+
+class LoadsFilesTraitTest extends TestCase
+{
+    public function testGetBuilder(): void
+    {
+        $builder = TestUser::loadFileBuilder('/path/to/test_users.csv', true);
+
+        $this->assertSame('test_users', $builder->getTable());
+    }
+
+    public function testGetBuilderWithOptions(): void
+    {
+        $builder = TestUser::loadFileBuilder('/path/to/test_users.csv', true);
+
+        $this->assertTrue($builder->isReplace());
+    }
+
+    public function testDefaultLoadFileOptions()
+    {
+        $builder = TestUserNoOptions::loadFileBuilder('/path/to/test_users.csv', true);
+
+        $this->assertFalse($builder->isReplace());
+    }
+
+    public function testLoadFile(): void
+    {
+        $this->instance(Builder::class, $builder = $this->createPartialMock(Builder::class, [
+            'load',
+        ]));
+
+        $builder->method('load')->willReturn(true);
+
+        $result = TestUser::loadFile('/path/to/employees.csv', true);
+        $this->assertTrue($result);
+    }
+}

tests/Feature/Models/TestUser.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tests\Feature\Models;
+
+use EllGreen\LaravelLoadFile\Builder\Builder;
+use EllGreen\LaravelLoadFile\Laravel\Traits\LoadsFiles;
+use Illuminate\Database\Eloquent\Model;
+
+class TestUser extends Model
+{
+    use LoadsFiles;
+
+    public function loadFileOptions(Builder $builder): void
+    {
+        $builder->replace();
+    }
+}

tests/Feature/Models/TestUserNoOptions.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Tests\Feature\Models;
+
+use EllGreen\LaravelLoadFile\Laravel\Traits\LoadsFiles;
+use Illuminate\Database\Eloquent\Model;
+
+class TestUserNoOptions extends Model
+{
+    use LoadsFiles;
+}

tests/Unit/Builder/Concerns/LoadsFilesTest.php renamed to tests/Unit/Builder/Concerns/HasFileTest.php

@@ -2,20 +2,20 @@
 
 namespace Tests\Unit\Builder\Concerns;
 
-use EllGreen\LaravelLoadFile\Builder\Concerns\LoadsFiles;
+use EllGreen\LaravelLoadFile\Builder\Concerns\HasFile;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-class LoadsFilesTest extends TestCase
+class HasFileTest extends TestCase
 {
-    /** @var MockObject|LoadsFiles */
+    /** @var MockObject|HasFile */
     private MockObject $loadsFiles;
 
     protected function setUp(): void
     {
         parent::setUp();
 
-        $this->loadsFiles = $this->getMockForTrait(LoadsFiles::class);
+        $this->loadsFiles = $this->getMockForTrait(HasFile::class);
     }
 
     public function testSetFile()