Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,16 @@ If you are using a different Statamic collection, update it in the addon setting

### ICS Downloads

ICS downloads use the following fields if they exist:
ICS downloads read the following entry fields when present:

- `address`
- `coordinates`
- `description`
| ICS property | Source |
|---|---|
| `LOCATION` | `address`, falling back to `location` — only when the value is a string |
| `URL` | `link`, falling back to `location` when that string is a URL |
| `GEO` | `coordinates` (`latitude` / `longitude`) |
| `DESCRIPTION` | `description` |

A URL-valued `location` (with no separate `address` / `link`) currently emits **both** `LOCATION:` and `URL:`.

The `coordinates` field must be a keyed array:

Expand Down Expand Up @@ -262,7 +267,4 @@ Generates an ICS download link.
**Parameters:**
- `date` date get occurrences to download

Includes:
- `location`
- `description`
- `link`
Includes the fields documented under [ICS Downloads](#ics-downloads).
42 changes: 31 additions & 11 deletions src/Types/Event.php
Original file line number Diff line number Diff line change
Expand Up @@ -105,20 +105,40 @@ public function toICalendarEvent(string|CarbonInterface $date): ?ICalendarEvent
return null;
}

return $this->decorate($this->buildICalendarEvent($date));
}

/**
* @return ICalendarEvent[]
*/
public function toICalendarEvents(): array
{
if (! $event = $this->toICalendarEvent($this->start())) {
return [];
}

return [$event];
}

protected function buildICalendarEvent(string|CarbonInterface $date): ICalendarEvent
{
$immutableDate = $this->toCarbonImmutable($date);

$iCalEvent = ICalendarEvent::create($this->event->title)
return ICalendarEvent::create($this->event->title)
->withoutTimezone()
->uniqueIdentifier($this->event->id())
->startsAt($immutableDate->setTimeFromTimeString($this->startTime()))
->endsAt($immutableDate->setTimeFromTimeString($this->endTime()));
}

