diff --git a/LICENSE.md b/LICENSE.md index bc5674f..6a920d6 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,17 +1,17 @@ -Copyright © 2008 by Yii Software (https://www.yiiframework.com/) +Copyright © 2008 by Yii Software () All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - * Neither the name of Yii Software nor the names of its +* Neither the name of Yii Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 1efd205..8444aa3 100644 --- a/README.md +++ b/README.md @@ -29,26 +29,17 @@ The package could be installed with composer: composer require yiisoft/yii-runner-roadrunner ``` -## Documentation - -- [English](docs/en/README.md) -- [Russian](docs/ru/README.md) - ## General usage Get RoadRunner: -``` +```shell ./vendor/bin/rr get ``` Create `worker.php` in your application root directory: ```php -withPsr7Worker($psr7Worker); ``` -## Testing - -### Unit testing - -The package is tested with [PHPUnit](https://phpunit.de/). To run tests: - -```shell -./vendor/bin/phpunit -``` - -### Mutation testing - -The package tests are checked with [Infection](https://infection.github.io/) mutation framework with -[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it: - -```shell -./vendor/bin/roave-infection-static-analysis-plugin -``` - -### Static analysis - -The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis: - -```shell -./vendor/bin/psalm -``` +## Documentation -## License +- [Guide](docs/guide/readme.md) +- [Internals](docs/internals.md) -The Yii RoadRunner Runner is free software. It is released under the terms of the BSD License. -Please see [`LICENSE`](./LICENSE.md) for more information. +## Support -Maintained by [Yii Software](https://www.yiiframework.com/). +If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. +You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). ## Support the project @@ -240,3 +207,10 @@ Maintained by [Yii Software](https://www.yiiframework.com/). [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en) [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk) [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack) + +## License + +The Yii RoadRunner Runner is free software. It is released under the terms of the BSD License. +Please see [`LICENSE`](./LICENSE.md) for more information. + +Maintained by [Yii Software](https://www.yiiframework.com/). diff --git a/composer.json b/composer.json index 6aa13e9..9e30775 100644 --- a/composer.json +++ b/composer.json @@ -12,7 +12,7 @@ "issues": "https://github.com/yiisoft/yii-runner-roadrunner/issues?state=open", "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", - "irc": "irc://irc.freenode.net/yii", + "irc": "ircs://irc.libera.chat:6697/yii", "chat": "https://t.me/yii3en", "source": "https://github.com/yiisoft/yii-runner-roadrunner" }, diff --git a/docs/en/grpc-application-runner.md b/docs/guide/en/grpc-application-runner.md similarity index 91% rename from docs/en/grpc-application-runner.md rename to docs/guide/en/grpc-application-runner.md index 42b9fb1..20f99c9 100644 --- a/docs/en/grpc-application-runner.md +++ b/docs/guide/en/grpc-application-runner.md @@ -10,15 +10,13 @@ For example, let's take the `Pinger` service described in the [documentation](ht ### DTO and service interface generation -A detailed description of how to do this can be read https://roadrunner.dev/docs/plugins-grpc +A detailed description of how to do this can be read ### Create worker for gRPC -Create a handler file in your application directory, for example - `GrpcWorker.php`: +Create a handler file in your application directory, for example `GrpcWorker.php`: ```php -declare(strict_types=1); - use Yiisoft\Yii\Runner\RoadRunner\RoadRunnerGrpcApplicationRunner; ini_set('display_errors', 'stderr'); diff --git a/docs/en/README.md b/docs/guide/en/readme.md similarity index 100% rename from docs/en/README.md rename to docs/guide/en/readme.md diff --git a/docs/guide/pt-BR/grpc-application-runner.md b/docs/guide/pt-BR/grpc-application-runner.md new file mode 100644 index 0000000..1e806d7 --- /dev/null +++ b/docs/guide/pt-BR/grpc-application-runner.md @@ -0,0 +1,57 @@ +# Executor de aplicativo gRPC para RoadRunner + +Yii RoadRunner Runner suporta a execução de serviços [gRPC](https://grpc.io) através de `RoadRunnerGrpcApplicationRunner`. + +> Aviso! Para suporte ao PHP 8.2 use a extensão `grpc` >= 1.56.0 + +## Uso geral + +Por exemplo, vamos pegar o serviço `Pinger` descrito na [documentação](https://roadrunner.dev/docs/plugins-grpc) + +### DTO e geração de interface de serviço + +Uma descrição detalhada de como fazer isso pode ser lida em + +### Criar trabalhador para gRPC + +Crie um arquivo handler no diretório do seu aplicativo, por exemplo `GrpcWorker.php`: + +```php +use Yiisoft\Yii\Runner\RoadRunner\RoadRunnerGrpcApplicationRunner; + +ini_set('display_errors', 'stderr'); + +require_once dirname(__DIR__) . '/vendor/autoload.php'; + +$application = new RoadRunnerGrpcApplicationRunner( + rootPath: __DIR__, + debug: true +); +$application->setServices([ + PingerInterface::class => Pinger::class, + ]) +$application->run(); +``` + +### Configurar RoadRunner + +Adicione o arquivo handler criado na seção `command` do arquivo de configuração `.rr.yaml` + +```yaml +version: '3' + +server: + command: "php GrpcWorker.php" +``` + +ou para a seção `command` do plugin `grpc` se você suporta múltiplos handlers (por exemplo, `http` e `grpc`) + +```yaml +version: '3' + +grpc: + pool: + command: "php GrpcWorker.php" +``` + +> Aviso! Se você também estiver implementando o lado do cliente (para chamar a API RoadRunner do aplicativo PHP), você precisará adicionar manualmente o pacote `grpc/grpc` da versão correta ao seu composer.json. diff --git a/docs/guide/pt-BR/readme.md b/docs/guide/pt-BR/readme.md new file mode 100644 index 0000000..29d88cf --- /dev/null +++ b/docs/guide/pt-BR/readme.md @@ -0,0 +1,3 @@ +# Documentação do Yii RoadRunner Runner + +- [Executor de aplicativo gRPC para RoadRunner](grpc-application-runner.md) diff --git a/docs/guide/readme.md b/docs/guide/readme.md new file mode 100644 index 0000000..06cdbf8 --- /dev/null +++ b/docs/guide/readme.md @@ -0,0 +1,6 @@ +# Yii RoadRunner Runner + +- [English](en/readme.md) +- [Português - Brasil](pt-BR/readme.md) +- [Русский](ru/readme.md) +- [Internals](../internals.md) diff --git a/docs/ru/grpc-application-runner.md b/docs/guide/ru/grpc-application-runner.md similarity index 100% rename from docs/ru/grpc-application-runner.md rename to docs/guide/ru/grpc-application-runner.md diff --git a/docs/ru/README.md b/docs/guide/ru/readme.md similarity index 100% rename from docs/ru/README.md rename to docs/guide/ru/readme.md diff --git a/docs/internals.md b/docs/internals.md new file mode 100644 index 0000000..8dc4049 --- /dev/null +++ b/docs/internals.md @@ -0,0 +1,45 @@ +# Internals + +## Unit testing + +The package is tested with [PHPUnit](https://phpunit.de/). To run tests: + +```shell +./vendor/bin/phpunit +``` + +## Mutation testing + +The package tests are checked with [Infection](https://infection.github.io/) mutation framework with +[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it: + +```shell +./vendor/bin/roave-infection-static-analysis-plugin +``` + +## Static analysis + +The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis: + +```shell +./vendor/bin/psalm +``` + +## Rector + +Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or +use either newest or any specific version of PHP: + +```shell +./vendor/bin/rector +``` + +## Composer require checker + +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. + +To run the checker, execute the following command: + +```shell +./vendor/bin/composer-require-checker +```