FileGeneratorTest::testCreatePermission() - Code Metrics - Inspection of "fixing filegeneration tests" - deviouspk/larapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 965fb6...8a373e )

by Arthur
created 2019-03-23 14:20 UTC
FileGeneratorTest::testCreatePermission() A

↳ Parent: FileGeneratorTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	20
Code Lines	14
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	14
nc	1
nop	0
dl	0
loc	20
rs	9.7998
c	0
b	0
f	0
<?php

namespace Foundation\Tests;

use Foundation\Abstracts\Tests\TestCase;
use Foundation\Core\Larapi;
use Foundation\Generator\Abstracts\ResourceGeneratedEvent;
use Foundation\Generator\Contracts\ResourceGenerationContract;
use Foundation\Generator\Events\CommandGeneratedEvent;
use Foundation\Generator\Events\ComposerGeneratedEvent;
use Foundation\Generator\Events\ControllerGeneratedEvent;
use Foundation\Generator\Events\FactoryGeneratedEvent;
use Foundation\Generator\Events\JobGeneratedEvent;
use Foundation\Generator\Events\ListenerGeneratedEvent;
use Foundation\Generator\Events\MiddlewareGeneratedEvent;
use Foundation\Generator\Events\MigrationGeneratedEvent;
use Foundation\Generator\Events\ModelGeneratedEvent;
use Foundation\Generator\Events\NotificationGeneratedEvent;
use Foundation\Generator\Events\PermissionGeneratedEvent;
use Foundation\Generator\Events\PolicyGeneratedEvent;
use Foundation\Generator\Events\ProviderGeneratedEvent;
use Foundation\Generator\Events\RequestGeneratedEvent;
use Foundation\Generator\Events\RouteGeneratedEvent;
use Foundation\Generator\Events\RuleGeneratedEvent;
use Foundation\Generator\Events\SeederGeneratedEvent;
use Foundation\Generator\Events\ServiceGeneratedEvent;
use Foundation\Generator\Events\TestGeneratedEvent;
use Foundation\Generator\Events\TransformerGeneratedEvent;
use Foundation\Generator\Managers\GeneratorManager;
use Foundation\Traits\DispatchedEvents;
use Foundation\Traits\DisableRefreshDatabase;
use \Illuminate\Support\Facades\Event;
use Illuminate\Support\Str;

/**
 * Created by PhpStorm.
 * User: arthur
 * Date: 10.03.19
 * Time: 18:35
 */
class FileGeneratorTest extends TestCase
{
    use DisableRefreshDatabase, DispatchedEvents;

    public function setUp(): void
    {
        parent::setUp();

        /* Do not remove this line. It prevents the listener that generates the files from executing */
        Event::fake();
    }

    protected function getModuleGenerator(string $moduleName): GeneratorManager
    {
        return GeneratorManager::module($moduleName, true);
    }

