Time::startTimer() - Code Metrics - Inspection of "Refactor starting methods" - godbout/alfred-time - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 48ce65...e784a2 )

by Guillaume

created 2017-05-13 11:47 UTC

Time::startTimer() C

↳ Parent: Time

Complexity

Conditions	8
Paths	37

Size

Total Lines	43
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	0

Metric	Value
c	7
b	0
f	0
dl	0
loc	43
rs	5.3846
cc	8
eloc	22
nc	37
nop	4

<?php

namespace AlfredTime;

use AlfredTime\Toggl;
use AlfredTime\Config;
use AlfredTime\Harvest;

class Time
{
    /**
     * @var mixed
     */
    private $config;

    /**
     * @var mixed
     */
    private $harvest;

    /**
     * @var mixed
     */
    private $toggl;

    /**
     * @param Config $config
     */
    public function __construct(Config $config = null)
    {
        $this->config = $config;
        $this->harvest = new Harvest($this->config->get('harvest', 'domain'), $this->config->get('harvest', 'api_token'));
        $this->toggl = new Toggl($this->config->get('toggl', 'api_token'));
    }

    /**
     * @param  $service
     * @param  $timerId
     * @return boolean
     */
    public function deleteServiceTimer($service, $timerId)
    {
        if ($this->$service->deleteTimer($timerId) === false) {
            return false;
        }

        if ($timerId === $this->config->get('workflow', 'timer_' . $service . '_id')) {
            $this->config->update('workflow', 'timer_' . $service . '_id', null);
        }

        return true;
    }

    /**
     * @param  $timerId
     * @return string
     */
    public function deleteTimer($timerId)
    {
        $message = '';

        foreach ($this->config->implementedServicesForFeature('delete') as $service) {
            if ($this->deleteServiceTimer($service, $timerId) === true) {
                $message .= '- ' . ucfirst($service) . ': deleted' . "\r\n";
            } else {
                $message .= '- ' . ucfirst($service) . ': cannot delete' . "\r\n";
            }
        }

        return $message;
    }

    /**
     * @param  $projectId
     * @return mixed
     */
    public function getProjectName($projectId)
    {
        $projectName = '';

        $projects = $this->getProjects();

        foreach ($projects as $project) {
            if ($project['id'] === $projectId) {
                $projectName = $project['name'];
                break;
            }
        }

        return $projectName;
    }

    /**
     * @return mixed
     */
    public function getProjects()

    {
        $projects = [];

/*
 * Temporary, only get the projects of Toggl
 * Later, we will get Harvest ones too
 */
        foreach ($this->config->implementedServicesForFeature('get_projects') as $service) {
            if ($this->config->isServiceActive($service) === true) {
                $projects = $this->$service->getProjects($this->getServiceDataCache($service));
            }
        }

        return $projects;
    }

    /**
     * @return mixed
     */
    public function getRecentTimers()

    {
        $timers = [];

        foreach ($this->config->implementedServicesForFeature('get_timers') as $service) {
            if ($this->config->isServiceActive($service) === true) {
                $timers = array_merge($timers, $this->getRecentServiceTimers($service));
            }
        }

        return $timers;
    }

    /**
     * @param  $service
     * @return mixed
     */
    public function getServiceDataCache($service)
    {
        $data = [];
        $cacheFile = getenv('alfred_workflow_data') . '/' . $service . '_cache.json';

        if (file_exists($cacheFile)) {
            $data = json_decode(file_get_contents($cacheFile), true);
        }

        return $data;
    }

    /**
     * @return mixed
     */
    public function getTags()

    {
        $tags = [];

/*
 * Temporary, only get the tags of Toggl
 * Later, we will get Harvest ones too
 */
        foreach ($this->config->implementedServicesForFeature('get_tags') as $service) {
            if ($this->config->isServiceActive($service) === true) {
                $tags = $this->$service->getTags($this->getServiceDataCache($service));
            }
        }

        return $tags;
    }

    /**
     * @param  $description
     * @param  $projectsDefault
     * @param  null               $tagsDefault
     * @param  boolean            $startDefault
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function startTimer($description = '', $projectsDefault = null, $tagsDefault = null, $startType = 'start')
    {
        $message = '';
        $oneServiceStarted = false;
        $implementedServices = $this->config->implementedServicesForFeature($startType);

/*
 * When starting a new timer, all the services timer IDs have to be put to null
 * so that when the user uses the UNDO feature, it doesn't delete old previous
 * other services timers. The timer IDs are used for the UNDO feature and
 * should then contain the IDs of the last starts through the workflow, not
 * through each individual sefrvice
 */
        if (empty($implementedServices) === true) {
            return '';
        }

        foreach ($this->config->activatedServices() as $service) {
            $this->config->update('workflow', 'timer_' . $service . '_id', null);
        }

