Skip to content

Generic/InterfaceNameSuffix: improve code coverage #650

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
Merged
merged 4 commits into from
Oct 30, 2024
Merged

Generic/InterfaceNameSuffix: improve code coverage #650

merged 4 commits into from
Oct 30, 2024

Conversation

rodrigoprimo
Copy link
Contributor

@rodrigoprimo rodrigoprimo commented Oct 29, 2024 •
edited
Loading

Description

This PR improves code coverage for the Generic.NamingConventions.InterfaceNameSuffix sniff and adds a new inline comment to the sniff to follow the same pattern used in the AbstractClassNamePrefix sniff.

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.

@rodrigoprimo
Generic/InterfaceNameSuffix: cleanup existing tests
9f6ceb7 
- Remove redundant tests.
- Remove unnecessary whitespaces.
- Use proper punctuation in a code comment.
- Make some tests more descriptive by making the class name reflect what
is being tested.
@rodrigoprimo
Generic/InterfaceNameSuffix: rename test case file
ceef93e 
Doing this to be able to create tests with syntax errors in additional,
separate test case files.
@rodrigoprimo
Generic/InterfaceNameSuffix: improve code coverage
e84d732 
- Add a separate test case file with a live coding/parse error test.
- Add a new test with comments and new lines in unexpected places and
parent interfaces.
@rodrigoprimo
Generic/InterfaceNameSuffix: add inline comment
2b7a230 
This commit just adds an inline comment documenting why the sniff bails
early if there is no interface name. Doing this to follow the same
pattern used by other similar sniffs like AbstractClassName
https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/8a7ee56347bb4017ffc778a42a532cbb1651a20b/src/Standards/Generic/Sniffs/NamingConventions/AbstractClassNamePrefixSniff.php#L48
@jrfnl jrfnl added this to the 3.11.0 milestone Oct 30, 2024
jrfnl
jrfnl approved these changes Oct 30, 2024
View reviewed changes
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.

Thanks @rodrigoprimo! LGTM.

@jrfnl jrfnl merged commit d02c686 into PHPCSStandards:master Oct 30, 2024
43 checks passed
@jrfnl jrfnl deleted the test-coverage-interface-name-suffix branch October 30, 2024 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrfnl jrfnl jrfnl approved these changes

Assignees
No one assigned
Labels
Standard: Generic Type: chores/QA
Projects
None yet
Milestone
3.11.0
Development

Successfully merging this pull request may close these issues.
2 participants
@rodrigoprimo @jrfnl