TranslatableRepositoryTest::createDocumentManagerMock() - Code Metrics - Inspection of "[Translation] Introduce translatable repository tr..." - php-lug/lug - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#61)

by Eric

created 2016-07-17 11:44 UTC

createDocumentManagerMock() A

↳ Parent: TranslatableRepositoryTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the Lug package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Lug\Component\Translation\Tests\Repository\Doctrine\MongoDB;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\DocumentRepository;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Query\Builder;
use Doctrine\ODM\MongoDB\UnitOfWork;
use Lug\Component\Resource\Model\ResourceInterface;
use Lug\Component\Translation\Context\LocaleContextInterface;
use Lug\Component\Translation\Model\TranslatableInterface;
use Lug\Component\Translation\Model\TranslatableTrait;
use Lug\Component\Translation\Model\TranslationInterface;
use Lug\Component\Translation\Model\TranslationTrait;
use Lug\Component\Translation\Repository\Doctrine\MongoDB\TranslatableRepository;
use Lug\Component\Translation\Repository\TranslatableRepositoryInterface;

/**
 * @author GeLo <[email protected]>
 */
class TranslatableRepositoryTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var TranslatableRepository
     */
    private $translatableRepository;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|DocumentManager
     */
    private $documentManager;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|UnitOfWork
     */
    private $unitOfWork;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|ClassMetadata
     */
    private $classMetadata;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|ResourceInterface
     */
    private $resource;

    /**
     * @var string
     */
    private $class;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|LocaleContextInterface
     */
    private $localeContext;

    /**
     * {@inheritdoc}
     */
    protected function setUp()
    {
        if (!class_exists(DocumentManager::class)) {
            $this->markTestSkipped();
        }

        $this->documentManager = $this->createDocumentManagerMock();
        $this->unitOfWork = $this->createUnitOfWorkMock();
        $this->classMetadata = $this->createClassMetadataMock();
        $this->resource = $this->createResourceMock();
        $this->localeContext = $this->createLocaleContextMock();
        $this->class = $this->classMetadata->name = TranslatableTest::class;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        $this->translatableRepository = new TranslatableRepository(
            $this->documentManager,
            $this->unitOfWork,
            $this->classMetadata,
            $this->resource,
            $this->localeContext
        );
    }

    public function testInheritance()
    {
        $this->assertInstanceOf(TranslatableRepositoryInterface::class, $this->translatableRepository);
        $this->assertInstanceOf(DocumentRepository::class, $this->translatableRepository);
    }

    public function testCreateQueryBuilderForCollection()
    {
        $this->classMetadata
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('getFieldNames')
            ->will($this->returnValue([]));

        $this->classMetadata
            ->expects($this->once())
            ->method('getAssociationTargetClass')
            ->with($this->identicalTo('translations'))
            ->will($this->returnValue($translationClass = TranslationTest::class));

        $translationClassMetadata = $this->createClassMetadataMock();
        $translationClassMetadata
            ->expects($this->once())
            ->method('getFieldNames')
            ->will($this->returnValue(['locale']));

        $this->documentManager
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('getClassMetadata')
            ->with($this->identicalTo($translationClass))
            ->will($this->returnValue($translationClassMetadata));

        $this->documentManager
            ->expects($this->once())
            ->method('createQueryBuilder')
            ->will($this->returnValue($queryBuilder = $this->createQueryBuilderMock()));

        $queryBuilder
            ->expects($this->once())
            ->method('field')
            ->with($this->identicalTo('translations.locale'))
            ->will($this->returnSelf());

        $this->localeContext
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('getLocales')
            ->will($this->returnValue($locales = ['fr']));

        $this->localeContext
            ->expects($this->once())
            ->method('getFallbackLocale')
            ->will($this->returnValue($fallbackLocale = 'en'));

        $queryBuilder
            ->expects($this->once())
            ->method('in')
            ->with($this->identicalTo(array_merge($locales, [$fallbackLocale])))
            ->will($this->returnSelf());

        $this->assertSame($queryBuilder, $this->translatableRepository->createQueryBuilderForCollection());
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|DocumentManager
     */
    private function createDocumentManagerMock()
    {
        return $this->createMock(DocumentManager::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|UnitOfWork
     */
    private function createUnitOfWorkMock()
    {
        return $this->createMock(UnitOfWork::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|ClassMetadata
     */
    private function createClassMetadataMock()
    {
        return $this->createMock(ClassMetadata::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|ResourceInterface
     */
    private function createResourceMock()
    {
        return $this->createMock(ResourceInterface::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|LocaleContextInterface
     */
    private function createLocaleContextMock()
    {
        return $this->createMock(LocaleContextInterface::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|Builder
     */
    private function createQueryBuilderMock()
    {
        return $this->createMock(Builder::class);
    }
}

/**
 * @author GeLo <[email protected]>
 */
class TranslatableTest implements TranslatableInterface

{
    use TranslatableTrait;
}

/**
 * @author GeLo <[email protected]>
 */
class TranslationTest implements TranslationInterface

{
    use TranslationTrait;
}


Pull Request — master (#61)

createDocumentManagerMock() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/*
4			* This file is part of the Lug package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Lug\Component\Translation\Tests\Repository\Doctrine\MongoDB;
13
14			use Doctrine\ODM\MongoDB\DocumentManager;
15			use Doctrine\ODM\MongoDB\DocumentRepository;
16			use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
17			use Doctrine\ODM\MongoDB\Query\Builder;
18			use Doctrine\ODM\MongoDB\UnitOfWork;
19			use Lug\Component\Resource\Model\ResourceInterface;
20			use Lug\Component\Translation\Context\LocaleContextInterface;
21			use Lug\Component\Translation\Model\TranslatableInterface;
22			use Lug\Component\Translation\Model\TranslatableTrait;
23			use Lug\Component\Translation\Model\TranslationInterface;
24			use Lug\Component\Translation\Model\TranslationTrait;
25			use Lug\Component\Translation\Repository\Doctrine\MongoDB\TranslatableRepository;
26			use Lug\Component\Translation\Repository\TranslatableRepositoryInterface;
27
28			/**
29			* @author GeLo <[email protected]>
30			*/
31			class TranslatableRepositoryTest extends \PHPUnit_Framework_TestCase
32			{
33			/**
34			* @var TranslatableRepository
35			*/
36			private $translatableRepository;
37
38			/**
39			* @var \PHPUnit_Framework_MockObject_MockObject\|DocumentManager
40			*/
41			private $documentManager;
42
43			/**
44			* @var \PHPUnit_Framework_MockObject_MockObject\|UnitOfWork
45			*/
46			private $unitOfWork;
47
48			/**
49			* @var \PHPUnit_Framework_MockObject_MockObject\|ClassMetadata
50			*/
51			private $classMetadata;
52
53			/**
54			* @var \PHPUnit_Framework_MockObject_MockObject\|ResourceInterface
55			*/
56			private $resource;
57
58			/**
59			* @var string
60			*/
61			private $class;
62
63			/**
64			* @var \PHPUnit_Framework_MockObject_MockObject\|LocaleContextInterface
65			*/
66			private $localeContext;
67
68			/**
69			* {@inheritdoc}
70			*/
71			protected function setUp()
72			{
73			if (!class_exists(DocumentManager::class)) {
74			$this->markTestSkipped();
75			}
76
77			$this->documentManager = $this->createDocumentManagerMock();
78			$this->unitOfWork = $this->createUnitOfWorkMock();
79			$this->classMetadata = $this->createClassMetadataMock();
80			$this->resource = $this->createResourceMock();
81			$this->localeContext = $this->createLocaleContextMock();
82			$this->class = $this->classMetadata->name = TranslatableTest::class;
			0 ignored issues – show Bug introduced 2016-06-10 16:27 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `PHPUnit_Framework_MockObject_MockObject` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
83
84			$this->translatableRepository = new TranslatableRepository(
85			$this->documentManager,
86			$this->unitOfWork,
87			$this->classMetadata,
88			$this->resource,
89			$this->localeContext
90			);
91			}
92
93			public function testInheritance()
94			{
95			$this->assertInstanceOf(TranslatableRepositoryInterface::class, $this->translatableRepository);
96			$this->assertInstanceOf(DocumentRepository::class, $this->translatableRepository);
97			}
98
99			public function testCreateQueryBuilderForCollection()
100			{
101			$this->classMetadata
			0 ignored issues – show Bug introduced 2016-01-19 20:19 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Doctrine\ODM\MongoDB\Mapping\ClassMetadata`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
102			->expects($this->once())
103			->method('getFieldNames')
104			->will($this->returnValue([]));
105
106			$this->classMetadata
107			->expects($this->once())
108			->method('getAssociationTargetClass')
109			->with($this->identicalTo('translations'))
110			->will($this->returnValue($translationClass = TranslationTest::class));
111
112			$translationClassMetadata = $this->createClassMetadataMock();
113			$translationClassMetadata
114			->expects($this->once())
115			->method('getFieldNames')
116			->will($this->returnValue(['locale']));
117
118			$this->documentManager
			0 ignored issues – show Bug introduced 2016-01-19 20:19 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Doctrine\ODM\MongoDB\DocumentManager`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
119			->expects($this->once())
120			->method('getClassMetadata')
121			->with($this->identicalTo($translationClass))
122			->will($this->returnValue($translationClassMetadata));
123
124			$this->documentManager
125			->expects($this->once())
126			->method('createQueryBuilder')
127			->will($this->returnValue($queryBuilder = $this->createQueryBuilderMock()));
128
129			$queryBuilder
130			->expects($this->once())
131			->method('field')
132			->with($this->identicalTo('translations.locale'))
133			->will($this->returnSelf());
134
135			$this->localeContext
			0 ignored issues – show Bug introduced 2016-01-19 20:19 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Lug\Component\Translatio...\LocaleContextInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
136			->expects($this->once())
137			->method('getLocales')
138			->will($this->returnValue($locales = ['fr']));
139
140			$this->localeContext
141			->expects($this->once())
142			->method('getFallbackLocale')
143			->will($this->returnValue($fallbackLocale = 'en'));
144
145			$queryBuilder
146			->expects($this->once())
147			->method('in')
148			->with($this->identicalTo(array_merge($locales, [$fallbackLocale])))
149			->will($this->returnSelf());
150
151			$this->assertSame($queryBuilder, $this->translatableRepository->createQueryBuilderForCollection());
152			}
153
154			/**
155			* @return \PHPUnit_Framework_MockObject_MockObject\|DocumentManager
156			*/
157			private function createDocumentManagerMock()
158			{
159			return $this->createMock(DocumentManager::class);
160			}
161
162			/**
163			* @return \PHPUnit_Framework_MockObject_MockObject\|UnitOfWork
164			*/
165			private function createUnitOfWorkMock()
166			{
167			return $this->createMock(UnitOfWork::class);
168			}
169
170			/**
171			* @return \PHPUnit_Framework_MockObject_MockObject\|ClassMetadata
172			*/
173			private function createClassMetadataMock()
174			{
175			return $this->createMock(ClassMetadata::class);
176			}
177
178			/**
179			* @return \PHPUnit_Framework_MockObject_MockObject\|ResourceInterface
180			*/
181			private function createResourceMock()
182			{
183			return $this->createMock(ResourceInterface::class);
184			}
185
186			/**
187			* @return \PHPUnit_Framework_MockObject_MockObject\|LocaleContextInterface
188			*/
189			private function createLocaleContextMock()
190			{
191			return $this->createMock(LocaleContextInterface::class);
192			}
193
194			/**
195			* @return \PHPUnit_Framework_MockObject_MockObject\|Builder
196			*/
197			private function createQueryBuilderMock()
198			{
199			return $this->createMock(Builder::class);
200			}
201			}
202
203			/**
204			* @author GeLo <[email protected]>
205			*/
206			class TranslatableTest implements TranslatableInterface
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-27 11:56 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
207			{
208			use TranslatableTrait;
209			}
210
211			/**
212			* @author GeLo <[email protected]>
213			*/
214			class TranslationTest implements TranslationInterface
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-27 11:56 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
215			{
216			use TranslationTrait;
217			}
218

php-lug / lug

Pull Request — master (#61)

createDocumentManagerMock() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like