ContainerTest::it_can_abort() - Code Metrics - Inspection of "Apply fixes from StyleCI" - laravel-zero/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — stable (#145)

by Nuno

created 2018-01-05 22:42 UTC

ContainerTest::it_can_abort() A

↳ Parent: ContainerTest

Complexity

Conditions	3
Paths	4

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	13
nc	4
nop	0
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0

<?php

namespace Tests;

use LaravelZero\Framework\Exceptions\NotImplementedException;
use LaravelZero\Framework\Contracts\Exceptions\ConsoleException;
use Symfony\Component\Console\Exception\CommandNotFoundException;

class ContainerTest extends TestCase
{
    /** @test */
    public function it_has_a_version_getter(): void
    {
        $this->assertEquals($this->app->getContainer()->version(), 'Test version');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_has_a_base_path_getter()
    {
        $container = $this->app->getContainer();

        $this->assertEquals(BASE_PATH, $container->basePath());
        $this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'Unit', $container->basePath('Unit'));
    }

    /** @test */
    public function it_has_a_config_path_getter()

    {
        $container = $this->app->getContainer();

        $this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'config', $container->configPath());
        $this->assertEquals(
            BASE_PATH.DIRECTORY_SEPARATOR.'config'.DIRECTORY_SEPARATOR.'custom.php',
            $container->configPath('custom.php')
        );
    }

    /** @test */
    public function it_has_a_database_path_getter()

    {
        $container = $this->app->getContainer();

        $this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'database', $container->databasePath());
        $this->assertEquals(
            BASE_PATH.DIRECTORY_SEPARATOR.'database'.DIRECTORY_SEPARATOR.'migrations',
            $container->databasePath('migrations')
        );
    }

    /** @test */
    public function it_has_a_lang_path_getter()
    {
        $this->assertEquals(
            BASE_PATH.DIRECTORY_SEPARATOR.'resources'.DIRECTORY_SEPARATOR.'lang', $this->app->getContainer()->langPath()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        );
    }

    /** @test */
    public function it_has_a_resource_path_getter()
    {
        $container = $this->app->getContainer();

        $this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'resources', $container->resourcePath());
        $this->assertEquals(
            BASE_PATH.DIRECTORY_SEPARATOR.'resources'.DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'js',
            $container->resourcePath('assets'.DIRECTORY_SEPARATOR.'js')
        );
        $this->assertEquals(
            BASE_PATH.DIRECTORY_SEPARATOR.'resources'.DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'js'.DIRECTORY_SEPARATOR.'app.php',
            $container->resourcePath('assets'.DIRECTORY_SEPARATOR.'js'.DIRECTORY_SEPARATOR.'app.php')
        );
    }

    /** @test */
    public function it_has_a_storage_path_getter()
    {
        $container = $this->app->getContainer();

        $this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'storage', $container->storagePath());
    }

    /** @test */
    public function it_has_environment_getter()
    {
        $container = $this->app->getContainer();

        $this->assertSame('Test version', $container->version());
    }

    /** @test */
    public function it_confirms_the_running_in_console()
    {
        $this->assertTrue(
            $this->app->getContainer()->runningInConsole()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        );
    }

    /** @test */
    public function it_has_namespace_getter()
    {
        $this->assertEquals($this->app->getContainer()->getNamespace(), 'App\\');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_confirms_that_is_not_down_for_maintenance()
    {
        $this->assertFalse(
            $this->app->getContainer()->isDownForMaintenance()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        );
    }

    /** @test */
    public function it_can_abort(): void
    {
        try {
            $this->app->getContainer()->abort(404, 'Foo');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        } catch (CommandNotFoundException $notFoundException) {

        }

        $this->assertInstanceOf(CommandNotFoundException::class, $notFoundException);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $this->assertEquals($notFoundException->getMessage(), 'Foo');

        try {
            abort(200, 'Bar', ['Foo' => 'Bar']);
        } catch (ConsoleException $consoleException) {

        }

        $this->assertInstanceOf(ConsoleException::class, $consoleException);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $this->assertEquals($consoleException->getExitCode(), 200);
        $this->assertEquals($consoleException->getMessage(), 'Bar');
        $this->assertEquals($consoleException->getHeaders(), ['Foo' => 'Bar']);
    }

    /** @test */
    public function it_dont_implement_method_register_configured_providers()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->registerConfiguredProviders();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_dont_implement_method_register()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->register('foo');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_dont_implement_method_register_deferred_provider()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->registerDeferredProvider('foo');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_dont_implement_method_register_boot()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->boot();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_dont_implement_method_register_booting()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->booting('foo');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_dont_implement_method_register_booted()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->booted('foo');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_dont_implement_method_get_cached_services_path()
    {
        $this->expectException(NotImplementedException::class);

        $this->app->getContainer()->getCachedServicesPath();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /** @test */
    public function it_configures_monolog()
    {
        $container = $this->app->getContainer();
        $callback = function () {
        };

        $this->assertFalse($container->hasMonologConfigurator());
        $this->app->getContainer()->configureMonologUsing($callback);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $this->assertTrue($container->hasMonologConfigurator());
        $this->assertSame($container->getMonologConfigurator(), $callback);
    }
}


Pull Request — stable (#145)

ContainerTest::it_can_abort() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace Tests;
4
5		use LaravelZero\Framework\Exceptions\NotImplementedException;
6		use LaravelZero\Framework\Contracts\Exceptions\ConsoleException;
7		use Symfony\Component\Console\Exception\CommandNotFoundException;
8
9		class ContainerTest extends TestCase
10		{
11		/** @test */
12		public function it_has_a_version_getter(): void
13		{
14		$this->assertEquals($this->app->getContainer()->version(), 'Test version');
		0 ignored issues – show Bug introduced 2018-01-03 23:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Container\Container` as the method `version()` does only exist in the following implementations of said interface: `LaravelZero\Framework\Container`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
15		}
16
17		/** @test */
18		public function it_has_a_base_path_getter()
19		{
20		$container = $this->app->getContainer();
21
22		$this->assertEquals(BASE_PATH, $container->basePath());
23		$this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'Unit', $container->basePath('Unit'));
24		}
25
26		/** @test */
27	View Code Duplication	public function it_has_a_config_path_getter()
		0 ignored issues – show Duplication introduced 2017-11-14 08:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
28		{
29		$container = $this->app->getContainer();
30
31		$this->assertEquals(BASE_PATH.DIRECTORY_SEPARATOR.'config', $container->configPath());
32		$this->assertEquals(
33		BASE_PATH.DIRECTORY_SEPARATOR.'config'.DIRECTORY_SEPARATOR.'custom.php',
34		$container->configPath('custom.php')
35		);
36		}
37
38		/** @test */

laravel-zero / framework

Pull Request — stable (#145)

ContainerTest::it_can_abort() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like