protected function decorate(ICalendarEvent $iCalEvent): ICalendarEvent
{
if ($address = $this->icsAddress()) {
$iCalEvent->address($address);
}

if (! is_null($coords = $this->event->coordinates)) {
$iCalEvent->coordinates($coords['latitude'], $coords['longitude']);
if ($this->hasValidCoordinates($coords = $this->event->get('coordinates'))) {
$iCalEvent->coordinates((float) $coords['latitude'], (float) $coords['longitude']);
}

if (! is_null($description = $this->event->description)) {
Expand All @@ -132,14 +152,6 @@ public function toICalendarEvent(string|CarbonInterface $date): ?ICalendarEvent
return $iCalEvent;
}

/**
* @return ICalendarEvent[]
*/
public function toICalendarEvents(): array
{
return Arr::wrap($this->toICalendarEvent($this->start()));
}

protected function eventUrl(): ?string
{
if (! is_null($link = $this->event->link)) {
Expand All @@ -162,6 +174,14 @@ protected function icsAddress(): ?string
return is_string($address) && $address !== '' ? $address : null;
}

// Entry::get() is untyped; keep mixed so a bad value can't TypeError the public ICS route.
protected function hasValidCoordinates(mixed $coords): bool
{
return is_array($coords)
&& is_numeric($coords['latitude'] ?? null)
&& is_numeric($coords['longitude'] ?? null);
}

protected function supplement(CarbonInterface $date): ?Entry
{
return unserialize(serialize($this->event))
Expand Down
70 changes: 37 additions & 33 deletions src/Types/MultiDayEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Spatie\IcalendarGenerator\Components\Event as ICalendarEvent;
use Statamic\Entries\Entry;
use Statamic\Fields\Values;
use Statamic\Support\Str;
use TransformStudios\Events\Day;

class MultiDayEvent extends Event
Expand Down Expand Up @@ -45,54 +46,48 @@ public function end(): CarbonImmutable
return $this->days->last()->end();
}

public function start(): CarbonImmutable
public function nextOccurrences(int $limit = 1): Collection
{
return $this->days->first()->start();
return $this->uniqueCollapsedOccurrences(parent::nextOccurrences($limit));
}

public function toICalendarEvent(string|CarbonInterface $date): ?ICalendarEvent
public function occurrencesBetween(string|CarbonInterface $from, string|CarbonInterface $to): Collection
{
if (! $this->occursOnDate($date)) {
return null;
}

$immutableDate = $this->toCarbonImmutable($date);
$day = $this->getDayFromDate($immutableDate);

$iCalEvent = ICalendarEvent::create($this->event->title)
->uniqueIdentifier($this->event->id())
->startsAt($immutableDate->setTimeFromTimeString($day->start()))
->endsAt($immutableDate->setTimeFromTimeString($day->end()));

if ($address = $this->icsAddress()) {
$iCalEvent->address($address);
}

if (! is_null($coords = $this->event->coordinates)) {
$iCalEvent->coordinates($coords['latitude'], $coords['longitude']);
}

if (! is_null($description = $this->event->description)) {
$iCalEvent->description($description);
}

if (! is_null($link = $this->eventUrl())) {
$iCalEvent->url($link);
}
return $this->uniqueCollapsedOccurrences(parent::occurrencesBetween($from, $to));
}

return $iCalEvent;
public function start(): CarbonImmutable
{
return $this->days->first()->start();
}

/**
* @return ICalendarEvent[]
*/
public function toICalendarEvents(): array
{
return collect($this->days)
->map(fn (Day $day, int $index) => $day->toICalendarEvent($this->event->title, $index))
return $this->days
->values()
->map(function (Day $day, int $index) {
$event = $this->toICalendarEvent($day->start());

return $event?->uniqueIdentifier(Str::slug($this->event->title).'-'.$index);
})
->filter()
->all();
}

protected function buildICalendarEvent(string|CarbonInterface $date): ICalendarEvent
{
$immutableDate = $this->toCarbonImmutable($date);
$day = $this->getDayFromDate($immutableDate);

return ICalendarEvent::create($this->event->title)
->uniqueIdentifier($this->event->id())
->startsAt($immutableDate->setTimeFromTimeString($day->start()))
->endsAt($immutableDate->setTimeFromTimeString($day->end()));
}

protected function rule(bool $useEnd = false): RRuleInterface
{
return tap(
Expand Down Expand Up @@ -139,4 +134,13 @@ private function getDayFromDate(CarbonInterface $date): ?Day
{
return $this->days->first(fn (Day $day, int $index) => $this->collapseMultiDays ? $index == 0 : $date->isSameDay($day->start()));
}

private function uniqueCollapsedOccurrences(Collection $occurrences): Collection
{
if (! $this->collapseMultiDays) {
return $occurrences;
}

return $occurrences->unique(fn (Entry $occurrence) => $occurrence->id())->values();
}
}
25 changes: 3 additions & 22 deletions src/Types/RecurringEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
use Illuminate\Support\Arr;
use RRule\RRule;
use RRule\RRuleInterface;
use Spatie\IcalendarGenerator\Components\Event as ICalendarEvent;
use Spatie\IcalendarGenerator\Enums\RecurrenceFrequency;
use Spatie\IcalendarGenerator\ValueObjects\RRule as ICalendarRule;

Expand All @@ -27,29 +26,11 @@ public function interval(): int
*/
public function toICalendarEvents(): array
{
$iCalEvent = ICalendarEvent::create($this->event->title)
->uniqueIdentifier($this->event->id())
->startsAt($this->start())
->endsAt($this->end())
->rrule($this->spatieRule());

if ($address = $this->icsAddress()) {
$iCalEvent->address($address);
if (! $event = $this->toICalendarEvent($this->start())) {
return [];
}

if (! is_null($coords = $this->event->coordinates)) {
$iCalEvent->coordinates($coords['latitude'], $coords['longitude']);
}

if (! is_null($description = $this->event->description)) {
$iCalEvent->description($description);
}

if (! is_null($link = $this->eventUrl())) {
$iCalEvent->url($link);
}

return [$iCalEvent];
return [$event->rrule($this->spatieRule())];
}

protected function rule(bool $useEnd = false): RRuleInterface
Expand Down
96 changes: 96 additions & 0 deletions tests/Http/Contollers/IcsControllerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -310,3 +310,99 @@

$this->assertStringNotContainsString('LOCATION:', $response->streamedContent());
});

test('multi-day whole-event download includes location url description and geo on every day', function () {
Carbon::setTestNow(now());

Entry::make()
->slug('multi-day-whole-event')
->collection('events')
->id('the-multi-day-whole-event')
->data([
'title' => 'Multi-day Whole Event',
'multi_day' => true,
'address' => '123 Main St',
'link' => 'https://example.com/join',
'coordinates' => [
'latitude' => 40,
'longitude' => 50,
],
'description' => 'The description',
'days' => [
[
'date' => now()->toDateString(),
'start_time' => '19:00',
'end_time' => '21:00',
],
[
'date' => now()->addDay()->toDateString(),
'start_time' => '11:00',
'end_time' => '15:00',
],
],
])->save();

$content = $this->get(route('statamic.events.ics.show', [
'event' => 'the-multi-day-whole-event',
]))->assertDownload('multi-day-whole-event.ics')->streamedContent();

expect(substr_count($content, 'LOCATION:123 Main St'))->toBe(2)
->and(substr_count($content, 'URL:https://example.com/join'))->toBe(2)
->and(substr_count($content, 'DESCRIPTION:The description'))->toBe(2)
->and(substr_count($content, 'GEO:40;50'))->toBe(2);
});

test('partial coordinates do not fatal and omit geo', function () {
Carbon::setTestNow(now()->setTimeFromTimeString('10:00'));

Entry::make()
->collection('events')
->slug('partial-coords-event')
->id('partial-coords-id')
->data([
'title' => 'Partial Coords Event',
'start_date' => Carbon::now()->toDateString(),
'start_time' => '11:00',
'end_time' => '12:00',
'address' => '123 Main St',
'coordinates' => [
'latitude' => 40,
],
])->save();

$content = $this->get(route('statamic.events.ics.show', [
'date' => now()->toDateString(),
'event' => 'partial-coords-id',
]))->assertDownload('partial-coords-event.ics')->streamedContent();

$this->assertStringContainsString('LOCATION:123 Main St', $content);
$this->assertStringNotContainsString('GEO:', $content);
});

test('non-numeric coordinates do not fatal and omit geo', function () {
Carbon::setTestNow(now()->setTimeFromTimeString('10:00'));

Entry::make()
->collection('events')
->slug('bad-coords-event')
->id('bad-coords-id')
->data([
'title' => 'Bad Coords Event',
'start_date' => Carbon::now()->toDateString(),
'start_time' => '11:00',
'end_time' => '12:00',
'address' => '123 Main St',
'coordinates' => [
'latitude' => 'north',
'longitude' => 'west',
],
])->save();

$content = $this->get(route('statamic.events.ics.show', [
'date' => now()->toDateString(),
'event' => 'bad-coords-id',
]))->assertDownload('bad-coords-event.ics')->streamedContent();

$this->assertStringContainsString('LOCATION:123 Main St', $content);
$this->assertStringNotContainsString('GEO:', $content);
});
31 changes: 31 additions & 0 deletions tests/Types/MultiDayEventsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
'timezone' => 'America/Vancouver',
]);

$this->entry = $entry;
$this->event = EventFactory::createFromEntry($entry);

$noEndTimeEntry = Entry::make()
Expand Down Expand Up @@ -113,6 +114,36 @@
expect($this->event->nextOccurrences()[0]->start)->toEqual(Carbon::parse('2019-11-24')->setTimeFromTimeString('11:00:00'));
});

