Merge remote-tracking branch 'yii/master' into enh-getValue

Author: yus-ham

.gitattributes

@@ -27,7 +27,6 @@
 /.gitattributes         export-ignore
 /.gitignore             export-ignore
 /.phpunit-watcher.yml   export-ignore
-/.scrutinizer.yml       export-ignore
 /.styleci.yml           export-ignore
 /infection.json.dist    export-ignore
 /phpunit.xml.dist       export-ignore

.scrutinizer.yml

@@ -3,9 +3,16 @@
 ## 4.0.0 under development
 
 - Chg #142: Redefine the callable parameter in `ArrayHelper::getValue()` to be a value matcher (yus-ham)
+- Enh #156: Improve psalm types in `ArrayHelper::getObjectVars()`, `ArrayableInterface`, `ArrayableTrait` and 
+  `ArrayAccessTrait` (@vjik)
+
+## 3.1.0 April 04, 2024
+
 - New #139: Add `ArrayHelper::parametrizedMerge()` method that allows to merge two or more arrays recursively with
   specified depth (@vjik)
-- Enh #140: Remove `null` from return type of `ArrayHelper::getObjectVars()` method (@Tigrov) 
+- New #149, #152: Add `ArrayrHelper::renameKey()` (@vjik, @Tigrov)
+- Enh #140: Remove `null` from return type of `ArrayHelper::getObjectVars()` method (@Tigrov)
+- Enh #152: Minor `ArrayableTrait` refactoring (@Tigrov)
 
 ## 3.0.0 January 12, 2023
 

CHANGELOG.md

