create a service generator

Author: bhargavraviya

README.md

@@ -22,12 +22,12 @@ RajTechnologies\Tools\ToolServiceProvider::class,
 
 ## URL Routes
 
-| Name            | URL                 | Description                     |
-|-----------------|---------------------|---------------------------------|
-| Clear Cache     | clear-cache         | all type cache clear in larevel |
-| HTTP status Code| httplist            | HTTP Status Code List (cheat sheet) |
-| Routes List     | routeslist          | All Routes List                 |
-| API Routes List | routeslist?only=api | Only API Routes List            |
+| Name             | URL                 | Description                         |
+| ---------------- | ------------------- | ----------------------------------- |
+| Clear Cache      | clear-cache         | all type cache clear in larevel     |
+| HTTP status Code | httplist            | HTTP Status Code List (cheat sheet) |
+| Routes List      | routeslist          | All Routes List                     |
+| API Routes List  | routeslist?only=api | Only API Routes List                |
 
 ## PWA App
 - Open your `config/app.php` and add the following to the `providers` array: 
@@ -175,6 +175,181 @@ class RepositoryServiceProvider extends ServiceProvider
    }
 }
 ```
+
+# Service Generator
+
+## Table of Contents
+  <ol>
+    <li><a href="#features">Features</a></li>
+    <li><a href="#installation">Installation</a></li>
+    <li>
+      <a href="#usage">Usage</a>
+      <ul>
+        <li><a href="#generate-services">Generate services</a></li>
+        <li><a href="#generate-services-for-models">Generate services for models</a></li>
+        <li><a href="#generate-services-for-controllers">Generate services for controllers</a></li>
+      </ul>
+    </li>
+    <li>
+        <a href="#the-service-pattern">The service pattern</a>
+        <ul>
+            <li><a href="#when-to-use-the-service-pattern">When to use the service pattern</a></li>
+            <li>
+                <a href="#how-to-use-services">How to use services</a>
+                <ul>
+                    <li><a href="#static-methods">Static methods</a></li>
+                    <li><a href="#depency-injection">Dependency Injection</a></li>
+                </ul>
+            </li>
+        </ul>
+    </li>
+    <li><a href="#more-generator-packages">More generator packages</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+  </ol>
+
+## Usage
+After installation the ```php artisan make:service {name}``` will be available in the list
+of artisan commands. 
+
+### Generate Service
+To generate a new service use the following artisan command.
+```bash
+php artisan make:service UserService
+```
+
+### Generate a service for a model
+Add a ```--service``` or ```-S``` param to generate a service for the model.
+```bash
+php artisan make:model Post --service
+```
+
+Use the ```-a``` or ```--all``` param to generate a service, migration, seeder, factory, policy, 
+and resource controller for the model.
+```bash
+php artisan make:model Post --all
+```
+
+### Generate a service for a controller
+Add a ```--service``` or ```-S``` param to generate a service for the controller.
+
+```bash
+php artisan make:controller PostController --service
+```
+
+## The service pattern
+
+### When to use the service pattern
+A common question is: where do I put my business logic? You want to keep your models thin and your controller functions 
+skinny. There are multiple ways to archive this, extracting your business logic to the
+service layer is a common method. By encapsulating your business logic in a service class you
+are able to re-use the logic for example in your controllers, commands, jobs and middelware.
+
+### How to use services
+Once you have made a service it is time to add your business logic. We will discus how to use a service via static methods,
+dependency injection and how to use it with interfaces and repositories.
+
+#### Static methods
+a common way to use a service is to call it's methods statically. It is similar to helper functions. Let's say we have
+a ```PostService``` with a method to get a post based on a slug.
+
+```php
+namespace App\Services;
+
+use App\Models\Post;
+
+class PostService
+{
+    // Declare the function as static
+    public static function getPostBySlug(string $slug): Post
+    {
+        return Post::with('tags')
+            ->where('slug', $slug)
+            ->get();
+    }
+}
+```
+
+Next you can include the service class for example your controller and call the ```getPostBySlug``` method statically.
+```php
+namespace App\Http\Controllers;
+
+// Include the service
+use App\Services\PostService;
+
+class PostController extends Controller
+{
+    public function show(string $slug)
+    {
+        // Call the method statically from the service class
+        $post = PostService::getPostBySlug($slug);
+        
+        return view('posts.show', compact('post'));
+    }
+}#
+```
+
+The ```getPostBySlug``` method is in this example a very simple function but as you can see it keeps you controller skinny
+and and your business logic seperated. Keep in mind that static classes and methods are stateless. The class won't save 
+any data in itself.
+
+#### Dependency Injection
+Another popular method is to use services with dependency injection. With dependency injection you can write loosely 
+coupled code. When done right this will improve the flexibility and maintainability of your code.
+
+The ```PostService``` we used as example before will remain
+almost the same except we don't declare the functions inside the class as static anymore.
+
+```php
+namespace App\Services;
+
+use App\Models\Post;
+
+class PostService
+{
+    public function getPostBySlug(string $slug): Post
+    {
+        return Post::with('tags')
+            ->where('slug', $slug)
+            ->get();
+    }
+}
+```
+
+Next we inject the service into the constructor of the class where we want to use it. Inside the constructor we
+assign the object to the ```$postService``` class property. Now the ```$postService``` property will be callable in 
+all functions within the class with ```$this->postService```. While typing your IDE will already typehint the functions
+in your PostService class, in this case only ```->getPostBySlug($slug)```. 
+```php
+namespace App\Http\Controllers;
+
+// Include the service
+use App\Services\PostService;
+
+class PostController extends Controller
+{
+    // Declare the property
+    protected $postService;
+
+    // Inject the service into the constructor
+    public function __construct(PostService $postService)
+    {
+        // Assign the service instance to the class property
+        $this->postService = $postService;
+    }
+
+    public function show($slug)
+    {
+        // Call the method you need from the service via the class property
+        $post = $this->postService->getPostBySlug($slug);
+        
+        return view('posts.show', compact('post'));
+    }
+}
+```
+
+
+
 ## Contributing
 
 - [Bhargav Raviya](https://github.com/bhargavraviya)

composer.json

@@ -31,7 +31,8 @@
     "extra": {
         "laravel": {
             "providers": [
-                "RajTechnologies\\Tools\\ToolServiceProvider"
+                "RajTechnologies\\Tools\\ToolServiceProvider",
+                "RajTechnologies\\Tools\\Http\\Providers\\CommandServiceProvider"
             ]
         }
     }

src/Console/MakeController.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace RajTechnologies\Tools\Console;
+
+use Illuminate\Routing\Console\ControllerMakeCommand;
+use Illuminate\Support\Str;
+use Symfony\Component\Console\Input\InputOption;
+
+class MakeController extends ControllerMakeCommand
+{
+    /**
+     * @return void
+     */
+    public function handle()
+    {
+        parent::handle();
+
+        if ($this->option('service')) {
+            $this->createService();
+        }
+    }
+
+    /**
+     * Create a model factory for the model.
+     *
+     * @return void
+     */
+    protected function createService()
+    {
+        $nameInput = Str::replace('Controller', '', $this->getNameInput());
+        $name = Str::studly($nameInput);
+
+        $this->call('make:service', [
+            'name' => "{$name}Service"
+        ]);
+    }
+
+    /**
+     * @return array
+     */
+    public function getOptions(): array
+    {
+        $options = parent::getOptions();
+        $options[] = ['service', 's', InputOption::VALUE_NONE, 'Generate a service for the controller'];
+
+        return $options;
+    }
+}

src/Console/MakeModel.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace RajTechnologies\Tools\Console;
+
+use Illuminate\Foundation\Console\ModelMakeCommand;
+use Illuminate\Support\Str;
+use Symfony\Component\Console\Input\InputOption;
+
+class MakeModel extends ModelMakeCommand
+{
+    /**
+     * @return void
+     */
+    public function handle()
+    {
+        parent::handle();
+
+        if ($this->option('all')) {
+            $this->input->setOption('service', true);
+        }
+
+        if ($this->option('service')) {
+            $this->createService();
+        }
+    }
+
+    /**
+     * Create a model factory for the model.
+     *
+     * @return void
+     */
+    protected function createService()
+    {
+        $name = Str::studly($this->getNameInput());
+
+        $this->call('make:service', [
+            'name' => "{$name}Service"
+        ]);
+    }
+
+    /**
+     * @return array
+     */
+    public function getOptions(): array
+    {
+        $options = parent::getOptions();
+        $options[] = ['service', 'S', InputOption::VALUE_NONE, 'Generate a service for the model'];
+
+        return $options;
+    }
+}

src/Console/MakeService.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace RajTechnologies\Tools\Console;
+
+use Illuminate\Console\GeneratorCommand;
+
+class MakeService extends GeneratorCommand
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'make:service {name}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new service class';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Service';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return __DIR__.'/../../stubs/service.stub';
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Services';
+    }
+}

src/Http/Providers/CommandServiceProvider.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace RajTechnologies\Tools\Http\Providers;
+
+use Illuminate\Foundation\Providers\ArtisanServiceProvider;
+use RajTechnologies\Tools\Console\MakeController;
+use RajTechnologies\Tools\Console\MakeModel;
+
+class CommandServiceProvider extends ArtisanServiceProvider
+{
+    /**
+     * Register the command.
+     *
+     * @return void
+     */
+    protected function registerModelMakeCommand()
+    {
+        $this->app->singleton('command.model.make', function ($app) {
+            return new MakeModel($app['files']);
+        });
+    }
+
+    /**
+     * Register the command.
+     *
+     * @return void
+     */
+    protected function registerControllerMakeCommand()
+    {
+        $this->app->singleton('command.controller.make', function ($app) {
+            return new MakeController($app['files']);
+        });
+    }
+}