Release Name: 0.5.0

Notes:
= Tryouts - v0.4 BETA

Tryouts is a high-level testing library for your command-line applications and Ruby codes.


== Terminology

Tryouts is a bit different than other testing libraries. Test definitions are organized in a similar way as Shoulda tests (although the keywords in the syntax are different). 

* Tryout: a set of drills (like basketball tryouts)
* Drill: a test. 
* Dream: the expected outcome of a drill. 


== Testing a command-line application (a CLI)

Tryouts tests command-line applications by comparing expected output with the actual output. Let's say we have an executable called mockout and we want to test the following commands:

    $ bin/executable
    $ bin/executable -f yaml
    
The tryout definition would look like this:

    command :executable, "path/2/executable"
    
    tryout "Common Usage" do
      drill  "No Command"
      drill "YAML Output", :f, 'yaml'
    end
    
And the expected output would be defined like this:

    dream "No Command" do
      output inline(%Q{
            Date:                                   2009-02-16
         Players:            d-bam, alberta, birds, condor man
          Owners:            greg, rupaul, telly, prince kinko
      })
    end
    dream "YAML Output" do
      format :yaml
      output ({
        "Date" => "2009-02-16",
        "Players" => ["d-bam", "alberta", "birds", "condor man"],
        "Owners" => ["greg", "rupaul", "telly", "prince kinko"]
      })
    end
    
== Testing Ruby codes (an API)

Tryouts employs the same approach for testing Ruby codes. The return value of the drill block is compared to the expectation defined by the dream. Here is an example of including dreams inside the tryout definition. 

    library :caesars, LIBRARY_PATH

    tryout "Common Usage" do
      dream "Some Maths", 3 
      drill "Some Maths" do
        12 / 4
      end
        
      dream "A Block", Proc, :class  # Test the class type instead of the value
      drill "A Block" do
        Proc.new do
          :anything
        end
      end
    end


== BETA Notice

This library is very new (est. 2009-05-19) and has not been vetted by the scrutiny of time. In particular you can expect:

* The test definition syntax may change in future releases. 
* Unexpected errors. 


== 3 Ways to define tryouts

There are three ways to define an instance of this class:
* In +_tryouts.rb+ files using the DSL syntax. One file per Tryouts object. 
  * See: http://github.com/delano/tryouts/blob/master/tryouts/mockoutcli_tryouts.rb
* In standalone ruby files using a hybrid DSL/OO syntax. Supports multiple 
  Tryouts objects per file. 
  * See: http://github.com/delano/tryouts/blob/master/tryouts/standalone_test.rb
* With regular object-oriented syntax.
  * See: http://tryouts.rubyforge.org/

== On Threads

Tryouts does some funky stuff to make it simple to write tests. This "funky 
stuff" means that this library is *not thread-safe at definition-time*. However, once 
all tryouts files are parsed (or in OO-syntax, once all objects are created), this
class should be *thread-safe at drill-time*. 

== More Info

* Check out the sourcecodes[http://github.com/delano/tryouts]
* Read the rdocs[http://tryouts.rubyforge.org/]
* About Solutious[http://solutious.com/about/]

== Thanks

* Everyone at Utrecht.rb 

== Credits

* Delano (@solutious.com)

== Related Projects

* Context[http://github.com/jeremymcanally/context/tree/master]
* Testy[http://github.com/ahoward/testy/tree/master]
* Expectations[http://expectations.rubyforge.org/]
* Zebra[http://github.com/giraffesoft/zebra/tree/master]

== License

See: LICENSE.txt


Changes:
TRYOUTS, CHANGES


#### 0.5.0 (2009-06-07) ###############################

* FIXED: Fix for running drills without dreams and for specifying verbose without a command name
* CHANGE: The executable has been renamed to 'sergeant'
* CHANGE: Gave reality a default rcode (0)
* CHANGE: Now using module_eval (was: class_eval) for setup and clean
* ADDED: Displays percentage of failed dreams
* ADDED: Drill stash!
* ADDED: xdream and better handling for drills and dreams with no name

#### 0.4.1 (2009-06-07) ###############################

* CHANGE: The CLI output is no longer terrifyingly ugly.


#### 0.4.0 (2009-06-05) ###############################

NOTE: Initial public release