Completed
Pull Request — master (#1)
by Gaël
13:40
created

NewsletterListCollectionTest   A

Complexity

Total Complexity 6

Size/Duplication

Total Lines 81
Duplicated Lines 19.75 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 0
Metric Value
dl 16
loc 81
c 0
b 0
f 0
wmc 6
lcom 1
cbo 3
rs 10

6 Methods

Rating   Name   Duplication   Size   Complexity  
A setUp() 0 15 1
A it_can_find_a_list_by_its_name() 8 8 1
A it_will_use_the_default_list_when_not_specifing_a_listname() 8 8 1
A it_will_throw_an_exception_when_using_a_default_list_that_does_not_exist() 0 16 1
A it_will_throw_an_exception_when_there_are_no_lists_defined() 0 13 1
A it_will_throw_an_exception_when_trying_to_find_a_list_that_does_not_exist() 0 6 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace DansMaCulotte\Newsletter\Test;
4
5
use PHPUnit\Framework\TestCase;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, DansMaCulotte\Newsletter\Test\TestCase.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
6
use DansMaCulotte\Newsletter\NewsletterList;
7
use DansMaCulotte\Newsletter\NewsletterListCollection;
8
use DansMaCulotte\Newsletter\Exceptions\InvalidNewsletterList;
9
10
class NewsletterListCollectionTest extends TestCase
11
{
12
    protected $newsletterListCollection;
13
14
    public function setUp() : void
15
    {
16
        parent::setUp();
17
18
        $this->newsletterListCollection = NewsletterListCollection::createFromConfig(
19
            [
20
                'lists' => [
21
                    'list1' => ['id' => 1],
22
                    'list2' => ['id' => 2],
23
                    'list3' => ['id' => 3],
24
                ],
25
                'defaultList' => 'list3',
26
            ]
27
        );
28
    }
29
30
    /** @test */
31 View Code Duplication
    public function it_can_find_a_list_by_its_name()
0 ignored issues
show
Duplication introduced by
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...
32
    {
33
        $list = $this->newsletterListCollection->findByName('list2');
34
35
        $this->assertInstanceOf(NewsletterList::class, $list);
36
37
        $this->assertEquals(2, $list->getId());
38
    }
39
40
    /** @test */
41 View Code Duplication
    public function it_will_use_the_default_list_when_not_specifing_a_listname()
0 ignored issues
show
Duplication introduced by
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...
42
    {
43
        $list = $this->newsletterListCollection->findByName('');
44
45
        $this->assertInstanceOf(NewsletterList::class, $list);
46
47
        $this->assertEquals(3, $list->getId());
48
    }
49
50
    /** @test */
51
    public function it_will_throw_an_exception_when_using_a_default_list_that_does_not_exist()
52
    {
53
        $newsletterListCollection = NewsletterListCollection::createFromConfig(
54
            [
55
                'lists' => [
56
                    'list1' => ['id' => 'list1'],
57
                ],
58
59
                'defaultList' => 'list2',
60
            ]
61
        );
62
63
        $this->expectException(InvalidNewsletterList::class);
64
65
        $newsletterListCollection->findByName('');
66
    }
67
68
    /** @test */
69
    public function it_will_throw_an_exception_when_there_are_no_lists_defined()
70
    {
71
        $this->expectException(InvalidNewsletterList::class);
72
73
        NewsletterListCollection::createFromConfig(
74
            [
75
                'lists' => [
76
                ],
77
78
                'defaultList' => 'list1',
79
            ]
80
        );
81
    }
82
83
    /** @test */
84
    public function it_will_throw_an_exception_when_trying_to_find_a_list_that_does_not_exist()
85
    {
86
        $this->expectException(InvalidNewsletterList::class);
87
88
        $this->newsletterListCollection->findByName('blabla');
89
    }
90
}
91