Merge pull request #19 from membrane-php/integrate-reader

Integrate reader
membrane-php · Sep 25, 2023 · d4066b7 · d4066b7
2 parents 04f6e42 + 86b1f87
commit d4066b7
Show file tree

Hide file tree

Showing 33 changed files with 605 additions and 3,096 deletions.
diff --git a/README.md b/README.md
@@ -5,40 +5,38 @@ To make sure it runs quickly we've used techniques inspired
 by [Nikita Popov](https://www.npopov.com/2014/02/18/Fast-request-routing-using-regular-expressions.html)
 and [Nicolas Grekas](https://nicolas-grekas.medium.com/making-symfonys-router-77-7x-faster-1-2-958e3754f0e1).
 
-# Requirements
+## Requirements
 
 - A valid [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification#readme).
 - An operationId on all [Operation Objects](https://spec.openapis.org/oas/v3.1.0#operation-object) so that each route is uniquely identifiable.
 
-# Rules
+## Rules
 
-## Naming Conventions
+### Naming Conventions
 
 - Forward slashes at the end of a server url will be ignored since [paths MUST begin with a forward slash.](https://spec.openapis.org/oas/v3.1.0#paths-object)
 - [Dynamic paths which are identical other than the variable names MUST NOT exist.](https://spec.openapis.org/oas/v3.1.0#paths-object)
 
-## Routing Priorities
+### Routing Priorities
 
 - [Static urls MUST be prioritized over dynamic urls](https://spec.openapis.org/oas/v3.1.0#paths-object).
 - Longer urls are prioritized over shorter urls.
 - Hosted servers will be prioritized over hostless servers.
 
-# Installation
+## Installation
 
 ```text
 composer require membrane/openapi-router
 ```
 
-# Quick Start
+## Quick Start
 
 To read routes dynamically, you can do the following:
 
 ```php
 <?php
 
-use Membrane\OpenAPIRouter\Reader\OpenAPIFileReader;
-use Membrane\OpenAPIRouter\Router\Collector\RouteCollector;
-use Membrane\OpenAPIRouter\Router\Router;
+use Membrane\OpenAPIRouter\Reader\OpenAPIFileReader;use Membrane\OpenAPIRouter\RouteCollector;use Membrane\OpenAPIRouter\Router;
 
 $openApi = (new OpenAPIFileReader())->readFromAbsoluteFilePath('/app/petstore.yaml');
 $routeCollection = (new RouteCollector())->collect($openApi);
@@ -49,19 +47,18 @@ $requestedOperationId = $router->route('http://petstore.swagger.io/v1/pets', 'ge
 echo $requestedOperationId; // listPets
 ```
 
-# Caching Routes
+## Caching Routes
 
 Run the following console command to cache the routes from your OpenAPI, to avoid reading your OpenAPI file everytime:
 
 ```text
 membrane:router:generate-routes <openapi-filepath> <destination-filepath>
 ```
 
-
 ```php
 <?php
 
-use Membrane\OpenAPIRouter\Router\Router;
+use Membrane\OpenAPIRouter\Router;
 
 $routeCollection = include '/app/cache/routes.php';
 

diff --git a/benchmark/CebeReaderNoResolveExternalOnly.php b/benchmark/CebeReaderNoResolveExternalOnly.php
@@ -6,8 +6,8 @@
 
 use cebe\openapi\Reader;
 use cebe\openapi\ReferenceContext;
-use Membrane\OpenAPIRouter\Router\Collector\RouteCollector;
-use Membrane\OpenAPIRouter\Router\Router;
+use Membrane\OpenAPIRouter\RouteCollector;
+use Membrane\OpenAPIRouter\Router;
 
 /**
  * @param string[] $requests

diff --git a/benchmark/CebeReaderResolveAll.php b/benchmark/CebeReaderResolveAll.php
@@ -5,8 +5,8 @@
 include_once __DIR__ . '/../vendor/autoload.php';
 
 use cebe\openapi\Reader;
-use Membrane\OpenAPIRouter\Router\Collector\RouteCollector;
-use Membrane\OpenAPIRouter\Router\Router;
+use Membrane\OpenAPIRouter\RouteCollector;
+use Membrane\OpenAPIRouter\Router;
 
 /**
  * @param string[] $requests

diff --git a/benchmark/WeirdAndWonderful.php b/benchmark/WeirdAndWonderful.php
@@ -5,8 +5,8 @@
 include_once __DIR__ . '/../vendor/autoload.php';
 
 use Membrane\OpenAPIRouter\Reader\OpenAPIFileReader;
-use Membrane\OpenAPIRouter\Router\Collector\RouteCollector;
-use Membrane\OpenAPIRouter\Router\Router;
+use Membrane\OpenAPIRouter\RouteCollector;
+use Membrane\OpenAPIRouter\Router;
 
 /**
  * @param string[] $requests

diff --git a/bin/membrane-router b/bin/membrane-router
@@ -3,7 +3,7 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-use Membrane\OpenAPIRouter\Console\Commands\CacheOpenAPIRoutes;
+use Membrane\OpenAPIRouter\Console\Command\CacheOpenAPIRoutes;
 use Symfony\Component\Console\Application;
 
 $application = new Application();

diff --git a/composer.json b/composer.json
@@ -5,12 +5,14 @@
   "autoload": {
     "psr-4": {
       "Membrane\\OpenAPIRouter\\": "src/",
-      "Membrane\\OpenAPIRouter\\Fixtures\\": "tests/fixtures/"
+      "Membrane\\OpenAPIRouter\\Fixtures\\": "tests/fixtures/",
+      "Membrane\\OpenAPIRouter\\Tests\\": "tests/"
     }
   },
   "require": {
     "php": "^8.1.0",
     "cebe/php-openapi": "^1.7",
+    "membrane/openapi-reader": "^1.0.0",
     "psr/http-message": "^1.0 || ^2.0",
     "psr/log": "^3.0",
     "symfony/console": "^6.2"

diff --git a/src/Console/Commands/CacheOpenAPIRoutes.php → src/Console/Command/CacheOpenAPIRoutes.php b/src/Console/Commands/CacheOpenAPIRoutes.php → src/Console/Command/CacheOpenAPIRoutes.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Membrane\OpenAPIRouter\Console\Commands;
+namespace Membrane\OpenAPIRouter\Console\Command;
 
 use Membrane\OpenAPIRouter\Console\Service\CacheOpenAPIRoutes as CacheOpenAPIRoutesService;
 use Symfony\Component\Console\Attribute\AsCommand;

diff --git a/src/Console/Service/CacheOpenAPIRoutes.php b/src/Console/Service/CacheOpenAPIRoutes.php
@@ -4,12 +4,12 @@
 
 namespace Membrane\OpenAPIRouter\Console\Service;
 
-use Membrane\OpenAPIRouter\Exception\CannotProcessOpenAPI;
-use Membrane\OpenAPIRouter\Exception\CannotReadOpenAPI;
-use Membrane\OpenAPIRouter\Exception\CannotRouteOpenAPI;
-use Membrane\OpenAPIRouter\Reader\OpenAPIFileReader;
-use Membrane\OpenAPIRouter\Router\Collector\RouteCollector;
-use Membrane\OpenAPIRouter\Router\RouteCollection;
+use Membrane\OpenAPIReader\Exception\CannotRead;
+use Membrane\OpenAPIReader\OpenAPIVersion;
+use Membrane\OpenAPIReader\Reader;
+use Membrane\OpenAPIRouter\Exception\CannotCollectRoutes;
+use Membrane\OpenAPIRouter\RouteCollection;
+use Membrane\OpenAPIRouter\RouteCollector;
 use Psr\Log\LoggerInterface;
 
 class CacheOpenAPIRoutes
@@ -31,15 +31,16 @@ public function cache(string $openAPIFilePath, string $cacheDestination): bool
         }
 
         try {
-            $openApi = (new OpenAPIFileReader())->readFromAbsoluteFilePath($openAPIFilePath);
-        } catch (CannotReadOpenAPI $e) {
+            $openApi = (new Reader([OpenAPIVersion::Version_3_0, OpenAPIVersion::Version_3_1]))
+                ->readFromAbsoluteFilePath($openAPIFilePath);
+        } catch (CannotRead $e) {
             $this->logger->error($e->getMessage());
             return false;
         }
 
         try {
             $routeCollection = (new RouteCollector())->collect($openApi);
-        } catch (CannotRouteOpenAPI | CannotProcessOpenAPI $e) {
+        } catch (CannotCollectRoutes $e) {
             $this->logger->error($e->getMessage());
             return false;
         }

diff --git a/src/Exception/CannotRouteOpenAPI.php → src/Exception/CannotCollectRoutes.php b/src/Exception/CannotRouteOpenAPI.php → src/Exception/CannotCollectRoutes.php
@@ -6,7 +6,9 @@
 
 /* This exception occurs when a route collection cannot be created from your OpenAPI */
 
-class CannotRouteOpenAPI extends \RuntimeException
+use RuntimeException;
+
+class CannotCollectRoutes extends RuntimeException
 {
     public const NO_ROUTES = 0;
 

diff --git a/src/Exception/CannotProcessOpenAPI.php b/src/Exception/CannotProcessOpenAPI.php
diff --git a/src/Exception/CannotReadOpenAPI.php b/src/Exception/CannotReadOpenAPI.php
diff --git a/src/Reader/OpenAPIFileReader.php b/src/Reader/OpenAPIFileReader.php
diff --git a/src/Router/Route/Path.php → src/Route/Path.php b/src/Router/Route/Path.php → src/Route/Path.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Membrane\OpenAPIRouter\Router\Route;
+namespace Membrane\OpenAPIRouter\Route;
 
 use JsonSerializable;
 

diff --git a/src/Router/Route/Route.php → src/Route/Route.php b/src/Router/Route/Route.php → src/Route/Route.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Membrane\OpenAPIRouter\Router\Route;
+namespace Membrane\OpenAPIRouter\Route;
 
 class Route
 {