BridgeChronos::hasValidate() - Code Metrics - Inspection of "Merge pull request #92 from SHyx0rmZ/code-style" - trivago/chapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 42287f...fba610 )

by Andy

created 2017-08-08 08:11 UTC

BridgeChronos::hasValidate() A

↳ Parent: BridgeChronos

Complexity

Conditions	2
Paths	2

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	11
cts	11
cp	1
rs	9.2
c	0
b	0
f	0
cc	2
eloc	13
nc	2
nop	1
crap	2

<?php
/**
 * @package: chapi
 *
 * @author:  msiebeneicher
 * @since:   2015-07-28
 *
 */

namespace Chapi\Service\JobRepository;

use Chapi\Component\Cache\CacheInterface;
use Chapi\Component\RemoteClients\ApiClientInterface;
use Chapi\Entity\Chronos\ChronosJobEntity;
use Chapi\Entity\JobEntityInterface;
use Chapi\Service\JobValidator\JobValidatorServiceInterface;
use Psr\Log\LoggerInterface;

class BridgeChronos implements BridgeInterface
{
    const CACHE_TIME_JOB_LIST = 60;

    const CACHE_KEY_JOB_LIST = 'jobs.list';

    const API_CALL_ADD = 'addingJob';

    const API_CALL_UPDATE = 'updatingJob';

    /**
     * @var ApiClientInterface
     */
    private $apiClient;

    /**
     * @var CacheInterface
     */
    private $cache;

    /**
     * @var JobValidatorServiceInterface
     */
    private $jobEntityValidatorService;

    /**
     * @var bool
     */
    private $cacheHasToDelete = false;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @param \Chapi\Component\RemoteClients\ApiClientInterface $apiClient
     * @param CacheInterface $cache
     * @param JobValidatorServiceInterface $jobEntityValidatorService
     * @param LoggerInterface $logger
     */
    public function __construct(
        ApiClientInterface $apiClient,
        CacheInterface $cache,
        JobValidatorServiceInterface $jobEntityValidatorService,
        LoggerInterface $logger
    ) {
        $this->apiClient = $apiClient;
        $this->cache = $cache;
        $this->jobEntityValidatorService = $jobEntityValidatorService;
        $this->logger = $logger;
    }

    /**
     * delete cache job.list if a job was removed
     */
    public function __destruct()
    {
        if ($this->cacheHasToDelete) {
            $this->cache->delete(self::CACHE_KEY_JOB_LIST);
        }
    }


    /**
     * @return ChronosJobEntity[]
     */
    public function getJobs()
    {
        $return = [];
        $jobList = $this->getJobList();

        if (!empty($jobList)) {
            // prepare return value
            foreach ($jobList as $jobData) {
                $return[] = new ChronosJobEntity($jobData);
            }
        }

        return $return;
    }

    /**
     * @param ChronosJobEntity|JobEntityInterface $jobEntity
     * @return bool
     */
    public function addJob(JobEntityInterface $jobEntity)
    {
        return $this->hasAddOrUpdateJob(self::API_CALL_ADD, $jobEntity);
    }

    /**
     * @param ChronosJobEntity|JobEntityInterface $jobEntity
     * @return bool
     */
    public function updateJob(JobEntityInterface $jobEntity)
    {
        return $this->hasAddOrUpdateJob(self::API_CALL_UPDATE, $jobEntity);
    }


    /**
     * @param ChronosJobEntity|JobEntityInterface $jobEntity
     * @return bool
     */
    public function removeJob(JobEntityInterface $jobEntity)
    {
        if ($this->apiClient->removeJob($jobEntity->getKey())) {
            $this->cacheHasToDelete = true;
            return true;
        }

        return false;
    }

    /**
     * @param JobEntityInterface $jobEntity
     * @return bool
     */
    private function hasValidate(JobEntityInterface $jobEntity)
    {
        $invalidProperties = $this->jobEntityValidatorService->getInvalidProperties($jobEntity);
        if (empty($invalidProperties)) {
            return true;
        }

        $this->logger->warning(
            sprintf(
                "Can't update job '%s'",
                $jobEntity->getKey()
            )
        );
        $this->logger->warning(
            sprintf(
                "The following job entity properties are not valid:\n%s",
                implode(', ', $invalidProperties)
            )
        );

        return false;
    }

    /**
     * @return array
     */
    private function getJobList()
    {
        $result = $this->cache->get(self::CACHE_KEY_JOB_LIST);

        if (is_array($result)) {
            // return list from cache
            return $result;
        }

        $result = $this->apiClient->listingJobs();
        if (!empty($result)) {
            // set result to cache
            $this->cache->set(self::CACHE_KEY_JOB_LIST, $result, self::CACHE_TIME_JOB_LIST);
        }

        return $result;
    }

    /**
     * @param string $apiMethod
     * @param JobEntityInterface $jobEntity
     * @return bool
     */
    private function hasAddOrUpdateJob($apiMethod, JobEntityInterface $jobEntity)
    {
        if ($this->hasValidate($jobEntity)) {
            if ($this->apiClient->{$apiMethod}($jobEntity)) {
                $this->cacheHasToDelete = true;
                return true;
            }
        }

        return false;
    }
}


