CatalogMapperTest - Code Metrics - Inspection of "Feature/base" - wambo-co/module-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#1)

by Andreas

created 2016-07-12 17:33 UTC

CatalogMapperTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	206
Duplicated Lines	43.69 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
wmc	7
c	4
b	0
f	1
lcom	1
cbo	7
dl	90
loc	206
rs	10

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getCatalog_EmptyArrayIsGiven_EmptyCatalogIsReturned()	0	16	1
A	getCatalog_ArrayOfTwoProductsGiven_ProductMapperThrowsException_CatalogExceptionIsThrown()	0	18	1
A	getCatalog_ArrayWithDuplicateSKUGiven_CatalogExceptionIsThrown()	23	23	1
A	getCatalog_ArrayWithDuplicateSlugsGiven_CatalogExceptionIsThrown()	23	23	1
A	getCatalog_ArrayWithSimilarSKUsGiven_CatalogExceptionIsThrown()	22	22	1
A	getCatalog_ArrayWithSimilarSlugsGiven_CatalogExceptionIsThrown()	22	22	1
B	getCatalog_ArrayOfTwoProductsGiven_ProductMapperReturnsProducts_CatalogWithTwoProductsIsReturned()	0	25	1

How to fix Duplicated Code

<?php

use Wambo\Catalog\Mapper\CatalogMapper;
use Wambo\Catalog\Mapper\ProductMapper;
use Wambo\Catalog\Model\Content;
use Wambo\Catalog\Model\Product;
use Wambo\Catalog\Model\SKU;
use Wambo\Catalog\Model\Slug;

/**
 * Class CatalogMapperTest contains tests for the CatalogMapper class.
 */
class CatalogMapperTest extends \PHPUnit_Framework_TestCase
namespace YourVendor;

class YourClass { }
{
    /**
     * @test
     */
    public function getCatalog_EmptyArrayIsGiven_EmptyCatalogIsReturned()
    {
        // arrange
        $catalogData = array();
        $productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);


        // act
        $result = $productMapper->getCatalog($catalogData);

