Merge pull request #11 from mateusjunges/junges-patch-1

Apply fixes from StyleCI and refactor readme

config/data-sync.php

@@ -4,5 +4,5 @@ return [
     'path'  => base_path('sync'),
     'order' => [
         //
-    ]
+    ],
 ];

readme.md

@@ -1,9 +1,30 @@
+<p align="center">
+<a href="https://packagist.org/packages/distinctm/laravel-data-sync" target="_blank"><img src="https://poser.pugx.org/distinctm/laravel-data-sync/d/total.svg" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/distinctm/laravel-data-sync" target="_blank"><img src="https://poser.pugx.org/distinctm/laravel-data-sync/v/stable.svg" alt="Latest Stable Version"></a>
+</p>
+
 # Laravel Data Sync
 
 Laravel utility to keep records synced between environments through source control
 
-## Installation & Usage
+## Installation 
-- Via composer: `composer require distinctm/laravel-data-sync`
+You can install this package via composer:
+```bash
+composer require distinctm/laravel-data-sync
+``` 
+
+Or add this line in your `composer.json`, inside of the `require` section:
+
+``` json
+{
+    "require": {
+        "distinctm/laravel-data-sync": "^1.0",
+    }
+}
+```
+then run ` composer install `
+
+## Usage
 - Run `php artisan vendor:publish --provider="distinctm\LaravelDataSync\DataSyncBaseServiceProvider" --tag="data-sync-config"` to publish config file. Specify directory for sync data files (default is a new sync directory in the project root)
 - Create a JSON file for each model, using the model name as the filename. Example: Product.json would update the Product model
 - Use nested arrays in place of hardcoded IDs for relationships

src/Exceptions/ErrorUpdatingModelException.php

