preview implementation of the Laminas ecosystem RFC

.platform.app.yaml

@@ -49,6 +49,7 @@ hooks:
     echo "- Installing application dependencies"
     composer install --no-ansi --no-dev --no-interaction --no-scripts --no-plugins --optimize-autoloader
     mkdir -p var/blog/feeds
+    mkdir -p var/ecosystem
     composer build
   deploy: |
     rm -f data/cache/config-cache.php
@@ -79,7 +80,15 @@ crons:
            ./vendor/bin/laminas repository:generate-data "$PLATFORM_VARIABLES" | base64 --decode | jq '."REPO_TOKEN"'
         fi
     shutdown_timeout: 20
-
+  generateecosystem:
+    # Refresh repository data every 6 hours (UTC).
+    spec: '* */4 * * *'
+    commands:
+      start: |
+        if [ "$PLATFORM_BRANCH" = master ]; then
+            ./vendor/bin/laminas ecosystem:seed-db
+        fi
+    shutdown_timeout: 20
 web:
   locations:
     '/':

ADD_ECOSYSTEM_PACKAGE.md

@@ -0,0 +1,51 @@
+# Adding your entry to the Laminas Ecosystem
+
+You can add packages **available via composer** to the `data/ecosystem/ecosystem-packages.json` file by following the steps below:
+
+- Entries must use the [template](#new-entry-template) as a guide.
+- Submit a PR.
+
+> Use the following command to make sure your submission will be correctly built:
+
+```bash
+composer build
+```
+
+> The following command can be run individually for testing:
+
+```bash
+./vendor/bin/laminas ecosystem:create-db
+```
+
+*Used for creating the database.*
+
+```bash
+./vendor/bin/laminas ecosystem:seed-db
+```
+
+*Used for updating the package data every X hours.*
+
+## New entry template
+
+```json
+{
+  "packagistUrl": "",
+  "githubUrl": "",
+  "categories": [],
+  "homepage": ""
+}
+```
+
+### New entry fields description
+
+- `packagistUrl` **required**
+  **string** - the packagist URL of the entry, with no query parameters
+
+- `githubUrl`
+  **string** - optional link to be displayed on the package card
+
+- `categories`
+  **array of strings** - user defined keywords used for filtering results
+
+- `homepage`
+  **string** - optional URL to package homepage, will overwrite "homepage" field from Packagist Api data

README.md

@@ -86,3 +86,7 @@ Everyone is welcome to post a blog entry. Once submitted, it will be reviewed by
 If it's rejected, the reason for the rejection will be included, so you can update it and resubmit the post if applicable.
 
 The submission process is described in the [ADD_BLOG_ENTRY](ADD_BLOG_ENTRY.md) file.
+
+## Adding packages to the Laminas Ecosystem
+
+The [ADD ECOSYSTEM PACKAGE](ADD_ECOSYSTEM_PACKAGE.md) file describes the process of adding packages to the [Laminas Ecosystem](https://getlaminas.org/ecosystem)

bootstrap/gulpfile.mjs

@@ -59,7 +59,8 @@ function js() {
             'node_modules/@popperjs/core/dist/umd/popper.min.js',
             'node_modules/bootstrap/dist/js/bootstrap.min.js',
             'node_modules/anchor-js/anchor.min.js',
-            'js/base.js'
+            'js/base.js',
+            'js/_ecosystem.js'
         ]))
         .pipe(concat({path: 'laminas.js'}))
         .pipe(terser({mangle: false}).on('error', function (e) {

bootstrap/js/_ecosystem.js

@@ -0,0 +1,84 @@
+'use strict';
+
+$(document).ready(function () {
+    $('.package-button').click(function (e) {
+        e.preventDefault();
+
+        const url = new URL(window.location.href);
+        const params = new URLSearchParams(url.search);
+        const entry = $(this).data('value');
+
+        if ($(this).hasClass('tag')) {
+            if (! params.has("tags[]", entry)) {
+                params.append("tags[]", entry);
+                url.search = params.toString();
+
+                window.location.replace(url.toString());
+            }
+        }
+
+        if ($(this).hasClass('category')) {
+            if (! params.has("categories[]", entry)) {
+                params.append("categories[]", entry);
+                url.search = params.toString();
+
+                window.location.replace(url.toString());
+            }
+        }
+    });
+
+    $('.ecosystem-filter').click(function (e) {
+        e.preventDefault();
+
+        const url = new URL(window.location.href);
+        const params = new URLSearchParams(url.search);
+        const entry = $(this).data('value');
+
+        if ($(this).hasClass('tag')) {
+            if (params.has("tags[]", entry)) {
+                params.delete("tags[]", entry);
+                url.search = params.toString();
+
+                window.location.replace(url.toString());
+            }
+        }
+
+        if ($(this).hasClass('category')) {
+            if (params.has("categories[]", entry)) {
+                params.delete("categories[]", entry);
+                url.search = params.toString();
+
+                window.location.replace(url.toString());
+            }
+        }
+    });
+
+    [...$('#ecosystem-pagination a')].forEach(a => {
+        const url = new URL(a.href)
+        for (let [k,v] of new URLSearchParams(window.location.search).entries()) {
+            if (k === 'tags[]' || k === 'categories[]' || k === 'q') {
+                url.searchParams.set(k,v)
+            }
+        }
+        a.href = url.toString();
+    })
+
+    $('#ecosystem-search').keypress(function (e) {
+        const search = $(this).val();
+        if (e.which === 13) {
+            setSearchQuery(search);
+        }
+    });
+
+    $('#ecosystem-search-btn').click(function (e) {
+        const search = $('#ecosystem-search').val();
+        setSearchQuery(search);
+    });
+
+    function setSearchQuery(search) {
+        const url = new URL(window.location.href);
+
+        url.searchParams.set('q', search);
+        window.location.replace(url.toString());
+    }
+});

bootstrap/scss/_custom-styles.scss

@@ -374,3 +374,89 @@ article {
         }
     }
 }
+
+#ecosystem-section {
+    .tag {
+        --filter-button-color: #00131e;
+    }
+    .category {
+        --filter-button-color: #678799;
+    }
+    #ecosystem-pagination {
+        margin-top: 1em;
+    }
+}
+
+.ecosystem-container {
+    display: flex;
+    flex-direction: column;
+    gap: 1em;
+}
+
+.ecosystem-package {
+    display: flex;
+    gap: 1em;
+
+    border: 1px solid grey;
+    border-radius: 5px;
+
+    padding: 1em;
+
+    .package-name {
+        font-size: 1.5em;
+        font-weight: bold;
+    }
+
+    .ecosystem-package-details {
+        display: flex;
+        flex-direction: column;
+        flex: 3;
+    }
+    .ecosystem-package-statistics {
+        flex: 1;
+        border-left: 1px solid grey;
+        padding-left: 1em;
+    }
+    .statistics-item {
+        margin-bottom: .5em;
+    }
+}
+
+.package-categories-container, .package-tags-container {
+    display: flex;
+    flex-wrap: wrap;
+    gap: .5em;
+    margin-bottom: .5em;
+
+    .package-button {
+        border: 2px solid var(--filter-button-color);
+        border-radius: 5px;
+        padding: 0 .5em;
+        color: var(--filter-button-color);
+        font-weight: bold;
+        background-color: white;
+    }
+}
+
+#ecosystem-filter-container {
+    display: flex;
+    flex-direction: row;
+    gap: .5em;
+
+    .ecosystem-filter {
+        border-radius: 5px;
+        color: white;
+        background-color: var(--filter-button-color);
+        padding: 0 .5em;
+    }
+}
+
+#ecosystem-search-container {
+    display: flex;
+    margin: .5em 0;
+    max-width: 50%;
+
+    #ecosystem-search-btn {
+        color: #00131e
+    }
+}

