riot 0.12.1 → 0.12.2

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+pkg
+.*.swp
+doc
+.yardoc
+*.tmproj
+_site
+*.watchr
+.DS_Store
+

data/.yardopts

@@ -0,0 +1,6 @@
+-r README.markdown
+--protected
+--no-private
+-
+CHANGELOG
+MIT-LICENSE

data/CHANGELOG

@@ -1,22 +1,34 @@
-*0.12.1*
+== 0.12.2
 
-* Error reporting now filters the backtrace to include only meaningful line items. [mbriggs]
+==== RDoc'ed the hell out of everything [jaknowlden]
 
-* Added ability to pass method arguments to asserts. [sirupsen]
+==== Deprecating the not! assertion macro. It may just be gone by 0.13.0 [jaknowlden]
 
-*0.12.0*
+==== Remove ANSI-color dependency [achiu]
 
-* Negative tests are finally here! Added support for `denies` and adjusted macros to care about it with `devaluate`. [jaknowlden, achiu]
+==== Switch from Jeweler to Bundler [achiu]
+
+==== Add PrettyDotMatrixReporter [achiu]
+
+== 0.12.1
+
+==== Error reporting now filters the backtrace to include only meaningful line items. [mbriggs]
+
+==== Added ability to pass method arguments to asserts. [sirupsen]
+
+== 0.12.0
+
+==== Negative tests are finally here! Added support for `denies` and adjusted macros to care about it with `devaluate`. [jaknowlden, achiu]
 
     denies("my name") { "Rumplestiltzkin" }.equals("Henry")
 
-*0.11.4*
+== 0.11.4
 
-* Passing Proc's instead of lambdas to `instance_eval` to comply with ruby 1.9.2. [skade]
+==== [skade] Passing Proc's instead of lambdas to `instance_eval` to comply with ruby 1.9.2.
 
-* Added `describe` alias for `context` for easier rspec porting. Useful at the top level and within a context. [nu7hatch]
+==== [nu7hatch] Added `describe` alias for `context` for easier rspec porting. Useful at the top level and within a context.
 
-Who can argue with porting from rspec to riot? Not me. [jaknowlden]
+Who can argue with porting from rspec to riot? Not me.
 
     describe "My thing" do
       asserts(:size).equals(:small)
@@ -30,21 +42,21 @@ The following also works:
       end # my
     end # Another thing is
 
-*0.11.3*
+== 0.11.3
 
-* Modified `matches` assertion macro to treat actual as a string before executing regular expression comparison. [jaknowlden]
+==== [jaknowlden] Modified `matches` assertion macro to treat actual as a string before executing regular expression comparison.
 
     asserts("a number") { 42 }.matches(/\d+/)
     # same as
     asserts("a number as string") { "42" }.matches(/\d+/)
 
-*0.11.2*
+== 0.11.2
 
-* [ISSUE] Options were not nesting. Now fixed. [jaknowlden]
+==== [jaknowlden] [ISSUE] Options were not nesting. Now fixed.
 
-*0.11.1*
+== 0.11.1
 
-* Middleware can now acts more like you would expect. Middleware now know the next neighbor in the chain and can do stuff to the context before and after the user-defined context is prepared. Removes support for the handle? method. Now we act more like a Rack app. [jaknowlden]
+==== [jaknowlden] Middleware can now acts more like you would expect. Middleware now know the next neighbor in the chain and can do stuff to the context before and after the user-defined context is prepared. Removes support for the handle? method. Now we act more like a Rack app.
 
     class MyMiddleware < Riot::ContextMiddleware
       register
@@ -58,9 +70,9 @@ The following also works:
       end
     end
 
-*0.11.0*
+== 0.11.0
 
-* Added option to Context#setup which puts the specific setup block at the beginning of the setups to be called for a context. Also useful for middlewares. [jaknowlden]
+==== [jaknowlden] Added option to Context#setup which puts the specific setup block at the beginning of the setups to be called for a context. Also useful for middlewares.
 
     context "Foo" do
       setup { puts "called second" }
@@ -68,7 +80,7 @@ The following also works:
       setup(true) { puts "called first" }
     end # Foo
 
-* Added idea of options for a context. This is another feature picked up from riot-rails work. [jaknowlden]
+==== [jaknowlden] Added idea of options for a context. This is another feature picked up from riot-rails work.
 
 Essentially, these are useful for middlewares. For instance, if you wanted to tell a middleware that was looking for a "transactional" option before running code in a transaction block, you might do this:
 
