Stories
=======

Stories and User Acceptance Tests for the minimalist test framework [Contest](http://github.com/citrusbyte/contest).

Description
-----------

Write user stories and user acceptace tests using Contest, the tiny add on to Test::Unit that provides nested contexts and declarative tests.

Usage
-----

Declare your stories as follows:

    require 'stories'

    class UserStoryTest < Test::Unit::TestCase
      story "As a user I want to create stories so I can test if they pass" do
        setup do
          @user = "valid user"
        end

        scenario "A valid user" do
          assert_equal "valid user", @user
        end
      end
    end

If you are using Rails, you can use stories for your integration tests with Webrat:

    class UserStoriesTest < ActionController::IntegrationTest
      story "As a user I want to log in so that I can access restricted features" do
        setup do
          @user = User.spawn
        end

        scenario "Using good information" do
          visit "/"
          click_link "Log in"
          fill_in :session_email, :with => user.email
          fill_in :session_password, :with => user.password
          click_button "Sign in"

          assert_not_contain "Log in"
          assert_not_contain "Sign up"
        end
      end
    end

You can run it normally, it's Test::Unit after all. If you want to run a particular test, say "yet more tests", try this:

    $ testrb my_test.rb -n test_yet_more_tests

Or with a regular expression:

    $ testrb my_test.rb -n /yet_more_tests/

Installation
------------

    $ gem sources -a http://gems.github.com (you only have to do this once)
    $ sudo gem install citrusbyte-stories

If you want to use it with Rails, add this to config/environment.rb:

    config.gem "citrusbyte-stories", :lib => 'stories', :source => 'http://gems.github.com'

Then you can vendor the gem:

    rake gems:install
    rake gems:unpack

License
-------

Copyright (c) 2009 Damian Janowski and Michel Martens for Citrusbyte

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.