1			<?php
2			/**
3			* @package: chapi
4			*
5			* @author: msiebeneicher
6			* @since: 2015-07-28
7			*
8			*/
9
10			namespace Chapi\Service\JobRepository;
11
12			use Chapi\Component\Cache\CacheInterface;
13			use Chapi\Component\RemoteClients\ApiClientInterface;
14			use Chapi\Entity\Chronos\ChronosJobEntity;
15			use Chapi\Entity\JobEntityInterface;
16			use Chapi\Service\JobValidator\JobValidatorServiceInterface;
17			use Psr\Log\LoggerInterface;
18
19			class BridgeChronos implements BridgeInterface
20			{
21			const CACHE_TIME_JOB_LIST = 60;
22
23			const CACHE_KEY_JOB_LIST = 'jobs.list';
24
25			const API_CALL_ADD = 'addingJob';
26
27			const API_CALL_UPDATE = 'updatingJob';
28
29			/**
30			* @var ApiClientInterface
31			*/
32			private $apiClient;
33
34			/**
35			* @var CacheInterface
36			*/
37			private $cache;
38
39			/**
40			* @var JobValidatorServiceInterface
41			*/
42			private $jobEntityValidatorService;
43
44			/**
45			* @var bool
46			*/
47			private $cacheHasToDelete = false;
48
49			/**
50			* @var LoggerInterface
51			*/
52			private $logger;
53
54			/**
55			* @param \Chapi\Component\RemoteClients\ApiClientInterface $apiClient
56			* @param CacheInterface $cache
57			* @param JobValidatorServiceInterface $jobEntityValidatorService
58			* @param LoggerInterface $logger
59			*/
60	8	View Code Duplication	public function __construct(
61			ApiClientInterface $apiClient,
62			CacheInterface $cache,
63			JobValidatorServiceInterface $jobEntityValidatorService,
64			LoggerInterface $logger
65			) {
66	8		$this->apiClient = $apiClient;
67	8		$this->cache = $cache;
68	8		$this->jobEntityValidatorService = $jobEntityValidatorService;
69	8		$this->logger = $logger;
70	8		}
71
72			/**
73			* delete cache job.list if a job was removed
74			*/
75	8		public function __destruct()
76			{
77	8		if ($this->cacheHasToDelete) {
78	3		$this->cache->delete(self::CACHE_KEY_JOB_LIST);
79			}
80	8		}
81
82
83			/**
84			* @return ChronosJobEntity[]
85			*/
86	2		public function getJobs()
87			{
88	2		$return = [];
89	2		$jobList = $this->getJobList();
90
91	2		if (!empty($jobList)) {
92			// prepare return value
93	2		foreach ($jobList as $jobData) {
94	2		$return[] = new ChronosJobEntity($jobData);
95			}
96			}
97
98	2		return $return;
99			}
100
101			/**
102			* @param ChronosJobEntity\|JobEntityInterface $jobEntity
103			* @return bool
104			*/
105	2		public function addJob(JobEntityInterface $jobEntity)
106			{
107	2		return $this->hasAddOrUpdateJob(self::API_CALL_ADD, $jobEntity);
108			}
109
110			/**
111			* @param ChronosJobEntity\|JobEntityInterface $jobEntity
112			* @return bool
113			*/
114	2		public function updateJob(JobEntityInterface $jobEntity)
115			{
116	2		return $this->hasAddOrUpdateJob(self::API_CALL_UPDATE, $jobEntity);
117			}
118
119
120			/**
121			* @param ChronosJobEntity\|JobEntityInterface $jobEntity
122			* @return bool
123			*/
124	2	View Code Duplication	public function removeJob(JobEntityInterface $jobEntity)
125			{
126	2		if ($this->apiClient->removeJob($jobEntity->getKey())) {
127	1		$this->cacheHasToDelete = true;
128	1		return true;
129			}
130
131	2		return false;
132			}
133
134			/**
135			* @param JobEntityInterface $jobEntity
136			* @return bool
137			*/
138	4		private function hasValidate(JobEntityInterface $jobEntity)
139			{
140	4		$invalidProperties = $this->jobEntityValidatorService->getInvalidProperties($jobEntity);
141	4		if (empty($invalidProperties)) {
142	2		return true;
143			}
144
145	2		$this->logger->warning(
146			sprintf(
147	2		"Can't update job '%s'",
148	2		$jobEntity->getKey()
149			)
150			);
151	2		$this->logger->warning(
152			sprintf(
153	2		"The following job entity properties are not valid:\n%s",
154	2		implode(', ', $invalidProperties)
155			)
156			);
157
158	2		return false;
159			}
160
161			/**
162			* @return array
163			*/
164	2		private function getJobList()
165			{
166	2		$result = $this->cache->get(self::CACHE_KEY_JOB_LIST);
167
168	2		if (is_array($result)) {
169			// return list from cache
170	1		return $result;
171			}
172
173	1		$result = $this->apiClient->listingJobs();
174	1		if (!empty($result)) {
175			// set result to cache
176	1		$this->cache->set(self::CACHE_KEY_JOB_LIST, $result, self::CACHE_TIME_JOB_LIST);
177			}
178
179	1		return $result;
180			}
181
182			/**
183			* @param string $apiMethod
184			* @param JobEntityInterface $jobEntity
185			* @return bool
186			*/
187	4		private function hasAddOrUpdateJob($apiMethod, JobEntityInterface $jobEntity)
188			{
189	4		if ($this->hasValidate($jobEntity)) {
190	2		if ($this->apiClient->{$apiMethod}($jobEntity)) {
191	2		$this->cacheHasToDelete = true;
192	2		return true;
193			}
194			}
195
196	2		return false;
197			}
198			}
199

trivago / chapi

GitHub Access Token became invalid

Push — master ( 42287f...fba610 )

BridgeChronos::hasValidate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like