BRASS

DESCRIPTION

BRASS is a standard assertions framework, framework's framework, or even a framework's framework's framework, depending on where you're staking out your assertions keister.

In other words, BRASS provides a standard rudimentary assertions framework that all other assertion and/or test framework can use, or at least comply with, and then everyone gets on swell.

Now, you may be thinking, "No thanks, I do it my way." But when you see how stupid simple BRASS is, you'll realize that, "Yea, that actually make sense." And feel a bit like a ass yourself for jumping to quick judgment.

Now, enough fluffery.

BRASS defines two Kernel methods: assert and refute

assert(truthiness, *fail_arguments)
refute(truthiness, *fail_arguments)

Where truthiness is any object evaluated for it's truth value (false and nil are false, everything else is true), and fail_arguments are exactly the same as those we would pass to the fail or raise methods.

The assert and refute methods do three things. First they test the truthiness, then they tick up the counts in the global assertions counter, and if truthiness fails, they raise an error. This error is either StandardError or the one specified by the fail_arguments.

The global assertions counter is $ASSERTION_COUNTS. If is simply a Hash formally defined as:

$ASSERTIONS_COUNTS = Hash.new{|h,k| h[k] = 0}

And though it is open to any key, they should be symbols and three in particular and standard :pass, :fail and :total. Whenever an assertion passes, the :total and :pass counts are incremented, and whenever an assertion fails the :total and :fail counts are incremented. You might wonder why there is a total entry when the sum of the other two would do just as well. Well, other frameworks might want to add some other counts, e.g. a :skip count, and to ensure we still get the proper total despite this, we keep a separate tally. Moving on....

Okay, last thing. When assert or refute raises an error, it marks the error as an assertion via the Exception#set_assertion method. This is a method extension to the Exception class along with the Exception#assertion? method which any test framework can use to distinguish an assertion error from an ordinarily error.

That's all, bro. Consider your brass ass informed.

COPYING

Distribute in accordance with the BSD-2-Clause license.

See COPYING.md file for details.