    public function testCreateSqlMigration()
    {
        $module = 'User';
        $class = "CreateUserTable";
        $table = "users";
        $mongo = false;
        $this->getModuleGenerator($module)->createMigration($class, $table, $mongo);

        $stub = "migration.stub";
        $table = "users";

        /* @var MigrationGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(MigrationGeneratedEvent::class);
        $this->assertNotNull($event);
        $this->assertEquals($module, $event->getModuleName());
        $this->assertEquals($stub, $event->getStub()->getName());
        $this->assertEquals($class, $event->getClassName());
        $this->assertEquals($table, $event->getTableName());
        $this->assertEquals($mongo,$event->isMongoMigration());
    }

    public function testCreateMongoMigration()
    {
        $module = 'User';
        $class = "CreateUserTable";
        $table = "users";
        $mongo = true;
        $this->getModuleGenerator($module)->createMigration($class, $table, $mongo);

        $stub = "migration-mongo.stub";
        $table = "users";

        /* @var MigrationGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(MigrationGeneratedEvent::class);
        $this->assertNotNull($event);
        $this->assertEquals($module, $event->getModuleName());
        $this->assertEquals($stub, $event->getStub()->getName());
        $this->assertEquals($class, $event->getClassName());
        $this->assertEquals($table, $event->getTableName());
        $this->assertEquals($mongo,$event->isMongoMigration());
    }

    public function testCreateFactory()
    {
        $module = "User";
        $model = $module;
        $class = $model . "Factory";
        $this->getModuleGenerator($module)->createFactory($module);

        $path = Larapi::getModule($module)->getFactories()->getPath() . "/$class.php";
        $stub = "factory.stub";
        $modelNamespace  = "Modules\User\Entities\User";

        /* @var FactoryGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(FactoryGeneratedEvent::class);
        $this->assertFileBasics(
            $event,
            $module,
            $stub,
            $path);
        $this->assertEquals($class,$event->getClassName());
        $this->assertEquals($model,$event->getModel());
        $this->assertEquals($modelNamespace,$event->getModelNamespace());

    }

    public function testCreateController()
    {
        $module = "User";
        $class = "UserController";
        $this->getModuleGenerator($module)->createController($class);

        $path = Larapi::getModule($module)->getControllers()->getPath() . "/$class.php";
        $stub = "controller.stub";
        $namespace = "Modules\User\Http\Controllers";

        /* @var ControllerGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ControllerGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateListener()
    {
        $module = "User";
        $class = "SendWelcomeMail";
        $eventClass = "UserRegisteredEvent";
        $queued = false;
        $this->getModuleGenerator($module)->createListener($class, $eventClass, $queued);

        $path = Larapi::getModule($module)->getListeners()->getPath() . '/SendWelcomeMail.php';
        $stub = "listener.stub";
        $namespace = "Modules\User\Listeners";
        $eventNamespace = "Modules\User\Events\UserRegisteredEvent";

        /* @var ListenerGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ListenerGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($queued, $event->isQueued());
        $this->assertEquals($eventClass, $event->getEvent());
        $this->assertEquals($eventNamespace, $event->getEventNamespace());
    }

    public function testCreateQueuedListener()
    {
        $module = "User";
        $class = "SendWelcomeMail";
        $eventClass = "UserRegisteredEvent";
        $queued = true;
        $this->getModuleGenerator($module)->createListener($class, $eventClass, $queued);

        $path = Larapi::getModule($module)->getListeners()->getPath() . '/SendWelcomeMail.php';
        $stub = "listener-queued.stub";
        $namespace = "Modules\User\Listeners";
        $eventNamespace = "Modules\User\Events\UserRegisteredEvent";

        /* @var ListenerGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ListenerGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($queued, $event->isQueued());
        $this->assertEquals($eventClass, $event->getEvent());
        $this->assertEquals($eventNamespace, $event->getEventNamespace());
    }

    public function testCreateJob()
    {
        $module = "User";
        $class = "RandomUserJob";
        $synchronous = false;

        $this->getModuleGenerator($module)->createJob($class, $synchronous);

        $path = Larapi::getModule($module)->getJobs()->getPath() . "/$class.php";
        $stub = "job-queued.stub";
        $namespace = "Modules\User\Jobs";

        /* @var JobGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(JobGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($synchronous, $event->isSynchronous());
    }

    public function testCreateSynchronousJob()
    {
        $module = "User";
        $class = "RandomUserJob";
        $synchronous = true;

        $this->getModuleGenerator($module)->createJob($class, $synchronous);

        $path = Larapi::getModule($module)->getJobs()->getPath() . "/$class.php";
        $stub = "job.stub";
        $namespace = "Modules\User\Jobs";

        /* @var JobGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(JobGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($synchronous, $event->isSynchronous());
    }

    public function testCreateCommand()
    {
        $module = "User";
        $class = "RandomCommand";
        $consoleCommand = "user:dosomethingrandom";

        $this->getModuleGenerator($module)->createCommand($class, $consoleCommand);

        $path = Larapi::getModule($module)->getCommands()->getPath() . "/$class.php";
        $stub = "command.stub";
        $namespace = "Modules\User\Console";


        /* @var CommandGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(CommandGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($consoleCommand, $event->getConsoleCommand());
    }

    public function testCreateMiddleware()
    {
        $module = "User";
        $class = "RandomMiddleware";

        $this->getModuleGenerator($module)->createMiddleware($class);

        $path = Larapi::getModule($module)->getMiddleWare()->getPath() . "/$class.php";
        $stub = "middleware.stub";
        $namespace = "Modules\User\Http\Middleware";

        /* @var MiddlewareGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(MiddlewareGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateProvider()
    {
        $module = "User";
        $class = "RandomServiceProvider";

        $this->getModuleGenerator($module)->createServiceProvider($class);

        $path = Larapi::getModule($module)->getServiceProviders()->getPath() . "/$class.php";
        $stub = "provider.stub";
        $namespace = "Modules\User\Providers";

        /* @var ProviderGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ProviderGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateService()
    {
        $module = "User";
        $class = "UserService";

        $this->getModuleGenerator($module)->createService($class);

        $path = Larapi::getModule($module)->getServices()->getPath() . "/$class.php";
        $stub = "service.stub";
        $namespace = "Modules\User\Services";

        /* @var ServiceGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ServiceGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateNotification()
    {
        $module = "User";
        $class = "RandomNotification";

        $this->getModuleGenerator($module)->createNotification($class);

        $path = Larapi::getModule($module)->getNotifications()->getPath() . "/$class.php";
        $stub = "notification.stub";
        $namespace = "Modules\User\Notifications";

        /* @var NotificationGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(NotificationGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateModel()
    {
        $module = "User";
        $modelName = "Address";
        $class = $module . $modelName;
        $needsMigration = true;
        $isMongoModel = false;

        $this->getModuleGenerator($module)->createModel($class, $isMongoModel, $needsMigration);

        $path = Larapi::getModule($module)->getModels()->getPath() . "/$module$modelName.php";
        $stub = "model.stub";
        $namespace = "Modules\User\Entities";

        /* @var ModelGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ModelGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);

        $stub = "migration.stub";
        $table = "user_addresses";
        $migrationClass = "CreateUserAddressTable";

        /* @var MigrationGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(MigrationGeneratedEvent::class);
        $this->assertNotNull($event);
        $this->assertEquals($module, $event->getModuleName());
        $this->assertEquals($stub, $event->getStub()->getName());
        $this->assertEquals($migrationClass, $event->getClassName());
        $this->assertEquals($table, $event->getTableName());
    }

    public function testCreatePolicy()
    {
        $module = "User";
        $class = "UserOwnershipPolicy";

        $this->getModuleGenerator($module)->createPolicy($class);

        $path = Larapi::getModule($module)->getPolicies()->getPath() . "/$class.php";
        $stub = "policy.stub";
        $namespace = "Modules\User\Policies";

        /* @var PolicyGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(PolicyGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateTransformer()
    {
        $module = "User";
        $model = "User";
        $class = "BlablaTransformer";

        $this->getModuleGenerator($module)->createTransformer($class, $model);

        $path = Larapi::getModule($module)->getTransformers()->getPath() . "/$class.php";
        $stub = "transformer.stub";
        $namespace = "Modules\User\Transformers";
        $modelNamespace = "Modules\User\Entities\User";

        /* @var TransformerGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(TransformerGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($model, $event->getModel());
        $this->assertEquals($modelNamespace, $event->getModelNamespace());
    }

    public function testCreateUnitTest()
    {
        $module = "User";
        $class = "AUserUnitTest";

        $this->getModuleGenerator($module)->createTest($class, 'unit');

        $path = Larapi::getModule($module)->getTests()->getPath() . "/$class.php";
        $stub = "unit-test.stub";
        $namespace = "Modules\User\Tests";
        $type = "unit";

        /* @var TestGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(TestGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
        $this->assertEquals($type, $event->getType());
    }

    public function testCreateRequest()
    {
        $module = "User";
        $class = "ARequest";

        $this->getModuleGenerator($module)->createRequest($class);

        $path = Larapi::getModule($module)->getRequests()->getPath() . "/$class.php";
        $stub = "request.stub";
        $namespace = "Modules\User\Http\Requests";

        /* @var RequestGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(RequestGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateRule()
    {
        $module = "User";
        $fileName = "BlalkaRule";

        $this->getModuleGenerator($module)->createRule($fileName);

        $path = Larapi::getModule($module)->getRules()->getPath() . "/$fileName.php";
        $stub = "rule.stub";
        $class = "BlalkaRule";
        $namespace = "Modules\User\Rules";

        /* @var RuleGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(RuleGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateSeeder()
    {
        $module = "User";
        $class = "BlablaSeeder";

        $this->getModuleGenerator($module)->createSeeder($class);

        $path = Larapi::getModule($module)->getSeeders()->getPath() . "/$class.php";
        $stub = "seeder.stub";
        $namespace = "Modules\User\Database\Seeders";

        /* @var SeederGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(SeederGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreatePermission()
    {
        $module = "User";
        $class = "UserPermission";

        $this->getModuleGenerator($module)->createPermission($class);

        $path = Larapi::getModule($module)->getPermissions()->getPath() . "/$class.php";
        $stub = "permission.stub";
        $namespace = "Modules\User\Permissions";

        /* @var PermissionGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(PermissionGeneratedEvent::class);
        $this->assertClassBasics(
            $event,
            $module,
            $stub,
            $class,
            $namespace,
            $path);
    }

    public function testCreateRoute()
    {
        $moduleName = "Demo";
        $routename = strtolower(Str::plural($moduleName)) . '.v1';

        $this->getModuleGenerator($moduleName)->createRoute();

        $expectedFileName = Larapi::getModule($moduleName)->getRoutes()->getPath() . "/$routename.php";
        $expectedStubName = "route.stub";
        $expectedVersion = "v1";

        /* @var RouteGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(RouteGeneratedEvent::class);
        $this->assertNotNull($event);

        $this->assertEquals($expectedFileName, $event->getFilePath());
        $this->assertEquals($expectedStubName, $event->getStub()->getName());
        $this->assertEquals($expectedVersion, $event->getVersion());
    }

    public function testCreateComposer()
    {
        $moduleName = "Demo";

        $this->getModuleGenerator($moduleName)->createComposer();

        $expectedFileName = Larapi::getModule($moduleName)->getPath() . "/composer.json";
        $expectedStubName = "composer.stub";
        $authorName = 'arthur devious';
        $authorMail = '[email protected]';

        /* @var ComposerGeneratedEvent $event */
        $event = $this->getFirstDispatchedEvent(ComposerGeneratedEvent::class);
        $this->assertNotNull($event);

        $this->assertEquals($expectedFileName, $event->getFilePath());
        $this->assertEquals($expectedStubName, $event->getStub()->getName());
        $this->assertEquals($authorName, $event->getAuthorName());
        $this->assertEquals($authorMail, $event->getAuthorMail());
    }


    /**
     * @param ResourceGenerationContract $event
     * @param string $module
     * @param $stub
     * @param string $class
     * @param string $namespace
     * @param string $path
     */
    private function assertClassBasics(?ResourceGenerationContract $event, string $module, $stub, string $class, string $namespace, string $path)
    {
        $this->assertFileBasics($event, $module, $stub, $path);
        $this->assertEquals($namespace, $event->getNamespace());
        $this->assertEquals($namespace, $event->/** @scrutinizer ignore-call */ getNamespace());
        $this->assertEquals($class, $event->getClassName());
        $this->assertEquals($path, $event->getFilePath());
    }

    private function assertFileBasics(?ResourceGenerationContract $event, string $module, $stub, string $path)
    {
        $this->assertNotNull($event);
        $this->assertEquals($module, $event->getModuleName());
        $this->assertEquals($stub, $event->getStub()->getName());
        $this->assertEquals($path, $event->getFilePath());
    }
}

deviouspk / larapi

Push — master ( 965fb6...8a373e )

FileGeneratorTest::testCreatePermission() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
