PasswordRepository   A
last analyzed

Complexity

Total Complexity 8

Size/Duplication

Total Lines 106
Duplicated Lines 19.81 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
wmc 8
lcom 1
cbo 2
dl 21
loc 106
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 9 1
A getByCustomerId() 10 10 2
A save() 0 14 2
A delete() 11 11 2
A getOlderThan() 0 13 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
declare(strict_types=1);
3
4
/**
5
 * File:PasswordRepository.php
6
 *
7
 * @author Maciej Sławik <[email protected]>
8
 * @copyright Copyright (C) 2018 Lizard Media (http://lizardmedia.pl)
9
 */
10
11
namespace LizardMedia\PasswordMigrator\Model\Data;
12
13
use Exception;
14
use LizardMedia\PasswordMigrator\Api\Data\PasswordInterface;
15
use LizardMedia\PasswordMigrator\Api\Data\PasswordRepositoryInterface;
16
use LizardMedia\PasswordMigrator\Model\Password;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, LizardMedia\PasswordMigrator\Model\Data\Password.

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...
17
use LizardMedia\PasswordMigrator\Model\ResourceModel\Password\Collection;
18
use LizardMedia\PasswordMigrator\Model\ResourceModel\Password\CollectionFactory;
19
use LizardMedia\PasswordMigrator\Model\PasswordFactory;
20
use LizardMedia\PasswordMigrator\Model\ResourceModel\Password as PasswordResource;
21
use Magento\Framework\Exception\NoSuchEntityException;
22
23
/**
24
 * Class PasswordRepository
25
 * @package LizardMedia\PasswordMigrator\Model\Data
26
 */
27
class PasswordRepository implements PasswordRepositoryInterface
28
{
29
    const EXPIRED_PASSWORDS_PURGE_SIZE = 60000;
30
31
    /**
32
     * @var PasswordFactory
33
     */
34
    private $passwordFactory;
35
36
    /**
37
     * @var PasswordResource
38
     */
39
    private $passwordResource;
40
41
    /**
42
     * @var CollectionFactory
43
     */
44
    private $collectionFactory;
45
46
    /**
47
     * PasswordRepository constructor.
48
     * @param PasswordFactory $passwordFactory
49
     * @param PasswordResource $passwordResource
50
     * @param CollectionFactory $collectionFactory
51
     */
52
    public function __construct(
53
        PasswordFactory $passwordFactory,
54
        PasswordResource $passwordResource,
55
        CollectionFactory $collectionFactory
56
    ) {
57
        $this->passwordFactory = $passwordFactory;
58
        $this->passwordResource = $passwordResource;
59
        $this->collectionFactory = $collectionFactory;
60
    }
61
62
    /**
63
     * @param int $customerId
64
     * @return PasswordInterface
65
     * @throws NoSuchEntityException
66
     */
67 View Code Duplication
    public function getByCustomerId(int $customerId): PasswordInterface
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...
68
    {
69
        /** @var Password $password */
70
        $password = $this->passwordFactory->create();
71
        $this->passwordResource->load($password, $customerId, Password::CUSTOMER_ID);
72
        if (!$password->getId()) {
73
            throw new NoSuchEntityException();
74
        }
75
        return $password->getDataModel();
76
    }
77
78
    /**
79
     * @param PasswordInterface $password
80
     * @return void
81
     * @throws Exception
82
     */
83
    public function save(PasswordInterface $password): void
84
    {
85
        /** @var Password $model */
86
        $model = $this->passwordFactory->create();
87
        if ($password->getId()) {
88
            $this->passwordResource->load($model, $password->getId());
89
        }
90
91
        $model->setData(Password::CUSTOMER_ID, $password->getCustomerId());
92
        $model->setData(Password::PASSWORD, $password->getPassword());
93
        $model->setData(Password::SALT, $password->getSalt());
94
95
        $this->passwordResource->save($model);
96
    }
97
98
    /**
99
     * @param PasswordInterface $password
100
     * @return void
101
     * @throws Exception
102
     */
103 View Code Duplication
    public function delete(PasswordInterface $password): void
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...
104
    {
105
        if (!$password->getId()) {
106
            throw new NoSuchEntityException();
107
        }
108
109
        /** @var Password $model */
110
        $model = $this->passwordFactory->create();
111
        $this->passwordResource->load($model, $password->getId());
112
        $this->passwordResource->delete($model);
113
    }
114
115
    /**
116
     * @param string $dateTime
117
     * @return PasswordInterface[]
118
     */
119
    public function getOlderThan(string $dateTime): array
120
    {
121
        /** @var Collection $collection */
122
        $collection = $this->collectionFactory->create();
123
        $collection->addFieldToFilter(Password::CREATED_AT, ['lt' => $dateTime])
124
            ->setPageSize(self::EXPIRED_PASSWORDS_PURGE_SIZE)
125
            ->setCurPage(1);
126
127
        return array_map(function ($password) {
128
            /** @var Password $password */
129
            return $password->getDataModel();
130
        }, $collection->getItems());
131
    }
132
}
133