New PHPCSUtils\Exceptions\InvalidTokenArray Exception
#344
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This introduces the first PHPCSUtils native exception, which will extend the PHPCS native `PHP_CodeSniffer\Exceptions\RuntimeException`, to throw an informative exception when a non-existent token array is requested. Includes implementing use of the new Exception in the `BCTokens::__callStatic()` method. Includes a unit test for the Exception. Notes: * While this does constitute a change in behaviour for the `BCTokens` class, it should not be considered a breaking change as this handles a state which was invalid to begin with. * Also note, that while another "base Exception" to extend, may be semantically more correct, using the PHPCS native `RuntimeException` follows the principle of "least surprise" as that is normally the only exception sniffs will encounter and this new Exception can still be caught by referencing the PHPCS native `RuntimeException` class.
Member
Author
|
Coveralls is still drunk. Real code coverage is now 98.14 % with 100% of the code in this PR covered. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces the first PHPCSUtils native exception, which will extend the PHPCS native
PHP_CodeSniffer\Exceptions\RuntimeException, to throw an informative exception when a non-existent token array is requested.Includes implementing use of the new Exception in the
BCTokens::__callStatic()method.Includes a unit test for the Exception.
Notes:
BCTokensclass, it should not be considered a breaking change as this handles a state which was invalid to begin with.RuntimeExceptionfollows the principle of "least surprise" as that is normally the only exception sniffs will encounter and this new Exception can still be caught by referencing the PHPCS nativeRuntimeExceptionclass.