Skip to content

Commit 5759629

Browse files
vicgonvtvicgonvt
authored
Merge pull request #25 from vicgonvt/feature_storage_json
Adds the ability to have the json files stored remotely
2 parents b177e8d + 0ab4a4f commit 5759629

File tree

2 files changed

+233
-17
lines changed

2 files changed

+233
-17
lines changed

‎src/Updater.php‎

Lines changed: 73 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,56 @@
22

33
namespace nullthoughts\LaravelDataSync;
44

5+
use Illuminate\Support\Collection;
6+
use Illuminate\Support\Facades\File;
7+
use Illuminate\Support\Facades\Storage;
8+
use Illuminate\Support\Str;
59
use nullthoughts\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
610
use nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException;
711
use nullthoughts\LaravelDataSync\Exceptions\NoCriteriaException;
812
use nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException;
9-
use Illuminate\Support\Collection;
10-
use Illuminate\Support\Facades\File;
11-
use Illuminate\Support\Str;
1213
use stdClass;
1314

1415
class Updater
1516
{
17+
/**
18+
* @var string
19+
*/
20+
private $directory;
21+
22+
/**
23+
* @var \Illuminate\Support\Collection
24+
*/
25+
private $files;
26+
27+
/**
28+
* @var bool
29+
*/
30+
private $remote;
31+
32+
/**
33+
* @var string
34+
*/
35+
private $disk;
36+
1637
/**
1738
* Get files in sync directory.
1839
*
19-
* @param string|null $path
20-
* @param string|null $model
40+
* @param string|null $path
41+
* @param string|null $model
42+
*
43+
* @param bool $remote
44+
* @param string $disk
2145
*
2246
* @throws \nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
2347
*/
24-
public function __construct($path = null, $model = null)
48+
public function __construct($path = null, $model = null, $remote = false, $disk = 's3')
2549
{
26-
$directory = $this->getDirectory($path);
27-
$this->files = $this->getFiles($directory, $model);
50+
$this->remote = $remote;
51+
$this->disk = $disk;
52+
53+
$this->directory = $this->getDirectory($path);
54+
$this->files = $this->getFiles($this->directory, $model);
2855
}
2956

3057
/**
@@ -50,11 +77,11 @@ public function run()
5077
/**
5178
* Parse each record for criteria/values and update/create model.
5279
*
53-
* @param string $file
54-
*
55-
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
80+
* @param string $file
5681
*
5782
* @return \Illuminate\Support\Collection
83+
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
84+
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
5885
*/
5986
protected function syncModel(string $file)
6087
{
@@ -89,7 +116,7 @@ protected function getDirectory($path)
89116
{
90117
$directory = $path ?? config('data-sync.path', base_path('sync'));
91118

92-
if (!file_exists($directory)) {
119+
if ($this->directoryMissingLocally($directory) || $this->directoryMissingRemotely($directory)) {
93120
throw new FileDirectoryNotFoundException();
94121
}
95122

@@ -110,10 +137,17 @@ protected function getFiles(string $directory, $model = null)
110137
return Collection::wrap($directory.'/'.$model.'.json');
111138
}
112139

113-
return collect(File::files($directory))
140+
$files = ($this->remote) ? Storage::disk($this->disk)->files($directory) : File::files($directory);
141+
142+
return collect($files)
114143
->filter(function ($file) {
115144
return pathinfo($file, PATHINFO_EXTENSION) == 'json';
116145
})->map(function ($path) {
146+
147+
if (is_string($path)) {
148+
return $path;
149+
}
150+
117151
return $path->getPathname();
118152
});
119153
}
@@ -204,15 +238,17 @@ protected function getModel(string $name)
204238
/**
205239
* Parses JSON from file and returns collection.
206240
*
207-
* @param string $file
208-
*
209-
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
241+
* @param string $file
210242
*
211243
* @return \Illuminate\Support\Collection
244+
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
245+
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
212246
*/
213247
protected function getRecords(string $file)
214248
{
215-
$records = collect(json_decode(File::get($file)));
249+
$fetchedFile = ($this->remote) ? Storage::disk($this->disk)->get($file) : File::get($file);
250+
251+
$records = collect(json_decode($fetchedFile));
216252

217253
if ($records->isEmpty()) {
218254
throw new NoRecordsInvalidJSONException($file);
@@ -273,4 +309,24 @@ protected function resolveObjects(Collection $record)
273309
return [$key => $value];
274310
})->toArray();
275311
}
312+
313+
/**
314+
* @param \Illuminate\Config\Repository $directory
315+
*
316+
* @return bool
317+
*/
318+
protected function directoryMissingLocally($directory)
319+
{
320+
return !$this->remote && !file_exists($directory);
321+
}
322+
323+
/**
324+
* @param \Illuminate\Config\Repository $directory
325+
*
326+
* @return bool
327+
*/
328+
protected function directoryMissingRemotely($directory)
329+
{
330+
return $this->remote && !Storage::disk($this->disk)->exists($directory);
331+
}
276332
}