        foreach ($implementedServices as $service) {
            $defaultProjectId = isset($projectsDefault[$service]) ? $projectsDefault[$service] : null;
            $defaultTags = isset($tagsDefault[$service]) ? $tagsDefault[$service] : null;

            $timerId = $this->$service->startTimer($description, $defaultProjectId, $defaultTags);
            $this->config->update('workflow', 'timer_' . $service . '_id', $timerId);

            if ($timerId !== null) {
                $oneServiceStarted = true;
                $message .= '- ' . ucfirst($service) . ': started' . "\r\n";
            } else {
                $message .= '- ' . ucfirst($service) . ': cannot start' . "\r\n";
            }
        }

        if ($oneServiceStarted === true) {
            $this->config->update('workflow', 'timer_description', $description);
            $this->config->update('workflow', 'is_timer_running', true);
        }

        return $message;
    }

    /**
     * @param  $description
     * @return string
     */
    public function startTimerWithDefaultOptions($description)
    {
        $projectsDefault = [
            'toggl'   => $this->config->get('toggl', 'default_project_id'),
            'harvest' => $this->config->get('harvest', 'default_project_id'),
        ];

        $tagsDefault = [
            'toggl'   => $this->config->get('toggl', 'default_tags'),
            'harvest' => $this->config->get('harvest', 'default_task_id'),
        ];



        return $this->startTimer($description, $projectsDefault, $tagsDefault, 'start_default');
    }

    /**
     * @return string
     */
    public function stopRunningTimer()
    {
        $message = '';
        $oneServiceStopped = false;

        foreach ($this->config->activatedServices() as $service) {

            $timerId = $this->config->get('workflow', 'timer_' . $service . '_id');

            if ($this->$service->stopTimer($timerId) === true) {
                $oneServiceStopped = true;
                $message .= '- ' . ucfirst($service) . ': stopped' . "\r\n";
            } else {
                $message .= '- ' . ucfirst($service) . ': cannot stop' . "\r\n";
            }
        }

        if ($oneServiceStopped === true) {
            $this->config->update('workflow', 'is_timer_running', false);
        }

        return $message;
    }

    /**
     * @return string
     */
    public function syncOnlineDataToLocalCache()

    {
        $message = '';

        foreach ($this->config->implementedServicesForFeature('sync_data') as $service) {
            if ($this->config->isServiceActive($service) === true) {
                $message .= $this->syncServiceOnlineDataToLocalCache($service);
            }
        }

        return $message;
    }

    /**
     * @return string
     */
    public function undoTimer()
    {
        $message = '';

        if ($this->config->hasTimerRunning() === true) {
            $this->stopRunningTimer();
        }

        $oneTimerDeleted = false;

        foreach ($this->config->servicesToUndo() as $service) {

            if ($this->deleteServiceTimer($service, $this->config->get('workflow', 'timer_' . $service . '_id')) === true) {
                $oneTimerDeleted = true;
                $message .= '- ' . ucfirst($service) . ': undid' . "\r\n";
            } else {
                $message .= '- ' . ucfirst($service) . ': cannot undo' . "\r\n";
            }
        }

        if ($oneTimerDeleted === true) {
            $this->config->update('workflow', 'is_timer_running', false);
        }

        return $message;
    }

    /**
     * @return mixed
     */
    private function getRecentServiceTimers($service)
    {
        return $this->$service->getRecentTimers();
    }

    /**
     * @param $data
     * @param string  $service
     */
    private function saveServiceDataCache($service, $data)
    {
        $cacheFile = getenv('alfred_workflow_data') . '/' . $service . '_cache.json';
        file_put_contents($cacheFile, json_encode($data));
    }

    /**
     * @param  string   $service
     * @return string
     */
    private function syncServiceOnlineDataToLocalCache($service)
    {
        $data = $this->$service->getOnlineData();

        if (empty($data) === true) {
            return '- ' . ucfirst($service) . ': cannot cache data' . "\r\n";
        }

        $this->saveServiceDataCache($service, $data);

        return '- ' . ucfirst($service) . ': data cached' . "\r\n";
    }
}