@@ -95,9 +107,9 @@ You can call set as many times as you like
       set :foo, :bar
     end
 
-* ContextMiddleware: a construction pattern that allows for custom code to be applied to any context given that the middleware chooses to. This is something I started building into riot-rails and decided it was useful enough to just put it into riot itself. [jaknowlden]
+==== [jaknowlden] ContextMiddleware: a construction pattern that allows for custom code to be applied to any context given that the middleware chooses to.
 
-If, for instance, you wanted to add a setup with some stuff only if the context description was equal to "Your Mom":
+This is something I started building into riot-rails and decided it was useful enough to just put it into riot itself. If, for instance, you wanted to add a setup with some stuff only if the context description was equal to "Your Mom":
 
     class YourMomMiddleware < Riot::ContextMiddleware
       register
@@ -113,9 +125,9 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       end
     end # YourMomMiddleware
 
-*0.10.13*
+== 0.10.13
 
-* Helpers are now run with other setups, not separately. Which means you could use a helper in a setup. [jaknowlden]
+==== [jaknowlden] Helpers are now run with other setups, not separately. Which means you could use a helper in a setup.
 
     context "Foo" do
       helper(:user) { User.new }
@@ -124,7 +136,7 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       end
     end # Foo
 
-* Correctly report non-RR assertion failures and errors when RR is used [vandrijevik]
+==== [vandrijevik] Correctly report non-RR assertion failures and errors when RR is used.
 
     context "Foo.bar" do
       asserts("baz is called") do
