1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<?php
namespace Illuminate\Tests\Integration\Database;
use Illuminate\Database\Eloquent\Attributes\CollectedBy;
use Illuminate\Database\Eloquent\Attributes\ObservedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\ModelInspector;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Schema;
class ModelInspectorTest extends DatabaseTestCase
{
protected function afterRefreshingDatabase()
{
Schema::create('parent_test_models', function (Blueprint $table) {
$table->id();
});
Schema::create('model_info_extractor_test_model', function (Blueprint $table) {
$table->increments('id');
$table->uuid();
$table->string('name');
$table->boolean('a_bool');
$table->foreignId('parent_test_model_id')->constrained();
$table->timestamp('nullable_date')->nullable();
$table->timestamps();
});
}
public function test_extracts_model_data()
{
$extractor = new ModelInspector($this->app);
$modelInfo = $extractor->inspect(ModelInspectorTestModel::class);
$this->assertModelInfo($modelInfo);
$this->assertSame(ModelInspectorTestModelEloquentCollection::class, $modelInfo['collection']);
$this->assertSame(ModelInspectorTestModelBuilder::class, $modelInfo['builder']);
}
public function test_command_returns_json()
{
$this->withoutMockingConsoleOutput()->artisan('model:show', ['model' => ModelInspectorTestModel::class, '--json' => true]);
$o = Artisan::output();
$this->assertJson($o);
$modelInfo = json_decode($o, true);
$this->assertModelInfo($modelInfo);
}
private function assertModelInfo(array $modelInfo)
{
$this->assertEquals(ModelInspectorTestModel::class, $modelInfo['class']);
$this->assertEquals(Schema::getConnection()->getConfig()['name'], $modelInfo['database']);
$this->assertEquals('model_info_extractor_test_model', $modelInfo['table']);
$this->assertNull($modelInfo['policy']);
$this->assertCount(8, $modelInfo['attributes']);
$this->assertAttributes([
'name' => 'id',
'increments' => true,
'nullable' => false,
'default' => null,
'unique' => true,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => null,
], $modelInfo['attributes'][0]);
$this->assertAttributes([
'name' => 'uuid',
'increments' => false,
'nullable' => false,
'default' => null,
'unique' => false,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => null,
], $modelInfo['attributes'][1]);
$this->assertAttributes([
'name' => 'name',
'increments' => false,
'nullable' => false,
'default' => null,
'unique' => false,
'fillable' => false,
'hidden' => false,
'appended' => null,
'cast' => null,
], $modelInfo['attributes'][2]);
$this->assertAttributes([
'name' => 'a_bool',
'increments' => false,
'nullable' => false,
'default' => null,
'unique' => false,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => 'bool',
], $modelInfo['attributes'][3]);
$this->assertAttributes([
'name' => 'parent_test_model_id',
'increments' => false,
'nullable' => false,
'default' => null,
'unique' => false,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => null,
], $modelInfo['attributes'][4]);
$this->assertAttributes([
'name' => 'nullable_date',
'increments' => false,
'nullable' => true,
'default' => null,
'unique' => false,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => 'datetime',
], $modelInfo['attributes'][5]);
$this->assertAttributes([
'name' => 'created_at',
'increments' => false,
'nullable' => true,
'default' => null,
'unique' => false,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => 'datetime',
], $modelInfo['attributes'][6]);
$this->assertAttributes([
'name' => 'updated_at',
'increments' => false,
'nullable' => true,
'default' => null,
'unique' => false,
'fillable' => true,
'hidden' => false,
'appended' => null,
'cast' => 'datetime',
], $modelInfo['attributes'][7]);
$this->assertCount(1, $modelInfo['relations']);
$this->assertEqualsCanonicalizing([
'name' => 'parentModel',
'type' => 'BelongsTo',
'related' => "Illuminate\Tests\Integration\Database\ParentTestModel",
], $modelInfo['relations'][0]);
$this->assertEmpty($modelInfo['events']);
$this->assertCount(1, $modelInfo['observers']);
$this->assertEquals('created', $modelInfo['observers'][0]['event']);
$this->assertCount(1, $modelInfo['observers'][0]['observer']);
$this->assertEquals("Illuminate\Tests\Integration\Database\ModelInspectorTestModelObserver@created", $modelInfo['observers'][0]['observer'][0]);
}
private function assertAttributes($expectedAttributes, $actualAttributes)
{
foreach (['name', 'increments', 'nullable', 'unique', 'fillable', 'hidden', 'appended', 'cast'] as $key) {
$this->assertEquals($expectedAttributes[$key], $actualAttributes[$key]);
}
// We ignore type because it varies from DB to DB
$this->assertArrayHasKey('type', $actualAttributes);
$this->assertArrayHasKey('default', $actualAttributes);
}
}
#[ObservedBy(ModelInspectorTestModelObserver::class)]
#[CollectedBy(ModelInspectorTestModelEloquentCollection::class)]
class ModelInspectorTestModel extends Model
{
use HasUuids;
protected static string $builder = ModelInspectorTestModelBuilder::class;
public $table = 'model_info_extractor_test_model';
protected $guarded = ['name'];
protected $casts = ['nullable_date' => 'datetime', 'a_bool' => 'bool'];
public function parentModel(): BelongsTo
{
return $this->belongsTo(ParentTestModel::class);
}
}
class ParentTestModel extends Model
{
public $table = 'parent_test_models';
public $timestamps = false;
}
class ModelInspectorTestModelObserver
{
public function created()
{
}
}
class ModelInspectorTestModelEloquentCollection extends Collection
{
}
class ModelInspectorTestModelBuilder extends Builder
{
}
|
