Completed
Push — master ( 0a8019...1b85db )
by Freek
03:11
created

GoogleCalendar   A

Complexity

Total Complexity 13

Size/Duplication

Total Lines 130
Duplicated Lines 18.46 %

Coupling/Cohesion

Components 1
Dependencies 4

Importance

Changes 2
Bugs 0 Features 0
Metric Value
wmc 13
lcom 1
cbo 4
dl 24
loc 130
rs 10
c 2
b 0
f 0

8 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 6 1
A getCalendarId() 0 4 1
B listEvents() 0 38 3
A getEvent() 0 6 1
A insertEvent() 8 8 2
A updateEvent() 8 8 2
A deleteEvent() 8 8 2
A getService() 0 4 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace Spatie\GoogleCalendar;
4
5
use Carbon\Carbon;
6
use DateTime;
7
use Google_Service_Calendar;
8
use Google_Service_Calendar_Event;
9
use Illuminate\Support\Collection;
10
11
class GoogleCalendar
12
{
13
    /** @var \Spatie\GoogleCalendar\Google_Service_Calendar */
14
    protected $calendarService;
15
16
    /** @var string */
17
    protected $calendarId;
18
19
    public function __construct(Google_Service_Calendar $calendarService, $calendarId)
20
    {
21
        $this->calendarService = $calendarService;
0 ignored issues
show
Documentation Bug introduced by
It seems like $calendarService of type object<Google_Service_Calendar> is incompatible with the declared type object<Spatie\GoogleCale...oogle_Service_Calendar> of property $calendarService.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
22
23
        $this->calendarId = $calendarId;
24
    }
25
26
    public function getCalendarId() : string
27
    {
28
        return $this->calendarId;
29
    }
30
31
    /**
32
     * List events.
33
     *
34
     * @param Carbon $startDateTime
35
     * @param Carbon $endDateTime
36
     * @param array $queryParameters
37
     *
38
     * @link https://developers.google.com/google-apps/calendar/v3/reference/events/list
39
     *
40
     * @return Collection
41
     */
42
    public function listEvents(Carbon $startDateTime = null, Carbon $endDateTime = null, $queryParameters = []) : Collection
43
    {
44
        $parameters = ['singleEvents' => true];
45
46
        if (is_null($startDateTime)) {
47
            $startDateTime = Carbon::now()->startOfDay();
48
        }
49
        $parameters['timeMin'] = $startDateTime->format(DateTime::RFC3339);
50
51
        if (is_null($endDateTime)) {
52
            $endDateTime = Carbon::now()->addYear()->endOfDay();
53
        }
54
        $parameters['timeMax'] = $endDateTime->format(DateTime::RFC3339);
55
56
        $parameters = array_merge($parameters, $queryParameters);
57
58
        $googleEvents = $this
59
            ->calendarService
60
            ->events
61
            ->listEvents($this->calendarId, $parameters)
62
            ->getItems();
63
64
        $events = collect($googleEvents)
65
            ->map(function (Google_Service_Calendar_Event $event) {
66
                return Event::createFromGoogleCalendarEvent($event, $this->calendarId);
67
            })
68
        ->sortBy(function (Event $event) {
69
           return $event->startDateTime->format(DATE_ISO8601);
70
        });
71
72
        /*
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
73
        $debug = $events->map(function (Event $event) {
74
            return $event->startDateTime->format('Y-m-d H:i:s') . ' - ' . $event->startDateTime->format('Y-m-d H:i:s') . $event->name . PHP_EOL;
75
        });
76
        */
77
78
        return $events;
79
    }
80
81
    /**
82
     * @param string $eventId
83
     * @return static
84
     */
85
    public function getEvent($eventId)
86
    {
87
        $googleEvent =  $this->calendarService->events->get($this->calendarId, $eventId);
88
89
        return Event::createFromGoogleCalendarEvent($googleEvent, $this->calendarId);
90
    }
91
92
    /**
93
     * Insert an event
94
     *
95
     * @param \Spatie\GoogleCalendar\Event|Google_Service_Calendar_Event $event
96
     *
97
     * @link https://developers.google.com/google-apps/calendar/v3/reference/events/insert
98
     *
99
     * @return mixed
100
     */
101 View Code Duplication
    public function insertEvent($event)
0 ignored issues
show
Duplication introduced by
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...
102
    {
103
        if ($event instanceof Event) {
104
            $event = $event->convertToGoogleEvent();
105
        }
106
107
        return $this->calendarService->events->insert($this->calendarId, $event);
108
    }
109
110
    /**
111
     * @param \Spatie\GoogleCalendar\Event|Google_Service_Calendar_Event $event
112
     *
113
     * @return \Google_Service_Calendar_Event
114
     */
115 View Code Duplication
    public function updateEvent($event)
0 ignored issues
show
Duplication introduced by
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...
116
    {
117
        if ($event instanceof Event) {
118
            $event = $event->convertToGoogleEvent();
119
        }
120
121
        return $this->calendarService->events->update($this->calendarId, $event->id, $event);
122
    }
123
124
    /**
125
     * @param string|\Spatie\GoogleCalendar\Event $eventId
126
     */
127 View Code Duplication
    public function deleteEvent($eventId)
0 ignored issues
show
Duplication introduced by
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...
128
    {
129
        if ($eventId instanceof Event) {
130
            $eventId = $eventId->id;
131
        }
132
133
        return $this->calendarService->events->delete($this->calendarId, $eventId);
134
    }
135
136
    public function getService() : Google_Service_Calendar
137
    {
138
        return $this->calendarService;
139
    }
140
}
141