Fix for a couple of dprecations in PHP 8.4

README.md

@@ -1,13 +1,14 @@
-# Reliese Laravel
+# Reliese Laravel Model Generator
 [![Build Status](https://travis-ci.org/reliese/laravel.svg?branch=master)](https://travis-ci.org/reliese/laravel)
 [![Latest Stable Version](https://poser.pugx.org/reliese/laravel/v/stable)](https://packagist.org/packages/reliese/laravel)
 [![Total Downloads](https://poser.pugx.org/reliese/laravel/downloads)](https://packagist.org/packages/reliese/laravel)
 [![Latest Unstable Version](https://poser.pugx.org/reliese/laravel/v/unstable)](https://packagist.org/packages/reliese/laravel)
 [![License](https://poser.pugx.org/reliese/laravel/license)](https://packagist.org/packages/reliese/laravel)
 
-Reliese Laravel is a collection of Laravel Components which aim is 
-to help the development process of Laravel applications by 
-providing some convenient code-generation capabilities.
+Reliese Laravel Model Generator aims to speed up the development process of Laravel applications by 
+providing some convenient code-generation capabilities. 
+The tool inspects your database structure, including column names and foreign keys, in order 
+to automatically generate Models that have correctly typed properties, along with any relationships to other Models.
 
 ## How does it work?
 
@@ -22,28 +23,19 @@ It is recommended that this package should only be used on a local environment f
 composer require reliese/laravel --dev
 ```
 
-Then you'll need to register the provider in `app/Providers/AppServiceProvider.php` file.
-
-```php
-public function register()
-{
-    if ($this->app->environment() == 'local') {
-        $this->app->register(\Reliese\Coders\CodersServiceProvider::class);
-    }
-}
-```
-
-## Models
-
-![Generating models with artisan](https://cdn-images-1.medium.com/max/800/1*hOa2QxORE2zyO_-ZqJ40sA.png "Making artisan code my Eloquent models")
-
 Add the `models.php` configuration file to your `config` directory and clear the config cache:
 
 ```shell
 php artisan vendor:publish --tag=reliese-models
+
+# Let's refresh our config cache just in case
 php artisan config:clear
 ```
 
+## Models
+
+![Generating models with artisan](https://cdn-images-1.medium.com/max/800/1*hOa2QxORE2zyO_-ZqJ40sA.png "Making artisan code my Eloquent models")
+
 ### Usage
 
 Assuming you have already configured your database, you are now all set to go.
@@ -82,7 +74,7 @@ fit your database needs. [Check it out](https://github.com/reliese/laravel/blob/
 #### 1. Keeping model changes
 
 You may want to generate your models as often as you change your database. In order
-not to lose you own model changes, you should set `base_files` to `true` in your `config/models.php`.
+not to lose your own model changes, you should set `base_files` to `true` in your `config/models.php`.
 
 When you enable this feature your models will inherit their base configurations from
 base models. You should avoid adding code to your base models, since you

composer.json

@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "php": ">=5.6.4",
+        "php": "^7.3|^8.0",
         "doctrine/dbal": ">=2.5",
         "illuminate/support": ">=5.1",
         "illuminate/database": ">=5.1",

config/models.php

@@ -211,7 +211,7 @@
         | TRUE: Schema name will be prepended on the table
         | FALSE:Table name will be set without schema name.
         | NULL: Table name will follow laravel pattern,
-        |   i.e if class name(plural) matches table name, then table name will not be added
+        |   i.e. if class name(plural) matches table name, then table name will not be added
         */
 
         'qualified_tables' => false,
@@ -253,11 +253,11 @@
         | Casts
         |--------------------------------------------------------------------------
         |
-        | You may want to specify which of your table fields should be casted as
-        | something different than a string. For instance, you may want a
-        | text field be casted as an array or and object.
+        | You may want to specify which of your table fields should be cast as
+        | something other than a string. For instance, you may want a
+        | text field be cast as an array or and object.
         |
-        | You may define column patterns which will be casted using the value
+        | You may define column patterns which will be cast using the value
         | assigned. We have defined some fields for you. Feel free to
         | modify them to fit your needs.
         |
@@ -281,6 +281,10 @@
 
         'except' => [
             'migrations',
+            'failed_jobs',
+            'password_resets',
+            'personal_access_tokens',
+            'password_reset_tokens',
         ],
 
         /*
@@ -321,6 +325,26 @@
 
         'lower_table_name_first' => false,
 
+        /*
+        |--------------------------------------------------------------------------
+        | Model Names
+        |--------------------------------------------------------------------------
+        |
+        | By default the generator will create models with names that match your tables.
+        | However, if you wish to manually override the naming, you can specify a mapping
+        | here between table and model names.
+        |
+        | Example:
+        |   A table called 'billing_invoices' will generate a model called `BillingInvoice`,
+        |   but you'd prefer it to generate a model called 'Invoice'. Therefore, you'd add
+        |   the following array key and value:
+        |     'billing_invoices' => 'Invoice',
+        */
+
+        'model_names' => [
+
+        ],
+
         /*
         |--------------------------------------------------------------------------
         | Relation Name Strategy
@@ -333,14 +357,19 @@
                             generates Post::user() and User::posts()
         |
         | 'foreign_key' Use the foreign key as the relation name.
-        |                   (post.author --> user.id)
-        |                       generates Post::author() and User::posts_author()
-        |               Column id's are ignored.
+        |               This can help to provide more meaningful relationship names, and avoids naming conflicts
+        |               if you have more than one relationship between two tables.
         |                   (post.author_id --> user.id)
+        |                       generates Post::author() and User::posts_where_author()
+        |                   (post.editor_id --> user.id)
+        |                       generates Post::editor() and User::posts_where_editor()
+        |               ID suffixes can be omitted from foreign keys.
+        |                   (post.author --> user.id)
+        |                   (post.editor --> user.id)
         |                       generates the same as above.
-        |               When the foreign key is redundant, it is omited.
+        |               Where the foreign key matches the related table name, it behaves as per the 'related' strategy.
         |                   (post.user_id --> user.id)
-        |                       generates User::posts() and not User::posts_user()
+        |                       generates Post::user() and User::posts()
         */
 
         'relation_name_strategy' => 'related',
@@ -366,6 +395,19 @@
          */
         'with_property_constants' => false,
 
+        /*
+         |--------------------------------------------------------------------------
+         | Optionally includes a full list of columns in the base generated models,
+         | which can be used to avoid making calls like
+         |
+         | ...
+         | \Illuminate\Support\Facades\Schema::getColumnListing
+         | ...
+         |
+         | which can be slow, especially for large tables.
+         */
+        'with_column_list' => false,
+
         /*
         |--------------------------------------------------------------------------
         | Disable Pluralization Name
@@ -387,6 +429,38 @@
         'override_pluralize_for' => [
 
         ],
+
+        /*
+        |--------------------------------------------------------------------------
+        | Move $hidden property to base files
+        |--------------------------------------------------------------------------
+        | When base_files is true you can set hidden_in_base_files to true
+        | if you want the $hidden to be generated in base files
+        |
+        */
+        'hidden_in_base_files' => false,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Move $fillable property to base files
+        |--------------------------------------------------------------------------
+        | When base_files is true you can set fillable_in_base_files to true
+        | if you want the $fillable to be generated in base files
+        |
+        */
+        'fillable_in_base_files' => false,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Generate return types for relation methods.
+        |--------------------------------------------------------------------------
+        | When enable_return_types is set to true, return type declarations are added
+        | to all generated relation methods for your models.
+        |
+        | NOTE: This requires PHP 7.0 or later.
+        |
+        */
+        'enable_return_types' => false,
     ],
 
     /*

src/Coders/Model/Factory.php

@@ -7,12 +7,12 @@
 
 namespace Reliese\Coders\Model;
 
+use Illuminate\Database\DatabaseManager;
+use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Str;
 use Reliese\Meta\Blueprint;
-use Reliese\Support\Classify;
 use Reliese\Meta\SchemaManager;
-use Illuminate\Filesystem\Filesystem;
-use Illuminate\Database\DatabaseManager;
+use Reliese\Support\Classify;
 
 class Factory
 {
@@ -319,6 +319,15 @@ private function shortenAndExtractImportableDependencies(&$placeholder, $model)
                 $namespacePieces = explode('\\', $usedClass);
                 $className = array_pop($namespacePieces);
 
+                /**
+                 * Avoid breaking same-model relationships when using base classes
+                 *
+                 * @see https://github.com/reliese/laravel/issues/209
+                 */
+                if ($model->usesBaseFiles() && $usedClass === $model->getQualifiedUserClassName()) {
+                    continue;
+                }
+
                 //When same class name but different namespace, skip it.
                 if (
                     $className == $model->getClassName() &&
@@ -328,7 +337,7 @@ private function shortenAndExtractImportableDependencies(&$placeholder, $model)
                 }
 
                 $importableDependencies[trim($usedClass, '\\')] = true;
-                $placeholder = str_replace($usedClass, $className, $placeholder);
+                $placeholder = preg_replace('!'.addslashes($usedClass).'\b!', addslashes($className), $placeholder, 1);
             }
         }
 
@@ -401,7 +410,8 @@ protected function body(Model $model)
             $properties = array_diff($properties, $excludedConstants);
 
             foreach ($properties as $property) {
-                $body .= $this->class->constant(strtoupper($property), $property);
+                $constantName = Str::upper(Str::snake($property));
+                $body .= $this->class->constant($constantName, $property);
             }
         }
 
@@ -445,19 +455,22 @@ protected function body(Model $model)
             $body .= $this->class->field('snakeAttributes', false, ['visibility' => 'public static']);
         }
 
-        if ($model->hasCasts()) {
-            $body .= $this->class->field('casts', $model->getCasts(), ['before' => "\n"]);
+        if ($model->usesColumnList()) {
+            $properties = array_keys($model->getProperties());
+
+            $body .= "\n";
+            $body .= $this->class->field('columns', $properties);
         }
 
-        if ($model->hasDates()) {
-            $body .= $this->class->field('dates', $model->getDates(), ['before' => "\n"]);
+        if ($model->hasCasts()) {
+            $body .= $this->class->field('casts', $model->getCasts(), ['before' => "\n"]);
         }
 
-        if ($model->hasHidden() && $model->doesNotUseBaseFiles()) {
+        if ($model->hasHidden() && ($model->doesNotUseBaseFiles() || $model->hiddenInBaseFiles())) {
             $body .= $this->class->field('hidden', $model->getHidden(), ['before' => "\n"]);
         }
 
-        if ($model->hasFillable() && $model->doesNotUseBaseFiles()) {
+        if ($model->hasFillable() && ($model->doesNotUseBaseFiles() || $model->fillableInBaseFiles())) {
             $body .= $this->class->field('fillable', $model->getFillable(), ['before' => "\n"]);
         }
 
@@ -470,7 +483,14 @@ protected function body(Model $model)
         }
 
         foreach ($model->getRelations() as $constraint) {
-            $body .= $this->class->method($constraint->name(), $constraint->body(), ['before' => "\n"]);
+            $body .= $this->class->method(
+                $constraint->name(),
+                $constraint->body(),
+                [
+                    'before' => "\n",
+                    'returnType' => $model->definesReturnTypes() ? $constraint->returnType() : null,
+                ]
+            );
         }
 
         // Make sure there not undesired line breaks
@@ -562,11 +582,11 @@ protected function userFileBody(Model $model)
     {
         $body = '';
 
-        if ($model->hasHidden()) {
+        if ($model->hasHidden() && !$model->hiddenInBaseFiles()) {
             $body .= $this->class->field('hidden', $model->getHidden());
         }
 
-        if ($model->hasFillable()) {
+        if ($model->hasFillable() && !$model->fillableInBaseFiles()) {
             $body .= $this->class->field('fillable', $model->getFillable(), ['before' => "\n"]);
         }
 
@@ -583,7 +603,7 @@ protected function userFileBody(Model $model)
      *
      * @return mixed|\Reliese\Coders\Model\Config
      */
-    public function config(Blueprint $blueprint = null, $key = null, $default = null)
+    public function config(?Blueprint $blueprint = null, $key = null, $default = null)
     {
         if (is_null($blueprint)) {
             return $this->config;