@@ -1,19 +1,19 @@
-Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
+Copyright © 2008 by Yii Software (<https://www.yiiframework.com/>)
 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
-   notice, this list of conditions and the following disclaimer.
- * 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
-   contributors may be used to endorse or promote products derived
-   from this software without specific prior written permission.
+* 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
+  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
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

LICENSE.md

@@ -1,6 +1,6 @@
 <p align="center">
     <a href="https://github.com/yiisoft" target="_blank">
-        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px">
+        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
     </a>
     <h1 align="center">Yii Arrays</h1>
     <br>
@@ -9,8 +9,7 @@
 [![Latest Stable Version](https://poser.pugx.org/yiisoft/arrays/v/stable.png)](https://packagist.org/packages/yiisoft/arrays)
 [![Total Downloads](https://poser.pugx.org/yiisoft/arrays/downloads.png)](https://packagist.org/packages/yiisoft/arrays)
 [![Build status](https://github.com/yiisoft/arrays/workflows/build/badge.svg)](https://github.com/yiisoft/arrays/actions?query=workflow%3Abuild)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiisoft/arrays/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/arrays/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/arrays/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/arrays/?branch=master)
+[![Code Coverage](https://codecov.io/gh/yiisoft/arrays/graph/badge.svg?token=SMTMNF4KT9)](https://codecov.io/gh/yiisoft/arrays)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Farrays%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/arrays/master)
 [![static analysis](https://github.com/yiisoft/arrays/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/arrays/actions?query=workflow%3A%22static+analysis%22)
 [![type-coverage](https://shepherd.dev/github/yiisoft/arrays/coverage.svg)](https://shepherd.dev/github/yiisoft/arrays)
@@ -88,6 +87,7 @@ Overall the helper has the following method groups.
 - map
 - merge
 - parametrizedMerge
+- renameKey
 - toArray
 
 ### Other
@@ -109,7 +109,7 @@ Array sorter has one static method which usage is like the following:
 [\IteratorAggregate](https://www.php.net/manual/class.iteratoraggregate),
 [\ArrayAccess](https://www.php.net/manual/class.arrayaccess) and
 [\Countable](https://www.php.net/manualn/class.countable.php).
- 
+
 Note that `ArrayAccessTrait` requires the class using it contain a property named `data` which should be an array.
 The data will be exposed by ArrayAccessTrait to support accessing the class object like an array.
 
@@ -164,36 +164,17 @@ $car = new Car();
 $data = $car->toArray(['type', 'color']); // ['type' => 'Crossover', 'color' => 'Red']
 ```
 
-## Testing
-
-### Unit testing
-
-The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
-
-```shell
-./vendor/bin/phpunit
-```
-
-### Mutation testing
+## Documentation
 
-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:
+- [Internals](docs/internals.md)
 
-```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
-```
+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 Arrays is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.
+The Yii Arrays 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/).
 

README.md

@@ -10,12 +10,12 @@
     "homepage": "https://www.yiiframework.com/",
     "license": "BSD-3-Clause",
     "support": {
-        "issues": "https://github.com/yiisoft/arrays/issues",
+        "issues": "https://github.com/yiisoft/arrays/issues?state=open",
+        "source": "https://github.com/yiisoft/arrays",
         "forum": "https://forum.yiiframework.com/",
         "wiki": "https://www.yiiframework.com/wiki/",
-        "irc": "irc://irc.freenode.net/yii",
-        "chat": "https://t.me/yii3en",
-        "source": "https://github.com/yiisoft/arrays"
+        "irc": "ircs://irc.libera.chat:6697/yii",
+        "chat": "https://t.me/yii3en"
     },
     "funding": [
         {
@@ -34,10 +34,10 @@
     "require-dev": {
         "maglnet/composer-require-checker": "^4.4",
         "phpunit/phpunit": "^9.5",
-        "rector/rector": "^0.19.0",
+        "rector/rector": "^1.0.0",
         "roave/infection-static-analysis-plugin": "^1.25",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.30|^5.20"
+        "vimeo/psalm": "^4.30|^5.23"
     },
     "autoload": {
         "psr-4": {

composer.json

@@ -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
+```

docs/internals.md

@@ -9,8 +9,9 @@
 >
     <projectFiles>
         <directory name="src" />
+        <file name="tests/PsalmTraitHelper.php" />
         <ignoreFiles>
-            <directory name="vendor"/>
+            <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
     <issueHandlers>

psalm.xml

@@ -9,6 +9,7 @@
 >
     <projectFiles>
         <directory name="src" />
+        <file name="tests/PsalmTraitHelper.php" />
         <ignoreFiles>
             <directory name="vendor"/>
         </ignoreFiles>

psalm80.xml

@@ -6,6 +6,8 @@
 
 use ArrayIterator;
 
+use function count;
+
 /**
  * `ArrayAccessTrait` provides the implementation for {@see \IteratorAggregate}, {@see \ArrayAccess}
  * and {@see \Countable}.
@@ -14,6 +16,9 @@
  * The data will be exposed by `ArrayAccessTrait` to support accessing the class object like an array.
  *
  * @property array $data
+ *
+ * @psalm-template TKey as array-key
+ * @psalm-template TValue as mixed
  */
 trait ArrayAccessTrait
 {
@@ -44,6 +49,8 @@ public function count(): int
      * This method is required by the interface {@see \ArrayAccess}.
      *
      * @param mixed $offset The offset to check on.
+     *
+     * @psalm-param TKey $offset
      */
     public function offsetExists(mixed $offset): bool
     {
@@ -56,6 +63,9 @@ public function offsetExists(mixed $offset): bool
      * @param mixed $offset The offset to retrieve element.
      *
      * @return mixed The element at the offset, null if no element is found at the offset.
+     *
+     * @psalm-param TKey $offset
+     * @psalm-return TValue
      */
     public function offsetGet(mixed $offset): mixed
     {
@@ -67,6 +77,9 @@ public function offsetGet(mixed $offset): mixed
      *
      * @param mixed $offset The offset to set element.
      * @param mixed $value The element value.
+     *
+     * @psalm-param TKey|null $offset
+     * @psalm-param TValue $value
      */
     public function offsetSet(mixed $offset, mixed $value): void
     {
@@ -81,6 +94,8 @@ public function offsetSet(mixed $offset, mixed $value): void
      * This method is required by the interface {@see \ArrayAccess}.
      *
      * @param mixed $offset The offset to unset element.
+     *
+     * @psalm-param TKey $offset
      */
     public function offsetUnset(mixed $offset): void
     {