Ability to sort occurrences (#77)

DOCUMENTATION.md

@@ -107,7 +107,9 @@ Currently only simple taxonomy filtering is supported, using the same syntax as
 {{ /events:between }}
 ```
 
-Further filtering is coming.
+**Sorting**
+
+By default the occurrenes are sorted in ascending order, to get them in descending order, use `sort="desc"` on any of the tags.
 
 ### Between Tag
 

phpunit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
  <coverage/>
  <testsuites>
  <testsuite name="Unit">
@@ -21,4 +21,5 @@
  <env name="MAIL_DRIVER" value="array"/>
  <env name="MAILCHIMP_DRIVER" value="log"/>
  </php>
+ <source/>
 </phpunit>

src/Events.php

@@ -34,6 +34,8 @@ class Events
 
  private ?string $site = null;
 
+ private string $sort = 'asc';
+
  private array $terms = [];
 
  public static function fromCollection(string $handle): self
@@ -102,6 +104,13 @@ public function site(string $handle): self
  return $this;
  }
 
+ public function sort(string $direction): self
+ {
+ $this->sort = $direction;
+
+ return $this;
+ }
+
  public function terms(string|array $terms): self
  {
  $this->terms = Arr::wrap($terms);
@@ -157,7 +166,7 @@ private function occurrences(callable $generator): EntryCollection
  return $this->entries
  // take each event and generate the occurences
  ->flatMap(callback: $generator)
- ->sortBy(fn (Entry $occurrence) => $occurrence->start)
+ ->sortBy(callback: fn (Entry $occurrence) => $occurrence->start, descending: $this->sort === 'desc')
  ->values();
  }
 

src/Tags/Events.php

@@ -132,6 +132,7 @@ private function generator(): Generator
  Generator::fromCollection($this->params->get('collection', 'events'));
 
  return $generator
+ ->sort($this->params->get('sort', 'asc'))
  ->when(
  value: $this->parseTerms(),
  callback: fn (Generator $generator, array $terms) => $generator->terms(terms: $terms)

tests/Feature/TagTest.php

@@ -341,4 +341,22 @@ public function canGenerateEventDownloadLink()
 
  $this->assertEquals('http://localhost/!/events/ics?collection=events&event=recurring-event', $url);
  }
+
+ /** @test */
+ public function canSortOccurrencesDesc()
+ {
+
+ $this->tag
+ ->setContext([])
+ ->setParameters([
+ 'collection' => 'events',
+ 'limit' => 3,
+ 'sort' => 'desc',
+ ]);
+
+ $occurrences = $this->tag->upcoming();
+
+ $this->assertTrue($occurrences[0]->start->isAfter($occurrences[1]->start));
+ $this->assertTrue($occurrences[1]->start->isAfter($occurrences[2]->start));
+ }
 }