diff options
Diffstat (limited to 'vendor/plugins/rspec/README')
| -rw-r--r-- | vendor/plugins/rspec/README | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/vendor/plugins/rspec/README b/vendor/plugins/rspec/README index ee351245d..0683b0deb 100644 --- a/vendor/plugins/rspec/README +++ b/vendor/plugins/rspec/README @@ -1,11 +1,13 @@ == RSpec -RSpec is a Behaviour Definition Framework intended for use in Behaviour -Driven Development. RSpec plays the same role that a unit testing framework -would play in a Test Driven Development environment, but does so using -words and structures that better support BDD. +RSpec is a Behaviour Driven Development framework with tools to express User Stories +with Executable Scenarios and Executable Examples at the code level. -RSpec ships with four modules: +RSpec ships with several modules: + +Spec::Story provides a framework for expressing User Stories + +Spec::Example provides a framework for expressing code Examples Spec::Matchers provides Expression Matchers for use with Spec::Expectations and Spec::Mocks. @@ -18,9 +20,6 @@ can do things like: Spec::Mocks supports creating Mock Objects, Stubs, and adding Mock/Stub behaviour to your existing objects. -Spec::Runner provides a very small but powerful DSL for writing executable -examples of how your code should work. - == Installation The simplest approach is to install the gem: @@ -39,9 +38,8 @@ In order to run RSpec's full suite of specs (rake pre_commit) you must install t * rake # Runs the build script * rcov # Verifies that the code is 100% covered by specs -* webgen # Generates the static HTML website -* RedCloth # Required by webgen -* syntax # Required by our own custom webgen extension to highlight ruby code +* webby # Generates the static HTML website +* syntax # Required to highlight ruby code * diff-lcs # Required if you use the --diff switch * win32console # Required by the --colour switch if you're on Windows * meta_project # Required in order to make releases at RubyForge @@ -60,7 +58,6 @@ Once those are all installed, you should be able to run the suite with the follo * cd .. * rake pre_commit - Note that RSpec itself - once built - doesn't have any dependencies outside the Ruby core and stdlib - with a few exceptions: @@ -69,3 +66,6 @@ and stdlib - with a few exceptions: * The Spec::Rake::SpecTask needs RCov if RCov is enabled in the task. See http://rspec.rubyforge.org for further documentation. + +== Contributing + |