composer.json

@@ -76,6 +76,7 @@
         "psr-4": {
             "App\\": "src/App/",
             "GetLaminas\\Blog\\": "src/Blog/",
+            "GetLaminas\\Ecosystem\\": "src/Ecosystem/",
             "GetLaminas\\ReleaseFeed\\": "src/ReleaseFeed/",
             "GetLaminas\\Security\\": "src/Security/"
         }
@@ -87,7 +88,8 @@
     "scripts": {
         "build": [
             "@build-blog",
-            "laminas security:build"
+            "laminas security:build",
+            "laminas ecosystem:create-db"
         ],
         "build-blog": [
             "laminas blog:seed-db",

config/autoload/global.php

@@ -9,4 +9,7 @@
     'blog'         => [
         'db' => 'sqlite:' . realpath(getcwd()) . '/var/blog/posts.db',
     ],
+    'packages'     => [
+        'db' => 'sqlite:' . realpath(getcwd()) . '/var/ecosystem/packages.db',
+    ],
 ];

config/config.php

@@ -36,6 +36,7 @@ class_exists(\Mezzio\Swoole\ConfigProvider::class)
 
     // Default App module config
     GetLaminas\Blog\ConfigProvider::class,
+    GetLaminas\Ecosystem\ConfigProvider::class,
     GetLaminas\ReleaseFeed\ConfigProvider::class,
     GetLaminas\Security\ConfigProvider::class,
     App\ConfigProvider::class,

config/routes.php

@@ -41,6 +41,9 @@
     // Blog routes
     (new GetLaminas\Blog\ConfigProvider())->registerRoutes($app, '/blog');
 
+    // Laminas ecosystem routes
+    (new GetLaminas\Ecosystem\ConfigProvider())->registerRoutes($app);
+
     // Security advisory routes
     (new GetLaminas\Security\ConfigProvider())->registerRoutes($app, '/security');
 

data/ecosystem/ecosystem-packages.json

@@ -0,0 +1,42 @@
+[
+  {
+    "packagistUrl": "https://packagist.org/packages/akrabat/ip-address-middleware",
+    "githubUrl":  "https://github.com/akrabat/ip-address-middleware",
+    "categories": ["ip", "address", "middleware"],
+    "homepage": ""
+  },
+  {
+    "packagistUrl": "https://packagist.org/packages/netglue/laminas-messenger",
+    "githubUrl":  "https://github.com/netglue/laminas-messenger",
+    "categories": ["laminas", "messenger"],
+    "homepage": ""
+  },
+  {
+    "packagistUrl": "https://packagist.org/packages/dotkernel/dot-errorhandler",
+    "githubUrl":  "https://github.com/dotkernel/dot-errorhandler",
+    "categories": ["error-handling"],
+    "homepage": "https://dotkernel.com"
+  },
+  {
+    "packagistUrl": "https://packagist.org/packages/roave/psr-container-doctrine",
+    "githubUrl":  "",
+    "categories": ["middleware", "doctrine"],
+    "homepage": ""
+  },
+  {
+    "packagistUrl": "https://packagist.org/packages/asgrim/mini-mezzio",
+    "githubUrl":  "https://github.com/asgrim/mini-mezzio",
+    "categories": ["mezzio"],
+    "homepage": ""
+  },
+  {
+    "packagistUrl": "https://packagist.org/packages/phly/phly-simple-page",
+    "categories": [],
+    "homepage": "https://github.com/phly/PhlySimplePage"
+  },
+  {
+    "packagistUrl": "https://packagist.org/packages/mezzio/mezzio-aurarouter",
+    "categories": [],
+    "homepage": ""
+  }
+]