Download the PHP package luthfi/simple-crud-generator without Composer

Laravel Simple CRUD Generator

Need faster TDD in Laravel project? This is a simple CRUD generator complete with automated testing suite.

Documentation

For installation instructions and usage, please take a look at the official documentation.

About this package

This package contains artisan make:crud commands to create a simple CRUD feature with test classes on our Laravel 5.5 (and later) application. This package is fairly simple, to boost test-driven development method on our laravel application. It now supports Laravel 12 and 13.

With this package installed on local environment, we can use (e.g.) php artisan make:crud Vehicle command to generate some files :

• App\Models\Vehicle.php eloquent model
• xxx_create_vehicles_table.php migration file
• VehicleController.php
• index.blade.php and forms.blade.php view file in resources/views/vehicles directory
• resources/lang/vehicle.php lang file
• VehicleFactory.php model factory file
• VehiclePolicy.php model policy file in app/Policies directory
• ManageVehiclesTest.php feature test class in tests/Feature directory
• VehicleTest.php unit test class in tests/Unit/Models directory
• VehiclePolicyTest.php unit test class in tests/Unit/Policies directory

It will update some file :

• Update routes/web.php to add vehicles resource route
• Update app/providers/AuthServiceProvider.php to add Vehicle model Policy class in $policies property

It will also create this file if it not exists :

• resources/lang/app.php lang file if it not exists
• tests/BrowserKitTest.php base Feature TestCase class if it not exists

Main purpose

The main purpose of this package is for faster Test-driven Development, it generates model CRUD scaffolds complete with Testing Classes which will use Laravel Browserkit Testing package and PHPUnit.

How to install

For Laravel 10x and later

For Laravel 9.x

For Laravel 8.x

For Laravel 5.6 to 7.x

For Laravel 5.5

To use this package on laravel 5.5, we need to add the package (with browserkit) within require-dev in composer.json file, like so :

The package will auto-discovered.

How to use

Just type in terminal $ php artisan make:crud ModelName command, it will create simple Laravel CRUD files of given model name completed with tests.

For example we want to create CRUD for 'App\Models\Vehicle' model.

Make sure we have set database credential on .env file, then :

Then visit our application url: http://localhost:8000/vehicles.

Usage on Fresh Install Laravel 8.x

In this example, we are using the laravel installer package to install new laravel project.

Available Commands

Model Attribute/column

The Model and table will only have 2 pre-definded attributes or columns : title and description on each generated model and database table. You can continue working on other column on the table.

Bootstrap 4 Views

The generated view files use Bootstrap 4 by default (for Laravel 5.6 and later).

Bootstrap 3 Views

We can also generates views that use Bootstrap 3 with --bs3 command option, eg for Laravel version 5.5.

For API

If we want to generate API Controller with feature tests, we use following command :

By default, we use Laravel Token Based Authentication, so we need to update our user model.

1. Add api_token column on our users_table_migration.
2. Add api_token as fillable property on User model.
3. Add api_token field on our UserFactory.

API Usage

The generated API is a REST API, using GET and POST verbs, with a URI of /api/modelname.

Example code for calling the generated API, using Guzzle:

// Read data a specific Vehicle record...
$uri = 'http://your-domain.com/api/vehicles/'.$vehicleID;
$headers = ['Authorization' => 'Bearer '.$apiToken];

$client = new \GuzzleHttp\Client();
$res = $client->request('GET', $uri, ['headers' => $headers]);

// Create a new Vehicle record...
$uri = 'http://your-domain.com/api/vehicles';
$headers = ['Authorization' => 'Bearer '.$apiToken];
$payload = json_encode([
    'title' => 'Vehicle Name 1',
    'description' => 'Vehicle Description 1',
]);

$client = new \GuzzleHttp\Client();
$res = $client->request('POST', $uri, ['body' => $payload, 'headers' => $headers]);

The generated functional tests will give you examples of how to adapt this code for other call types.

Config file

You can configure your own by publishing the config file:

That will generate config/simple-crud.php file.

By default, this package have some configuration:

Publishing Stub Files

Stub files is the templates which we use to generate the code for each model classes and files. We can customize the stub files as we needed by publishing them to our project directory.

That will generate stub files on stubs/simple-crud directory. Now we can change some stub files based on our project needs.

Attention

• The package will creates the Model class file, the command will stop if the Model already exists.
• You need a resources/views/layouts/app.blade.php view file, simply create one with php artisan make:auth command. You can change this configuration via the config/simple-crud.php file.

The --parent-model Command Option

We have --parent-model option to create a CRUD feature nested with existing model.

I often creating a CRUD feature nested with the existing model, like:

• Adding payment history entries for an invoice
• Adding work orders under a project
• Adding attachments under document
• Many more

Since this package was (only) for creating the "first-class citizen" CRUD feature, we need to create the nested CRUD feature manually. The command --parent-model option can save our time more.

Example

When one department has many section, then we are adding a nested controller like so:

So we will have routes like:

Including the model, controller, views, feature test, unit tests.

To create the CRUD feature, we can run:

We will have a working Section CRUD feature with title and description attribute under Departments namespace, completed with tests. (Where Department is the existing model and Section is the new model.)

Screenshots

Visit your application in new resource route : http://127.0.0.1:8000/vehicles

Generated testing suite

Next, let us try the generated testing suite. To use the generated testing classes, we can set the database environment using in-memory database SQLite. Open phpunit.xml. Add two lines below on the env :

Then run PHPUnit

All tests should be passed.

Issue/Proposal

If you find any issue, or want to propose some idea to help this package better, please create an issue in this github repo.

License

This package is open-sourced software licensed under the MIT license.