From 5c4d5267f653ffb6204a9e5c09b5739b112d1732 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Mon, 15 Apr 2024 09:12:08 -0300 Subject: [PATCH 1/7] Docs folder standardization and other fixes --- README.md | 3 +-- docs/internals.md | 40 ++++++++++++++++++++++++++++++++++++++++ psalm.xml | 2 +- 3 files changed, 42 insertions(+), 3 deletions(-) create mode 100644 docs/internals.md diff --git a/README.md b/README.md index e68bf1b..d7f7122 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ [![static analysis](https://github.com/yiisoft/cache-wincache/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/cache-wincache/actions?query=workflow%3A%22static+analysis%22) [![type-coverage](https://shepherd.dev/github/yiisoft/cache-wincache/coverage.svg)](https://shepherd.dev/github/yiisoft/cache-wincache) - This package uses the PHP [Windows Cache](https://sourceforge.net/projects/wincache/) ([see also](https://www.php.net/manual/book.wincache.php)) extension and implements [PSR-16](https://www.php-fig.org/psr/psr-16/) cache. @@ -28,7 +27,7 @@ This package uses the PHP [Windows Cache](https://sourceforge.net/projects/winca The package could be installed with composer: -``` +```shell composer require yiisoft/cache-wincache --prefer-dist ``` diff --git a/docs/internals.md b/docs/internals.md new file mode 100644 index 0000000..6ef50da --- /dev/null +++ b/docs/internals.md @@ -0,0 +1,40 @@ +# 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 +``` + +## 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: + +```shell +./vendor/bin/rector +``` + +## Dependencies + +Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive +[Composer](https://getcomposer.org/) dependencies. diff --git a/psalm.xml b/psalm.xml index 8dc065a..9bdb9b5 100644 --- a/psalm.xml +++ b/psalm.xml @@ -2,7 +2,7 @@ From 98c37d7cf7c699f0b868b9dceb4ca0810615d886 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Mon, 15 Apr 2024 11:32:24 -0300 Subject: [PATCH 2/7] Update internals.md --- docs/internals.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/internals.md b/docs/internals.md index 6ef50da..9954ded 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -38,3 +38,9 @@ use either newest or any specific version of PHP: Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive [Composer](https://getcomposer.org/) dependencies. + +To run the checker, execute the following command: + +```shell +./vendor/bin/composer-require-checker +``` From 4247a0a20a8a4758440695271906fcb1ef2e1d6f Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Mon, 15 Apr 2024 11:55:25 -0300 Subject: [PATCH 3/7] Update internals.md --- docs/internals.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internals.md b/docs/internals.md index 9954ded..b715d9f 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ./vendor/bin/psalm ``` -## Code style +## 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: From a3883a977cd49d60ea24b3ec3fc5b5366e17ce85 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Wed, 17 Apr 2024 10:06:20 -0300 Subject: [PATCH 4/7] v --- composer.json | 2 +- psalm.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index acc9081..f8c3201 100644 --- a/composer.json +++ b/composer.json @@ -15,7 +15,7 @@ "issues": "https://github.com/yiisoft/cache-wincache/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/cache-wincache" }, diff --git a/psalm.xml b/psalm.xml index 9bdb9b5..8dc065a 100644 --- a/psalm.xml +++ b/psalm.xml @@ -2,7 +2,7 @@ From d03513fc1d814382a346d452c8896f00850de03e Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Thu, 18 Apr 2024 19:13:10 -0300 Subject: [PATCH 5/7] Docs folder standardization and other fixes --- LICENSE.md | 8 ++++---- README.md | 33 ++++++++------------------------- docs/internals.md | 11 ----------- 3 files changed, 12 insertions(+), 40 deletions(-) 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 d7f7122..fe04b10 100644 --- a/README.md +++ b/README.md @@ -71,37 +71,20 @@ To work with values in a more efficient manner, batch operations should be used: This package can be used as a cache handler for the [Yii Caching Library](https://github.com/yiisoft/cache). -## Testing +## Documentation -### Unit testing +- More information can be found in the [Internals.](docs/internals.md) -The package is tested with [PHPUnit](https://phpunit.de/). To run tests: +## Support -```shell -./vendor/bin/phpunit -``` - -### Mutation testing - -The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it: - -```shell -./vendor/bin/infection -``` - -### Static analysis - -The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis: - -```shell -./vendor/bin/psalm -``` +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 +## 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) -### Follow updates +## Follow updates [![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/) [![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework) @@ -111,7 +94,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ## License -The Yii Cache Library - WinCache Handler is free software. It is released under the terms of the BSD License. +The Yii Access 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/docs/internals.md b/docs/internals.md index b715d9f..3ca962d 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -33,14 +33,3 @@ use either newest or any specific version of PHP: ```shell ./vendor/bin/rector ``` - -## Dependencies - -Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive -[Composer](https://getcomposer.org/) dependencies. - -To run the checker, execute the following command: - -```shell -./vendor/bin/composer-require-checker -``` From 06b7900db24eebeb77ae35e03752be058cb64341 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Sat, 20 Apr 2024 07:48:14 -0300 Subject: [PATCH 6/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe04b10..3b6993b 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ You may also check out other [Yii Community Resources](https://www.yiiframework. ## License -The Yii Access is free software. It is released under the terms of the BSD License. +The Yii Cache Library - WinCache Handler 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/). From 39dd2411a4ec1fd749c255836d481d319ca91088 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Sun, 21 Apr 2024 06:23:07 -0300 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b6993b..5e099c5 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ This package can be used as a cache handler for the [Yii Caching Library](https: ## Documentation -- More information can be found in the [Internals.](docs/internals.md) +- [Internals](docs/internals.md) ## Support