Generic.WhiteSpace.ScopeIndent false positive with nested match-es

[andrey-yantsen]

Describe the bug

The ScopeIndent sniff suggests a quite strange indentation when processing multi-nested match-statements

// It's a copy of my bug report from the old repo (squizlabs/PHP_CodeSniffer#3875)
// Thank you, Juliette, for an amazing initiative in keeping the project going!

Code sample

<?php

echo match (1) {
    0 => match (2) {
        2 => match (3) {
            3 => 3,
            default => -1,
        },
    },
    1 => match (2) {
        1 => match (3) {
            3 => 3,
            default => -1,
        },
        2 => match (3) {
            3 => 3,
            default => -1,
        },
    },
};

How that code will look if formatted as suggested

<?php

echo match (1) {
    0 => match (2) {
        2 => match (3) {
            3 => 3,
            default => -1,
        },
    },
    1 => match (2) {
        1 => match (3) {
            3 => 3,
            default => -1,
        },
            2 => match (3) {
                3 => 3,
                default => -1,
            },
    },
};

Custom ruleset

N/A — reproducible with PSR12

To reproduce

Steps to reproduce the behavior:

1. Create a file called test.php with the code sample above
2. Run phpcs -s --standard=psr12 test.php
3. See errors displayed

------------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
------------------------------------------------------------------------------------------------------------------------------
 15 | ERROR | [x] Line indented incorrectly; expected at least 12 spaces, found 8
    |       |     (Generic.WhiteSpace.ScopeIndent.Incorrect)
 16 | ERROR | [x] Line indented incorrectly; expected at least 16 spaces, found 12
    |       |     (Generic.WhiteSpace.ScopeIndent.Incorrect)
 17 | ERROR | [x] Line indented incorrectly; expected at least 16 spaces, found 12
    |       |     (Generic.WhiteSpace.ScopeIndent.Incorrect)
 18 | ERROR | [x] Line indented incorrectly; expected 12 spaces, found 8 (Generic.WhiteSpace.ScopeIndent.IncorrectExact)
------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------

Expected behavior

No indentation errors.

Versions (please complete the following information)

Operating System	macOS 12.5
PHP version	8.0
PHP_CodeSniffer version	3.9.0
Standard	PSR2
Install type	Local composer

Additional context

none

Please confirm:

• I have searched the issue list and am not opening a duplicate issue.
• I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.
• I have verified the issue still exists in the master branch of PHP_CodeSniffer.

[andrey-yantsen]

The issues is still present in v3.9.0.

[jrfnl]

@andrey-yantsen You are welcome to submit a patch...

[andrey-yantsen]

@jrfnl I'm in no way rushing it, and I want to do a patch at some later date. Sorry if it sounded like an attack, that wasn't my intention :)

I just saw that there were some changes around the processing of match-es in the last releases, and I wanted to save some time on retesting to anybody stumbling upon this ticket. I probably should've just updated the PHP_CodeSniffer version in the initial message 😅 I'll do better next time.

[jrfnl]

Pff.. this was complex one. PR #502 should fix it though. Testing appreciated.

[andrey-yantsen]

Thank you, @jrfnl!

I just checked the master branch — the issue is gone for all the examples I had at hand.

[jrfnl]

Thanks @andrey-yantsen for testing and confirming!

[mdeboer]

@andrey-yantsen @jrfnl Can we re-open this? I can confirm that this ticket solved a lot of issues but I found another scenario where this isn't fixed yet.

In case where a method has attributes, formatted like this, the false positive would still occur. Note that this only occurs when a method has attributes and only when exactly formatted like this. Attributes on the class have no effect.

<?php

class Foo
{
    #[
        AttributeA(),
        AttributeB()
    ]
    public function foo(): int
    {
        $bar = 'bar';

        $result = match ($bar) {
            'foo' => true,
            'bar' => 300,
            'baz' => 'hello world',
            default => null
        };

        if ($result === null) {
            return 404;
        }

        return 200;
    }
}

Output

--- test.php
+++ PHP_CodeSniffer
@@ -17,10 +17,10 @@
             default => null
         };
 
-        if ($result === null) {
-            return 404;
-        }
+            if ($result === null) {
+                return 404;
+            }
 
-        return 200;
+            return 200;
     }
 }

When formatted like this either with one or multiple attributes, everything is ok and the output is empty.

<?php

class Foo
{
    #[AttributeA()]
    #[AttributeB()]
    public function foo(): int
    {
        $bar = 'bar';

        $result = match ($bar) {
            'foo' => true,
            'bar' => 300,
            'baz' => 'hello world',
            default => null
        };

        if ($result === null) {
            return 404;
        }

        return 200;
    }
}

[jrfnl]

@mdeboer Please open a new issue.