Merge pull request #34 from jsor-labs/changelog

Implement combined changelog for all components

Author: WyriHaximus

bin/build

@@ -52,9 +52,7 @@ if ($input->hasParameterOption('--use-asset-dev-server')) {
 }
 
 if (!$input->hasParameterOption('--no-component-update')) {
-    $components = React\Website\Data\components($container['github.client']);
-
-    foreach ($components as $component) {
+    foreach ($container['data.components'] as $component) {
         $output->writeln(sprintf(
             '<comment>Updating component %s...</comment>',
             $component['repository']

config/berti.config.php

@@ -16,13 +16,24 @@
     };
 
     $container['data.components'] = function (Pimple\Container $container) {
-        return React\Website\Data\components($container['github.client']);
+        return React\Website\Data\components(
+            $container['github.client'],
+            $container['markdown.cache']
+        );
     };
 
     $container['data.components_by_category'] = function (Pimple\Container $container) {
         return React\Website\Data\components_by_category($container['data.components']);
     };
 
+    $container['data.releases'] = function (Pimple\Container $container) {
+        return React\Website\Data\releases($container['data.components']);
+    };
+
+    $container['data.releases_by_year'] = function (Pimple\Container $container) {
+        return React\Website\Data\releases_by_year($container['data.releases']);
+    };
+
     $container['data.built_with'] = function (Pimple\Container $container) {
         return React\Website\Data\built_with($container['github.client']);
     };
@@ -145,6 +156,16 @@
             $container['data.components_by_category']
         );
 
+        $twig->addGlobal(
+            'releases',
+            $container['data.releases']
+        );
+
+        $twig->addGlobal(
+            'releases_by_year',
+            $container['data.releases_by_year']
+        );
+
         $twig->addGlobal(
             'built_with',
             $container['data.built_with']

pages/changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+The combined changelog for all ReactPHP components.

src/berti.php

@@ -43,7 +43,7 @@ function github_url_generator(
 
 /**
  * This function extends the `Berti\twig_renderer()` to dynamically switch
- * templates if a component repository is detected.
+ * templates, eg. if a component repository is detected.
  *
  * It also passes additional component context data when rendering the template.
  */
@@ -58,9 +58,11 @@ function template_renderer(
     /** @var \Symfony\Component\Finder\SplFileInfo $documentInput */
     $documentInput = $context['berti']['document']->input;
 
-    $path = dirname($documentInput->getRealPath());
+    if ('changelog.md' === $documentInput->getRelativePathname()) {
+        return $bertiRenderer('changelog.html.twig', $context);
+    }
 
-    $repo = $repositoryDetector($path);
+    $repo = $repositoryDetector(dirname($documentInput->getRealPath()));
 
     if (!$repo) {
         return $bertiRenderer($name, $context);
@@ -79,14 +81,7 @@ function ($component) use ($repo) {
         return $bertiRenderer($name, $context);
     }
 
-    $process = new Process('git describe --tags', $path);
-    $process->run();
-
-    // Might return HEAD if not in a tag checkout
-    $version = trim($process->getOutput());
-
     $context['component'] = $component;
-    $context['component_version'] = $version;
 
     $name = 'component.html.twig';
 

src/data.php

@@ -3,21 +3,59 @@
 namespace React\Website\Data;
 
 use Github\Client;
+use Github\ResultPager;
+use Psr\Cache\CacheItemPoolInterface;
 
-function components(Client $client): array
+function components(Client $client, CacheItemPoolInterface $markdownCache): array
 {
-    return array_map(function ($component) use ($client) {
+    return array_map(function ($component) use ($client, $markdownCache) {
         [$username, $repository] = explode('/', $component['repository']);
 
-        $component['versions'] = array_map(
-            function ($tag) {
-                return $tag['name'];
+        $component['contributors'] = $client->repo()->contributors($username, $repository);
+        $component['participation'] = $client->repo()->participation($username, $repository);
+
+        $releases = (new ResultPager($client))
+            ->fetchAll(
+                $client->repo()->releases(),
+                'all',
+                [$username, $repository, ['per_page' => 100]]
+            );
+
+        $releases = array_map(
+            function (array $release) use ($client, $markdownCache, $component) {
+                $cacheKey = 'gfm' . md5($component['repository'] . $release['body']);
+
+                $cacheItem = $markdownCache->getItem($cacheKey);
+
+                if ($cacheItem->isHit()) {
+                    $html = $cacheItem->get();
+                } else {
+                    $html = $client->markdown()->render(
+                        $release['body'],
+                        'gfm',
+                        $component['repository']
+                    );
+
+                    $cacheItem->set($html);
+                    $markdownCache->save($cacheItem);
+                }
+
+                return [
+                    'version' => ltrim($release['tag_name'], 'v'),
+                    'tag' => $release['tag_name'],
+                    'date' => new \DateTimeImmutable($release['created_at']),
+                    'html' => $html,
+                    'url' => $release['html_url'],
+                ];
             },
-            $client->repo()->tags($username, $repository)
+            $releases
         );
 
-        $component['contributors'] = $client->repo()->contributors($username, $repository);
-        $component['participation'] = $client->repo()->participation($username, $repository);
+        usort($releases, function ($a, $b) {
+            return \version_compare($b['version'], $a['version']);
+        });
+
+        $component['releases'] = array_values($releases);
 
         return array_merge(
             $client->repo()->show($username, $repository),
@@ -41,6 +79,43 @@ function components_by_category(array $components): array
     return $byCategory;
 }
 
+function releases(array $components): array
+{
+    $releases = [];
+
+    foreach ($components as $component) {
+        foreach ($component['releases'] as $release) {
+            $time = (int) $release['date']->format('U');
+
+            $releases[(PHP_INT_MAX - $time) . '-' . $component['repository']] = [
+                'component' => $component['title'],
+                'repository' => $component['repository'],
+            ] + $release;
+        }
+    }
+
+    ksort($releases, SORT_NATURAL);
+
+    return array_values($releases);
+}
+
+function releases_by_year(array $releases): array
+{
+    $byYear = [];
+
+    foreach ($releases as $release) {
+        $year = (int) $release['date']->format('Y');
+
+        if (!isset($byYear[$year])) {
+            $byYear[$year] = [];
+        }
+
+        $byYear[$year][] = $release;
+    }
+
+    return $byYear;
+}
+
 function built_with(Client $client): array
 {
     return array_map(function ($component) use ($client) {

static-files/assets/0.0da4d5f750914aa5280f.js renamed to static-files/assets/0.6a34aef149239e7a6f57.js

@@ -1,12 +1,12 @@
 {
-  "0.0da4d5f750914aa5280f.js": "0.0da4d5f750914aa5280f.js",
+  "0.6a34aef149239e7a6f57.js": "0.6a34aef149239e7a6f57.js",
   "icons.svg?hszqu": "f963ff7998d9564c268d2d32f08aeffc.svg",
   "icons.ttf?hszqu": "a7d4d592f015c765bef62de7c96023be.ttf",
   "icons.woff?hszqu": "b2f931638bc837a31b6e7f19c542a289.woff",
   "main-critical.css": "main-critical.b3ce38ea4d05827d3ea9.css",
   "main-critical.js": "main-critical.b3ce38ea4d05827d3ea9.js",
-  "main.css": "main.2c3050a7d983f67a1210.css",
-  "main.js": "main.2c3050a7d983f67a1210.js",
+  "main.css": "main.c26014c6022c74ac7c57.css",
+  "main.js": "main.c26014c6022c74ac7c57.js",
   "search.svg": "72dc47391c5751aa9e94d8d46846e31c.svg",
   "sourcesanspro-bold.woff": "be4ba3dd17008135675e945b630be8f6.woff",
   "sourcesanspro-regular.woff": "19ca4d35c8f94db0fa14422334dd2ad3.woff"