assert.cr provides a simple C++-style
assert! macro you can use anywhere in your crystal code. if
the expression passed to
assert! roughly evaluates to true
at runtime, then nothing will happen and your code will proceed on normally. If the
expression evaluates to false (e.g.
assert! 2 + 1 == 4 or
then an exception will be raised giving you a stack trace of the failed assertion as
well as a message repeating the expression that failed.
If you build your app/library with the
--release compile-time flag (which you should
always use for production builds), assertions will not be compiled so there will be
zero performance hit for using this library.
Add this to your application's
dependencies: assert: github: sam0x17/assert.cr
This is a simple assertion that will fail if it gets to execute since
5 - 5 = 0 and
# example.cr require "assert" assert! 5 - 5 puts "made it past the assertion"
Runtime result without --release flag:
$ crystal run src/example.cr Unhandled exception: assertion "5 - 5" failed (Exception) from src/assert.cr:0:1 in '__crystal_main' from /usr/share/crystal/src/crystal/main.cr:104:5 in 'main_user_code' from /usr/share/crystal/src/crystal/main.cr:93:7 in 'main' from /usr/share/crystal/src/crystal/main.cr:133:3 in 'main' from __libc_start_main from _start from ???
Runtime result with --release flag:
$ crystal run src/example.cr --release made it past the assertion