‎tests/Unit/UpdaterRemoteTest.php‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
<?php
2+
3+
namespace nullthoughts\LaravelDataSync\Tests;
4+
5+
use Illuminate\Support\Facades\File;
6+
use Illuminate\Support\Facades\Storage;
7+
use nullthoughts\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
8+
use nullthoughts\LaravelDataSync\Tests\fakes\UpdaterFake;
9+
use Exception;
10+
11+
class UpdaterRemoteTest extends TestCase
12+
{
13+
protected function setUp(): void
14+
{
15+
parent::setUp();
16+
17+
Storage::fake('s3');
18+
Storage::disk('s3')->put('test-data/roles.json', File::get(__DIR__.'/../test-data/roles.json'));
19+
foreach (File::directories(__DIR__.'/../test-data/') as $directory) {
20+
$files = File::files($directory);
21+
22+
foreach ($files as $file) {
23+
Storage::disk('s3')->put('test-data/'.basename($directory).'/'.$file->getRelativePathname(), File::get($file->getPathname()));
24+
}
25+
}
26+
}
27+
28+
/** @test */
29+
public function it_adds_roles_to_the_database_in_remote()
30+
{
31+
$updater = new UpdaterFake('test-data', 'roles', true, 's3');
32+
33+
$updater->run();
34+
35+
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
36+
$this->assertDatabaseHas('roles', ['slug' => 'borrow-ferrari']);
37+
$this->assertDatabaseHas('roles', ['slug' => 'destroy-ferrari']);
38+
}
39+
40+
/** @test */
41+
public function it_can_default_to_configuration_in_remote()
42+
{
43+
config()->set('data-sync.path', 'test-data');
44+
45+
$updater = new UpdaterFake(null, null, true, 's3');
46+
47+
$updater->run();
48+
49+
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
50+
$this->assertDatabaseHas('roles', ['slug' => 'borrow-ferrari']);
51+
$this->assertDatabaseHas('roles', ['slug' => 'destroy-ferrari']);
52+
}
53+
54+
/** @test */
55+
public function it_can_update_an_existing_record_in_remote()
56+
{
57+
config()->set('data-sync.path', 'test-data');
58+
(new UpdaterFake(null, null, true, 's3'))->run();
59+
60+
config()->set('data-sync.path', 'test-data/valid');
61+
(new UpdaterFake(null, null, true, 's3'))->run();
62+
63+
$this->assertDatabaseHas('roles', ['category' => 'changed']);
64+
$this->assertDatabaseHas('roles', ['category' => 'changed']);
65+
$this->assertDatabaseHas('roles', ['category' => 'changed']);
66+
}
67+
68+
/** @test */
69+
public function it_can_update_the_relationship_in_remote()
70+
{
71+
$supervisor = Supervisor::create([
72+
'name' => 'CEO',
73+
]);
74+
75+
config()->set('data-sync.path', 'test-data/relationship');
76+
(new UpdaterFake(null, null, true, 's3'))->run();
77+
78+
$this->assertEquals($supervisor->id, Roles::first()->supervisor_id);
79+
$this->assertTrue($supervisor->is(Roles::first()->supervisor));
80+
}
81+
82+
/**
83+
* @test
84+
* @group current
85+
*/
86+
public function exception_is_thrown_if_the_directory_does_not_exists()
87+
{
88+
try {
89+
new UpdaterFake(null, null, true, 's3');
90+
91+
$this->fail('exception was thrown');
92+
} catch (Exception $e) {
93+
$this->assertEquals('Specified sync file directory does not exist', $e->getMessage());
94+
}
95+
}
96+
97+
/** @test */
98+
public function invalid_json_throws_an_exception_in_remote()
99+
{
100+
try {
101+
$updater = new UpdaterFake('test-data/invalid-json', null, true, 's3');
102+
$updater->run();
103+
104+
$this->fail('exception was thrown');
105+
} catch (Exception $e) {
106+
$this->assertStringContainsString('No records or invalid JSON for', $e->getMessage());
107+
}
108+
}
109+
110+
/** @test */
111+
public function the_json_must_contain_a_key_with_an_underscore_in_remote()
112+
{
113+
try {
114+
$updater = new UpdaterFake('test-data/no-criteria', null, true, 's3');
115+
$updater->run();
116+
117+
$this->fail('exception was thrown');
118+
} catch (Exception $e) {
119+
$this->assertEquals('No criteria/attributes detected', $e->getMessage());
120+
}
121+
}
122+
123+
/** @test */
124+
public function order_of_imports_can_be_defined_in_config_in_remote()
125+
{
126+
config()->set('data-sync.order', [
127+
'Supervisor',
128+
'Roles',
129+
]);
130+
131+
$updater = new UpdaterFake('test-data/ordered', null, true, 's3');
132+
$updater->run();
133+
134+
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
135+
$this->assertDatabaseHas('supervisors', ['name' => 'CEO']);
136+
}
137+
138+
/** @test */
139+
public function exception_is_thrown_if_imports_are_in_incorrect_order_in_remote()
140+
{
141+
config()->set('data-sync.order', [
142+
'Roles',
143+
'Supervisor',
144+
]);
145+
146+
$this->expectException(ErrorUpdatingModelException::class);
147+
148+
$updater = new UpdaterFake('test-data/ordered', null, true, 's3');
149+
$updater->run();
150+
}
151+
152+
/** @test */
153+
public function it_ignores_non_json_files_in_remote()
154+
{
155+
$updater = new UpdaterFake('test-data/not-json', null, true, 's3');
156+
$updater->run();
157+
158+
$this->assertDatabaseMissing('roles', ['slug' => 'update-student-records']);
159+
}
160+
}

0 commit comments

Comments
 (0)