Toggl::startTimer() - 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

Toggl::startTimer() A

↳ Parent: Toggl

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	4
nc	3
nop	0

<?php

namespace Godbout\Alfred\Time\Services;

use Exception;
use Carbon\Carbon;
use Carbon\CarbonInterval;
use MorningTrain\TogglApi\TogglApi;

class Toggl extends TimerService
{
    private $client;

    private $data = null;


    public function __construct($apiToken)
    {
        $this->client = new TogglApi($apiToken);
    }

    public function projects()
    {
        return $this->extractFromData('projects');
    }

    public function tags()
    {
        return $this->extractFromData('tags');
    }

    public function pastTimers()
    {
        try {
            $pastTimers = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

            $togglTimers = $this->client->getTimeEntriesInRange(Carbon::today(), Carbon::today()->subDays(30));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            return $this->convertToPastTimers($togglTimers);
        } catch (Exception $e) {
            return [];
        }
    }

    public function startTimer()
    {
        try {
            $timer = $this->client->startTimeEntry([
                'description' => getenv('timer_description'),
                'pid' => getenv('timer_project_id'),
                'tags' => getenv('timer_tag') ? [getenv('timer_tag')] : '',
                'created_with' => 'Alfred Time'
            ]);

            if (! isset($timer->id)) {
                return false;
            }
        } catch (Exception $e) {
            return false;
        }

        return $timer->id;
    }

    public function stopCurrentTimer()