@@ -7,7 +7,7 @@ use Throwable;
 
 class ErrorUpdatingModelException extends Exception
 {
-    public function __construct(string $message = "", int $code = 0, Throwable $previous = null)
+    public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
 

src/Exceptions/NoRecordsInvalidJSONException.php

@@ -7,7 +7,7 @@ use Throwable;
 
 class NoRecordsInvalidJSONException extends Exception
 {
-    public function __construct(string $message = "", int $code = 0, Throwable $previous = null)
+    public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
 

src/Updater.php

@@ -2,17 +2,17 @@
 
 namespace distinctm\LaravelDataSync;
 
+use distinctm\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
 use distinctm\LaravelDataSync\Exceptions\FileDirectoryNotFoundException;
 use distinctm\LaravelDataSync\Exceptions\NoCriteriaException;
 use distinctm\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\File;
-use distinctm\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
 
 class Updater
 {
     /**
-     * Get files in sync directory
+     * Get files in sync directory.
      *
      * @param string|null $path
      * @param string|null $model
@@ -26,7 +26,7 @@ class Updater
     }
 
     /**
-     * Execute syncModel for each file
+     * Execute syncModel for each file.
      *
      * @return mixed
      */
@@ -46,12 +46,13 @@ class Updater
     }
 
     /**
-     * Parse each record for criteria/values and update/create model
+     * Parse each record for criteria/values and update/create model.
      *
      * @param string $file
      *
-     * @return \Illuminate\Support\Collection
      * @throws \distinctm\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
+     *
+     * @return \Illuminate\Support\Collection
      */
     protected function syncModel(string $file)
     {
@@ -74,26 +75,27 @@ class Updater
     }
 
     /**
-     * Get directory path for sync files
+     * Get directory path for sync files.
      *
      * @param $path
      *
-     * @return string
      * @throws \distinctm\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
+     *
+     * @return string
      */
     protected function getDirectory($path)
     {
         $directory = $path ?? config('data-sync.path', base_path('sync'));
 
         if (!file_exists($directory)) {
-            throw new FileDirectoryNotFoundException;
+            throw new FileDirectoryNotFoundException();
         }
 
         return $directory;
     }
 
     /**
-     * Get list of files in directory
+     * Get list of files in directory.
      *
      * @param string      $directory
      * @param string|null $model
@@ -115,9 +117,10 @@ class Updater
     }
 
     /**
-     * Sort Models by pre-configured order
+     * Sort Models by pre-configured order.
      *
      * @param \Illuminate\Support\Collection $files
+     *
      * @return \Illuminate\Support\Collection
      */
     protected function sortModels(\Illuminate\Support\Collection $files)
@@ -139,12 +142,13 @@ class Updater
     }
 
     /**
-     * Filter record criteria
+     * Filter record criteria.
      *
      * @param object $record
      *
-     * @return \Illuminate\Support\Collection
      * @throws \distinctm\LaravelDataSync\Exceptions\NoCriteriaException
+     *
+     * @return \Illuminate\Support\Collection
      */
     protected function getCriteria(object $record)
     {
@@ -153,7 +157,7 @@ class Updater
         });
 
         if ($criteria->count() == 0) {
-            throw new NoCriteriaException;
+            throw new NoCriteriaException();
         }
 
         return $criteria->mapWithKeys(function ($value, $key) {
@@ -162,7 +166,7 @@ class Updater
     }
 
     /**
-     * Filter record values
+     * Filter record values.
      *
      * @param object $record
      *
@@ -184,7 +188,7 @@ class Updater
     }
 
     /**
-     * Returns model name for file
+     * Returns model name for file.
      *
      * @param string $name
      *
@@ -196,12 +200,13 @@ class Updater
     }
 
     /**
-     * Parses JSON from file and returns collection
+     * Parses JSON from file and returns collection.
      *
      * @param string $file
      *
-     * @return \Illuminate\Support\Collection
      * @throws \distinctm\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
+     *
+     * @return \Illuminate\Support\Collection
      */
     protected function getRecords(string $file)
     {
@@ -215,11 +220,11 @@ class Updater
     }
 
     /**
-     * Check if column is criteria for a condition match
+     * Check if column is criteria for a condition match.
      *
      * @param string $key
      *
-     * @return boolean
+     * @return bool
      */
     protected function isCriteria($key)
     {
@@ -227,7 +232,7 @@ class Updater
     }
 
     /**
-     * Return ID for nested key-value pairs
+     * Return ID for nested key-value pairs.
      *
      * @param string $key
      * @param object $values
@@ -239,7 +244,6 @@ class Updater
         $model = $this->getModel($key);
 
         $values = collect($values)->mapWithKeys(function ($value, $column) {
-
             if (is_object($value)) {
                 return $this->resolveId($column, $value);
             }
@@ -251,7 +255,7 @@ class Updater
     }
 
     /**
-     * Detect nested objects and resolve them
+     * Detect nested objects and resolve them.
      *
      * @param \Illuminate\Support\Collection $record
      *
@@ -267,5 +271,4 @@ class Updater
             return [$key => $value];
         })->toArray();
     }
-
 }

tests/TestCase.php

@@ -12,7 +12,7 @@ class TestCase extends \Orchestra\Testbench\TestCase
         $app['config']->set('database.default', 'testdb');
         $app['config']->set('database.connections.testdb', [
             'driver'   => 'sqlite',
-            'database' => ':memory:'
+            'database' => ':memory:',
         ]);
     }
 

tests/Unit/UpdaterTest.php

@@ -2,9 +2,9 @@
 
 namespace distinctm\LaravelDataSync\Tests;
 
+use distinctm\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
 use distinctm\LaravelDataSync\Tests\Fakes\UpdaterFake;
 use Exception;
-use distinctm\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
 
 class UpdaterTest extends TestCase
 {
@@ -69,7 +69,6 @@ class UpdaterTest extends TestCase
             new UpdaterFake();
 
             $this->fail('exception was thrown');
-
         } catch (Exception $e) {
             $this->assertEquals('Specified sync file directory does not exist', $e->getMessage());
         }
@@ -83,7 +82,6 @@ class UpdaterTest extends TestCase
             $updater->run();
 
             $this->fail('exception was thrown');
-
         } catch (Exception $e) {
             $this->assertContains('No records or invalid JSON for', $e->getMessage());
         }
@@ -97,7 +95,6 @@ class UpdaterTest extends TestCase
             $updater->run();
 
             $this->fail('exception was thrown');
-
         } catch (Exception $e) {
             $this->assertEquals('No criteria/attributes detected', $e->getMessage());
         }
@@ -108,7 +105,7 @@ class UpdaterTest extends TestCase
     {
         config()->set('data-sync.order', [
             'Supervisor',
-            'Roles'
+            'Roles',
         ]);
 
         $updater = new UpdaterFake(__DIR__.'/../test-data/ordered');
@@ -123,7 +120,7 @@ class UpdaterTest extends TestCase
     {
         config()->set('data-sync.order', [
             'Roles',
-            'Supervisor'
+            'Supervisor',
         ]);
 
         $this->expectException(ErrorUpdatingModelException::class);