1		<?php
2
3		namespace AlfredTime;
4
5		use AlfredTime\Toggl;
6		use AlfredTime\Config;
7		use AlfredTime\Harvest;
8
9		class Time
10		{
11		/**
12		* @var mixed
13		*/
14		private $config;
15
16		/**
17		* @var mixed
18		*/
19		private $harvest;
20
21		/**
22		* @var mixed
23		*/
24		private $toggl;
25
26		/**
27		* @param Config $config
28		*/
29		public function __construct(Config $config = null)
30		{
31		$this->config = $config;
32		$this->harvest = new Harvest($this->config->get('harvest', 'domain'), $this->config->get('harvest', 'api_token'));
33		$this->toggl = new Toggl($this->config->get('toggl', 'api_token'));
34		}
35
36		/**
37		* @param $service
38		* @param $timerId
39		* @return boolean
40		*/
41		public function deleteServiceTimer($service, $timerId)
42		{
43		if ($this->$service->deleteTimer($timerId) === false) {
44		return false;
45		}
46
47		if ($timerId === $this->config->get('workflow', 'timer_' . $service . '_id')) {
48		$this->config->update('workflow', 'timer_' . $service . '_id', null);
49		}
50
51		return true;
52		}
53
54		/**
55		* @param $timerId
56		* @return string
57		*/
58		public function deleteTimer($timerId)
59		{
60		$message = '';
61
62		foreach ($this->config->implementedServicesForFeature('delete') as $service) {
63		if ($this->deleteServiceTimer($service, $timerId) === true) {
64		$message .= '- ' . ucfirst($service) . ': deleted' . "\r\n";
65		} else {
66		$message .= '- ' . ucfirst($service) . ': cannot delete' . "\r\n";
67		}
68		}
69
70		return $message;
71		}
72
73		/**
74		* @param $projectId
75		* @return mixed
76		*/
77		public function getProjectName($projectId)
78		{
79		$projectName = '';
80
81		$projects = $this->getProjects();
82
83		foreach ($projects as $project) {
84		if ($project['id'] === $projectId) {
85		$projectName = $project['name'];
86		break;
87		}
88		}
89
90		return $projectName;
91		}
92
93		/**
94		* @return mixed
95		*/
96	View Code Duplication	public function getProjects()
		0 ignored issues – show Duplication introduced 2017-05-12 08:06 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...
97		{
98		$projects = [];
99
100		/*
101		* Temporary, only get the projects of Toggl
102		* Later, we will get Harvest ones too
103		*/
104		foreach ($this->config->implementedServicesForFeature('get_projects') as $service) {
105		if ($this->config->isServiceActive($service) === true) {
106		$projects = $this->$service->getProjects($this->getServiceDataCache($service));
107		}
108		}
109
110		return $projects;
111		}
112
113		/**
114		* @return mixed
115		*/
116	View Code Duplication	public function getRecentTimers()
		0 ignored issues – show Duplication introduced 2017-05-02 03:35 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...
117		{
118		$timers = [];
119
120		foreach ($this->config->implementedServicesForFeature('get_timers') as $service) {
121		if ($this->config->isServiceActive($service) === true) {
122		$timers = array_merge($timers, $this->getRecentServiceTimers($service));
123		}
124		}
125
126		return $timers;
127		}
128
129		/**
130		* @param $service
131		* @return mixed
132		*/
133		public function getServiceDataCache($service)
134		{
135		$data = [];
136		$cacheFile = getenv('alfred_workflow_data') . '/' . $service . '_cache.json';
137
138		if (file_exists($cacheFile)) {
139		$data = json_decode(file_get_contents($cacheFile), true);
140		}
141
142		return $data;
143		}
144
145		/**
146		* @return mixed
147		*/
148	View Code Duplication	public function getTags()
		0 ignored issues – show Duplication introduced 2017-05-12 08:06 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...
149		{
150		$tags = [];
151
152		/*
153		* Temporary, only get the tags of Toggl
154		* Later, we will get Harvest ones too
155		*/
156		foreach ($this->config->implementedServicesForFeature('get_tags') as $service) {
157		if ($this->config->isServiceActive($service) === true) {
158		$tags = $this->$service->getTags($this->getServiceDataCache($service));
159		}
160		}
161
162		return $tags;
163		}
164
165		/**
166		* @param $description
167		* @param $projectsDefault
168		* @param null $tagsDefault
169		* @param boolean $startDefault
		0 ignored issues – show Bug introduced 2017-05-13 11:49 UTC by Report Bug Copy Issue Report There is no parameter named `$startDefault`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
170		* @return string
171		*/
172		public function startTimer($description = '', $projectsDefault = null, $tagsDefault = null, $startType = 'start')
173		{
174		$message = '';
175		$oneServiceStarted = false;
176		$implementedServices = $this->config->implementedServicesForFeature($startType);
177
178		/*
179		* When starting a new timer, all the services timer IDs have to be put to null
180		* so that when the user uses the UNDO feature, it doesn't delete old previous
181		* other services timers. The timer IDs are used for the UNDO feature and
182		* should then contain the IDs of the last starts through the workflow, not
183		* through each individual sefrvice
184		*/
185		if (empty($implementedServices) === true) {
186		return '';
187		}
188
189		foreach ($this->config->activatedServices() as $service) {
190		$this->config->update('workflow', 'timer_' . $service . '_id', null);
191		}
192
193		foreach ($implementedServices as $service) {
194		$defaultProjectId = isset($projectsDefault[$service]) ? $projectsDefault[$service] : null;
195		$defaultTags = isset($tagsDefault[$service]) ? $tagsDefault[$service] : null;
196
197		$timerId = $this->$service->startTimer($description, $defaultProjectId, $defaultTags);
198		$this->config->update('workflow', 'timer_' . $service . '_id', $timerId);
199
200		if ($timerId !== null) {
201		$oneServiceStarted = true;
202		$message .= '- ' . ucfirst($service) . ': started' . "\r\n";
203		} else {
204		$message .= '- ' . ucfirst($service) . ': cannot start' . "\r\n";
205		}
206		}
207
208		if ($oneServiceStarted === true) {
209		$this->config->update('workflow', 'timer_description', $description);
210		$this->config->update('workflow', 'is_timer_running', true);
211		}
212
213		return $message;
214		}
215
216		/**
217		* @param $description
218		* @return string
219		*/
220		public function startTimerWithDefaultOptions($description)
221		{
222		$projectsDefault = [
223		'toggl' => $this->config->get('toggl', 'default_project_id'),
224		'harvest' => $this->config->get('harvest', 'default_project_id'),
225		];
226
227		$tagsDefault = [
228		'toggl' => $this->config->get('toggl', 'default_tags'),
229		'harvest' => $this->config->get('harvest', 'default_task_id'),
230		];
231
232
233
234		return $this->startTimer($description, $projectsDefault, $tagsDefault, 'start_default');
235		}
236
237		/**
238		* @return string
239		*/
240		public function stopRunningTimer()
241		{
242		$message = '';
243		$oneServiceStopped = false;
244
245	View Code Duplication	foreach ($this->config->activatedServices() as $service) {
		0 ignored issues – show Duplication introduced 2017-05-13 09:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
246		$timerId = $this->config->get('workflow', 'timer_' . $service . '_id');
247
248		if ($this->$service->stopTimer($timerId) === true) {
249		$oneServiceStopped = true;
250		$message .= '- ' . ucfirst($service) . ': stopped' . "\r\n";
251		} else {
252		$message .= '- ' . ucfirst($service) . ': cannot stop' . "\r\n";
253		}
254		}
255
256		if ($oneServiceStopped === true) {
257		$this->config->update('workflow', 'is_timer_running', false);
258		}
259
260		return $message;
261		}
262
263		/**
264		* @return string
265		*/
266	View Code Duplication	public function syncOnlineDataToLocalCache()
		0 ignored issues – show Duplication introduced 2017-05-09 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...
267		{
268		$message = '';
269
270		foreach ($this->config->implementedServicesForFeature('sync_data') as $service) {
271		if ($this->config->isServiceActive($service) === true) {
272		$message .= $this->syncServiceOnlineDataToLocalCache($service);
273		}
274		}
275
276		return $message;
277		}
278
279		/**
280		* @return string
281		*/
282		public function undoTimer()
283		{
284		$message = '';
285
286		if ($this->config->hasTimerRunning() === true) {
287		$this->stopRunningTimer();
288		}
289
290		$oneTimerDeleted = false;
291
292	View Code Duplication	foreach ($this->config->servicesToUndo() as $service) {
		0 ignored issues – show Duplication introduced 2017-05-13 09:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
293		if ($this->deleteServiceTimer($service, $this->config->get('workflow', 'timer_' . $service . '_id')) === true) {
294		$oneTimerDeleted = true;
295		$message .= '- ' . ucfirst($service) . ': undid' . "\r\n";
296		} else {
297		$message .= '- ' . ucfirst($service) . ': cannot undo' . "\r\n";
298		}
299		}
300
301		if ($oneTimerDeleted === true) {
302		$this->config->update('workflow', 'is_timer_running', false);
303		}
304
305		return $message;
306		}
307
308		/**
309		* @return mixed
310		*/
311		private function getRecentServiceTimers($service)
312		{
313		return $this->$service->getRecentTimers();
314		}
315
316		/**
317		* @param $data
318		* @param string $service
319		*/
320		private function saveServiceDataCache($service, $data)
321		{
322		$cacheFile = getenv('alfred_workflow_data') . '/' . $service . '_cache.json';
323		file_put_contents($cacheFile, json_encode($data));
324		}
325
326		/**
327		* @param string $service
328		* @return string
329		*/
330		private function syncServiceOnlineDataToLocalCache($service)
331		{
332		$data = $this->$service->getOnlineData();
333
334		if (empty($data) === true) {
335		return '- ' . ucfirst($service) . ': cannot cache data' . "\r\n";
336		}
337
338		$this->saveServiceDataCache($service, $data);
339
340		return '- ' . ucfirst($service) . ': data cached' . "\r\n";
341		}
342		}
343

godbout / alfred-time

Push — master ( 48ce65...e784a2 )

Time::startTimer() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like