    {
        if ($timerId = $this->runningTimer()) {
            $response = $this->client->stopTimeEntry($timerId);

            if (! isset($response->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()
    {
        $timer = $this->client->getRunningTimeEntry();

        return $timer->id ?? false;
    }

    public function continueTimer($timerId)
    {
        /**
         * Timer attributes are stored in env variables
         * gathered in startTimer.
         */
        return $this->startTimer();
    }

    public function deleteTimer($timerId)
    {
        try {
            $this->client->deleteTimeEntry($timerId);
        } catch (Exception $e) {
            return false;
        }

        return true;
    }

    private function extractFromData($needle)
    {
        $data = $this->getData();

        if (! isset($data->$needle)) {
            return [];
        }

        $nonDeletedData = $this->filterOutServerwiseDeletedItemsFromData($data->$needle);

        return array_column($nonDeletedData, 'name', 'id');
    }

    private function getData()
    {
        if (is_null($this->data)) {
            return $this->client->getMe(true);
        }

        return $this->data;
    }

    private function filterOutServerwiseDeletedItemsFromData($items = [])
    {
        return array_filter($items, function ($item) {
            return ! isset($item->server_deleted_at);
        });
    }

    protected function convertToPastTimers($togglTimers)
    {
        $projects = $this->projects();

        return array_reverse(
            array_map(function ($togglTimer) use ($projects) {
                return $this->buildPastTimerObject($togglTimer, $projects);
            }, $togglTimers)
        );
    }

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

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

    // do something with $myArray
}
        $pastTimer['description'] = $togglTimer->description ?? null;
        $pastTimer['duration'] = CarbonInterval::seconds($togglTimer->duration)->cascade()->format('%H:%I:%S');

        if (isset($togglTimer->pid)) {
            $pastTimer['project_id'] = $togglTimer->pid;
            $pastTimer['project_name'] = $projects[$togglTimer->pid];
        }

        if (isset($togglTimer->tags)) {
            $pastTimer['tags'] = implode(', ', (array) $togglTimer->tags);
        }

        return (object) $pastTimer;
    }
}


1		<?php
2
3		namespace Godbout\Alfred\Time\Services;
4
5		use Exception;
6		use Carbon\Carbon;
7		use Carbon\CarbonInterval;
8		use MorningTrain\TogglApi\TogglApi;
9
10		class Toggl extends TimerService
11		{
12		private $client;
13
14		private $data = null;
15
16
17		public function __construct($apiToken)
18		{
19		$this->client = new TogglApi($apiToken);
20		}
21
22		public function projects()
23		{
24		return $this->extractFromData('projects');
25		}
26
27		public function tags()
28		{
29		return $this->extractFromData('tags');
30		}
31
32		public function pastTimers()
33		{
34		try {
35		$pastTimers = [];
		0 ignored issues – show Unused Code introduced 2019-03-28 14:59 UTC by Report Bug Copy Issue Report `$pastTimers` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
36
37		$togglTimers = $this->client->getTimeEntriesInRange(Carbon::today(), Carbon::today()->subDays(30));
		0 ignored issues – show Documentation introduced 2019-03-28 14:59 UTC by Report Bug Copy Issue Report `\Carbon\Carbon::today()` is of type `object`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
38
39		return $this->convertToPastTimers($togglTimers);
40		} catch (Exception $e) {
41		return [];
42		}
43		}
44
45		public function startTimer()
46		{
47		try {
48		$timer = $this->client->startTimeEntry([
49		'description' => getenv('timer_description'),
50		'pid' => getenv('timer_project_id'),
51		'tags' => getenv('timer_tag') ? [getenv('timer_tag')] : '',
52		'created_with' => 'Alfred Time'
53		]);
54
55		if (! isset($timer->id)) {
56		return false;
57		}
58		} catch (Exception $e) {
59		return false;
60		}
61
62		return $timer->id;
63		}
64
65	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...
66		{
67		if ($timerId = $this->runningTimer()) {
68		$response = $this->client->stopTimeEntry($timerId);
69
70		if (! isset($response->id)) {
71		throw new Exception("Can't stop current running timer.", 1);
72
73		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...
74		}
75
76		return true;
77		}
78
79		return false;
80		}
81
82		public function runningTimer()
83		{
84		$timer = $this->client->getRunningTimeEntry();
85
86		return $timer->id ?? false;
87		}
88
89		public function continueTimer($timerId)
90		{
91		/**
92		* Timer attributes are stored in env variables
93		* gathered in startTimer.
94		*/
95		return $this->startTimer();
96		}
97
98		public function deleteTimer($timerId)
99		{
100		try {
101		$this->client->deleteTimeEntry($timerId);
102		} catch (Exception $e) {
103		return false;
104		}
105
106		return true;
107		}
108
109		private function extractFromData($needle)
110		{
111		$data = $this->getData();
112
113		if (! isset($data->$needle)) {
114		return [];
115		}
116
117		$nonDeletedData = $this->filterOutServerwiseDeletedItemsFromData($data->$needle);
118
119		return array_column($nonDeletedData, 'name', 'id');
120		}
121
122		private function getData()
123		{
124		if (is_null($this->data)) {
125		return $this->client->getMe(true);
126		}
127
128		return $this->data;
129		}
130
131		private function filterOutServerwiseDeletedItemsFromData($items = [])
132		{
133		return array_filter($items, function ($item) {
134		return ! isset($item->server_deleted_at);
135		});
136		}
137
138		protected function convertToPastTimers($togglTimers)
139		{
140		$projects = $this->projects();
141
142		return array_reverse(
143		array_map(function ($togglTimer) use ($projects) {
144		return $this->buildPastTimerObject($togglTimer, $projects);
145		}, $togglTimers)
146		);
147		}
148
149		protected function buildPastTimerObject($togglTimer, $projects)
150		{
151		$pastTimer['id'] = $togglTimer->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...
152		$pastTimer['description'] = $togglTimer->description ?? null;
153		$pastTimer['duration'] = CarbonInterval::seconds($togglTimer->duration)->cascade()->format('%H:%I:%S');
154
155		if (isset($togglTimer->pid)) {
156		$pastTimer['project_id'] = $togglTimer->pid;
157		$pastTimer['project_name'] = $projects[$togglTimer->pid];
158		}
159
160		if (isset($togglTimer->tags)) {
161		$pastTimer['tags'] = implode(', ', (array) $togglTimer->tags);
162		}
163
164		return (object) $pastTimer;
165		}
166		}
167

godbout / alfred-time

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

Toggl::startTimer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like