Squiz/ArrayDeclaration: fixes false positive when handling short lists inside foreach

[rodrigoprimo]

Description

This PR fixes a false positive when handling a short list inside a foreach as reported in #527. I implemented the solution that @jrfnl described in this comment: #527 (comment).

I included a separate commit with some tests that I wrote to improve test coverage for this sniff while I was familiarizing myself with its code. This is not a full code coverage commit. There are still some uncovered lines in this sniff, and those lines might be unreachable, but I have not investigated this at this time. There are also potentially some more relevant tests that could be added for lines that are already covered. This is also not addressed in this commit.

cc @VladaHejda in case you are available to test this PR and confirm if it fixes the problem that you reported. Thanks.

Suggested changelog entry

Squiz.Arrays.ArrayDeclaration: fix false positive when handling short lists inside foreach

Related issues/external references

Fixes #527

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
  • This change is only breaking for integrators, not for external standards or end-users.
• Documentation improvement

PR checklist

• I have checked there is no other PR open for the same change.
• I have read the Contribution Guidelines.
• I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
• I have added tests to cover my changes.
• I have verified that the code complies with the projects coding standards.
• [Required for new sniffs] I have added XML documentation for the sniff.

[jrfnl]

Thanks for this PR @rodrigoprimo!

Looking good. I have only left a few small remarks inline.

I included a separate commit with some tests that I wrote to improve test coverage for this sniff while I was familiarizing myself with its code.

I appreciate the additional tests, but for the record: these should have been pulled in a separate PR as they have nothing to do with the issue you are addressing in this PR.

[rodrigoprimo]

Thanks for your review, @jrfnl. I believe I replied to all your comments, and this PR is ready for another check.

I appreciate the additional tests, but for the record: these should have been pulled in a separate PR as they have nothing to do with the issue you are addressing in this PR.

Noted. Please let me know if you prefer that I move the commit with the additional tests to a separate PR in this case.

[jrfnl]

Thanks for finishing this off @rodrigoprimo, all good now.