test('can collapse a multi day event into one occurrence', function () {
$event = EventFactory::createFromEntry($this->entry, collapseMultiDays: true);

$occurrences = $event->occurrencesBetween(
Carbon::parse('2019-11-23')->startOfDay(),
Carbon::parse('2019-11-25')->endOfDay(),
);

expect($occurrences)->toHaveCount(1)
->and($occurrences->first()->start)->toEqual(Carbon::parse('2019-11-23 19:00')->shiftTimezone('America/Vancouver'))
->and($occurrences->first()->end)->toEqual(Carbon::parse('2019-11-25 15:00')->shiftTimezone('America/Vancouver'));
});

test('can collapse upcoming multi day occurrences', function () {
Carbon::setTestNowAndTimezone('2019-11-22', 'America/Vancouver');

$event = EventFactory::createFromEntry($this->entry, collapseMultiDays: true);

expect($event->nextOccurrences(3))->toHaveCount(1);
});

test('does not collapse a multi day event by default', function () {
$occurrences = $this->event->occurrencesBetween(
Carbon::parse('2019-11-23')->startOfDay(),
Carbon::parse('2019-11-25')->endOfDay(),
);

expect($occurrences)->toHaveCount(3);
});

test('day is all day when no start and end time', function () {
$days = $this->allDayEvent->days();

Expand Down
Loading