Merge branch 'refactor-classnames'

* refactor-classnames:
  chore: update model's contracts
  chore: apply changes c549f97
  chore: apply changes 6a118c2
  refactor!: get rid of unnecessary interface
  feat: add more model traits to helps extendability of address
  refactor!: rename address classnames

src/Contracts/Address.php

@@ -7,15 +7,11 @@
 /**
  * @property-read int $id
  * @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
+ * @property null|int $village_code
+ * @property null|int $district_code
+ * @property null|int $regency_code
+ * @property null|int $province_code
+ * @property null|int $postal_code
  */
 interface Address
 {

src/Contracts/District.php

@@ -11,7 +11,20 @@
  * @property-read Regency $regency
  * @property-read \Illuminate\Support\Collection<int, Village> $villages
  */
-interface District extends Model
+interface District
 {
-    //
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Province
+     */
+    public function province();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Regency
+     */
+    public function regency();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany|Village
+     */
+    public function villages();
 }

src/Contracts/HasAddress.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Contracts;
+
+/**
+ * @property-read null|Address $address
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+interface HasAddress
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphOne|\Address
+     */
+    public function address();
+}

src/Contracts/Addressable.php → src/Contracts/HasAddresses.php

@@ -5,9 +5,11 @@
 namespace Creasi\Nusa\Contracts;
 
 /**
- * @property-read \Illuminate\Database\Eloquent\Collection<int, Address>|Address[] $addresses
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Address> $addresses
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
  */
-interface Addressable
+interface HasAddresses
 {
     /**
      * @return \Illuminate\Database\Eloquent\Relations\MorphMany|Address

src/Contracts/Province.php

@@ -9,7 +9,20 @@
  * @property-read \Illuminate\Support\Collection<int, District> $districts
  * @property-read \Illuminate\Support\Collection<int, Village> $villages
  */
-interface Province extends Model
+interface Province
 {
-    //
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany|Regency
+     */
+    public function regencies();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany|District
+     */
+    public function districts();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany|Village
+     */
+    public function villages();
 }

src/Contracts/Regency.php

@@ -10,7 +10,20 @@
  * @property-read \Illuminate\Support\Collection<int, District> $districts
  * @property-read \Illuminate\Support\Collection<int, Village> $villages
  */
-interface Regency extends Model
+interface Regency
 {
-    //
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Province
+     */
+    public function province();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany|District
+     */
+    public function districts();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany|Village
+     */
+    public function villages();
 }

src/Contracts/Village.php

@@ -8,12 +8,25 @@
  * @property-read int $district_code
  * @property-read int $regency_code
  * @property-read int $province_code
- * @property-read ?int $postal_code
+ * @property-read null|int $postal_code
  * @property-read Province $province
  * @property-read Regency $regency
  * @property-read District $district
  */
-interface Village extends Model
+interface Village
 {
-    //
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Province
+     */
+    public function province();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Regency
+     */
+    public function regency();
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|District
+     */
+    public function district();
 }

src/Models/Address.php

@@ -8,16 +8,17 @@
 use Illuminate\Database\Eloquent\Model as EloquentModel;
 
 /**
- * @property-read ?EloquentModel $owner
- * @property-read ?Province $province
- * @property-read ?Regency $regency
- * @property-read ?District $district
- * @property-read ?Village $village
+ * @property-read null|EloquentModel $owner
  *
  * @mixin \Illuminate\Contracts\Database\Eloquent\Builder
  */
 class Address extends EloquentModel implements AddressContract
 {
+    use Concerns\BelongsToDistrict;
+    use Concerns\BelongsToProvince;
+    use Concerns\BelongsToRegency;
+    use Concerns\BelongsToVillage;
+
     public function getCasts()
     {
         return \array_merge($this->casts, [
@@ -77,36 +78,4 @@ public function owner()
     {
         return $this->morphTo();
     }
-
-    /**
-     * @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/Concerns/BelongsToDistrict.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Models\Concerns;
+
+use Creasi\Nusa\Models\District;
+
+/**
+ * @property-read null|\Creasi\Nusa\Contracts\District $district
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+trait BelongsToDistrict
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|\Creasi\Nusa\Contracts\District
+     */
+    public function district()
+    {
+        return $this->belongsTo(District::class);
+    }
+}

src/Models/Concerns/BelongsToProvince.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Models\Concerns;
+
+use Creasi\Nusa\Models\Province;
+
+/**
+ * @property-read null|\Creasi\Nusa\Contracts\Province $province
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+trait BelongsToProvince
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|\Creasi\Nusa\Contracts\Province
+     */
+    public function province()
+    {
+        return $this->belongsTo(Province::class);
+    }
+}

src/Models/Concerns/BelongsToRegency.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Models\Concerns;
+
+use Creasi\Nusa\Models\Regency;
+
+/**
+ * @property-read null|\Creasi\Nusa\Contracts\Regency $regency
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+trait BelongsToRegency
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|\Creasi\Nusa\Contracts\Regency
+     */
+    public function regency()
+    {
+        return $this->belongsTo(Regency::class);
+    }
+}

src/Models/Concerns/BelongsToVillage.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Creasi\Nusa\Models\Concerns;
+
+use Creasi\Nusa\Models\Village;
+
+/**
+ * @property-read null|\Creasi\Nusa\Contracts\Village $village
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+trait BelongsToVillage
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|\Creasi\Nusa\Contracts\Village
+     */
+    public function village()
+    {
+        return $this->belongsTo(Village::class);
+    }
+}

src/Support/HasAddress.php → src/Models/Concerns/WithAddress.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Creasi\Nusa\Support;
+namespace Creasi\Nusa\Models\Concerns;
 
 /**
- * @mixin \Illuminate\Database\Eloquent\Model
+ * @mixin \Creasi\Nusa\Contracts\HasAddress
  */
-trait HasAddress
+trait WithAddress
 {
     /**
      * @return \Illuminate\Database\Eloquent\Relations\MorphOne|\Creasi\Nusa\Contracts\Address

src/Support/HasAddresses.php → src/Models/Concerns/WithAddresses.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Creasi\Nusa\Support;
+namespace Creasi\Nusa\Models\Concerns;
 
 /**
- * @mixin \Illuminate\Database\Eloquent\Model
+ * @mixin \Creasi\Nusa\Contracts\HasAddresses
  */
-trait HasAddresses
+trait WithAddresses
 {
     /**
      * @return \Illuminate\Database\Eloquent\Relations\MorphMany|\Creasi\Nusa\Contracts\Address

src/Models/Model.php

@@ -4,18 +4,23 @@
 
 namespace Creasi\Nusa\Models;
 
-use Creasi\Nusa\Contracts\Model as ModelContract;
 use Illuminate\Contracts\Database\Query\Builder;
 use Illuminate\Database\Eloquent\Model as EloquentModel;
 
 /**
+ * @property-read int $code
+ * @property-read string $name
+ * @property-read null|float $latitude
+ * @property-read null|float $longitude
+ * @property-read null|array $coordinates
+ *
  * @method static static search(string|int $keyword)
  * @method Builder whereCode(int $code)
  * @method Builder whereName(string $name)
  *
  * @mixin \Illuminate\Contracts\Database\Eloquent\Builder
  */
-abstract class Model extends EloquentModel implements ModelContract
+abstract class Model extends EloquentModel
 {
     public $incrementing = false;