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.

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

Generic/NestingLevel: improve code coverage #764

Merged
merged 4 commits into from
Dec 10, 2024

Conversation

rodrigoprimo
Copy link
Contributor

Description

This PR improves code coverage for the Generic.Metrics.NestingLevel sniff and makes a tiny improvement to the sniff code. No user-facing changes were made.

Related issues/external references

Part of #146

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 jrfnl added this to the 3.11.2 milestone Dec 10, 2024
Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

LGTM Thanks @rodrigoprimo !

… set

Quoting @jrfnl: "Only checking for the scope_opener, when
accessing/using both the scope_opener and scope_closer indexes, is
probably fine in practical terms. However, the part of the code base
which sets these indexes is not sufficiently covered by tests, nor does
it document that those indexes will only be set if both can be set, so
there may be edge case exceptions" (PHPCSStandards#684 (comment)).

The sniff was already working fine before this change. Checking if
`scope_closer` is just an extra precaution to err on the side of caution.

This commit also updates the related code comment to better reflect what
the if condition does.
Doing this to be able to create tests with syntax errors on separate
files.
This commit improves the tests by adding more tokens that increase the
nesting level and are already considered by the sniff, but were not
being used in the tests.
@jrfnl jrfnl force-pushed the test-coverage-nesting-level branch from 8da5343 to 9811fc5 Compare December 10, 2024 20:42
@jrfnl jrfnl merged commit 5033272 into PHPCSStandards:master Dec 10, 2024
45 checks passed
@jrfnl jrfnl deleted the test-coverage-nesting-level branch December 10, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants