Lumen generators

A collection of generators for Lumen and Laravel 5.

Contents

• Why ?

• Installation

• Quick Usage

• Detailed Usage

  • Model Generator

  • Migration Generator

  • Pivot Table Generator (Since version 1.1.0)

  • Controller Generator

  • Routes Generator

  • Resource Generator

  • Multiple Resources From File

• Testing

• Development Notes

• Contributing

Why ?

I installed Lumen and wanted to use it to create a REST API (since this is the main usage of Lumen). But I didn't find commands which will speed up my workflow. That's why I created this package and included useful commands to build a RESTful API.

This packages was mainly built to be used with Lumen, but it should work fine with Laravel 5 too.

Installation

Add the generators package to your composer.json by running the command:

composer require flickerleap/lumen-generators

Then add the service provider in the file app/Providers/AppServiceProvider.phplike the following:

public function register()
{
    if ($this->app->environment() == 'local') {
        $this->app->register('FlickerLeap\Generators\CommandsServiceProvider');
    }
}

Don't forget to include the application service provider on your bootstrap/app.php and to enable Eloquent and Facades if you are using Lumen

If you run the command php artisan list you will see the list of added commands:

flickerleap:controller               Generates RESTful controller using the RESTActions trait
flickerleap:controller:rest-actions  Generates REST actions trait to use into controllers
flickerleap:migration                Generates a migration to create a table with schema
flickerleap:model                    Generates a model class for a RESTfull resource
flickerleap:pivot-table              Generates creation migration for a pivot table
flickerleap:resource                 Generates a model, migration, controller and routes for RESTful resource
flickerleap:resources                Generates multiple resources from a file
flickerleap:route                    Generates RESTful routes.

Quick Usage

To generate a RESTful resource for your application (model, migration, controller and RESTful routes), you simply need to run one single command. For example:

php artisan flickerleap:resource task "name;string;required;fillable project_id;integer:unsigned;numeric;fillable,key due;date;;date" --add=timestamps --belongs-to=project

will generate these files:

app/Task.php

<?php namespace App;

use Illuminate\Database\Eloquent\Model;

class Task extends Model {

	protected $fillable = ["name", "project_id"];

	protected $dates = ["due"];

	public static $rules = [
		"name" => "required",
		"project_id" => "numeric",
	];

	public function project()
	{
		return $this->belongsTo("App\Project");
	}

}

app/Http/Controllers/RESTActions.php

<?php namespace App\Http\Controllers;

use Illuminate\Http\Request;


trait RESTActions {

	protected $statusCodes = [
		'done' => 200,
		'created' => 201,
		'removed' => 204,
		'not_valid' => 400,
		'not_found' => 404,
		'conflict' => 409,
		'permissions' => 401
	];

	public function all()
	{
		$m = self::MODEL;
		return $this->respond('done', $m::all());
	}

	public function get($id)
	{
		$m = self::MODEL;
		$model = $m::find($id);
		if(is_null($model)){
			return $this->respond('not_found');
		}
		return $this->respond('done', $model);
	}

	public function add(Request $request)
	{
		$m = self::MODEL;
		$this->validate($request, $m::$rules);
		return $this->respond('created', $m::create($request->all()));
	}

	public function put(Request $request, $id)
	{
		$m = self::MODEL;
		$this->validate($request, $m::$rules);
		$model = $m::find($id);
		if(is_null($model)){
			return $this->respond('not_found');
		}
		$model->update($request->all());
		return $this->respond('done', $model);
	}

	public function remove($id)
	{
		$m = self::MODEL;
		if(is_null($m::find($id))){
			return $this->respond('not_found');
		}
		$m::destroy($id);
		return $this->respond('removed');
	}

    protected function respond($status, $data = [])
    {
    	return response()->json($data, $this->statusCodes[$status]);
    }

}

app/Http/Controllers/TasksController.php

<?php namespace App\Http\Controllers;


class TasksController extends Controller {

	const MODEL = "App\Task";

	use RESTActions;

}

app/Http/routes.php

// These lignes will be added
/**
 * Routes for resource task
 */
$app->get('task', 'TasksController@all');
$app->get('task/{id}', 'TasksController@get');
$app->post('task', 'TasksController@add');
$app->put('task/{id}', 'TasksController@put');
$app->delete('task/{id}', 'TasksController@remove');

