Adopt model casts method

Author: jasonmccreary

src/Generators/ModelGenerator.php

@@ -215,7 +215,7 @@ protected function buildProperties(Model $model): string
 
         $columns = $this->castableColumns($model->columns());
         if (!empty($columns)) {
-            $properties[] = str_replace('[]', $this->pretty_print_array($columns), $this->filesystem->stub('model.casts.stub'));
+            $properties[] = str_replace('[]', $this->pretty_print_array($columns, indent: 8), $this->filesystem->stub('model.casts.stub'));
         }
 
         return trim(implode(PHP_EOL, array_filter($properties, fn ($property) => !empty(trim($property)))));
@@ -237,11 +237,11 @@ protected function fillableColumns(array $columns): array
         );
     }
 
-    private function pretty_print_array(array $data, bool $assoc = true): string
+    private function pretty_print_array(array $data, bool $assoc = true, int $indent = 4): string
     {
         $output = var_export($data, true);
-        $output = preg_replace('/^\s+/m', '        ', $output);
-        $output = preg_replace(['/^array\s\(/', '/\)$/'], ['[', '    ]'], $output);
+        $output = preg_replace('/^\s+/m', str_repeat(' ', $indent + 4), $output);
+        $output = preg_replace(['/^array\s\(/', '/\)$/'], ['[', str_repeat(' ', $indent) . ']'], $output);
 
         if (!$assoc) {
             $output = preg_replace('/^(\s+)[^=]+=>\s+/m', '$1', $output);

stubs/model.casts.stub

@@ -1,6 +1,9 @@
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [];
+    protected function casts(): array
+    {
+        return [];
+    }

tests/fixtures/models/alias-relationships.php

@@ -23,14 +23,17 @@ class Salesman extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-        'belongs_alias_id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+            'belongs_alias_id' => 'integer',
+        ];
+    }
 
     public function lead(): HasOne
     {

tests/fixtures/models/all-column-types.php

@@ -72,31 +72,34 @@ class AllType extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'bigInteger' => 'integer',
-        'boolean' => 'boolean',
-        'date' => 'date',
-        'dateTime' => 'datetime',
-        'dateTimeTz' => 'datetime',
-        'decimal' => 'decimal',
-        'double' => 'double',
-        'float' => 'float',
-        'json' => 'array',
-        'mediumInteger' => 'integer',
-        'nullableTimestamps' => 'timestamp',
-        'smallInteger' => 'integer',
-        'timestamp' => 'timestamp',
-        'timestampTz' => 'timestamp',
-        'tinyInteger' => 'integer',
-        'unsignedBigInteger' => 'integer',
-        'unsignedDecimal' => 'decimal',
-        'unsignedInteger' => 'integer',
-        'unsignedMediumInteger' => 'integer',
-        'unsignedSmallInteger' => 'integer',
-        'unsignedTinyInteger' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'bigInteger' => 'integer',
+            'boolean' => 'boolean',
+            'date' => 'date',
+            'dateTime' => 'datetime',
+            'dateTimeTz' => 'datetime',
+            'decimal' => 'decimal',
+            'double' => 'double',
+            'float' => 'float',
+            'json' => 'array',
+            'mediumInteger' => 'integer',
+            'nullableTimestamps' => 'timestamp',
+            'smallInteger' => 'integer',
+            'timestamp' => 'timestamp',
+            'timestampTz' => 'timestamp',
+            'tinyInteger' => 'integer',
+            'unsignedBigInteger' => 'integer',
+            'unsignedDecimal' => 'decimal',
+            'unsignedInteger' => 'integer',
+            'unsignedMediumInteger' => 'integer',
+            'unsignedSmallInteger' => 'integer',
+            'unsignedTinyInteger' => 'integer',
+        ];
+    }
 }

tests/fixtures/models/certificate-pascal-case-example.php

@@ -25,15 +25,18 @@ class Certificate extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-        'certificate_type_id' => 'integer',
-        'expiry_date' => 'date',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+            'certificate_type_id' => 'integer',
+            'expiry_date' => 'date',
+        ];
+    }
 
     public function certificateType(): BelongsTo
     {

tests/fixtures/models/certificate-type-pascal-case-example.php

@@ -20,13 +20,16 @@ class CertificateType extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+        ];
+    }
 
     public function certificates(): HasMany
     {

tests/fixtures/models/comment-global-namespace.php

@@ -18,11 +18,14 @@ class Comment extends Model
     protected $fillable = [];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+        ];
+    }
 }

tests/fixtures/models/comment.php

@@ -18,11 +18,14 @@ class Comment extends Model
     protected $fillable = [];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+        ];
+    }
 }

tests/fixtures/models/custom-models-namespace.php

@@ -22,12 +22,15 @@ class Tag extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-        'active' => 'boolean',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+            'active' => 'boolean',
+        ];
+    }
 }

tests/fixtures/models/custom-pivot-membership.php

@@ -35,15 +35,18 @@ class Membership extends Pivot
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-        'user_id' => 'integer',
-        'team_id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+            'user_id' => 'integer',
+            'team_id' => 'integer',
+        ];
+    }
 
     public function user(): BelongsTo
     {

tests/fixtures/models/custom-pivot-table-name.php

@@ -29,13 +29,16 @@ class User extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+        ];
+    }
 
     public function accounts(): BelongsToMany
     {

tests/fixtures/models/custom-pivot-team.php

@@ -20,13 +20,16 @@ class Team extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+        ];
+    }
 
     public function users(): BelongsToMany
     {

tests/fixtures/models/custom-pivot-user.php

@@ -20,13 +20,16 @@ class User extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+        ];
+    }
 
     public function teams(): BelongsToMany
     {

tests/fixtures/models/disable-auto-columns-phpdoc.php

@@ -33,11 +33,14 @@ class State extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'country_id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'country_id' => 'integer',
+        ];
+    }
 }

tests/fixtures/models/disable-auto-columns.php

@@ -28,11 +28,14 @@ class State extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'country_id' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'country_id' => 'integer',
+        ];
+    }
 }

tests/fixtures/models/foreign-key-shorthand-phpdoc.php

@@ -30,16 +30,19 @@ class Comment extends Model
     ];
 
     /**
-     * The attributes that should be cast to native types.
+     * Get the attributes that should be cast.
      *
-     * @var array
+     * @return array<string, string>
      */
-    protected $casts = [
-        'id' => 'integer',
-        'post_id' => 'integer',
-        'author_id' => 'integer',
-        'ccid' => 'integer',
-    ];
+    protected function casts(): array
+    {
+        return [
+            'id' => 'integer',
+            'post_id' => 'integer',
+            'author_id' => 'integer',
+            'ccid' => 'integer',
+        ];
+    }
 
     public function post(): BelongsTo
     {