Harvest::stopCurrentTimer() - Code Metrics - Inspection of "Merge branch 'v2'" - godbout/alfred-time - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3b0b6a...263c36 )

by Guillaume

created 2019-06-09 13:26 UTC

Harvest::stopCurrentTimer() A

↳ Parent: Harvest

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	16
Ratio	100 %

Importance

Changes

Metric	Value
dl	16
loc	16
rs	9.7333
c	0
b	0
f	0
cc	3
nc	3
nop	0

<?php

namespace Godbout\Alfred\Time\Services;

use Carbon\Carbon;
use Carbon\CarbonInterval;
use Required\Harvest\Client;
use Required\Harvest\Exception\NotFoundException;
use Required\Harvest\Exception\AuthenticationException;
use Required\Harvest\Exception\ValidationFailedException;

class Harvest extends TimerService
{
    public $allowsEmptyProject = false;

    public $allowsEmptyTag = false;

    private $client;


    public function __construct($accountId, $apiToken)
    {
        $this->client = new Client();

        $this->client->authenticate($accountId, $apiToken);
    }

    public function projects()
    {
        try {
            return array_column($this->client->projects()->all(['']), 'name', 'id');
        } catch (AuthenticationException $e) {
            return [];
        }
    }

    public function tags()
    {
        try {
            $taskAssignments = $this->client->projects()->taskAssignments()->all(
                (int) getenv('timer_project_id'),
                ['is_active' => true]
            );

            array_walk($taskAssignments, function ($taskAssignment) use (&$tags) {
                $tags[$taskAssignment['task']['id']] = $taskAssignment['task']['name'];
            });

            return $tags;
        } catch (AuthenticationException $e) {
            return [];
        }
    }

    public function pastTimers()
    {
        try {
            $harvestTimers = $this->client->timeEntries()->all([
                'from' => Carbon::today()->subDays(30),
                'to' => Carbon::today()
            ]);

            return $this->convertToPastTimers($harvestTimers);
        } catch (AuthenticationException $e) {
            return [];
        }
    }

    public function startTimer()
    {
        try {
            $timer = $this->client->timeEntries()->create([
                'notes' => getenv('timer_description'),
                'project_id' => (int) getenv('timer_project_id'),
                'task_id' => (int) getenv('timer_tag_id'),
                'spent_date' => date('Y-m-d')
            ]);

            if (! isset($timer['id'])) {
                return false;
            }
        } catch (ValidationFailedException $e) {
            return false;
        }

        return $timer['id'];
    }

    public function stopCurrentTimer()

    {
        if ($timerId = $this->runningTimer()) {
            $timer = $this->client->timeEntries()->stop($timerId);

            if (! isset($timer['id'])) {
                throw new \Exception("Can't stop current running timer.", 1);

                return false;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
            }

            return true;
        }

        return false;
    }

    public function runningTimer()
    {
        try {
            $timer = $this->client->timeEntries()->all(['is_running' => true]);

            return $timer[0]['id'] ?? false;
        } catch (\Exception $e) {
            return false;
        }
    }

    public function continueTimer($timerId)
    {
        $timer = $this->client->timeEntries()->restart($timerId);

        return $timer['id'] ?? false;
    }

    public function deleteTimer($timerId)
    {
        try {
            $this->client->timeEntries()->remove($timerId);
        } catch (NotFoundException $e) {
            return false;
        }

        return true;
    }

    protected function convertToPastTimers($harvestTimers)
    {
        return array_map(function ($harvestTimer) {
            return $this->buildPastTimerObject($harvestTimer);
        }, $harvestTimers);
    }

