Feat model contracts

database/migrations/create_nusa_tables.php

@@ -60,6 +60,21 @@ public function up(): void
             $table->foreign('regency_code')->references('code')->on($tableNames['regencies']);
             $table->foreign('province_code')->references('code')->on($tableNames['provinces']);
         });
+
+        Schema::create('addresses', function (Blueprint $table) use ($tableNames) {
+            $table->id();
+            $table->string('line');
+            $table->char('village_code', 10)->nullable();
+            $table->char('district_code', 6)->nullable();
+            $table->char('regency_code', 4)->nullable();
+            $table->char('province_code', 2)->nullable();
+            $table->char('postal_code', 5)->nullable();
+
+            $table->foreign('village_code')->references('code')->on($tableNames['villages'])->nullOnDelete();
+            $table->foreign('district_code')->references('code')->on($tableNames['districts'])->nullOnDelete();
+            $table->foreign('regency_code')->references('code')->on($tableNames['regencies'])->nullOnDelete();
+            $table->foreign('province_code')->references('code')->on($tableNames['provinces'])->nullOnDelete();
+        });
     }
 
     /**
@@ -69,6 +84,7 @@ public function down(): void
     {
         $tableNames = config('creasi.nusa.table_names');
 
+        Schema::dropIfExists('address');
         Schema::dropIfExists($tableNames['villages']);
         Schema::dropIfExists($tableNames['districts']);
         Schema::dropIfExists($tableNames['regencies']);

src/Contracts/Address.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property string $line
+ * @property ?int $village_code
+ * @property ?int $district_code
+ * @property ?int $regency_code
+ * @property ?int $province_code
+ * @property ?int $postal_code
+ * @property-read ?Village $village
+ * @property-read ?District $district
+ * @property-read ?Regency $regency
+ * @property-read ?Province $province
+ */
+interface Address
+{
+    //
+}

src/Contracts/District.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property-read int $regency_code
+ * @property-read int $province_code
+ * @property-read Province $province
+ * @property-read Regency $regency
+ * @property-read \Illuminate\Support\Collection<int, Village> $villages
+ */
+interface District extends Model
+{
+    //
+}

src/Contracts/Model.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property-read int $code
+ * @property-read string $name
+ * @property-read ?float $latitude
+ * @property-read ?float $longitude
+ * @property-read ?array $coordinates
+ */
+interface Model
+{
+    //
+}

src/Contracts/Province.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property-read \Illuminate\Support\Collection<int, Regency> $regencies
+ * @property-read \Illuminate\Support\Collection<int, District> $districts
+ * @property-read \Illuminate\Support\Collection<int, Village> $villages
+ */
+interface Province extends Model
+{
+    //
+}

src/Contracts/Regency.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property-read int $province_code
+ * @property-read Province $province
+ * @property-read \Illuminate\Support\Collection<int, District> $districts
+ * @property-read \Illuminate\Support\Collection<int, Village> $villages
+ */
+interface Regency extends Model
+{
+    //
+}

src/Contracts/Village.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property-read int $district_code
+ * @property-read int $regency_code
+ * @property-read int $province_code
+ * @property-read ?int $postal_code
+ * @property-read Province $province
+ * @property-read Regency $regency
+ * @property-read District $district
+ */
+interface Village extends Model
+{
+    //
+}

