Time::syncOnlineDataToLocalCache() - Code Metrics - Inspection of "Refactor, moving config methods to Config class (T..." - godbout/alfred-time - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 60bcf6...cc7b46 )

by Guillaume

created 2017-05-13 10:18 UTC

Time::syncOnlineDataToLocalCache() A

↳ Parent: Time

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	12
Ratio	100 %

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
c	4
b	0
f	1
dl	12
loc	12
rs	9.4285
cc	3
eloc	6
nc	3
nop	0

<?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
     * @return string
     */
    public function startTimer($description = '', $projectsDefault = null, $tagsDefault = null, $startDefault = false)
    {
        $message = '';
        $startType = $startDefault === true ? 'start_default' : 'start';
        $atLeastOneServiceStarted = 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) === false) {
            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) {
                    $atLeastOneServiceStarted = true;
                    $message .= '- ' . ucfirst($service) . ': started' . "\r\n";
                } else {
                    $message .= '- ' . ucfirst($service) . ': cannot start' . "\r\n";
                }
            }
        }

        if ($atLeastOneServiceStarted === 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, true);
    }

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

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

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

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

        if ($atLeastOneServiceStopped === 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();
        }

        $atLeastOneTimerDeleted = false;

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

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

        if ($atLeastOneTimerDeleted === 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)

    {
        $message = '';
        $data = $this->$service->getOnlineData();

        if (empty($data) === false) {
            $this->saveServiceDataCache($service, $data);
            $message .= '- ' . ucfirst($service) . ': data cached' . "\r\n";
        } else {
            $message .= '- ' . ucfirst($service) . ': cannot cache data' . "\r\n";
        }

        return $message;
    }
}


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	View Code Duplication	public function deleteTimer($timerId)
		0 ignored issues – show Duplication introduced 2017-05-08 19:18 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...
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
170		* @return string
171		*/
172		public function startTimer($description = '', $projectsDefault = null, $tagsDefault = null, $startDefault = false)
173		{
174		$message = '';
175		$startType = $startDefault === true ? 'start_default' : 'start';
176		$atLeastOneServiceStarted = false;
177		$implementedServices = $this->config->implementedServicesForFeature($startType);
178
179		/*
180		* When starting a new timer, all the services timer IDs have to be put to null
181		* so that when the user uses the UNDO feature, it doesn't delete old previous
182		* other services timers. The timer IDs are used for the UNDO feature and
183		* should then contain the IDs of the last starts through the workflow, not
184		* through each individual sefrvice
185		*/
186		if (empty($implementedServices) === false) {
187		foreach ($this->config->activatedServices() as $service) {
188		$this->config->update('workflow', 'timer_' . $service . '_id', null);
189		}
190
191		foreach ($implementedServices as $service) {
192		$defaultProjectId = isset($projectsDefault[$service]) ? $projectsDefault[$service] : null;
193		$defaultTags = isset($tagsDefault[$service]) ? $tagsDefault[$service] : null;
194
195		$timerId = $this->$service->startTimer($description, $defaultProjectId, $defaultTags);
196		$this->config->update('workflow', 'timer_' . $service . '_id', $timerId);
197
198		if ($timerId !== null) {
199		$atLeastOneServiceStarted = true;
200		$message .= '- ' . ucfirst($service) . ': started' . "\r\n";
201		} else {
202		$message .= '- ' . ucfirst($service) . ': cannot start' . "\r\n";
203		}
204		}
205		}
206
207		if ($atLeastOneServiceStarted === true) {
208		$this->config->update('workflow', 'timer_description', $description);
209		$this->config->update('workflow', 'is_timer_running', true);
210		}
211
212		return $message;
213		}
214
215		/**
216		* @param $description
217		* @return string
218		*/
219		public function startTimerWithDefaultOptions($description)
220		{
221		$projectsDefault = [
222		'toggl' => $this->config->get('toggl', 'default_project_id'),
223		'harvest' => $this->config->get('harvest', 'default_project_id'),
224		];
225
226		$tagsDefault = [
227		'toggl' => $this->config->get('toggl', 'default_tags'),
228		'harvest' => $this->config->get('harvest', 'default_task_id'),
229		];
230
231		return $this->startTimer($description, $projectsDefault, $tagsDefault, true);
232		}
233
234		/**
235		* @return string
236		*/
237		public function stopRunningTimer()
238		{
239		$message = '';
240		$atLeastOneServiceStopped = false;
241
242	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...
243		$timerId = $this->config->get('workflow', 'timer_' . $service . '_id');
244
245		if ($this->$service->stopTimer($timerId) === true) {
246		$atLeastOneServiceStopped = true;
247		$message .= '- ' . ucfirst($service) . ': stopped' . "\r\n";
248		} else {
249		$message .= '- ' . ucfirst($service) . ': cannot stop' . "\r\n";
250		}
251		}
252
253		if ($atLeastOneServiceStopped === true) {
254		$this->config->update('workflow', 'is_timer_running', false);
255		}
256
257		return $message;
258		}
259
260		/**
261		* @return string
262		*/
263	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...
264		{
265		$message = '';
266
267		foreach ($this->config->implementedServicesForFeature('sync_data') as $service) {
268		if ($this->config->isServiceActive($service) === true) {
269		$message .= $this->syncServiceOnlineDataToLocalCache($service);
270		}
271		}
272
273		return $message;
274		}
275
276		/**
277		* @return string
278		*/
279		public function undoTimer()
280		{
281		$message = '';
282
283		if ($this->config->hasTimerRunning() === true) {
284		$this->stopRunningTimer();
285		}
286
287		$atLeastOneTimerDeleted = false;
288
289	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...
290		if ($this->deleteServiceTimer($service, $this->config->get('workflow', 'timer_' . $service . '_id')) === true) {
291		$atLeastOneTimerDeleted = true;
292		$message .= '- ' . ucfirst($service) . ': undid' . "\r\n";
293		} else {
294		$message .= '- ' . ucfirst($service) . ': cannot undo' . "\r\n";
295		}
296		}
297
298		if ($atLeastOneTimerDeleted === true) {
299		$this->config->update('workflow', 'is_timer_running', false);
300		}
301
302		return $message;
303		}
304
305		/**
306		* @return mixed
307		*/
308		private function getRecentServiceTimers($service)
309		{
310		return $this->$service->getRecentTimers();
311		}
312
313		/**
314		* @param $data
315		* @param string $service
316		*/
317		private function saveServiceDataCache($service, $data)
318		{
319		$cacheFile = getenv('alfred_workflow_data') . '/' . $service . '_cache.json';
320		file_put_contents($cacheFile, json_encode($data));
321		}
322
323		/**
324		* @param string $service
325		* @return string
326		*/
327	View Code Duplication	private function syncServiceOnlineDataToLocalCache($service)
		0 ignored issues – show Duplication introduced 2017-05-13 10:07 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...
328		{
329		$message = '';
330		$data = $this->$service->getOnlineData();
331
332		if (empty($data) === false) {
333		$this->saveServiceDataCache($service, $data);
334		$message .= '- ' . ucfirst($service) . ': data cached' . "\r\n";
335		} else {
336		$message .= '- ' . ucfirst($service) . ': cannot cache data' . "\r\n";
337		}
338
339		return $message;
340		}
341		}
342

godbout / alfred-time

Push — master ( 60bcf6...cc7b46 )

Time::syncOnlineDataToLocalCache() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like