database/migrations/date_time_create_tasks.php

<?php

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateTasksMigration extends Migration
{
    
    public function up()
    {
        Schema::create('tasks', function(Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->integer('project_id')->unsigned();
            $table->date('due');
            $table->foreign('project_id')
                ->references('id')
                ->on('projects');
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::drop('tasks');
    }
}

Now simply run the migration and you are ready to go.

More then that, you can generate multiple resources with only one command ! Click here to see an example

Detailed Usage

Model Generator

The flickerleap:model command is used to generate a model class based on Eloquent. It has the following syntax:

flickerleap:model name [--fillable=...] [--dates=...] [--has-many=...] [--has-one=...] [--belongs-to=...] [--belongs-to-many=...] [--rules=...] [--timestamps=false] [--path=...] [--soft-deletes=true] [--force=true]

• name: the name of the model.

php artisan flickerleap:model Task generates the following:

<?php namespace App;

use Illuminate\Database\Eloquent\Model;

class Task extends Model {

	protected $fillable = [];

	protected $dates = [];

	public static $rules = [
		// Validation rules
	];

	// Relationships

}

• --fillable: the mass fillable fields of the model separated with commas.

php artisan flickerleap:model Task --fillable=name,title gives:

//...	
	protected $fillable = ['name', 'title'];

• --dates: the date fields of the model, these will be converted automatically to Carbon instances on retrieval.

php artisan flickerleap:model Task --dates=started_at,published_at gives:

//...	
	protected $dates = ['started_at', 'published_at'];

• --path: specifies the path where to store the model php file. This path is used to know the namespace of the model. The default value is "app".

php artisan flickerleap:model Task --path="app/Http/Models" gives:

<?php namespace App\Http\Models;
//...

• --has-one, --has-many, --belongs-to and --belongs-to-many: the relationships of the model following the syntax relation1:model1,relation2:model2,.... If the model is missing, it will be deducted from the relation's name. If the model is given without a namespace, it will be considered having the same namespace as the model being generated.

php artisan flickerleap:model Task --has-many=accounts --belongs-to="owner:App\User" --has-one=number:Phone belongs-to-many=tags --path=tests/tmp

gives:

//...
	public function accounts()
	{
		return $this->hasMany("Tests\Tmp\Account");
	}

	public function owner()
	{
		return $this->belongsTo("App\User");
	}

	public function number()
	{
		return $this->hasOne("Tests\Tmp\Phone");
	}

	public function tags()
	{
		return $this->belongsToMany("Tests\Tmp\Tag")->withTimestamps();
	}

• --rules: specifies the validation rules of the model's fields. The syntax is field1=rules1 field2=rules2 ....

php artisan flickerleap:model TestingModel --rules="name=required age=integer|min:13 email=email|unique:users,email_address"`

gives:

// ...
	public static $rules = [
		"name" => "required",
		"age" => "integer|min:13",
		"email" => "email|unique:users,email_address",
	];

• --timestamps: Enables timestamps on the model. Giving --timestamps=false will add public $timestamps = false; to the generated model. The default value is true.

• --soft-deletes: Adds Illuminate\Database\Eloquent\SoftDeletes trait to the model. This is disabled by default.

• --force: tells the generator to override the existing file. By default, if the model file already exists, it will not be overriden and the output will be something like:

TestingModel model already exists; use --force option to override it !

Migration Generator

The flickerleap:migration command is used to generate a migration to create a table with schema. It has the following syntax:

flickerleap:migration table [--schema=...] [--add=...] [--keys=...] [--force=true] [--file=...]

• table: the name of the table to create.

• --file: The migration file name (to speicify only for testing purpose). By default the name follows the patern date_time_create_tableName_table.php.

• --schema: the schema of the table using the syntax field1:type.arg1,ag2:modifier1:modifier2.. field2:.... The type could be text, string.50, decimal.5,2 for example. Modifiers can be unique or nullable for example. See documentation for the list of available types and modifiers.

php artisan flickerleap:migration tasks --schema="amount:decimal.5,2:after.'size':default.8 title:string:nullable"

gives:

<?php

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateTasksMigration extends Migration
{
    
    public function up()
    {
        Schema::create('tasks', function(Blueprint $table) {
            $table->increments('id');
            $table->decimal('amount', 5, 2)->after('size')->default(8);
            $table->string('title')->nullable();
            // Constraints declaration

        });
    }

    public function down()
    {
        Schema::drop('tasks');
    }
}

• --add: Specifies additional columns like timestamps, softDeletes, rememberToken and nullableTimestamps.

• --keys: the foreign keys of the table following the syntax field:column:table:on_delete:on_update .... The column is optional ("id" by default). The table is optional if the field follows the naming convention singular_table_name_id. on_delete and on_update are optional too.

php artisan flickerleap:migration tasks --keys="category_type_id user_id:identifier:members:cascade"

gives:

//...
$table->foreign('category_type_id')
    ->references('id')
    ->on('category_types');

$table->foreign('user_id')
    ->references('identifier')
    ->on('members')
    ->onDelete('cascade');

Pivot Table Generator

The flickerleap:pivot-table command is used to generate a migration to create a pivot table between two models. It has the following syntax:

flickerleap:pivot-table model1 model2 [--add=...] [--force=true] [--file=...]

• model1 and model2: names of the two models (or the two tables if the models don't follow the naming conventions)

• --add: Specifies additional columns like timestamps, softDeletes, rememberToken and nullableTimestamps.

• --file: The migration file name. By default the name follows the patern date_time_create_table_name.php.

php artisan flickerleap:pivot-table Tag Project --add=timestamps

gives:

<?php

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateProjectTagMigration extends Migration
{
    
    public function up()
    {
        Schema::create('project_tag', function(Blueprint $table) {
            $table->increments('id');
            $table->integer('project_id')->unsigned()->index();
            $table->integer('tag_id')->unsigned()->index();
            $table->foreign('project_id')
                ->references('id')
                ->on('projects');
            $table->foreign('tag_id')
                ->references('id')
                ->on('tags');
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::drop('project_tag');
    }
}

Controller Generator

There are two commands for controllers. The first one is flickerleap:controller:rest-actions which generates a trait used by all generated controllers. This trait includes the following methods:

• all() : returns all the model entries as JSON.

• get($id) : returns a specific model by id as JSON.

• add(Request $request) : adds a new model or returns validation errors as JSON.

• put(Request $request, $id) : updates a model or returns validation errors as JSON.

• remove($id) : removes an entry by id.

Note that the trait doesn't use the common used methods on Laravel (like index, store, ...) to avoid conflicts. Which enables you to use this trait with controllers you already have in your application.

The second command is flickerleap:controller which actually generates the controller. The syntax of this command is flickerleap:controller model [--no-routes] [--force=true].

• model: Name of the model (with namespace if not App).

• --no-routes: Since routes are generated by default for the controller, this option is used to tell the generator "do not generate routes !".

• --force: tells the generator to override the existing file.

• --laravel: create Laravel style routes

php artisan flickerleap:controller Task --no-routes gives:

<?php namespace App\Http\Controllers;


class TasksController extends Controller {

	const MODEL = "App\\Task";

	use RESTActions;

}

Routes Generator

The flickerleap:route command is used to generate RESTfull routes for a controller. It has the following syntax:

flickerleap:route resource [--controller=...] [--force=true]

• resource: the resource name to use in the URLs.

• --controller: the corresponding controller. If missing it's deducted from the resource name.

• --force: tells the generator to override the existing file.

• --laravel: create Laravel style routes

php artisan flickerleap:route project-type adds the following routes:

$app->get('project-type', 'ProjectTypesController@all');
$app->get('project-type/{id}', 'ProjectTypesController@get');
$app->post('project-type', 'ProjectTypesController@add');
$app->put('project-type/{id}', 'ProjectTypesController@put');
$app->delete('project-type/{id}', 'ProjectTypesController@remove');

php artisan flickerleap:route project-type --laravel adds the following routes:

Route::get('project-type', 'ProjectTypesController@all');
Route::get('project-type/{id}', 'ProjectTypesController@get');
Route::post('project-type', 'ProjectTypesController@add');
Route::put('project-type/{id}', 'ProjectTypesController@put');
Route::delete('project-type/{id}', 'ProjectTypesController@remove');

Resource Generator

The flickerleap:resource command makes it very easy to generate a RESTful resource. It generates a model, migration, controller and routes. The syntax is : flickerleap:resource name fields [--add=...] [--has-many=...] [--has-one=...] [--belongs-to=...] [--migration-file=...] [--path=...] [--force=true]

• name: the name of the resource used in the URLs and to determine the model, table and controller names.

• fields: specifies the fields of the resource along with schema and validation rules. It follows the syntax name;schema;rules;tags ...

  • name: the name of the field

  • schema: the schema following the syntax in the model generator. (note that the name is not part of the schema like on the model generator)

  • rules: the validation rules

  • tags: additional tags separated by commas. The possible tags are:

    • fillable: add this field to the fillable array of the model.

    • date: add this field to the dates array of the model.

    • key: this field is a foreign key.

• --add: Specifies additional columns like timestamps, softDeletes, rememberToken and nullableTimestamps of the migration and if the list contains no timestamps, the model with contain public $timestamps = false;.

• --has-one, --has-many and --belongs-to are the same as for the flickerleap:model command.

• --migration-file: passed to the flickerleap:migration as the --file option.

• --path: Defines where to store the model file as well as its namespace.

• --force: tells the generator to override the existing file.

• --laravel: create Laravel style routes

Multiple Resources From File

The flickerleap:resources (note the "s" in "resources") command takes the generation process to an other level by parsing a file and generating multiple resources based on it. The syntax is

flickerleap:resources filename [--path=...] [--force=true]

This generator is smart enough to add foreign keys automatically when finding a belongsTo relation. It also generates pivot tables for belongsToMany relations automatically.

The file given to the command should be a valid YAML file ( for the moment, support of other types like XML or JSON could be added in the future). An example is the following:

• --path: Defines where to store the model files as well as their namespace.

• --laravel: create Laravel style routes

---
Store:
  hasMany: products
  fields:
    name:
      schema: string:50 unique
      rules: required|min:3
      tags: fillable
Product:
  belongsTo: store
  fields:
    name:
      schema: string
      rules: required
      tags: fillable
    store_id:
      schema: integer unsigned
      rules: required numeric
      tags: fillable key
    desc:
      schema: text nullable
      tags: fillable
    published_at:
      schema: date
      rules: date
      tags: date fillable
    price:
      schema: 'decimal:5,2' # need quotes when using ','
      rules: numeric
      tags: fillable
  add: timestamps softDeletes

Testing

To test the generators, I included a fresh lumen installation under the folder lumen-test to which I added this package and have written some acceptance tests using Codeception. To run tests you just have to execute the install.sh to install dependencies then execute test.sh.

Development Notes

• Comming versions

  • Seeder and Test generators

  • Requested Feature: Custom Templates

  • Requested Feature: Fractal integration

  • Requested Feature: Add possibility to not run migrations when using flickerleap:resources

  • Documentation: Adding examples

• Version 1.3.3

  • Bug Fixed: Rules issue when creating resources from YAML file

• Version 1.3.2

  • Bug Fixed: softDeletes not added to model

• Version 1.3.1

  • Bug Fixed: duplicate column for the foriegn key when using flickerleap:resources

• Version 1.3.0

  • Requested Feature: Disabling timestamps

  • Requested Feature: Lumen 5.3 routes support

• Version 1.2.0

  • Tests fixed.

  • Bug fixed: Undefined index: factory

  • Feature added: Check if file already exists before generating it

  • Feature added: Support for additional columns like nullableTimestamps() and softDeletes() in migrations

  • Feature added: Specifying namespace for flickerleap:resource and flickerleap:resources

• Version 1.1.1

  • Pivot table generation from the flickerleap:resources command bug fixed.

• Version 1.1.0

  • Pivot table generator added.

  • belongsToMany relationship added to model generator.

  • Multiple resources generator adds foreign keys for belongsTo relationships automatically.

  • Multiple resources generator adds pivot tables for belongsToMany relationships automatically.

  • Generated migrations file names changed to be supported by migrate command.

• Version 1.0.0

  • Model Generator

  • Migration Generator

  • Controller Generator

  • Routes Generator

  • Resource Generator

  • Multiple Resources From File

Contributing

Pull requests are welcome :D