Merge pull request #27 from laravel-enso/refactor/insightsUpdates

aocneanu · web-flow · commit f361977993b6 · 2019-12-13T09:54:21.000+02:00
Refactor/insights updates
diff --git a/src/AppServiceProvider.php b/src/AppServiceProvider.php
@@ -30,6 +30,14 @@ private function load()
     }
 
     private function publish()
+    {
+        $this->publishConfig()
+            ->publishFactories()
+            ->publishExamples()
+            ->publishEmailViews();
+    }
+
+    private function publishConfig()
     {
         $this->publishes([
             __DIR__.'/config' => config_path('enso'),
@@ -39,6 +47,11 @@ private function publish()
             __DIR__.'/config' => config_path('enso'),
         ], 'enso-config');
 
+        return $this;
+    }
+
+    private function publishFactories()
+    {
         $this->publishes([
             __DIR__.'/database/factories' => database_path('factories'),
         ], 'data-import-factory');
@@ -47,18 +60,30 @@ private function publish()
             __DIR__.'/database/factories' => database_path('factories'),
         ], 'enso-factories');
 
-        $this->publishes([
-            __DIR__.'/../stubs/Imports/Importers/ExampleImporter.stub' => app_path('Imports/Importers/ExampleImporter.php'),
-            __DIR__.'/../stubs/Imports/Templates/exampleTemplate.stub' => app_path('Imports/Templates/exampleTemplate.json'),
-            __DIR__.'/../stubs/Imports/Validators/CustomValidator.stub' => app_path('Imports/Validators/CustomValidator.php'),
-        ], 'data-import-examples');
+        return $this;
+    }
 
+    private function publishEmailViews()
+    {
         $this->publishes([
             __DIR__.'/resources/views' => resource_path('views/vendor/laravel-enso/data-import'),
         ], 'data-import-mail');
 
         $this->publishes([
             __DIR__.'/resources/views' => resource_path('views/vendor/laravel-enso/data-import'),
         ], 'enso-mail');
+
+        return $this;
+    }
+
+    private function publishExamples()
+    {
+        $this->publishes([
+            __DIR__.'/../stubs/Imports/Importers/ExampleImporter.stub' => app_path('Imports/Importers/ExampleImporter.php'),
+            __DIR__.'/../stubs/Imports/Templates/exampleTemplate.stub' => app_path('Imports/Templates/exampleTemplate.json'),
+            __DIR__.'/../stubs/Imports/Validators/CustomValidator.stub' => app_path('Imports/Validators/CustomValidator.php'),
+        ], 'data-import-examples');
+
+        return $this;
     }
 }
diff --git a/src/app/Attributes/Column.php b/src/app/Attributes/Column.php
@@ -4,7 +4,7 @@
 
 class Column
 {
-    const Mandatory = ['name'];
+    public const Mandatory = ['name'];
 
-    const Optional = ['validations'];
+    public const Optional = ['validations'];
 }
diff --git a/src/app/Attributes/Sheet.php b/src/app/Attributes/Sheet.php
@@ -4,7 +4,7 @@
 
 class Sheet
 {
-    const Mandatory = ['name', 'columns', 'importerClass'];
+    public const Mandatory = ['name', 'columns', 'importerClass'];
 
-    const Optional = ['validatorClass', 'chunkSize'];
+    public const Optional = ['validatorClass', 'chunkSize'];
 }
diff --git a/src/app/Attributes/Template.php b/src/app/Attributes/Template.php
@@ -4,5 +4,5 @@
 
 class Template
 {
-    const Attributes = ['sheets', 'timeout'];
+    public const Attributes = ['sheets', 'timeout'];
 }
diff --git a/src/app/Enums/ImportTypes.php b/src/app/Enums/ImportTypes.php
@@ -3,7 +3,7 @@
 namespace LaravelEnso\DataImport\app\Enums;
 
 use Exception;
-use LaravelEnso\DataImport\app\Exceptions\DataImportException;
+use LaravelEnso\DataImport\app\Exceptions\DataImport;
 use LaravelEnso\Enums\app\Services\Enum;
 
 class ImportTypes extends Enum
