Parse form requests, add documentation

Author: Riley Aven

README.md

@@ -1,19 +1,18 @@
-# This is my package laravel-rules-to-schema
+# Laravel Rules to Schema
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/riley19280/laravel-rules-to-schema.svg?style=flat-square)](https://packagist.org/packages/riley19280/laravel-rules-to-schema)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/riley19280/laravel-rules-to-schema/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/riley19280/laravel-rules-to-schema/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/riley19280/laravel-rules-to-schema/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/riley19280/laravel-rules-to-schema/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/riley19280/laravel-rules-to-schema.svg?style=flat-square)](https://packagist.org/packages/riley19280/laravel-rules-to-schema)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+Create a json schema for your Laravel rules 
 
-## Support us
+## Prerequisites
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-rules-to-schema.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-rules-to-schema)
+It is recommended to use `FormRequest` classes in your application to use this package. 
+This allows for easy extraction of rule objects to pass them into this package.
 
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+You can still use this package just by passing in an array of rules, but that is a but more cumbersome.
 
 ## Installation
 
@@ -23,43 +22,72 @@ You can install the package via composer:
 composer require riley19280/laravel-rules-to-schema
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="laravel-rules-to-schema-migrations"
-php artisan migrate
-```
-
-You can publish the config file with:
+And publish the config file with:
 
 ```bash
 php artisan vendor:publish --tag="laravel-rules-to-schema-config"
 ```
 
-This is the contents of the published config file:
+## Usage
 
 ```php
-return [
-];
+use \Illuminate\Foundation\Http\FormRequest;
+
+$schema = LaravelRulesToSchema::parse(FormRequest|array $rules): FluentSchema
+
+$schema->compile(); // Returns an array representation of the json schema 
 ```
 
-Optionally, you can publish the views using
+## Customization
 
-```bash
-php artisan vendor:publish --tag="laravel-rules-to-schema-views"
+### JSON Schema Representation
+
+This package relies on [riley19280/fluent-json-schema](https://github.com/riley19280/fluent-json-schema) to build
+and represent JSON schemas. For details on how to use and configure the objects returned from the rule parser,
+please see the [documentation](https://github.com/riley19280/fluent-json-schema) for that package.
+
+
+### Registering schemas for custom rules
+
+JSON Schema definitions for custom rules can be registered in the config file by providing the rule name or class name.
+
+The type can be any of the simple JSON schema types (array, boolean, integer, null, number, object, string).
+If a more complex type is required, you can provide the class name that implements `LaravelRulesToSchema\Contracts\HasJsonSchema`
+
+```php
+// config/rules-to-schema.php
+
+'custom_rule_schemas' => [
+    // \CustomPackage\CustomRule::class => \Support\CustomRuleSchemaDefinition::class,
+    // \CustomPackage\CustomRule::class => 'string',
+    // \CustomPackage\CustomRule::class => ['null', 'string'],
+],
 ```
 
-## Usage
+### Extending the rule parser
+
+Should you want to further customize or tweak how rules are parsed, additional parsers can be added in the config file.
+Each parser is run for each rule in the order it is defined in the config file.
+Custom parsers must implement the `LaravelRulesToSchema\Contracts\RuleParser` interface.
 
 ```php
-$laravelRulesToSchema = new LaravelRulesToSchema();
-echo $laravelRulesToSchema->echoPhrase('Hello, LaravelRulesToSchema!');
+// config/rules-to-schema.php
+
+'parsers' => [
+    ...
+    \CustomPackage\CustomParser::class,
+],
 ```
 
-## Testing
+### Tools for package developers
 
-```bash
-composer test
+If your package contains a custom rule, you can provide the types as part of the package as well.
+
+In a service provider you can use the following methods to programmatically register a rule or parser:
+
+```php
+LaravelRulesToSchema::registerCustomRuleSchema(CustomRule::class, CustomRuleSchemaDefinition::class);
+LaravelRulesToSchema::registerParser(CustomParser::class);
 ```
 
 ## Changelog

composer.json

@@ -1,10 +1,13 @@
 {
     "name": "riley19280/laravel-rules-to-schema",
-    "description": "Parse Laravel validation rules into a Json Schema Object",
+    "description": "Parse Laravel validation rules into a Json Schema",
     "keywords": [
         "Riley Aven",
         "laravel",
-        "laravel-rules-to-schema"
+        "laravel-rules-to-schema",
+        "json schema",
+        "laravel rule",
+        "parse rule"
     ],
     "homepage": "https://github.com/riley19280/laravel-rules-to-schema",
     "license": "MIT",

config/rules-to-schema.php

@@ -13,7 +13,7 @@
 return [
 
     /*
-     * The key to store validation rules under
+     * The internal key to store validation rules under for parsers
      * This should be unique and not match any real property names
      * that will be submitted in requests.
      */

src/Facades/LaravelRulesToSchema.php

@@ -6,7 +6,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static FluentSchema parse(array $rules) Parse Rules
+ * @method static FluentSchema parse(string|array $rules) Parse Rules
  * @method static void registerParser(string $parser) Register a rule parser
  * @method static void registerCustomRuleSchema(string $rule, mixed $type) Register a schema for a custom rule
  *

src/LaravelRulesToSchema.php

@@ -3,6 +3,7 @@
 namespace LaravelRulesToSchema;
 
 use FluentJsonSchema\FluentSchema;
+use Illuminate\Foundation\Http\FormRequest;
 
 class LaravelRulesToSchema
 {
@@ -12,8 +13,17 @@ class LaravelRulesToSchema
 
     protected static array $additionalCustomSchemas = [];
 
-    public function parse(array $rules): FluentSchema
+    public function parse(string|array $rules): FluentSchema
     {
+        if (is_string($rules)) {
+            if (! class_exists($rules)) {
+                throw new \Exception("Class $rules does not implement ".FormRequest::class.' and can not be parsed.');
+            }
+            $instance = new $rules;
+
+            $rules = method_exists($instance, 'rules') ? app()->call([$instance, 'rules']) : [];
+        }
+
         $normalizedRules = (new ValidationRuleNormalizer($rules))->getRules();
 
         $schema = FluentSchema::make()

tests/.pest/snapshots/ParsingTest/parse_for_request_class.snap

@@ -0,0 +1,11 @@
+{
+    "type": "object",
+    "required": [
+        "field1"
+    ],
+    "properties": {
+        "field1": {
+            "type": "string"
+        }
+    }
+}

tests/Fixtures/CustomFormRequest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace LaravelRulesToSchema\Tests\Fixtures;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class CustomFormRequest extends FormRequest
+{
+    public function rules(): array
+    {
+        return [
+            'field1' => ['required', 'string'],
+        ];
+    }
+}

tests/ParsingTest.php

@@ -3,6 +3,7 @@
 use Illuminate\Validation\Rule;
 use Illuminate\Validation\Rules\Enum;
 use LaravelRulesToSchema\Facades\LaravelRulesToSchema;
+use LaravelRulesToSchema\Tests\Fixtures\CustomFormRequest;
 use LaravelRulesToSchema\Tests\Fixtures\TestEnum;
 use LaravelRulesToSchema\Tests\Fixtures\TestIntBackedEnum;
 use LaravelRulesToSchema\Tests\Fixtures\TestModel;
@@ -231,3 +232,8 @@
     expect(LaravelRulesToSchema::parse($rules)->compile())
         ->toMatchSnapshot();
 });
+
+test('parse for request class', function () {
+    expect(LaravelRulesToSchema::parse(CustomFormRequest::class)->compile())
+        ->toMatchSnapshot();
+});