Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Detect BC breaks due to parameter name changes, in line with PHP 8.0 named arguments requirements #266

Merged
merged 9 commits into from
Dec 6, 2021
Merged

Detect BC breaks due to parameter name changes, in line with PHP 8.0 named arguments requirements #266

merged 9 commits into from
Dec 6, 2021

Conversation

asgrim
Copy link
Member

@asgrim asgrim commented Aug 17, 2020

Fixes #264

@asgrim asgrim self-assigned this Aug 17, 2020
@Ocramius
Copy link
Member

Note: also needs to configure the new rule in bin/*.php

@asgrim asgrim mentioned this pull request Jan 18, 2021
Closed
asgrim and others added 9 commits December 6, 2021 05:16
@asgrim @Ocramius
Added test for parameter name changes becoming a BC break for PHP 8
f0b356c
@asgrim @Ocramius
Basic param renames are now a BC break
c8f3030
@asgrim @Ocramius
Improved BC check class doc
dd3e458
@asgrim @Ocramius
Added ParameterNameChanged check into bin/rbcc script
4b2c6ef
@asgrim @Ocramius
Support for @no-named-parameters annotation in docblock to suppress p…
c22793f 
…arameter name changes being marked as BC breaks
@Ocramius
Removed solved TODO: ParameterNameChanged applies regardless of PHP…
17adbea 
… version

Ref: https://github.com/Roave/BackwardCompatibilityCheck/pull/266/files#r472284330
@Ocramius
Upgraded ParameterNameChanged to comply with latest `roave/better-r…
02b986a 
…eflection:5.0.x` changes

This changes types and symbols that are dictated by interface and dependency changes.
@Ocramius
Ensuring that added/removed parameters are ignored by the `ParameterN…
4fa0de2 
…ameChanged` detector

Ref: https://github.com/Roave/BackwardCompatibilityCheck/pull/266/files#r497631718

This fixes following escaped mutation:

```
Escaped mutants:
================

1) /app/src/DetectChanges/BCBreak/FunctionBased/ParameterNameChanged.php:87    [M] UnwrapArrayIntersectKey

--- Original
+++ New
@@ @@
      */
     private function checkSymbols(array $from, array $to) : iterable
     {
-        foreach (array_intersect_key($from, $to) as $index => $commonParameter) {
+        foreach ($from as $index => $commonParameter) {
             yield from $this->compareParameter($commonParameter, $to[$index]);
         }
     }
```
@Ocramius
Removed redundant namespace declaration in test assets
e4a1527
@Ocramius Ocramius force-pushed the named-parameter-support branch from b91f240 to e4a1527 Compare December 6, 2021 04:48
@Ocramius Ocramius added this to the 6.0.0 milestone Dec 6, 2021
@Ocramius Ocramius added bc break and removed WIP labels Dec 6, 2021
@Ocramius Ocramius changed the title Named parameter support Detect BC breaks due to parameter name changes, in line with PHP 8.0 named arguments requirements Dec 6, 2021
Ocramius
Ocramius approved these changes Dec 6, 2021
View reviewed changes
Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asgrim I've adapted your patch to latest 6.0.x state, and it's good to go 🚢

@Ocramius Ocramius merged commit 7d37292 into 6.0.x Dec 6, 2021
@Ocramius Ocramius deleted the named-parameter-support branch December 6, 2021 04:54
@asgrim
Copy link
Member Author

asgrim commented Dec 6, 2021

Thanks @Ocramius !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ocramius Ocramius Ocramius approved these changes

Assignees

@asgrim asgrim

Labels
bc break enhancement
Projects
None yet
Milestone
6.0.0
Development

Successfully merging this pull request may close these issues.

PHP8: Named parameters support & opt-out attribute
2 participants
@asgrim @Ocramius