        // assert
        $this->assertNotNull($result, "getCatalog should have returned an empty catalog");
    }

    /**
     * When the product mapper throws an exception the getCatalog function should throw a CatalogException
     *
     * @test
     * @expectedException Wambo\Catalog\Error\CatalogException
     */
    public function getCatalog_ArrayOfTwoProductsGiven_ProductMapperThrowsException_CatalogExceptionIsThrown()
    {
        // arrange
        $catalogData = [
            ["sku" => "0001"],
            ["sku" => "0002"],
        ];
        $productMapperMock = $this->createMock(ProductMapper::class);
        $productMapperMock->method("getProduct")->willThrowException(new Exception("Some product mapper exception"));

        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);


        // act
        $productMapper->getCatalog($catalogData);
    }

    /**
     * If the the given product catalog data contains products with duplicate SKUs a
     * Wambo\Catalog\Error\CatalogException should be thrown.
     *
     * @test
     *
     * @expectedException Wambo\Catalog\Error\CatalogException
     * @expectedExceptionMessageRegExp /Cannot add a second product with the SKU '.+'/
     */
    public function getCatalog_ArrayWithDuplicateSKUGiven_CatalogExceptionIsThrown()

    {
        // arrange
        $catalogData = [
            ["sku" => "0001"],
            ["sku" => "0002"],
            ["sku" => "0001"],
        ];

        $productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
        $productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
            new Product(new SKU("0001"), new Slug("product-1"), "Product 1", new Content("Summary")),
            new Product(new SKU("0002"), new Slug("product-2"), "Product 2", new Content("Summary")),
            new Product(new SKU("0001"), new Slug("product-1a"), "Product 1a", new Content("Summary")))
        );

        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);

        // act
        $productMapper->getCatalog($catalogData);
    }

    /**
     * If the the given product catalog data contains products with duplicate Slugs a
     * Wambo\Catalog\Error\CatalogException should be thrown.
     *
     * @test
     *
     * @expectedException Wambo\Catalog\Error\CatalogException
     * @expectedExceptionMessageRegExp /Cannot add a second product with the Slug 'product-1'/
     */
    public function getCatalog_ArrayWithDuplicateSlugsGiven_CatalogExceptionIsThrown()

    {
        // arrange
        $catalogData = [
            ["sku" => "0001"],
            ["sku" => "0002"],
            ["sku" => "0003"],
        ];

        $productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
        $productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
            new Product(new SKU("0001"), new Slug("product-1"), "Product 1", new Content("Summary")),
            new Product(new SKU("0002"), new Slug("product-2"), "Product 2", new Content("Summary")),
            new Product(new SKU("0003"), new Slug("product-1"), "Product 3", new Content("Summary")))
        );

        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);

        // act
        $productMapper->getCatalog($catalogData);
    }

    /**
     * If the the given product catalog data contains products with similar SKUs a
     * Wambo\Catalog\Error\CatalogException should be thrown.
     *
     * @test
     *
     * @expectedException Wambo\Catalog\Error\CatalogException
     * @expectedExceptionMessageRegExp /Cannot add a second product with the SKU 'product'/
     */
    public function getCatalog_ArrayWithSimilarSKUsGiven_CatalogExceptionIsThrown()

    {
        // arrange
        $catalogData = [
            ["sku" => "0001"],
            ["sku" => "0002"],
            ["sku" => "0003"],
        ];

        $productMapperMock = $this->createMock(ProductMapper::class);
        $productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
            new Product(new SKU("product"), new Slug("product-a"), "Product 1", new Content("Summary")),
            new Product(new SKU("product"), new Slug("product-b"), "Product 2", new Content("Summary")))
        );

        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);

        // act
        $productMapper->getCatalog($catalogData);
    }

    /**
     * If the the given product catalog data contains products with similar slugs a
     * Wambo\Catalog\Error\CatalogException should be thrown.
     *
     * @test
     *
     * @expectedException Wambo\Catalog\Error\CatalogException
     * @expectedExceptionMessageRegExp /Cannot add a second product with the Slug 'a-product'/
     */
    public function getCatalog_ArrayWithSimilarSlugsGiven_CatalogExceptionIsThrown()

    {
        // arrange
        $catalogData = [
            ["sku" => "0001"],
            ["sku" => "0002"],
            ["sku" => "0003"],
        ];

        $productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
        $productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
            new Product(new SKU("0001"), new Slug("a-product"), "Product 1", new Content("Summary")),
            new Product(new SKU("0002"), new Slug("A-Product"), "Product 2", new Content("Summary")))
        );

        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);

        // act
        $productMapper->getCatalog($catalogData);
    }

    /**
     * @test
     */
    public function getCatalog_ArrayOfTwoProductsGiven_ProductMapperReturnsProducts_CatalogWithTwoProductsIsReturned()
    {
        // arrange
        $catalogData = [
            ["sku" => "0001"],
            ["sku" => "0002"],
        ];

        $productMapperMock = $this->createMock(ProductMapper::class);
        $productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
            new Product(new SKU("0001"), new Slug("product-1"), "Product 1", new Content("Summary")),
            new Product(new SKU("0002"), new Slug("product-2"), "Product 2", new Content("Summary")))
        );

        /** @var ProductMapper $productMapperMock A product mapper instance */

        $productMapper = new CatalogMapper($productMapperMock);


        // act
        $catalog = $productMapper->getCatalog($catalogData);

        // assert
        $this->assertCount(2, $catalog, "The catalog should contain two products");
    }
}

1		<?php
2
3		use Wambo\Catalog\Mapper\CatalogMapper;
4		use Wambo\Catalog\Mapper\ProductMapper;
5		use Wambo\Catalog\Model\Content;
6		use Wambo\Catalog\Model\Product;
7		use Wambo\Catalog\Model\SKU;
8		use Wambo\Catalog\Model\Slug;
9
10		/**
11		* Class CatalogMapperTest contains tests for the CatalogMapper class.
12		*/
13		class CatalogMapperTest extends \PHPUnit_Framework_TestCase
		0 ignored issues – show Coding Style Compatibility introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
