When I hear the word “assertion”, the first thing that comes to my mind is PHPUnit assertions. Sure, I write assertions in my unit tests. But is that the only application? Today I decided to figure it out, or, at least, learn more about the subject.
Assertions should be used as a debugging feature only. You may use them for sanity-checks that test for conditions that should always be
TRUEand that indicate some programming errors if not or to check for the presence of certain features like extension functions or certain system limits and features.
Assertions should not be used for normal runtime operations like input parameter checks. As a rule of thumb your code should always be able to work correctly if assertion checking is not activated.
This StackOverflow discussion expands a bit on the subject and concludes that assertions are just a developer tool used for troubleshooting and such. Bummer!
But I’m not that easily stopped. Next stop – search for tools and libraries on GitHub and Packagist. There’s more luck here! A whole lot of different libraries exist that help with asserting facts and matching values to patterns. I’ve checked a few of them and here’s the Top 3 List that I’m considering for use in my code:
- beberlei/assert – simple to use library, with a respectable number of implemented assertions. It supports chained methods, lazy assertions, and is easy to extend. (See this blog post, announcing version 2 a few years back.) Also, the fact that almost 300 projects depend on it, makes it an attractive choice.
- nilportugues/php-assert – also an easy to use library, which offers even more assertions, grouped into a number of categories (generic, string, integer, float, array, date and time, object, and file upload). It’s not anywhere near as popular as the previous option, but that is probably just a question of time.
- peridot-php/leo – a much more advanced assertion and matching library than the previous two options. In fact, so much more advanced, that it has a dedicated documentation website. This is understandable, as this library is a part of the Peridot BDD testing framework. It is easy to extend too, but I’m not sure yet that I need that level of complexity in my projects.
I found a few more alternatives, but they looked like side projects or small toolboxes for specific needs. None of those impressed me enough to be linked here.
It’s too late at night to make a decision right now on which project I like the most. But I will definitely play more with the ones above. If you have any experience with those or with any other assertion/matching library, I’m interested to hear.