Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
RSpec runner and formatters
Ruby Cucumber Shell HTML
branch: 2-0-stable

This branch is 22 commits ahead, 3589 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
autotest Whitespace gone
bin Add 'autospec' command to alert user that it has been removed.
features don't use tap in feature (no tap in 1.8.6)
lib Add deprecated Spec::Rake::SpecTask from rspec-1 with deprecation
script Spec->Rspec. Refactoring complete
.document words
.treasure_map.rb Fixing one more beholder issue
History.markdown update history
License.txt Correcting the spelling of my name
README.markdown links to docs
Rakefile add relish again
Upgrade.markdown words
rspec-core.gemspec Use a link for upgrade instructions
specs.watchr nothing, really


RSpec Core

Behaviour Driven Development for Ruby



gem install rspec      # for rspec-core, rspec-expectations, rspec-mocks
gem install rspec-core # for rspec-core only

Upgrading from rspec-1.x

See Upgrade.markdown

This will install the rspec, rspec-core, rspec-expectations and rspec-mocks gems.

Get Started

Start with a simple example of behavior you expect from your system. Do this before you write any implementation code:

# in spec/calculator_spec.rb
describe Calculator, "add" do
  it "returns the sum of its arguments" do, 2).should eq(3)

Run this with the rspec command, and watch it fail:

$ rspec spec/calculator_spec.rb
./spec/calculator_spec.rb:1: uninitialized constant Calculator

Implement the simplest solution:

# in lib/calculator.rb
class Calculator
  def add(a,b)
    a + b

Be sure to require the implementation file in the spec:

# in spec/calculator_spec.rb
# - RSpec adds ./lib to the $LOAD_PATH, so you can
#   just require "calculator" directly
require "calculator"

Now run the spec again, and watch it pass:

$ rspec spec/calculator_spec.rb

Finished in 0.000315 seconds
1 example, 0 failures

Use the documentation formatter to see the resulting spec:

$ rspec spec/calculator_spec.rb --format doc
Calculator add
  returns the sum of its arguments

Finished in 0.000379 seconds
1 example, 0 failures

Known issues


Learn more

While not comprehensive yet, you can learn quite a lot from the Cucumber features in the features directory. If there is a feature that is not documented there, or you find them insufficient to understand how to use a feature, please submit issues to



Also see

Something went wrong with that request. Please try again.