From f2e0dd9a1123dc5769d3e968b9422f965b9b4d03 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Thu, 16 May 2024 05:24:23 -0300 Subject: [PATCH] Update file (#346) Co-authored-by: Sergei Tigrov Co-authored-by: Sergei Predvoditelev --- LICENSE.md | 6 +++--- README.md | 54 +++++++++++++++++++---------------------------- composer.json | 16 +++++++++++--- docs/internals.md | 15 ++++++------- phpunit.xml.dist | 2 +- 5 files changed, 45 insertions(+), 48 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a920d605..c48bcea79 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -5,13 +5,13 @@ 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 79da3f426..ad6df92f6 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@

- + Yii - + PostgreSQL -

PostgreSQL driver for Yii Database

+

Yii Database PostgreSQL driver


+[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-pgsql/v/stable.png)](https://packagist.org/packages/yiisoft/db-pgsql) +[![Total Downloads](https://poser.pugx.org/yiisoft/db-pgsql/downloads.png)](https://packagist.org/packages/yiisoft/db-pgsql) +[![rector](https://github.com/yiisoft/db-pgsql/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-pgsql/actions/workflows/rector.yml) +[![codecov](https://codecov.io/gh/yiisoft/db-pgsql/branch/master/graph/badge.svg?token=3FGN91IVZA)](https://codecov.io/gh/yiisoft/db-pgsql) +[![StyleCI](https://github.styleci.io/repos/145220173/shield?branch=master)](https://github.styleci.io/repos/145220173?branch=master) + PostgreSQL driver for [Yii Database](https://github.com/yiisoft/db) is a [PostgreSQL] database adapter. The package provides a database connection interface and a set of classes for interacting with a [PostgreSQL] database. It allows you to perform common database operations such as executing queries, building and executing `INSERT`, `UPDATE`, @@ -17,21 +23,15 @@ as stored procedures and server-side cursors. [PostgreSQL]: https://www.postgresql.org/ -[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-pgsql/v/stable.png)](https://packagist.org/packages/yiisoft/db-pgsql) -[![Total Downloads](https://poser.pugx.org/yiisoft/db-pgsql/downloads.png)](https://packagist.org/packages/yiisoft/db-pgsql) -[![rector](https://github.com/yiisoft/db-pgsql/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-pgsql/actions/workflows/rector.yml) -[![codecov](https://codecov.io/gh/yiisoft/db-pgsql/branch/master/graph/badge.svg?token=3FGN91IVZA)](https://codecov.io/gh/yiisoft/db-pgsql) -[![StyleCI](https://github.styleci.io/repos/145220173/shield?branch=master)](https://github.styleci.io/repos/145220173?branch=master) - ## Support version -| PHP | Pgsql Version | CI-Actions -|:----:|:------------------------:|:---:| -|**8.0 - 8.2**| **9.0 - 15.0**|[![build](https://github.com/yiisoft/db-pgsql/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-pgsql/actions/workflows/build.yml) [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fdb-pgsql%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-pgsql/master) [![static analysis](https://github.com/yiisoft/db-pgsql/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-pgsql/actions/workflows/static.yml) [![type-coverage](https://shepherd.dev/github/yiisoft/db-pgsql/coverage.svg)](https://shepherd.dev/github/yiisoft/db-pgsql) +| PHP | PostgreSQL Version | CI-Actions +|---------------|---------------------|----------- +| **8.0 - 8.3** | **9.0 - 15.0** |[![build](https://github.com/yiisoft/db-pgsql/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-pgsql/actions/workflows/build.yml) [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fdb-pgsql%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-pgsql/master) [![static analysis](https://github.com/yiisoft/db-pgsql/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-pgsql/actions/workflows/static.yml) [![type-coverage](https://shepherd.dev/github/yiisoft/db-pgsql/coverage.svg)](https://shepherd.dev/github/yiisoft/db-pgsql) ## Installation -The package could be installed via composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell composer require yiisoft/db-pgsql @@ -39,25 +39,22 @@ composer require yiisoft/db-pgsql ## Documentation -English: - -- For config connection to PostgreSQL database check [Connecting PostgreSQL](https://github.com/yiisoft/db/blob/master/docs/en/connection/pgsql.md). -- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. - -Português - Brasil: +For config connection to PostgreSQL database check [Connecting PostgreSQL](https://github.com/yiisoft/db/blob/master/docs/guide/en/connection/pgsql.md). -- Para configurar a conexão com o PostgreSQL leia [Connecting PostgreSQL](https://github.com/yiisoft/db/blob/master/docs/pt-BR/connection/pgsql.md).s -- [Confira a documentação](https://github.com/yiisoft/db/blob/master/docs/pt-BR/README.md) para aprender como usar. - -Testing: +[Check the documentation](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md) to learn about usage. - [Internals](docs/internals.md) -## Support - 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). +## License + +The Yii Database PostgreSQL driver 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/). + ## Support the project [![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft) @@ -69,10 +66,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework. [![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 DataBase PostgreSQL Extension 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 01822ba1c..16a72d36e 100644 --- a/composer.json +++ b/composer.json @@ -13,13 +13,23 @@ "homepage": "https://www.yiiframework.com/", "license": "BSD-3-Clause", "support": { + "issues": "https://github.com/yiisoft/db-pgsql/issues?state=open", "source": "https://github.com/yiisoft/db-pgsql", - "issues": "https://github.com/yiisoft/db-pgsql/issues", "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", - "chat": "https://t.me/yii3en", - "irc": "ircs://irc.libera.chat:6697/yii" + "irc": "ircs://irc.libera.chat:6697/yii", + "chat": "https://t.me/yii3en" }, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/yiisoft" + }, + { + "type": "github", + "url": "https://github.com/sponsors/yiisoft" + } + ], "require": { "php": "^8.0", "ext-json": "*", diff --git a/docs/internals.md b/docs/internals.md index fb7a88ba2..d6d2876b7 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -10,7 +10,7 @@ All our packages have github actions by default, so you can test your [contribut For greater ease it is recommended to use docker containers. -You can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file with PostgreSQL 15 +You can use the [docker-compose.yml](../docker-compose.yml) file with PostgreSQL 15 that is in the root of the package: ```shell @@ -40,9 +40,7 @@ container. Use `docker run` command argument for it: ## Unit testing -The package is tested with [PHPUnit](https://phpunit.de/). - -The following steps are required to run the tests: +The package is tested with [PHPUnit](https://phpunit.de/). To run tests: 1. Run the docker container for the dbms. 2. Install the dependencies of the project with composer. @@ -69,7 +67,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ./vendor/bin/psalm ``` -## Rector +## Code style Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP: @@ -78,11 +76,10 @@ use either newest or any specific version of PHP: ./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`. +## Dependencies -To run the checker, execute the following command: +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 diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 4b99ba011..6dd47cbe7 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,5 +1,5 @@ - +