├── .gitignore
├── LICENSE
├── README.md
├── composer.json
├── src
    ├── LaravelMakeServiceProvider.php
    ├── MakeService.php
    └── Stubs
    │   ├── interface.stub
    │   ├── service.interface.stub
    │   └── service.stub
└── tests
    ├── GenerateTest.php
    └── StubExistTest.php


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | .DS_Store
3 | composer.lock
4 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2018 getsolaris (https://github.com/getsolaris)
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center">
 2 | 
 3 | [![Latest Stable Version](http://poser.pugx.org/getsolaris/laravel-make-service/v)](https://packagist.org/packages/getsolaris/laravel-make-service) [![Monthly Downloads](http://poser.pugx.org/getsolaris/laravel-make-service/d/monthly)](https://packagist.org/packages/getsolaris/laravel-make-service)
 4 | [![Total Downloads](http://poser.pugx.org/getsolaris/laravel-make-service/downloads)](https://packagist.org/packages/getsolaris/laravel-make-service)
 5 | [![License](http://poser.pugx.org/getsolaris/laravel-make-service/license)](https://packagist.org/packages/getsolaris/laravel-make-service)
 6 | [![PHP Version Require](http://poser.pugx.org/getsolaris/laravel-make-service/require/php)](https://packagist.org/packages/getsolaris/laravel-make-service)
 7 | 
 8 | </p>
 9 | 
10 | # A MVCS pattern create a service command for Laravel 5+
11 | Create a new service class and service interface
12 | 
13 | # Install
14 | ```bash
15 | composer require getsolaris/laravel-make-service --dev
16 | ```
17 | 
18 | # Suggest
19 | getsolaris.kr@gmail.com
20 | 
21 | 
22 | # Usage
23 | ```bash
24 | $ php artisan make:service {name : Create a service class} {--i : Optional of create a service interface}
25 | ```
26 | 
27 | # Example
28 | 
29 | ## Create a service class
30 | ```bash
31 | $ php artisan make:service UserService
32 | ```
33 | 
34 | ```php
35 | <?php
36 | // app/Http/Services/UserService.php
37 | 
38 | namespace App\Services;
39 | 
40 | /**
41 |  * Class UserService
42 |  * @package App\Services
43 |  */
44 | class UserService
45 | {
46 | 
47 | }
48 | ```
49 | 
50 | ## + Optional service interface
51 | 
52 | ```
53 | v1.0.x -> contract
54 | v1.1.x -> interface
55 | ```
56 | 
57 | ```bash
58 | $ php artisan make:service UserService --i
59 | ```
60 | 
61 | ```php
62 | <?php
63 | // app/Http/Services/Contracts/UserServiceInterface.php
64 | 
65 | namespace App\Services\Interfaces;
66 | 
67 | /**
68 |  * Interface UserServiceInterface
69 |  * @package App\Services\Interfaces
70 |  */
71 | interface UserServiceInterface
72 | {
73 | 
74 | }
75 | 
76 | ```
77 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "getsolaris/laravel-make-service",
 3 |     "description": "A MVCS pattern create a service command for Laravel 5+",
 4 |     "keywords": [
 5 |         "laravel",
 6 |         "mvcs",
 7 |         "service",
 8 |         "contract",
 9 |         "pattern"
10 |     ],
11 |     "type": "library",
12 |     "require": {
13 |         "php": "^7.1|^8.0",
14 |         "illuminate/support": "~5.6.34|~5.7.0|~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0",
15 |         "illuminate/console": "~5.6.34|~5.7.0|~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0"
16 |     },
17 |     "require-dev": {
18 |         "phpunit/phpunit": "^9.5|^10.0"
19 |     },
20 |     "license": "MIT",
21 |     "authors": [
22 |         {
23 |             "name": "getsolaris",
24 |             "email": "getsolaris.kr@gmail.com"
25 |         }
26 |     ],
27 |     "extra": {
28 |         "laravel": {
29 |             "providers": [
30 |                 "Getsolaris\\LaravelMakeService\\LaravelMakeServiceProvider"
31 |             ]
32 |         }
33 |     },
34 |     "autoload": {
35 |         "psr-4": {
36 |             "Getsolaris\\LaravelMakeService\\": "src/"
37 |         },
38 |         "classmap": [
39 |             "src/"
40 |         ]
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/src/LaravelMakeServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Getsolaris\LaravelMakeService;
 4 | 
 5 | use Illuminate\Support\ServiceProvider;
 6 | 
 7 | class LaravelMakeServiceProvider extends ServiceProvider
 8 | {
 9 |     /**
10 |      * Register the application services.
11 |      *
12 |      * @return void
13 |      */
14 |     public function register(): void
15 |     {
16 |         $this->commands(MakeService::class);
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/src/MakeService.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Getsolaris\LaravelMakeService;
  4 | 
  5 | use Illuminate\Console\GeneratorCommand;
  6 | 
  7 | /**
  8 |  * Class MakeService.
  9 |  *
 10 |  * @author  getsolaris (https://github.com/getsolaris)
 11 |  */
 12 | class MakeService extends GeneratorCommand
 13 | {
 14 |     /**
 15 |      * STUB_PATH.
 16 |      */
 17 |     const STUB_PATH = __DIR__ . '/Stubs/';
 18 | 
 19 |     /**
 20 |      * The name and signature of the console command.
 21 |      *
 22 |      * @var string
 23 |      */
 24 |     protected $signature = 'make:service {name : Create a service class} {--i : Create a service interface}';
 25 | 
 26 |     /**
 27 |      * The console command description.
 28 |      *
 29 |      * @var string
 30 |      */
 31 |     protected $description = 'Create a new service class and contract';
 32 | 
 33 |     /**
 34 |      * The type of class being generated.
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     protected $type = 'Service';
 39 | 
 40 |     protected function getStub()
 41 |     {
 42 |     }
 43 | 
 44 |     /**
 45 |      * @return string
 46 |      */
 47 |     protected function getServiceStub(): string
 48 |     {
 49 |         return self::STUB_PATH . 'service.stub';
 50 |     }
 51 | 
 52 |     protected function getInterfaceStub(): string
 53 |     {
 54 |         return self::STUB_PATH . 'interface.stub';
 55 |     }
 56 | 
 57 |     /**
 58 |      * @return string
 59 |      */
 60 |     protected function getServiceInterfaceStub(): string
 61 |     {
 62 |         return self::STUB_PATH . 'service.interface.stub';
 63 |     }
 64 | 
 65 |     /**
 66 |      * Execute the console command.
 67 |      *
 68 |      * @return bool|null
 69 |      *
 70 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
 71 |      * @see \Illuminate\Console\GeneratorCommand
 72 |      *
 73 |      */
 74 |     public function handle()
 75 |     {
 76 |         if ($this->isReservedName($this->getNameInput())) {
 77 |             $this->error('The name "' . $this->getNameInput() . '" is reserved by PHP.');
 78 | 
 79 |             return false;
 80 |         }
 81 | 
 82 |         $name = $this->qualifyClass($this->getNameInput());
 83 | 
 84 |         $path = $this->getPath($name);
 85 | 
 86 |         if ((! $this->hasOption('force') ||
 87 |                 ! $this->option('force')) &&
 88 |             $this->alreadyExists($this->getNameInput())) {
 89 |             $this->error($this->type . ' already exists!');
 90 | 
 91 |             return false;
 92 |         }
 93 | 
 94 |         $this->makeDirectory($path);
 95 |         $isInterface = $this->option('i');
 96 | 
 97 |         $this->files->put(
 98 |             $path,
 99 |             $this->sortImports(
100 |                 $this->buildServiceClass($name, $isInterface)
101 |             )
102 |         );
103 |         $message = $this->type;
104 | 
105 |         // Whether to create contract
106 |         if ($isInterface) {
107 |             $interfaceName = $this->getNameInput() . 'Interface.php';
108 |             $interfacePath = str_replace($this->getNameInput() . '.php', 'Interfaces/', $path);
109 | 
110 |             $this->makeDirectory($interfacePath . $interfaceName);
111 | 
112 |             $this->files->put(
113 |                 $interfacePath . $interfaceName,
114 |                 $this->sortImports(
115 |                     $this->buildServiceInterface($this->getNameInput())
116 |                 )
117 |             );
118 | 
119 |             $message .= ' and Interface';
120 |         }
121 | 
122 |         $this->info($message . ' created successfully.');
123 |     }
124 | 
125 |     /**
126 |      * Build the class with the given name.
127 |      *
128 |      * @param string $name
129 |      * @param $isInterface
130 |      * @return string
131 |      *
132 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
133 |      */
134 |     protected function buildServiceClass(string $name, $isInterface): string
135 |     {
136 |         $stub = $this->files->get(
137 |             $isInterface ? $this->getServiceInterfaceStub() : $this->getServiceStub()
138 |         );
139 | 
140 |         return $this->replaceNamespace($stub, $name)->replaceClass($stub, $name);
141 |     }
142 | 
143 |     /**
144 |      * Build the class with the given name.
145 |      *
146 |      * @param string $name
147 |      * @return string
148 |      *
149 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
150 |      */
151 |     protected function buildServiceInterface(string $name): string
152 |     {
153 |         $stub = $this->files->get($this->getInterfaceStub());
154 | 
155 |         return $this->replaceNamespace($stub, $name)->replaceClass($stub, $name);
156 |     }
157 | 
158 |     /**
159 |      * @param $rootNamespace
160 |      * @return string
161 |      */
162 |     protected function getDefaultNamespace($rootNamespace): string
163 |     {
164 |         return $rootNamespace . '\Services';
165 |     }
166 | }
167 | 


--------------------------------------------------------------------------------
/src/Stubs/interface.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Services\Interfaces;
 4 | 
 5 | /**
 6 |  * Interface {{ class }}Interface
 7 |  * @package App\Services\Interfaces
 8 |  */
 9 | interface {{ class }}Interface
10 | {
11 | 
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Stubs/service.interface.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace {{ namespace }};
 4 | 
 5 | use {{ namespace }}\Interfaces\{{ class }}Interface;
 6 | 
 7 | /**
 8 |  * Class {{ class }}
 9 |  * @package App\Services
10 |  */
11 | class {{ class }} implements {{ class }}Interface
12 | {
13 | 
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Stubs/service.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace {{ namespace }};
 4 | 
 5 | /**
 6 |  * Class {{ class }}
 7 |  * @package App\Services
 8 |  */
 9 | class {{ class }}
10 | {
11 | 
12 | }
13 | 


--------------------------------------------------------------------------------
/tests/GenerateTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use PHPUnit\Framework\TestCase;
 4 | use Illuminate\Foundation\Testing\Concerns\InteractsWithConsole;
 5 | use Tests\CreatesApplication;
 6 | 
 7 | /**
 8 |  * @property \Illuminate\Contracts\Container\Container $app
 9 |  */
10 | class GenerateTest extends TestCase
11 | {
12 |     use CreatesApplication, InteractsWithConsole;
13 | 
14 |     protected $app;
15 | 
16 |     public function setUp(): void
17 |     {
18 |         parent::setUp();
19 |         $this->app = require __DIR__ . '/../../bootstrap/app.php';
20 |     }
21 | 
22 |     /**
23 |      * @return void
24 |      */
25 |     public function test_make_service_command(): void
26 |     {
27 |         $this->artisan('make:service TestService')->assertSuccessful();
28 |     }
29 | 
30 |     /**
31 |      * @return void
32 |      */
33 |     public function test_make_service_to_interface_command(): void
34 |     {
35 |         $this->artisan('make:service TestService --i')->assertSuccessful();
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/tests/StubExistTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use PHPUnit\Framework\TestCase;
 4 | 
 5 | class StubExistTest extends TestCase
 6 | {
 7 |     /**
 8 |      * @return void
 9 |      */
10 |     public function test_exist_service_stub(): void
11 |     {
12 |         $this->assertFileExists(__DIR__ . '/../src/Stubs/service.stub');
13 |     }
14 | 
15 |     /**
16 |      * @return void
17 |      */
18 |     public function test_exist_interface_stub(): void
19 |     {
20 |         $this->assertFileExists(__DIR__ . '/../src/Stubs/interface.stub');
21 |     }
22 | 
23 |     /**
24 |      * @return void
25 |      */
26 |     public function test_exist_service_interface_stub(): void
27 |     {
28 |         $this->assertFileExists(__DIR__ . '/../src/Stubs/service.interface.stub');
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------