CacheTest - Code Metrics - Inspection of "I have no idea where to look for these errors. And..." - sminnee/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — authenticator-refactor ( 16f104...61b037 )

by Simon

created 2017-05-20 08:29 UTC

CacheTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	65
Duplicated Lines	49.23 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
dl	32
loc	65
rs	10
c	0
b	0
f	0
wmc	3
lcom	0
cbo	3

3 Methods

Rating	Name	Duplication	Size	Complexity
B	setUp()	0	28	1
A	testApcuCacheFactory()	16	16	1
A	testMemCacheFactory()	16	16	1

How to fix Duplicated Code

<?php

namespace SilverStripe\Core\Tests\Cache;

use Psr\SimpleCache\CacheInterface;
use SilverStripe\Core\Cache\ApcuCacheFactory;
use SilverStripe\Core\Cache\MemcachedCacheFactory;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Core\Test\Cache\CacheTest\MockCache;
use SilverStripe\Dev\SapphireTest;
use Symfony\Component\Cache\Simple\ApcuCache;
use Symfony\Component\Cache\Simple\MemcachedCache;

class CacheTest extends SapphireTest
{
    protected function setUp()
    {
        parent::setUp();

        Injector::inst()
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.
    }
}
            ->load([
                ApcuCacheFactory::class => [
                    'constructor' => [ 'version' => 'ss40test' ]
                ],
                MemcachedCacheFactory::class => MemcachedCacheFactory::class,
                CacheInterface::class . '.TestApcuCache' =>  [
                    'factory' => ApcuCacheFactory::class,
                    'constructor' => [
                        'namespace' => 'TestApcuCache',
                        'defaultLifetime' => 2600,
                    ],
                ],
                CacheInterface::class . '.TestMemcache' => [
                    'factory' => MemcachedCacheFactory::class,
                    'constructor' => [
                        'namespace' => 'TestMemCache',
                        'defaultLifetime' => 5600,
                    ],
                ],
                ApcuCache::class => MockCache::class,
                MemcachedCache::class => MockCache::class,
            ]);
    }

    public function testApcuCacheFactory()

    {
        $cache = Injector::inst()->get(CacheInterface::class .'.TestApcuCache');
        $this->assertInstanceOf(
            MockCache::class,
            $cache
        );
        $this->assertEquals(
            [
                'TestApcuCache_'.md5(BASE_PATH),
                2600,
                'ss40test'
            ],
            $cache->getArgs()
        );
    }

    public function testMemCacheFactory()

    {
        $cache = Injector::inst()->get(CacheInterface::class .'.TestMemcache');
        $this->assertInstanceOf(
            MockCache::class,
            $cache
        );
        $this->assertEquals(
            [
                null,
                'TestMemCache_'.md5(BASE_PATH),
                5600
            ],
            $cache->getArgs()
        );
    }
}


1		<?php
2
3		namespace SilverStripe\Core\Tests\Cache;
4
5		use Psr\SimpleCache\CacheInterface;
6		use SilverStripe\Core\Cache\ApcuCacheFactory;
7		use SilverStripe\Core\Cache\MemcachedCacheFactory;
8		use SilverStripe\Core\Injector\Injector;
9		use SilverStripe\Core\Test\Cache\CacheTest\MockCache;
10		use SilverStripe\Dev\SapphireTest;
11		use Symfony\Component\Cache\Simple\ApcuCache;
12		use Symfony\Component\Cache\Simple\MemcachedCache;
13
14		class CacheTest extends SapphireTest
15		{
16		protected function setUp()
17		{
18		parent::setUp();
19
20		Injector::inst()
		0 ignored issues – show Bug introduced 2017-05-20 08:33 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Container\ContainerInterface` as the method `load()` does only exist in the following implementations of said interface: `SilverStripe\Core\Injector\Injector`. 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...
21		->load([
22		ApcuCacheFactory::class => [
23		'constructor' => [ 'version' => 'ss40test' ]
24		],
25		MemcachedCacheFactory::class => MemcachedCacheFactory::class,
26		CacheInterface::class . '.TestApcuCache' => [
27		'factory' => ApcuCacheFactory::class,
28		'constructor' => [
29		'namespace' => 'TestApcuCache',
30		'defaultLifetime' => 2600,
31		],
32		],
33		CacheInterface::class . '.TestMemcache' => [
34		'factory' => MemcachedCacheFactory::class,
35		'constructor' => [
36		'namespace' => 'TestMemCache',
37		'defaultLifetime' => 5600,
38		],
39		],
40		ApcuCache::class => MockCache::class,
41		MemcachedCache::class => MockCache::class,
42		]);
43		}
44
45	View Code Duplication	public function testApcuCacheFactory()
		0 ignored issues – show Duplication introduced 2017-05-20 08:34 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...
46		{
47		$cache = Injector::inst()->get(CacheInterface::class .'.TestApcuCache');
48		$this->assertInstanceOf(
49		MockCache::class,
50		$cache
51		);
52		$this->assertEquals(
53		[
54		'TestApcuCache_'.md5(BASE_PATH),
55		2600,
56		'ss40test'
57		],
58		$cache->getArgs()
59		);
60		}
61
62	View Code Duplication	public function testMemCacheFactory()
		0 ignored issues – show Duplication introduced 2017-05-20 08:34 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...
63		{
64		$cache = Injector::inst()->get(CacheInterface::class .'.TestMemcache');
65		$this->assertInstanceOf(
66		MockCache::class,
67		$cache
68		);
69		$this->assertEquals(
70		[
71		null,
72		'TestMemCache_'.md5(BASE_PATH),
73		5600
74		],
75		$cache->getArgs()
76		);
77		}
78		}
79

sminnee / silverstripe-framework

Push — authenticator-refactor ( 16f104...61b037 )

CacheTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like