README.rdoc in ae-1.6.1 vs README.rdoc in ae-1.7.0

- old
+ new

@@ -1,37 +1,34 @@ = Assertive Expressive -* home: http://rubyworks.github.com/ae/ -* code: http://github.com/rubyworks/ae/ - - == DESCRIPTION Assertive Expressive (AE) is an assertions framework intended for reuse by any TDD, BDD or similar system. -== FEATURES/ISSUES +== FEATURES * Clear, simple and concise syntax. * Uses higher-order functions and fluid notation. * Reusable core extensions ease assertion construction. * Core extensions are standardized around Ruby Facets. * But Facets is not a dependency; the extensions are built-in. * Easily extensible allowing for alternate notations. * Eats it's own dog food. -== RELEASE NOTES +== RESOURCES -Please see HISTORY file. +* home: http://rubyworks.github.com/ae/ +* code: http://github.com/rubyworks/ae/ == SYNOPSIS AE defines the method +assert+. It's is compatible with the method -as defined by Test::Unit and minitest, which verifies truth of a +as defined by Test::Unit and MiniTest, which verifies truth of a single argument (and can accept an optional failure message). assert(true) In addition AE's +assert+ method has been extended to accept a block, @@ -62,13 +59,38 @@ end end "Daffy Duck".assert.daffy? -Please have a look at the QEDocs and RDocs to learn more. +When an assertion fails an Assertion exception is raised. Any test +framework can catch this exception and process it accordingly. +Technically the framework should check to see that the exception +object responds affirmatively to the #assertion? method. This way any +type of exception can be used as a means of assertion, not just AE's +Assertion class. +Please have a look at the QED and API documentation to learn more. + +== INTEGRATION + +Generally speaking, AE can be used with any test framework simply by putting +<code>require 'ae'</code> in a test helper script. However to fully +integrate with a test framework and ensure the test framework recognizes +AE assertions (as more than just exceptions) and to ensure assertion +counts are correct, a little extra interfacing code may be necessary. + +Lucky for you AE has already done the leg work for the most common +test frameworks: + +* require 'ae/adapters/testunit' +* require 'ae/adapters/minitest' +* require 'ae/adapters/rspec' + +Note that Cucumber does not need an adapter. + + == HOW TO INSTALL === Gem Installs AE releases it's gems via Gemcutter. If you don't have Gemcutter @@ -97,11 +119,16 @@ Windows users use 'ruby setup.rb all'. == COPYRIGHTS & LICENSE +(Apache 2.0 License) + Copyright (c) 2008,2010 Thomas Sawyer Unless otherwise provided for by the originating author, this -program is distributed under the terms of the Apache 2 license. +program is distributed under the terms of the Apache 2.0 license. +See the Apache2.txt for details. -See LICENSE file for details. +Protions of this program may be copyrighted by others. See the +NOTICE.rdoc file for details. +