    protected function buildPastTimerObject($harvestTimer)
    {
        $pastTimer['id'] = $harvestTimer['id'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $pastTimer['description'] = $harvestTimer['notes'];
        $pastTimer['project_id'] = $harvestTimer['project']['id'];
        $pastTimer['project_name'] = $harvestTimer['project']['name'];
        $pastTimer['tags'] = $harvestTimer['task']['name'];
        $pastTimer['duration'] = CarbonInterval::seconds(
            floor($harvestTimer['hours'] * 3600)
        )->cascade()->format('%H:%I:%S');

        return (object) $pastTimer;
    }
}


1		<?php
2
3		namespace Godbout\Alfred\Time\Services;
4
5		use Carbon\Carbon;
6		use Carbon\CarbonInterval;
7		use Required\Harvest\Client;
8		use Required\Harvest\Exception\NotFoundException;
9		use Required\Harvest\Exception\AuthenticationException;
10		use Required\Harvest\Exception\ValidationFailedException;
11
12		class Harvest extends TimerService
13		{
14		public $allowsEmptyProject = false;
15
16		public $allowsEmptyTag = false;
17
18		private $client;
19
20
21		public function __construct($accountId, $apiToken)
22		{
23		$this->client = new Client();
24
25		$this->client->authenticate($accountId, $apiToken);
26		}
27
28		public function projects()
29		{
30		try {
31		return array_column($this->client->projects()->all(['']), 'name', 'id');
32		} catch (AuthenticationException $e) {
33		return [];
34		}
35		}
36
37		public function tags()
38		{
39		try {
40		$taskAssignments = $this->client->projects()->taskAssignments()->all(
41		(int) getenv('timer_project_id'),
42		['is_active' => true]
43		);
44
45		array_walk($taskAssignments, function ($taskAssignment) use (&$tags) {
46		$tags[$taskAssignment['task']['id']] = $taskAssignment['task']['name'];
47		});
48
49		return $tags;
50		} catch (AuthenticationException $e) {
51		return [];
52		}
53		}
54
55		public function pastTimers()
56		{
57		try {
58		$harvestTimers = $this->client->timeEntries()->all([
59		'from' => Carbon::today()->subDays(30),
60		'to' => Carbon::today()
61		]);
62
63		return $this->convertToPastTimers($harvestTimers);
64		} catch (AuthenticationException $e) {
65		return [];
66		}
67		}
68
69		public function startTimer()
70		{
71		try {
72		$timer = $this->client->timeEntries()->create([
73		'notes' => getenv('timer_description'),
74		'project_id' => (int) getenv('timer_project_id'),
75		'task_id' => (int) getenv('timer_tag_id'),
76		'spent_date' => date('Y-m-d')
77		]);
78
79		if (! isset($timer['id'])) {
80		return false;
81		}
82		} catch (ValidationFailedException $e) {
83		return false;
84		}
85
86		return $timer['id'];
87		}
88
89	View Code Duplication	public function stopCurrentTimer()
		0 ignored issues – show Duplication introduced 2019-03-28 14:59 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...
90		{
91		if ($timerId = $this->runningTimer()) {
92		$timer = $this->client->timeEntries()->stop($timerId);
93
94		if (! isset($timer['id'])) {
95		throw new \Exception("Can't stop current running timer.", 1);
96
97		return false;
		0 ignored issues – show Unused Code introduced 2019-03-28 14:59 UTC by Report Bug Copy Issue Report `return false;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
98		}
99
100		return true;
101		}
102
103		return false;
104		}
105
106		public function runningTimer()
107		{
108		try {
109		$timer = $this->client->timeEntries()->all(['is_running' => true]);
110
111		return $timer[0]['id'] ?? false;
112		} catch (\Exception $e) {
113		return false;
114		}
115		}
116
117		public function continueTimer($timerId)
118		{
119		$timer = $this->client->timeEntries()->restart($timerId);
120
121		return $timer['id'] ?? false;
122		}
123
124		public function deleteTimer($timerId)
125		{
126		try {
127		$this->client->timeEntries()->remove($timerId);
128		} catch (NotFoundException $e) {
129		return false;
130		}
131
132		return true;
133		}
134
135		protected function convertToPastTimers($harvestTimers)
136		{
137		return array_map(function ($harvestTimer) {
138		return $this->buildPastTimerObject($harvestTimer);
139		}, $harvestTimers);
140		}
141
142		protected function buildPastTimerObject($harvestTimer)
143		{
144		$pastTimer['id'] = $harvestTimer['id'];
		0 ignored issues – show Coding Style Comprehensibility introduced 2019-03-28 14:59 UTC by Report Bug Copy Issue Report `$pastTimer` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$pastTimer = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
145		$pastTimer['description'] = $harvestTimer['notes'];
146		$pastTimer['project_id'] = $harvestTimer['project']['id'];
147		$pastTimer['project_name'] = $harvestTimer['project']['name'];
148		$pastTimer['tags'] = $harvestTimer['task']['name'];
149		$pastTimer['duration'] = CarbonInterval::seconds(
150		floor($harvestTimer['hours'] * 3600)
151		)->cascade()->format('%H:%I:%S');
152
153		return (object) $pastTimer;
154		}
155		}
156

godbout / alfred-time

Push — master ( 3b0b6a...263c36 )

Harvest::stopCurrentTimer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like