@@ -15,8 +15,8 @@ public static function attributes()
                 array_keys(config('enso.imports.configs')),
                 array_column(config('enso.imports.configs'), 'label')
             );
-        } catch (Exception $e) {
-            throw DataImportException::configNotReadable();
+        } catch (Exception $exception) {
+            throw DataImport::configNotReadable();
         }
 
         return $data;
diff --git a/src/app/Enums/Statuses.php b/src/app/Enums/Statuses.php
@@ -6,8 +6,8 @@
 
 class Statuses extends IOStatuses
 {
-    const Processed = 23;
-    const ExportingRejected = 26;
+    public const Processed = 23;
+    public const ExportingRejected = 26;
 
     protected static $data = [
         IOStatuses::Waiting => 'Waiting',
diff --git a/src/app/Exceptions/DataImport.php b/src/app/Exceptions/DataImport.php
@@ -4,7 +4,7 @@
 
 use LaravelEnso\Helpers\app\Exceptions\EnsoException;
 
-class DataImportException extends EnsoException
+class DataImport extends EnsoException
 {
     public static function configNotReadable()
     {
diff --git a/src/app/Exceptions/Template.php b/src/app/Exceptions/Template.php
@@ -6,7 +6,7 @@
 use LaravelEnso\Helpers\app\Classes\Obj;
 use LaravelEnso\Helpers\app\Exceptions\EnsoException;
 
-class TemplateException extends EnsoException
+class Template extends EnsoException
 {
     public static function missingRootAttributes($attrs)
     {
diff --git a/src/app/Jobs/ChunkImportJob.php b/src/app/Jobs/ChunkImportJob.php
@@ -18,6 +18,8 @@ class ChunkImportJob implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
+    public $queue;
+
     private $dataImport;
     private $template;
     private $user;
@@ -26,10 +28,14 @@ class ChunkImportJob implements ShouldQueue
     private $chunk;
     private $index;
 
-    public $queue;
-
-    public function __construct(DataImport $dataImport, Template $template, User $user, Obj $params, string $sheetName, Collection $chunk)
-    {
+    public function __construct(
+        DataImport $dataImport,
+        Template $template,
+        User $user,
+        Obj $params,
+        string $sheetName,
+        Collection $chunk
+    ) {
         $this->dataImport = $dataImport;
         $this->template = $template;
         $this->user = $user;
diff --git a/src/app/Jobs/ImportJob.php b/src/app/Jobs/ImportJob.php
@@ -16,14 +16,14 @@ class ImportJob implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
+    public $queue;
+    public $timeout;
+
     private $dataImport;
     private $params;
     private $template;
     private $user;
 
-    public $queue;
-    public $timeout;
-
     public function __construct(DataImport $dataImport, Template $template, array $params = [])
     {
         $this->dataImport = $dataImport;
diff --git a/src/app/Jobs/RejectedExportJob.php b/src/app/Jobs/RejectedExportJob.php
@@ -16,12 +16,12 @@ class RejectedExportJob implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    private $dataImport;
-    private $user;
-
     public $queue;
     public $timeout;
 
+    private $dataImport;
+    private $user;
+
     public function __construct(DataImport $dataImport, User $user)
     {
         $this->dataImport = $dataImport;
diff --git a/src/app/Models/DataImport.php b/src/app/Models/DataImport.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Storage;
 use LaravelEnso\DataImport\app\Enums\ImportTypes;
 use LaravelEnso\DataImport\app\Enums\Statuses;
-use LaravelEnso\DataImport\app\Exceptions\DataImportException;
+use LaravelEnso\DataImport\app\Exceptions\DataImport as DataImportException;
 use LaravelEnso\DataImport\app\Jobs\ImportJob;
 use LaravelEnso\DataImport\app\Services\Structure;
 use LaravelEnso\DataImport\app\Services\Template;
@@ -44,7 +44,7 @@ public function rejected()
     public function handle(UploadedFile $file, array $params = [])
     {
         $template = new Template($this);
-        $structure = new Structure($this, $template, $file);
+        $structure = new Structure($template, $file);
 
         if ($structure->validates()) {
             tap($this)->save()
diff --git a/src/app/Notifications/ImportDone.php b/src/app/Notifications/ImportDone.php
@@ -42,7 +42,7 @@ public function toMail($notifiable)
             ->subject($this->mailSubject())
             ->markdown('laravel-enso/data-import::emails.import', [
                 'name' => $notifiable->person->appellative
-                    ?: $notifiable->person->name,
+                    ?? $notifiable->person->name,
                 'filename' => $this->filename(),
                 'type' => $this->type(),
                 'successful' => $this->dataImport->successful,
diff --git a/src/app/Services/ExcelSeeder.php b/src/app/Services/ExcelSeeder.php
@@ -15,8 +15,6 @@ class ExcelSeeder extends Seeder
 
     public function run()
     {
-        // DataImport::reguard(); //TODO test!
-
         factory(DataImport::class)->create([
             'type' => $this->type,
             'status' => Statuses::Waiting,
@@ -25,6 +23,7 @@ public function run()
 
     private function importFile()
     {
+        //TODO refactor
         return new UploadedFile(
             Storage::path('seeds'.DIRECTORY_SEPARATOR.$this->filename),
             $this->filename,
diff --git a/src/app/Services/Importers/Chunk.php b/src/app/Services/Importers/Chunk.php
@@ -32,7 +32,8 @@ class Chunk
     private $validator;
     private $importer;
 
-    public function __construct(DataImport $dataImport, Template $template, User $user, Obj $params, string $sheetName, Collection $chunk, int $index)
+    public function __construct(DataImport $dataImport, Template $template, User $user, Obj $params,
+        string $sheetName, Collection $chunk, int $index)
     {
         $this->dataImport = $dataImport;
         $this->template = $template;
diff --git a/src/app/Services/Importers/Import.php b/src/app/Services/Importers/Import.php
@@ -5,7 +5,6 @@
 use Carbon\Carbon;
 use DateTime;
 use LaravelEnso\Core\app\Models\User;
-use LaravelEnso\DataImport\app\Contracts\AfterHook;
 use LaravelEnso\DataImport\app\Contracts\BeforeHook;
 use LaravelEnso\DataImport\app\Jobs\ChunkImportJob;
 use LaravelEnso\DataImport\app\Models\DataImport;
@@ -113,7 +112,7 @@ private function prepareChunk()
 
             $this->rowIterator->next();
 
-            if ($this->sheetHasFinished()) {
+            if ($this->fileHasFinished()) {
                 $this->dataImport->update(['file_parsed' => true]);
 
                 break;
@@ -191,13 +190,4 @@ private function closeReader()
 
         return $this;
     }
-
-    private function afterHook()
-    {
-        $importer = $this->template->importer($this->sheetName);
-
-        if ($importer instanceof AfterHook) {
-            $importer->after($this->user, $this->params);
-        }
-    }
 }
diff --git a/src/app/Services/Reader/XLSX.php b/src/app/Services/Reader/XLSX.php
@@ -7,7 +7,7 @@
 use Box\Spout\Reader\Common\Creator\ReaderEntityFactory;
 use Exception;
 use Illuminate\Support\Str;
-use LaravelEnso\DataImport\app\Exceptions\DataImportException;
+use LaravelEnso\DataImport\app\Exceptions\DataImport;
 
 class XLSX
 {
@@ -25,7 +25,7 @@ public function open()
         try {
             $this->reader->open($this->file);
         } catch (Exception $exception) {
-            throw DataImportException::fileNotReadable();
+            throw DataImport::fileNotReadable();
         }
 
         return $this;
@@ -61,7 +61,7 @@ protected function sheet($sheetName)
 
     protected function normalizeSheet($string)
     {
-        return Str::snake(Str::lower(($string)));
+        return Str::snake(Str::lower($string));
     }
 
     protected function normalizeHeader(Row $row)
diff --git a/src/app/Services/Structure.php b/src/app/Services/Structure.php
@@ -3,20 +3,17 @@
 namespace LaravelEnso\DataImport\app\Services;
 
 use Illuminate\Http\UploadedFile;
-use LaravelEnso\DataImport\app\Models\DataImport;
 use LaravelEnso\DataImport\app\Services\Reader\Structure as Reader;
 use LaravelEnso\DataImport\app\Services\Validators\Structure as Validator;
 
 class Structure
 {
-    private $dataImport;
     private $file;
     private $summary;
     private $template;
 
-    public function __construct(DataImport $dataImport, Template $template, UploadedFile $file)
+    public function __construct(Template $template, UploadedFile $file)
     {
-        $this->dataImport = $dataImport;
         $this->template = $template;
         $this->file = $file;
         $this->summary = new Summary($this->file->getClientOriginalName());
diff --git a/src/app/Services/Template.php b/src/app/Services/Template.php
@@ -67,15 +67,15 @@ public function importer($sheetName)
     {
         $class = $this->sheet($sheetName)->get('importerClass');
 
-        return new $class;
+        return new $class();
     }
 
     public function customValidator($sheetName)
     {
         if ($this->sheet($sheetName)->has('validatorClass')) {
             $class = $this->sheet($sheetName)->get('validatorClass');
 
-            return new $class;
+            return new $class();
         }
     }
 
diff --git a/src/app/Services/Validators/Row.php b/src/app/Services/Validators/Row.php
@@ -18,6 +18,13 @@ public function run(Obj $row)
         }
     }
 
+    public function rules(array $rules)
+    {
+        $this->rules = $rules;
+
+        return $this;
+    }
+
     private function addErrors()
     {
         collect($this->rules)->keys()->each(function ($column) {
@@ -29,11 +36,4 @@ private function addErrors()
             }
         });
     }
-
-    public function rules(array $rules)
-    {
-        $this->rules = $rules;
-
-        return $this;
-    }
 }
diff --git a/src/app/Services/Validators/Template.php b/src/app/Services/Validators/Template.php
diff --git a/src/routes/api.php b/src/routes/api.php
diff --git a/src/routes/app/imports.php b/src/routes/app/imports.php
diff --git a/src/routes/app/rejected.php b/src/routes/app/rejected.php
diff --git a/src/routes/app/template.php b/src/routes/app/template.php
diff --git a/tests/features/DataImportTest.php b/tests/features/DataImportTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`class Column`
`6`	`6`	`{`
`7`		`- const Mandatory = ['name'];`
	`7`	`+ public const Mandatory = ['name'];`
`8`	`8`
`9`		`- const Optional = ['validations'];`
	`9`	`+ public const Optional = ['validations'];`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`class Sheet`
`6`	`6`	`{`
`7`		`- const Mandatory = ['name', 'columns', 'importerClass'];`
	`7`	`+ public const Mandatory = ['name', 'columns', 'importerClass'];`
`8`	`8`
`9`		`- const Optional = ['validatorClass', 'chunkSize'];`
	`9`	`+ public const Optional = ['validatorClass', 'chunkSize'];`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`
`5`	`5`	`class Template`
`6`	`6`	`{`
`7`		`- const Attributes = ['sheets', 'timeout'];`
	`7`	`+ public const Attributes = ['sheets', 'timeout'];`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`
`7`	`7`	`class Statuses extends IOStatuses`
`8`	`8`	`{`
`9`		`- const Processed = 23;`
`10`		`- const ExportingRejected = 26;`
	`9`	`+ public const Processed = 23;`
	`10`	`+ public const ExportingRejected = 26;`
`11`	`11`
`12`	`12`	`protected static $data = [`
`13`	`13`	`IOStatuses::Waiting => 'Waiting',`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use LaravelEnso\Helpers\app\Exceptions\EnsoException;`
`6`	`6`
`7`		`-class DataImportException extends EnsoException`
	`7`	`+class DataImport extends EnsoException`
`8`	`8`	`{`
`9`	`9`	`public static function configNotReadable()`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use LaravelEnso\Helpers\app\Classes\Obj;`
`7`	`7`	`use LaravelEnso\Helpers\app\Exceptions\EnsoException;`
`8`	`8`
`9`		`-class TemplateException extends EnsoException`
	`9`	`+class Template extends EnsoException`
`10`	`10`	`{`
`11`	`11`	`public static function missingRootAttributes($attrs)`
`12`	`12`	`{`