Merge pull request #71 from clue-labs/legacy-clients

Redirect legacy HttpClient and SocketClient pages to HTTP and Socket

Author: WyriHaximus

config/berti.config.php

@@ -225,10 +225,12 @@
     });
 
     $container['document.finder'] = $container->protect(function ($path) {
+        // Legacy components redirect via static-files/ instead of rendering their docs
         return (new Symfony\Component\Finder\Finder())
             ->name('/\.md$/')
             ->name('LICENSE')
             ->files()
+            ->exclude(['http-client', 'socket-client'])
             ->in($path . '/tmp/components')
             ->in($path . '/pages');
     });

data/components.php

@@ -61,6 +61,7 @@
         'repository' => 'reactphp/promise-stream',
         'category' => 'Utility Components'
     ],
+    // Legacy components are only kept to list their releases in the changelog
     [
         'title' => 'HttpClient',
         'repository' => 'reactphp/http-client',

src/data.php

@@ -97,6 +97,10 @@ function components_by_category(array $components): array
     $byCategory = [];
 
     foreach ($components as $component) {
+        if ('Legacy Components' === $component['category']) {
+            continue;
+        }
+
         if (!isset($byCategory[$component['category']])) {
             $byCategory[$component['category']] = [];
         }

static-files/http-client/changelog.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>HttpClient: Changelog - ReactPHP</title>
+        <meta http-equiv="refresh" content="0; url=../changelog.html#http-100-2020-07-11">
+    </head>
+    <body>
+        <p>HttpClient has been migrated over to the HTTP component, see the <a href="../changelog.html#http-100-2020-07-11">combined changelog</a>.</p>
+    </body>
+</html>

static-files/http-client/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>HttpClient - ReactPHP</title>
+        <meta http-equiv="refresh" content="0; url=../http/#client-usage">
+    </head>
+    <body>
+        <p>HttpClient has been migrated over to the <a href="../http/#client-usage">HTTP component</a>.</p>
+    </body>
+</html>

static-files/http-client/license.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>HttpClient: License - ReactPHP</title>
+        <meta http-equiv="refresh" content="0; url=../http/license.html">
+    </head>
+    <body>
+        <p>HttpClient has been migrated over to the HTTP component, see its <a href="../http/license.html">license</a>.</p>
+    </body>
+</html>

static-files/socket-client/changelog.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>SocketClient: Changelog - ReactPHP</title>
+        <meta http-equiv="refresh" content="0; url=../changelog.html#socket-070-2017-04-10">
+    </head>
+    <body>
+        <p>SocketClient has been merged into the Socket component, see the <a href="../changelog.html#socket-070-2017-04-10">combined changelog</a>.</p>
+    </body>
+</html>

static-files/socket-client/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>SocketClient - ReactPHP</title>
+        <meta http-equiv="refresh" content="0; url=../socket/#client-usage">
+    </head>
+    <body>
+        <p>SocketClient has been merged into the <a href="../socket/#client-usage">Socket component</a>.</p>
+    </body>
+</html>

static-files/socket-client/license.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>SocketClient: License - ReactPHP</title>
+        <meta http-equiv="refresh" content="0; url=../socket/license.html">
+    </head>
+    <body>
+        <p>SocketClient has been merged into the Socket component, see its <a href="../socket/license.html">license</a>.</p>
+    </body>
+</html>