Merge pull request #2 from RajTechnologiesPvtLtd/feature/pivot-table

create a pivot table generator

Author: bhargavraviya

README.md

@@ -175,6 +175,18 @@ class RepositoryServiceProvider extends ServiceProvider
    }
 }
 ```
+# Pivot Table Generator
+
+## Usage
+Run the following command on the command-line to generate a new migration for the pivot table.
+```
+php artisan make:pivot {first_table_name} {second_table_name}
+```
+
+The command will create a new migration in ```database/migrations```. Run the migrations to create the table.
+```
+php artisan migrate
+```
 
 # Service Generator
 
@@ -348,8 +360,6 @@ class PostController extends Controller
 }
 ```
 
-
-
 ## Contributing
 
 - [Bhargav Raviya](https://github.com/bhargavraviya)

composer.json

@@ -13,6 +13,8 @@
         "generator",
         "cli",
         "artisan",
+        "pivot",
+        "migrations"
         "services",
         "pattern"
     ],

src/Console/MakePivotCommand.php

@@ -0,0 +1,174 @@
+<?php
+
+namespace RajTechnologies\Tools\Console;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use Illuminate\Support\Str;
+use Symfony\Component\Console\Input\InputArgument;
+
+class MakePivotCommand extends GeneratorCommand
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'make:pivot {first_table_name} {second_table_name}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new pivot table';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Migration';
+
+    /**
+     * Build the class with the given name.
+     *
+     * @param  string  $name
+     * @return string
+     *
+     * @throws FileNotFoundException
+     */
+    protected function buildClass($name): string
+    {
+        $stub = $this->files->get($this->getStub());
+
+        return $this->populateStub($stub);
+    }
+
+    /**
+     * Replace the namespace for the given stub.
+     *
+     * @param string $stub
+     * @return string
+     */
+    protected function populateStub(string $stub): string
+    {
+        list($firstTable, $secondTable) = $this->getSortedInput();
+
+        $searches = [
+            [
+                '{{ first_table_name }}',
+                '{{ second_table_name }}',
+                '{{ class }}',
+                '{{ pivot_table }}'
+            ],
+        ];
+
+        foreach ($searches as $search) {
+            $stub = str_replace(
+                $search,
+                [
+                    $firstTable,
+                    $secondTable,
+                    $this->getClassName(),
+                    $this->getNameInput()
+                ],
+                $stub
+            );
+        }
+
+        return $stub;
+    }
+
+    /**
+     * @return string
+     */
+    public function getClassName(): string
+    {
+        $name = Str::studly($this->getNameInput());
+
+        return "Create{$name}Table";
+    }
+
+    /**
+     * @return array
+     */
+    protected function getSortedInput(): array
+    {
+        $inputValues = [
+            $this->getSingularInput('first_table_name'),
+            $this->getSingularInput('second_table_name')
+        ];
+        sort($inputValues);
+
+        return $inputValues;
+    }
+
+    /**
+     * Get the desired class name from the input.
+     *
+     * @return string
+     */
+    protected function getNameInput(): string
+    {
+        $sortedInput = $this->getSortedInput();
+
+        return implode('_', $sortedInput);
+    }
+
+    /**
+     * @param string $name
+     * @return string
+     */
+    protected function getSingularInput(string $name): string
+    {
+        return Str::lower(Str::singular(trim($this->argument($name))));
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub(): string
+    {
+        return __DIR__ . '/../../stubs/pivot_migration.stub';
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace): string
+    {
+        return $rootNamespace . '/../database/migrations';
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments(): array
+    {
+        return [
+            ['first_table_name', InputArgument::REQUIRED, 'The name of the first table'],
+            ['second_table_name', InputArgument::REQUIRED, 'The name of the second table'],
+        ];
+    }
+
+    /**
+     * Get the destination class path.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function getPath($name): string
+    {
+        $filename = now()->format('Y_m_d_his') . "_create_" . $this->getNameInput() . "_table.php";
+
+        return database_path('migrations/' . $filename);
+    }
+}

src/ToolServiceProvider.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\Facades\File;
 use RajTechnologies\Tools\Console\MakeRepository;
 use RajTechnologies\Tools\Console\MakeRepositoryInterface;
+use RajTechnologies\Tools\Console\MakePivotCommand;
 use RajTechnologies\Tools\Console\MakeModel;
 use RajTechnologies\Tools\Console\MakeService;
 
@@ -30,6 +31,11 @@ public function boot(){
             ], 'config');
         }
 		// Repository Pattern End
+		// Pivot Table Start
+		if ($this->app->runningInConsole()) {
+            $this->commands([MakePivotCommand::class]);
+        }
+		// Pivot Table End
 		// Service Start
 		if ($this->app->runningInConsole()) {
             $this->commands([
@@ -72,4 +78,4 @@ protected function bindInterfaces()
 	// Repository Pattern End
 }
 
-?>
+?>

stubs/pivot_migration.stub

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class {{ class }} extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('{{ pivot_table }}', function (Blueprint $table) {
+            $table->foreignId('{{ first_table_name }}_id')->onDelete('cascade');
+            $table->foreignId('{{ second_table_name }}_id')->onDelete('cascade');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('{{ pivot_table }}');
+    }
+}