@@ -136,7 +148,7 @@ If, for instance, you wanted to add a setup with some stuff only if the context
   would previously return [:fail, "baz() Called 0 times. Expected 1 times."], and will now
   correctly return [:error, #<RuntimeError: oh noes>]
 
-* Recording description as is. Providing #detailed_description for proper behavior [jaknowlden]
+==== [jaknowlden] Recording description as is. Providing #detailed_description for proper behavior
 
     foo_context = context(Foo) {}
     bar_context = foo_context.context(Bar) {}
@@ -145,7 +157,7 @@ If, for instance, you wanted to add a setup with some stuff only if the context
     bar_context.detailed_description
     => "Foo Bar"
 
-* No longer assuming topic when no block provided to an assertion. Instead, assuming block fails by default. Use `asserts_topic` only now. [jaknowlden]
+==== [jaknowlden] No longer assuming topic when no block provided to an assertion. Instead, assuming block fails by default. Use `asserts_topic` only now.
 
     context "foo" do
       setup { "bar" }
@@ -154,11 +166,11 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       asserts("topic").equals(false) # Will actually pass :)
     end
 
-*0.10.12*
+== 0.10.12
 
-* Recognizing file and line number of an assertion declaration on failure [vandrijevik]
+==== [vandrijevik] Recognizing file and line number of an assertion declaration on failure
 
-* RR support in Riot [vandrijevik,jaknowlden]
+==== [vandrijevik,jaknowlden] RR support in Riot
 
     # teststrap.rb
     require 'riot'
@@ -169,7 +181,7 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       asserts("failure due to not calling hello") { mock!.hello {"world"} } # actually fails
     end
 
-* Added Riot::Message to make messages in macros easier to write [jaknowlden]
+==== [jaknowlden] Added Riot::Message to make messages in macros easier to write
 
     def evaluate(actual, expected)
       # ...
@@ -177,28 +189,28 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       # ...
     end
 
-* Added responds_to as a respond_to alias [jaknowlden]
+==== [jaknowlden] Added responds_to as a respond_to alias
 
-* Added the equivalent_to macro to compare case equality (===). equals is now (==) [jaknowlden]
+==== [jaknowlden] Added the equivalent_to macro to compare case equality (===). equals is now (==)
 
-* Assuming RootContext if nil parent provided. Added Context#parent to the API [jaknowlden]
+==== [jaknowlden] Assuming RootContext if nil parent provided. Added Context#parent to the API
 
     Riot::Context.new("Hi", nil) {}.parent.class
     => Riot::RootContext
 
-*0.10.11*
+== 0.10.11
 
-* Context#asserts_topic now takes an optional description [gabrielg, jaknowlden]
+==== [gabrielg, jaknowlden] Context#asserts_topic now takes an optional description
 
     asserts_topic.exists
     asserts_topic("some kind of description").exists
 
-* Added not! assertion macro [gabrielg, jaknowlden]
+==== [gabrielg, jaknowlden] Added not! assertion macro
 
     setup { User.new(:funny? => false) }
     asserts(:funny?).not!
 
-* Added Context#hookup to add some setup code to an already defined topic [jaknowlden]
+==== [jaknowlden] Added Context#hookup to add some setup code to an already defined topic
 
     context "yo mama" do
       setup { YoMama.new }
@@ -209,31 +221,31 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       end
     end
 
-* Added Riot.alone! mode to ensure Riot.run is not run at-exit [jaknowlden]
+==== [jaknowlden] Added Riot.alone! mode to ensure Riot.run is not run at-exit
 
     Riot.alone!
     Riot.run
 
   This will still print output unless you also Riot.silently!
 
-* Returning non-zero status at-exit when tests don't pass [gabrielg, jaknowlden]
+==== [gabrielg, jaknowlden] Returning non-zero status at-exit when tests don't pass
 
-*0.10.10*
+== 0.10.10
 
-* Passing assertion macros can now return a custom message [dasch, jaknowlden]
+==== [dasch, jaknowlden] Passing assertion macros can now return a custom message
 
     def evaluate(actual, *expectings)
       1 == 1 ? pass("1 does equal 1") : fail("1 does not equal 1 in this universe")
     end
 
-* Removing Context#extend_assertions and related code [jaknowlden]
+==== [jaknowlden] Removing Context#extend_assertions and related code
 
-* Allow the use of symbolic descriptions as shorthands for sending the message to the topic [dasch]
+==== [dasch] Allow the use of symbolic descriptions as shorthands for sending the message to the topic
 
     setup { "foo" }
     asserts(:upcase).equals("FOO")
 
-* Added AssertionMacro and #register for macros [jaknowlden, splattael]
+==== [jaknowlden, splattael] Added AssertionMacro and #register for macros
 
     module My
       class CustomThingAssertion < Riot::AssertionMacro
@@ -248,7 +260,7 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       Riot::Assertion.register_macro :custom_thing, CustomThingAssertion
     end
 
-* Replace IOReporter#say with #puts. Also add #print. [splattael]
+==== [splattael] Replace IOReporter#say with #puts. Also add #print.
 
     class SomeNewReporter < IOReporter
       def pass
@@ -261,6 +273,6 @@ If, for instance, you wanted to add a setup with some stuff only if the context
       # ...
     end
 
-*0.10.9 and before*
+== 0.10.9 and before
 
-See [commit log](http://github.com/thumblemonks/riot/commits/master)
+See the commit log: http://github.com/thumblemonks/riot/commits/master

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/README.markdown

@@ -1,146 +1,383 @@
 # Riot
 
-A fast, expressive and concise unit-testing framework.
-
+A fast, expressive, and contextual ruby unit testing framework. Protest the slow test.
 
 ## Installation 
 
-Add Gemcutter to your gem sources:
-
-    !!!plain
-    sudo gem sources -a http://gemcutter.org
-
-Then, simply install the Riot gem like so:
-
-    !!!plain
-    sudo gem install riot
-
+    gem install riot
 
 ## Usage
 
-In contrast to other popular Ruby testing frameworks such as Test::Unit,
-[Shoulda](http://github.com/thoughtbot/shoulda) and [RSpec](http://rspec.info/),
-Riot does not run a `setup` and `teardown` sequence before and after each test. This speeds
-up the test runs quite a bit, but also puts restrictions on how you write your tests. In
-general, you should avoid mutating any objects under test.
+In contrast to other popular Ruby testing frameworks such as Test::Unit, [Shoulda](http://github.com/thoughtbot/shoulda) and [RSpec](http://rspec.info/), Riot does not run a `setup` and `teardown` sequence before and after each test. This speeds up test execution quite a bit, but also changes how you write your tests. In general and in my opinion, you should avoid mutating any objects under test and if you use Riot you're pretty much going to have to.
 
-In Riot, tests reside in *contexts*. Within these, a *topic* object is defined through a
-`setup` block. The actual assertions are then made with `assert`.
+In Riot, tests reside in `contexts`. Within these, a `topic` object is defined through a `setup` block. The actual assertions are then made with an `asserts` or `denies` block.
 
-    context "An Array" do
+    context "An empty Array" do
       setup { Array.new }
-      asserts("is empty") { topic.empty? }
-    end
+      asserts("it is empty") { topic.empty? }
+      denies("it has any elements") { topic.any? }
+    end # An Array
 
-As you can see, the setup block doesn't use any instance variables to save the object under
-test -- rather, the return value of the block is used as the *topic*. This object can then
-be accessed in the assertions using the `topic` attribute.
+As you can see, the setup block doesn't use any instance variables to save the object under test — rather, the return value of the block is used as the `topic`. This object can then be accessed in the assertions using the `topic` attribute. Furthermore, at their very basic level, assertions need only return a boolean. When using `asserts`, `true` indicates a pass while `false` indicates a fail; subsequently, when using `denies`, `true` indicates a failure whereas `false` indicates success.
 
-Furthermore, assertions need only return a boolean; `true` indicates a pass, while `false`
-indicates a fail.
-
-Contexts can also be nested; the `setup` blocks are executed outside-in before.
+Of course, you can nest contexts as well; the `setup` blocks are executed outside-in; as in, the parents' setups are run before the current context allowing for a setup hierarchy. `teardown` blocks are run inside out; the current context's teardowns are run before any of its parents'. This is what you would expect from other frameworks as well.
 
     context "An Array" do
       setup { Array.new }
 
+      asserts("is empty") { topic.empty? }
+
       context "with one element" do
         setup { topic << "foo" }
-        asserts("is not empty") { !topic.empty? }
+        asserts("array is not empty") { !topic.empty? }
         asserts("returns the element on #first") { topic.first == "foo" }
       end
-    end
+    end # An Array
 
+By the way, you can put any kind of ruby object in your context description. Riot will call `to_s` on the actual value before it is used in a reporting context. This fact will become [useful later](http://thumblemonks.github.com/riot/hacking.html#context-middleware) ;)
 
-### Using assertion macros
+### Assertions {#assertions}
 
-Macros greatly simplify a lot of assertions by capturing common practises, e.g. comparing
-some value using the `==` operator. They work by calling the macro method on the return
-value of `asserts`:
+Well, how useful would Riot be if you could only return true/false from an assertion? Pretty useful, actually; but, we can make it more useful! No; that's not crazy. No it isn't. Yes; I'm sure.
 
-    asserts("#first") { topic.first }.equals("foo")
+We can do this with assertion macros. You can think of these as special assertion modifiers that check the return value of the assertion block. Actually, it's not that you **can** think of them this way; you **should** think of them this way.
 
-Other macros are available; for a complete overview, see {Riot::AssertionMacro}.
+Let's take this little for instance:
 
-A common pattern is to make assertions on the return value of some attribute or method
-on the `topic` -- to simplify this, we have provided an easy to use shorthand. Simply
-give a Symbol as the first argument to `asserts` and leave out the block.
+    context "Yummy things" do
+      setup { ["cookies", "donuts"] }
 
-    asserts(:first).equals("foo")
+      asserts("#first") { topic.first }.equals("cookies")
+    end # Yummy things
 
+First, how's that for a readable test? Second, you should notice that the assertion block will return the `first` item from the `topic` (which is assumed to be `Enumerable` in this case); if it isn't `Enumerable`, then you have other problems. Since the first element in the array is "cookies", the assertion will pass. Yay!
 
-If you're like me, you like to write a bunch of failing tests for a context and then make
-them pass. This can easily be done by simply calling an `asserts` or `should` command with
-no block returning the actual value.
+But wait, there's more. Riot is about helping you write faster and more readable tests. Notice any duplication in the example above (besides the value "cookies")? I do. How about that `first` notation in the assertion name and reference in the assertion block. Riot provides a shortcut which allows you to reference methods on the topic through the assertion name. Here's another way to write the same test:
 
-    asserts("something special")
-    should("do something special")
+    context "Yummy things" do
+      setup { ["cookies", "donuts"] }
 
-Both of the above tests will fail. You can use this similar to a `should_eventually`. The
-difference is that `should_eventually` is not technically a failure and will therefore be
-ignored in time by (based on my experience). The above two blocks will actually show up as
-failures and should hopefully drive you to making them pass.
+      asserts(:first).equals("cookies")
+    end # Yummy things
 
-### Reading Riot's output
+Now that's real yummy. Want some more? Perhaps you just want to test the topic itself &mdash; not a method or attribute of it. You could do this:
 
-Riot can output the test results in several ways, the default being *story reporting*. With
-this reporter, the output looks like the following:
+    context "Yummy things" do
+      setup { ["cookies", "donuts"] }
 
-    !!!plain
-    An Array
-      + asserts is empty
-    An Array with one element
-      + asserts is not empty
-      + asserts returns the element on #first
-    
-    3 passes, 0 failures, 0 errors in 0.000181 seconds
+      asserts("topic") { topic }.size(2)
+    end # Yummy things
 
-The various shorthands and macros are built in a way that ensures expressive and specific
-feedback, e.g. the assertion
+But, as you can probably already guess, that's gross and redundant. To solve this, Riot provides the `asserts_topic` shortcut which is a helper that pretty much just does `asserts("topic") { topic }` for you.
 
-    asserts(:full_name).matches(/^\w+ \w+$/)
+    context "Yummy things" do
+      setup { ["cookies", "donuts"] }
 
-yields the output
+      asserts_topic.size(2)
+    end # Yummy things
 
-    !!!plain
-    + asserts #full_name matches /^\w+ \w+$/
+Yep, more readable.
+
+#### Negative Assertions {#negative-assertions}
+
+Way back in the first code example we saw a reference to `denies`; this is what is called the negative assertion. You could probably also call it a counter assertion, but I don't. You can use `denies` with any assertion macro that you can use `asserts` with; it's just that `denies` expects the assertion to fail for the test to pass. For instance:
+
+    context "My wallet" do
+      setup do
+        Wallet.new(1000) # That's 1000 cents, or $10USD yo
+      end
+
+      asserts(:enough_for_lunch?)
+      denies(:enough_for_lunch?)
+    end # My wallet
+
+One of those will pass and the other will fail. If $10 is not enough for lunch the `denies` statement will pass; and then you should move to Chicago where it is enough (if only barely).
+
+#### Built-in Assertion Macros {#builtin-macros}
+
+There are a bunch of built-in assertion macros for your everyday use. Be sure to [write your own](http://thumblemonks.github.com/riot/hacking.html#writing-assertion-macros) if these don't satisfy your every need. You will notice the two varying mechanisms for passing arguments into the macros: one is the conventional form of message passing (via actual arguments) and the other is derived from a provided block. If the macro expects one argument, you can use either form (but not both). If the macro accepts multiple arguments, the last argument you want to pass in can be provided via the block.
+
+The advantage of using the block is that its innards are evaluated against the same scope that the assertion was evaluated against. This means you can use the same helpers and instance variables in the macro block to generate an expected value (if you so desire). It's also useful if you have a fairly complex routine for generating the expected value.
+
+{#builtin-macro-list}
+* **Equals**: compares equality of the actual value to the expected value using the `==` operator 
+  * `asserts.equals(Object)`
+  * `denies.equals(Object)`
+  * `asserts.equals { Object }`
+  * `denies.equals { Object }`
+
+* **Equivalent To**: compares equivalence of actual value to the expected value using the `===` operator
+  * `asserts.equivalent_to(Object)`
+  * `denies.equivalent_to(Object)`
+  * `asserts.equivalent_to { Object }`
+  * `denies.equivalent_to { Object }`
+
+* **Assigns**: checks that the actual value has an instance variable defined within it's scope. You can also validate the value of that variable. Very much mimicing the `assigns` found in Rails-ish tests from way back in form, function, and need.
+  * `asserts("a person") { Person.new }.assigns(:email)`
+  * `denies("a person") { Person.new }.assigns(:email)`
+  * `asserts("a person") { Person.new(:email => "a@b.com") }.assigns(:email, "a@b.com")`
+  * `denies("a person") { Person.new(:email => "a@b.com") }.assigns(:email, "a@b.com")`
+  * `asserts.assigns { :email }`
+  * `denies.assigns { :email }`
+  * `asserts.assigns(:email) { "a@b.com" }`
+  * `denies.assigns(:email) { "a@b.com" }`
+
+* **Nil**: simply checks the actual value for its nil-ness. Expects no arguments.
+  * `asserts.nil`
+  * `denies.nil`
+
+* **Exists**: pretty much the opposite of the `nil` assertion macro. Expects no arguments.
+  * `asserts.exists`
+  * `denies.exists`
+
+* **Matches**: compares the actual value to a provided regular expression
+  * `asserts.matches(%r{Regex})`
+  * `denies.matches(%r{Regex})`
+  * `asserts.matches { /Regex/ }`
+  * `denies.matches { /Regex/ }`
+
+* **Raises**: validates the type of exception raised from the assertion block. Optionally, you can give it the message you expected in the form of a literal string or even a portion of it.
+  * `asserts.raises(ExceptionClass)`
+  * `denies.raises(ExceptionClass)`
+  * `asserts.raises(ExceptionClass, "Expected message")`
+  * `denies.raises(ExceptionClass, "Expected message")`
+  * `asserts.raises(ExceptionClass) { "ted mess" }`
+  * `denies.raises(ExceptionClass) { "ted mess" }`
+
+* **Kind Of**: validates the type of object returned from the assertion block
+  * `asserts.kind_of(Class)`
+  * `denies.kind_of(Class)`
+  * `asserts.kind_of { Class }`
+  * `denies.kind_of { Class }`
+
+* **Responds To**: checks that the actual object `respond_to?` to a particular message
+  * `asserts.respond_to(:foo)`
+  * `denies.respond_to(:foo)`
+  * `asserts.respond_to { "foo" }`
+  * `denies.respond_to { "foo" }`
+  * `asserts.responds_to("foo")`
+  * `denies.responds_to("foo")`
+  * `asserts.responds_to { :foo }`
+  * `denies.responds_to { :foo }`
+
+* **Includes**: checks for the existence of: a character or sequence of characters in a string, an element in an array, or a key in a hash.
+  * `asserts("this string") { "barbie q" }.includes("foo")`
+  * `denies("this string") { "barbie q" }.includes("foo")`
+  * `asserts("this array") { [1,2,3] }.includes(2)`
+  * `denies("this array") { [1,2,3] }.includes(2)`
+  * `asserts("this hash") { {:key1 => "foo"} }.includes(:key2)`
+  * `denies("this hash") { {:key1 => "foo"} }.includes(:key2)`
+  * `asserts.includes { "foo" }`
+  * `denies.includes { "foo" }`
+  * `asserts.includes { 2 }`
+  * `denies.includes { 2 }`
+  * `asserts.includes { :key }`
+  * `denies.includes { :key }`
+
+* **Size**: compares the size of the actual object to the number you provide. Works with anything that responds to `size(Numeric)` (strings, arrays, hashes, etc).
+  * `asserts.size(Numeric)`
+  * `denies.size(Numeric)`
+  * `asserts.size { Numeric }`
+  * `denies.size { Numeric }`
+
+* **Any**: checks the result of calling `any?` on the actual value. Expects no arguments.
+  * `asserts.any`
+  * `denies.any`
+
+* **Empty**: checks the result of calling `empty?` on the actual value. Expects no arguments.
+  * `asserts.empty`
+  * `denies.empty`
+
+* **Same Elements**: compares actual to expected to see if they contain the same elements. Uses `Set` under-the-hood, just so you know.
+  * `asserts.same_elements(Array)`
+  * `denies.same_elements(Array)`
+  * `asserts.same_elements { Array }`
+  * `denies.same_elements { Array }`
+
+* **Not!**: Expects no arguments and simply checks that the actual value is non-truthy. This is different than `exists` which only checks that the actual value is not nil. This assertion was added at the inception of Riot to deal with the fact that Riot didn't yet have negative assertions. I am hereby declaring this macro `@deprecated`. Please stop using it (note to self) because it will be removed someday.
+  * `asserts("i'm confused") { false }.not!`
+  * `denies("i'm not confused?") { true }.not!`
+
+### Setups, Hookups, and Helpers {#setups-hookups}
+
+We're not even close to done yet; there's a lot more cool stuff for you to know about. You know about `setup` already; but you may not know that you can call `setup` multiple times within a Context. Well, you can. They run in the order you write them (top-down) and the result of a prior `setup` will be the `topic` for the next setup. In this way you **could** chain together some partitioned setup criteria without ever explicitly setting a variable (instance or local).
+
+    context "A cheesey order" do
+      setup { Cheese.create!(:name => "Blue") }
+      setup { Order.create!(:cheese => topic, :purchase_order => "123-abc") }
+  
+      asserts_topic.kind_of(Order) # I love tests that are readable
+    end # A cheesey order
+
+This notion about a prior `setup` being the `topic` for a latter `setup` is true even when the `setup` is called from a parent Context.
+
+More than likely, however, you'll want to modify something about the topic without changing what the topic for the context is. To do this, Riot provides the `hookup` block, which is just like a `setup` block except that `hookup` will always return the `topic` that was provided to it. It's kind of like calling `Object#tap`. Here's a for-instance:
+
+    context "A Person" do
+      setup { Person.new(:name => "Master Blasterr") }
+
+      denies(:valid?) # :(
+
+      context "with valid email" do
+        hookup { topic.email = "master@blast.err" }
+        asserts(:valid?) # Yay!
+      end # with valid email
+    end # A complex thing
+
+If the point didn't smack you in the face there, think about using `setup` instead of `hookup` in the sub-context. Had you written that as a `setup` block, you'd have to return `topic` after setting the email address, or else the new topic would be the actual email address; and you probably don't want to actually be calling `"master@blast.err".valid?` in the assertion.
+
+You can also call `hookup` as many times as you like; the great part is that the `topic` never changes.
+
+#### Helpers {#helpers}
+
+You remember how you used to &mdash; or currently do &mdash; create instance variables to hold some data that you're going to use in your tests? Well, Riot allows you to still do that yucky stuff, but would rather you use a helper to encapsulate it. For instance, you could do this:
+
+    context "A greedy monkey" do
+      setup do
+        @a_ripe_banana = Banana.new(:ripe => true)
+        Monkey.new
+      end
+
+      hookup { topic.takes(@a_ripe_banana) }
+
+      asserts(:bananas).size(1)
+    end # A greedy monkey
+
+Or, you could do this
+
+    context "A greedy monkey" do
+      helper(:a_ripe_banana) { Banana.new(:ripe => true) }
+      setup { Monkey.new }
+
+      hookup { topic.takes(a_ripe_banana) }
+
+      asserts(:bananas).size(1)
+    end # A greedy monkey
+
+"So! What's the difference?", you ask. Nothing really. It's all aesthetic; but, it's a better aesthetic for a couple of reasons. Let me tell you why:
+
+1. Helpers are good ways to encapsulate related setup data and give that data namespace
+2. The act of setting up data does not clutter up your setups or assertions
+3. I'll argue that it makes the code more readable; ex. how do you verbalize to your friends `@a_banana` and `a_banana`. In the former, I probably say "at a banana" and think "Why do I sound like a muppet when I talk?".
+3. Being that helpers are blocks, you can actually pass arguments to them
+
+What's that about (4)? Yes, helpers are really just over-glorified methods, which means you can pass arguments to them. Which means you can build factories with them. Which means those factories can go away when the context is no longer used and they're no longer cluttering up your object space. You want another for instance, eh?
 
+    context "A greedy monkey" do
+      helper(:make_a_banana) do |color|
+        Banana.new(:color => color)
+      end
+
+      setup { Monkey.new }
+
+      hookup do
+        topic.takes(make_a_banana("green"))
+        topic.takes(make_a_banana("blue"))
+      end
+
+      asserts(:bananas).size(2)
+      asserts("green bananas") { topic.bananas.green }.size(1)
+      asserts("blue bananas") { topic.bananas.blue }.size(1)
+    end # A greedy monkey
+
+Or you could `make_many_bananas` or whatever. There are also lots of clever ways to get helpers included into a context which you will hopefully see when you read up on Context Middleware and look through the Recipes. Riot Rails makes liberal use of helpers when [setting up a context](http://github.com/thumblemonks/riot-rails/master/lib/riot/action_controller/context_middleware.rb) to test controllers.
+
+Again, you define as many helpers as you like; you can also replace existing helpers by simply defining a helper with the same name (*that's because they're just methods defined within the context instance ... shhh*).
+
+### Running Riot {#running}
 
-### Testing Rack application
+Running your Riot tests is pretty simple. You can put your test files wherever you want, but it's generally a good idea to put them in a "test" directory. You can run individual test files using the normal ruby command:
 
-Rack applications can easily be tested using [Riot::Rack](http://github.com/dasch/riot-rack),
-which integrates [Rack::Test](http://github.com/brynary/rack-test) into Riot.
+    !!!plain
+    ruby test/units/monkey_test.rb
+    # or
+    ruby -Itest test/units/monkey_test.rb
+
+I like the latter and use it often. It means the test directory is loaded into the load path, which means I  don't have to be explicit about where to find my `teststrap.rb` file (which you might have named `test_helper.rb` in other projects even though it's a silly name). In your teststrap file you'll put all your common setup; maybe even including your Riot hacks. An out-of-the-box teststrap might look like this:
 
+    require 'rubygems'
+    require '<my-library>'
     require 'riot'
-    require 'riot/rack'
 
-    context "HelloWorldApp" do
-      # Specify your app using the #app helper. If you don't specify
-      # one, Riot::Rack will recursively look for a config.ru file.
-      app { HelloWorldApp }
+Of course, you probably want to use rake to run your tests. Here's a basic Rakefile that will find our tests in the test directory or its subdirectories if the filename ends in `_test.rb`:
 
-      # You can use all the Rack::Test helpers in the setup blocks.
-      setup { get '/' }
+    require 'rubygems'
 
-      # You can access the response directly.
-      asserts(:status).equals(200)
-      asserts(:body).equals("Hello, World!")
+    require 'rake'
+    require 'rake/testtask'
+
+    desc "Run all our tests"
+    task :test do
+      Rake::TestTask.new do |t|
+        t.libs << "test"
+        t.pattern = "test/**/*_test.rb"
+        t.verbose = false
+      end
     end
 
+    task :default => :test
+
+And then on the command line you simply run:
+
+    !!!plain
+    rake
+    # or
+    rake test
+
+### Mocking {#mocking}
+
+Mocking seems to be all the rage this decade. I try very hard to avoid it altogether through judicious use of anonymous classes, but sometimes you just need to mock. For Riot, [RR](http://github.com/btakita/rr) seemed to fit the bill nicely because it's:
+
+* Lightweight
+* Laid back
+* Test framework agnostic and easy to integrate with
+* Starts and ends with TWO R's!
+
+That second to last point needs to be stressed a bit more. RR's default behavior is to not give a crap about what test framework you use. I can already hear you thinking, *"But wait, aren't you tying Riot to a mock framework?"*
+
+Well, not really. Riot is mock framework agnostic; it'll work with any framework that can be worked with. Riot does not implicitly require in any RR support; you have to do that in your test-strapping.
+
+However, there are a number of things you expect from a test framework when mocking is involved. Namely, if a mock expectation fails you want the context or assertion to fail, too. Additionally, you don't want to have to ask the mocking framework to validate itself for each assertion; you want Riot to do that for you. And some other things. So, Riot does most of the tedious mock-lifting for you and it suggests you use RR, but doesn't require it.
+
+But enough of this hemming and hawing. What's it look like?! In your `teststrap.rb` you need to require in `riot/rr`:
+
+    # I'm teststrap.rb
+
+    require 'rubygems'
+    require 'riot/rr'
+
+Then, in your tests, you use standard RR syntax for all of your mocking needs:
+
+    require 'teststrap.rb'
+
+    context "A nice Person" do
+      setup do
+        Nice::Person.new
+      end
+  
+      should("find a nice thing to say") do
+        mock(topic).make_network_request { "Nice haircut" }
+        topic.say_something_nice
+      end.equals("Nice haircut")
+
+    end # A nice Person
+
+So, if `#say_something_nice` never calls `#make_network_request`, that assertion will fail for that reason first. If it does call `#make_network_request`, but for some reason "Nice haircut" is not returned, the tests will fail for that reason instead. It's like catching two birds with one test.
+
+This is not an RR guide so you need to get familiar with it's syntax. Needless to say, if you require it in it's methods are available within any assertion, setup, teardown, hookup, and helper.
 
 ## Contributing
 
-Riot is still in its infancy, so both the internal and external API may change radically.
-That being said, we would love to hear any thoughts and ideas, and bug reports are always
-welcome. We hang out in `#riot` on `irc.freenode.net`.
+Riot is slowly solidifying its internal and external API. That being said, we would love to hear any thoughts and ideas, and bug reports are always welcome. We hang out in `#riot` on `irc.freenode.net`.
 
-The code is hosted on [GitHub](http://github.com), and can be fetched with
+Source code is hosted on [GitHub](http://github.com), and can be fetched with
 [Git](http://git-scm.com) by running:
 
     !!!plain
     git clone git://github.com/thumblemonks/riot.git
 
+If you want to make changes, please feel free to do so. The best process is to fork, fix, and send a pull request.
 
 ## License
 
-Riot is released under the MIT license. See {file:MIT-LICENSE}.
+Riot is released under the MIT license. See [MIT LICENSE](https://github.com/thumblemonks/riot/blob/master/MIT-LICENSE).