Ability to export existing models as sync files

Bump league/flysystem from 1.1.3 to 1.1.4

.github/workflows/phpunit.yml

@@ -0,0 +1,20 @@
+name: PHPUnit
+
+on: [push]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: php-actions/composer@v5
+
+      - name: PHPUnit Tests
+        uses: php-actions/phpunit@v2
+        with:
+          php_extensions: xdebug mbstring
+          bootstrap: vendor/autoload.php
+          configuration: phpunit.xml
+          args: --coverage-text

composer.json

@@ -10,10 +10,10 @@
     ],
     "require": {
         "ext-json": "*",
-        "php": "^7.2|^8.0"
+        "php": "^8.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^5.0"
+        "orchestra/testbench": "^7.0"
     },
     "autoload": {
         "psr-4" : {

config/data-sync.php

@@ -1,7 +1,19 @@
 <?php
 
 return [
+    /**
+     * Namespace for Laravel Models
+     */
+    'namespace' => '\\App\\Models\\',
+
+    /**
+     * Path to directory containing JSON files for synchronization
+     */
     'path'  => base_path('sync'),
+
+    /**
+     * Array of Model names which controls the synchronization order
+     */
     'order' => [
         //
     ],

phpunit.xml

@@ -1,21 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false"
+         stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
     <testsuites>
         <testsuite name="Unit">
             <directory suffix="Test.php">./tests/Unit</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
 </phpunit>

src/Console/Commands/Export.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace nullthoughts\LaravelDataSync\Console\Commands;
+
+use nullthoughts\LaravelDataSync\Exporter;
+use Illuminate\Console\Command;
+
+class Export extends Command
+{
+    protected $signature = 'data:export {model} {--criteria=*} {--except=*} {--only=*}';
+
+    protected $description = 'Export Model data for synchronization';
+
+    public function handle()
+    {
+        $model = $this->argument('model');
+
+        $this->info('Exporting ' . $model . ' model to sync data file');
+
+        (new Exporter($model, $this->option('criteria'), $this->option('except'), $this->option('only')))->run();
+
+        $this->comment('Export for data sync completed');
+    }
+}

src/DataSyncBaseServiceProvider.php

@@ -17,6 +17,7 @@ class DataSyncBaseServiceProvider extends ServiceProvider
     {
         $this->commands([
             Console\Commands\Sync::class,
+            Console\Commands\Export::class,
         ]);
     }
 

src/Exporter.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace nullthoughts\LaravelDataSync;
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Support\Facades\Storage;
+use nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException;
+
+class Exporter
+{
+    private $modelName;
+
+    private $criteria;
+
+    private $except;
+
+    private $only;
+
+    /**
+     * Get files in sync directory.
+     *
+     * @param  string  $model
+     * @param  array  $criteria
+     *
+     * @throws \nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
+     */
+    public function __construct(string $modelName, array $criteria = [], $except = [], $only = [])
+    {
+        $this->modelName = $modelName;
+        $this->criteria = $criteria;
+        $this->except = $except;
+        $this->only = $only;
+    }
+
+    /**
+     * Export Model data to sync file.
+     *
+     * @return mixed
+     */
+    public function run()
+    {
+        $class = config('data-sync.namespace', '\\App\\Models\\') . $this->modelName;
+        $filename = $this->getDirectory() . '/' . $this->modelName . '.json';
+        $data = $this->prepareData($class);
+
+        file_put_contents($filename, $data);
+    }
+
+    /**
+     * Get directory path for sync files.
+     *
+     * @throws \nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
+     *
+     * @return string
+     */
+    protected function getDirectory()
+    {
+        $directory = config('data-sync.path', base_path('sync'));
+
+        if (! file_exists($directory)) {
+            throw new FileDirectoryNotFoundException();
+        }
+
+        return $directory;
+    }
+
+    protected function prepareData($class)
+    {
+        $class = new $class;
+        $keys = $this->prepareKeys($class);
+
+        return $class->select($keys)->get()->toJson();
+    }
+
+    protected function prepareKeys($class)
+    {
+        $keys = Schema::getColumnListing($class->getTable());
+
+        if ($this->only) {
+            $keys = array_intersect($keys, $this->only);
+        }
+
+        if ($this->except) {
+            $keys = array_diff($keys, $this->except);
+        }
+        
+
+        return collect($keys)->map(function ($key) {
+            if (in_array($key, $this->criteria)) {
+                return $key . ' as _' . $key;
+            }
+
+            return $key;
+        })->toArray();
+    }
+}

src/Updater.php

@@ -10,7 +10,6 @@ use nullthoughts\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
 use nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException;
 use nullthoughts\LaravelDataSync\Exceptions\NoCriteriaException;
 use nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException;
-use stdClass;
 
 class Updater
 {
@@ -37,7 +36,7 @@ class Updater
     /**
      * @var string
      */
-    private $baseNamespace = '\\App\\';
+    private $modelNamespace;
 
     /**
      * Get files in sync directory.
@@ -54,6 +53,7 @@ class Updater
     {
         $this->remote = $remote;
         $this->disk = $disk;
+        $this->modelNamespace = config('data-sync.namespace', '\\App\\Models\\');
 
         $this->directory = $this->getDirectory($path);
         $this->files = $this->getFiles($this->directory, $model);
@@ -66,7 +66,7 @@ class Updater
      */
     public function setNamespace($namespace)
     {
-        $this->baseNamespace = $namespace;
+        $this->modelNamespace = $namespace;
     }
 
     /**
@@ -195,13 +195,13 @@ class Updater
     /**
      * Filter record criteria.
      *
-     * @param stdClass $record
+     * @param object $record
      *
      * @throws \nullthoughts\LaravelDataSync\Exceptions\NoCriteriaException
      *
      * @return \Illuminate\Support\Collection
      */
-    protected function getCriteria(stdClass $record)
+    protected function getCriteria(object $record)
     {
         $criteria = collect($record)->filter(function ($value, $key) {
             return $this->isCriteria($key);
@@ -219,11 +219,11 @@ class Updater
     /**
      * Filter record values.
      *
-     * @param stdClass $record
+     * @param object $record
      *
      * @return \Illuminate\Support\Collection
      */
-    protected function getValues(stdClass $record)
+    protected function getValues(object $record)
     {
         return collect($record)->reject(function ($value, $key) {
             if ($this->isCriteria($key)) {
@@ -247,7 +247,7 @@ class Updater
      */
     protected function getModel(string $name)
     {
-        return $this->baseNamespace.Str::studly(pathinfo($name, PATHINFO_FILENAME));
+        return $this->modelNamespace . Str::studly(pathinfo($name, PATHINFO_FILENAME));
     }
 
     /**
@@ -288,11 +288,11 @@ class Updater
      * Return ID for nested key-value pairs.
      *
      * @param string $key
-     * @param stdClass $values
+     * @param object $values
      *
      * @return array
      */
-    protected function resolveId(string $key, stdClass $values)
+    protected function resolveId(string $key, object $values)
     {
         $model = $this->getModel($key);