src/Models/Address.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Models;
+
+use Creasi\Nusa\Contracts\Address as AddressContract;
+use Illuminate\Database\Eloquent\Model as EloquentModel;
+
+/**
+ * @property-read ?Province $province
+ * @property-read ?Regency $regency
+ * @property-read ?District $district
+ * @property-read ?Village $village
+ *
+ * @mixin \Illuminate\Contracts\Database\Eloquent\Builder
+ */
+class Address extends EloquentModel implements AddressContract
+{
+    public $timestamps = false;
+
+    public function getCasts()
+    {
+        return \array_merge($this->casts, [
+            'village_code' => 'int',
+            'district_code' => 'int',
+            'regency_code' => 'int',
+            'province_code' => 'int',
+            'postal_code' => 'int',
+        ]);
+    }
+
+    public function getFillable()
+    {
+        return \array_merge($this->fillable, [
+            'line',
+            'village_code',
+            'district_code',
+            'regency_code',
+            'province_code',
+            'postal_code',
+        ]);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Village
+     */
+    public function village()
+    {
+        return $this->belongsTo(Village::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|District
+     */
+    public function district()
+    {
+        return $this->belongsTo(District::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Regency
+     */
+    public function regency()
+    {
+        return $this->belongsTo(Regency::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Province
+     */
+    public function province()
+    {
+        return $this->belongsTo(Province::class);
+    }
+}

src/Models/District.php

@@ -4,16 +4,16 @@
 
 namespace Creasi\Nusa\Models;
 
+use Creasi\Nusa\Contracts\District as DistrictContract;
+
 /**
- * @property-read int $regency_code
- * @property-read int $province_code
  * @property-read Province $province
  * @property-read Regency $regency
- * @property-read \Illuminate\Database\Eloquent\Collection<int, Village>|Village[] $villages
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Village> $villages
  */
-class District extends Model
+class District extends Model implements DistrictContract
 {
-    protected $fillable = ['code', 'regency_code', 'province_code', 'name'];
+    protected $fillable = ['regency_code', 'province_code'];
 
     protected $casts = [
         'regency_code' => 'int',

src/Models/Model.php

@@ -4,18 +4,13 @@
 
 namespace Creasi\Nusa\Models;
 
+use Creasi\Nusa\Contracts\Model as ModelContract;
 use Illuminate\Database\Eloquent\Model as EloquentModel;
 
 /**
- * @property-read int $code
- * @property-read string $name
- * @property-read ?float $latitude
- * @property-read ?float $longintude
- * @property-read ?array $coordinates
- *
  * @mixin \Illuminate\Contracts\Database\Eloquent\Builder
  */
-abstract class Model extends EloquentModel
+abstract class Model extends EloquentModel implements ModelContract
 {
     public $incrementing = false;
 
@@ -31,6 +26,7 @@ public function getConnectionName()
     public function getCasts()
     {
         return \array_merge($this->casts, [
+            'code' => 'int',
             'latitude' => 'float',
             'longitude' => 'float',
             'coordinates' => 'array',
@@ -39,6 +35,6 @@ public function getCasts()
 
     public function getFillable()
     {
-        return \array_merge($this->fillable, ['latitude', 'longitude', 'coordinates']);
+        return \array_merge($this->fillable, ['code', 'name', 'latitude', 'longitude', 'coordinates']);
     }
 }

src/Models/Province.php

@@ -4,14 +4,16 @@
 
 namespace Creasi\Nusa\Models;
 
+use Creasi\Nusa\Contracts\Province as ProvinceContract;
+
 /**
- * @property-read \Illuminate\Database\Eloquent\Collection<int, Regency>|Regency[] $regencies
- * @property-read \Illuminate\Database\Eloquent\Collection<int, District>|District[] $districts
- * @property-read \Illuminate\Database\Eloquent\Collection<int, Village>|Village[] $villages
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Regency> $regencies
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, District> $districts
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Village> $villages
  */
-class Province extends Model
+class Province extends Model implements ProvinceContract
 {
-    protected $fillable = ['code', 'name'];
+    protected $fillable = [];
 
     protected $casts = [];
 

src/Models/Regency.php

@@ -4,15 +4,16 @@
 
 namespace Creasi\Nusa\Models;
 
+use Creasi\Nusa\Contracts\Regency as RegencyContract;
+
 /**
- * @property-read int $province_code
  * @property-read Province $province
- * @property-read \Illuminate\Database\Eloquent\Collection<int, District>|District[] $districts
- * @property-read \Illuminate\Database\Eloquent\Collection<int, Village>|Village[] $villages
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, District> $districts
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Village> $villages
  */
-class Regency extends Model
+class Regency extends Model implements RegencyContract
 {
-    protected $fillable = ['code', 'province_code', 'name'];
+    protected $fillable = ['province_code'];
 
     protected $casts = [
         'province_code' => 'int',

src/Models/Village.php

@@ -4,18 +4,16 @@
 
 namespace Creasi\Nusa\Models;
 
+use Creasi\Nusa\Contracts\Village as VillageContract;
+
 /**
- * @property-read int $district_code
- * @property-read int $regency_code
- * @property-read int $province_code
- * @property-read int $postal_code
  * @property-read Province $province
  * @property-read Regency $regency
  * @property-read District $district
  */
-class Village extends Model
+class Village extends Model implements VillageContract
 {
-    protected $fillable = ['code', 'district_code', 'regency_code', 'province_code', 'name', 'postal_code'];
+    protected $fillable = ['district_code', 'regency_code', 'province_code', 'postal_code'];
 
     protected $casts = [
         'district_code' => 'int',