14		{
15		/**
16		* @test
17		*/
18		public function getCatalog_EmptyArrayIsGiven_EmptyCatalogIsReturned()
19		{
20		// arrange
21		$catalogData = array();
22		$productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
23		/** @var ProductMapper $productMapperMock A product mapper instance */
24
25		$productMapper = new CatalogMapper($productMapperMock);
26
27
28		// act
29		$result = $productMapper->getCatalog($catalogData);
30
31		// assert
32		$this->assertNotNull($result, "getCatalog should have returned an empty catalog");
33		}
34
35		/**
36		* When the product mapper throws an exception the getCatalog function should throw a CatalogException
37		*
38		* @test
39		* @expectedException Wambo\Catalog\Error\CatalogException
40		*/
41		public function getCatalog_ArrayOfTwoProductsGiven_ProductMapperThrowsException_CatalogExceptionIsThrown()
42		{
43		// arrange
44		$catalogData = [
45		["sku" => "0001"],
46		["sku" => "0002"],
47		];
48		$productMapperMock = $this->createMock(ProductMapper::class);
49		$productMapperMock->method("getProduct")->willThrowException(new Exception("Some product mapper exception"));
50
51		/** @var ProductMapper $productMapperMock A product mapper instance */
52
53		$productMapper = new CatalogMapper($productMapperMock);
54
55
56		// act
57		$productMapper->getCatalog($catalogData);
58		}
59
60		/**
61		* If the the given product catalog data contains products with duplicate SKUs a
62		* Wambo\Catalog\Error\CatalogException should be thrown.
63		*
64		* @test
65		*
66		* @expectedException Wambo\Catalog\Error\CatalogException
67		* @expectedExceptionMessageRegExp /Cannot add a second product with the SKU '.+'/
68		*/
69	View Code Duplication	public function getCatalog_ArrayWithDuplicateSKUGiven_CatalogExceptionIsThrown()
		0 ignored issues – show Duplication introduced 2016-07-12 17:29 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...
70		{
71		// arrange
72		$catalogData = [
73		["sku" => "0001"],
74		["sku" => "0002"],
75		["sku" => "0001"],
76		];
77
78		$productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
79		$productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
80		new Product(new SKU("0001"), new Slug("product-1"), "Product 1", new Content("Summary")),
81		new Product(new SKU("0002"), new Slug("product-2"), "Product 2", new Content("Summary")),
82		new Product(new SKU("0001"), new Slug("product-1a"), "Product 1a", new Content("Summary")))
83		);
84
85		/** @var ProductMapper $productMapperMock A product mapper instance */
86
87		$productMapper = new CatalogMapper($productMapperMock);
88
89		// act
90		$productMapper->getCatalog($catalogData);
91		}
92
93		/**
94		* If the the given product catalog data contains products with duplicate Slugs a
95		* Wambo\Catalog\Error\CatalogException should be thrown.
96		*
97		* @test
98		*
99		* @expectedException Wambo\Catalog\Error\CatalogException
100		* @expectedExceptionMessageRegExp /Cannot add a second product with the Slug 'product-1'/
101		*/
102	View Code Duplication	public function getCatalog_ArrayWithDuplicateSlugsGiven_CatalogExceptionIsThrown()
		0 ignored issues – show Duplication introduced 2016-07-12 17:29 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...
103		{
104		// arrange
105		$catalogData = [
106		["sku" => "0001"],
107		["sku" => "0002"],
108		["sku" => "0003"],
109		];
110
111		$productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
112		$productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
113		new Product(new SKU("0001"), new Slug("product-1"), "Product 1", new Content("Summary")),
114		new Product(new SKU("0002"), new Slug("product-2"), "Product 2", new Content("Summary")),
115		new Product(new SKU("0003"), new Slug("product-1"), "Product 3", new Content("Summary")))
116		);
117
118		/** @var ProductMapper $productMapperMock A product mapper instance */
119
120		$productMapper = new CatalogMapper($productMapperMock);
121
122		// act
123		$productMapper->getCatalog($catalogData);
124		}
125
126		/**
127		* If the the given product catalog data contains products with similar SKUs a
128		* Wambo\Catalog\Error\CatalogException should be thrown.
129		*
130		* @test
131		*
132		* @expectedException Wambo\Catalog\Error\CatalogException
133		* @expectedExceptionMessageRegExp /Cannot add a second product with the SKU 'product'/
134		*/
135	View Code Duplication	public function getCatalog_ArrayWithSimilarSKUsGiven_CatalogExceptionIsThrown()
		0 ignored issues – show Duplication introduced 2016-07-12 17:29 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...
136		{
137		// arrange
138		$catalogData = [
139		["sku" => "0001"],
140		["sku" => "0002"],
141		["sku" => "0003"],
142		];
143
144		$productMapperMock = $this->createMock(ProductMapper::class);
145		$productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
146		new Product(new SKU("product"), new Slug("product-a"), "Product 1", new Content("Summary")),
147		new Product(new SKU("product"), new Slug("product-b"), "Product 2", new Content("Summary")))
148		);
149
150		/** @var ProductMapper $productMapperMock A product mapper instance */
151
152		$productMapper = new CatalogMapper($productMapperMock);
153
154		// act
155		$productMapper->getCatalog($catalogData);
156		}
157
158		/**
159		* If the the given product catalog data contains products with similar slugs a
160		* Wambo\Catalog\Error\CatalogException should be thrown.
161		*
162		* @test
163		*
164		* @expectedException Wambo\Catalog\Error\CatalogException
165		* @expectedExceptionMessageRegExp /Cannot add a second product with the Slug 'a-product'/
166		*/
167	View Code Duplication	public function getCatalog_ArrayWithSimilarSlugsGiven_CatalogExceptionIsThrown()
		0 ignored issues – show Duplication introduced 2016-07-12 17:29 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...
168		{
169		// arrange
170		$catalogData = [
171		["sku" => "0001"],
172		["sku" => "0002"],
173		["sku" => "0003"],
174		];
175
176		$productMapperMock = $this->getMockBuilder(ProductMapper::class)->disableOriginalConstructor()->getMock();
177		$productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
178		new Product(new SKU("0001"), new Slug("a-product"), "Product 1", new Content("Summary")),
179		new Product(new SKU("0002"), new Slug("A-Product"), "Product 2", new Content("Summary")))
180		);
181
182		/** @var ProductMapper $productMapperMock A product mapper instance */
183
184		$productMapper = new CatalogMapper($productMapperMock);
185
186		// act
187		$productMapper->getCatalog($catalogData);
188		}
189
190		/**
191		* @test
192		*/
193		public function getCatalog_ArrayOfTwoProductsGiven_ProductMapperReturnsProducts_CatalogWithTwoProductsIsReturned()
194		{
195		// arrange
196		$catalogData = [
197		["sku" => "0001"],
198		["sku" => "0002"],
199		];
200
201		$productMapperMock = $this->createMock(ProductMapper::class);
202		$productMapperMock->method("getProduct")->will($this->onConsecutiveCalls(
203		new Product(new SKU("0001"), new Slug("product-1"), "Product 1", new Content("Summary")),
204		new Product(new SKU("0002"), new Slug("product-2"), "Product 2", new Content("Summary")))
205		);
206
207		/** @var ProductMapper $productMapperMock A product mapper instance */
208
209		$productMapper = new CatalogMapper($productMapperMock);
210
211
212		// act
213		$catalog = $productMapper->getCatalog($catalogData);
214
215		// assert
216		$this->assertCount(2, $catalog, "The catalog should contain two products");
217		}
218		}

wambo-co / module-catalog

Pull Request — develop (#1)

CatalogMapperTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like