RSpec Gherkin

Different approach to Gherkin features in RSpec. It is based on two premises:

1. Requirements are written by business in semi-formal, human-readable Gherkin.
2. Automation of those is done by programmers in formal, machine-readable RSpec.

It resigns from the idea of regexp-parseable Cucumber features. As Uncle Bob noticed in his article:

I mean, the point was to get the business to provide a formal specification of the system so that the programmers could understand it. What in the name of heaven is the point of having the programmers write the formal specification so that the programmers can then understand it?

Installation

Add this gem to test group in Gemfile:

ruby group :test do gem 'rspec-gherkin' end

In your spec_helper include environment and rspec-gherkin:

ruby require File.expand_path('../../config/environment', __FILE__) require 'capybara/rails' # only for Rails require 'rspec-gherkin'

Basic Usage

1. Put your requirements in features directory under application’s root path:

   features/manage_articles.feature

   ``` Feature: Manage Articles In order to make a blog As an author I want to create and manage articles

   Scenario: Articles List Given I have articles titled Pizza, Breadsticks When I go to the list of articles Then I should see “Pizza” And I should see “Breadsticks” ```

2. Put specs for for those features in spec/features directory:

   spec/features/manage_articles_spec.rb

   ```ruby require ‘spec_helper’

   feature ‘Manage Articles’ do scenario ‘Articles List’ do create(:article, :title => “Pizza”) create(:article, :title => “Breadsticks”) visit articles_path expect(page).to have_content ‘Pizza’ expect(page).to have_content ‘Breadsticks’ end end ```

In specs you can use Capybara, FactoryGirl, helpers, and whatever you want.

You can run both *.feature files and _spec.rb spec as usual.

```sh # Run all features rspec features rspec spec/features rspec –tag feature

Run individual features

rspec features/manage_articles.feature rspec spec/features/manage_articles_spec.rb ```

You may want to add --tag ~feature to your .rspec file to not run slow features specs by default.

Scenario outline

RSpec Gherkin has also support for Scenario Outlines. Just add additional params to your scenario.

``` Feature: using scenario outlines Scenario Outline: a simple outline Given there is a monster with hitpoints When I attack the monster and do points damage Then the monster should be

Examples:
  | hp     | damage | state   | happy |
  | 10.0   | 13     | dead    | false |
  | 8.0    | 5      | alive   | true  | ```

ruby feature 'using scenario outlines' do scenario 'a simple outline' do |hp, damage, state, happy| expect(hp).to be_a(Float) expect(damage).to be_a(Fixnum) expect(state).to be_a(String) expect([true, false]).to include happy end end

Configuration

By default features in features directory are mapped to specs in spec/features.

Also each feature has an additional metadata: { :type => :feature, :feature => true }.

You can change this by adding configuration options in spec_helper. Here are the defaults:

ruby RSpec.configure do |config| config.feature_mapping = { :feature => 'features/**/*.feature', :spec => 'spec/features/**/*_spec.rb' } config.feature_metadata = { :type => :feature, :feature => :true } end

FAQ

How it differs from capybara/rspec

It is an extension to it. rspec-gherin among others:

1. Focuses on strong mapping between features and specs for them
2. Allows for running feature files directly
3. Notifies if any features/scenarios have pending specs
4. Notifies if any specs have no matching features/scenarios
5. Marks specs as pending if matching feature has been tagged as @updated
6. Provides RSpec messages, indicating location of feature and spec files.
7. Extracts examples from Scenario Outlines and passes them to specs.

License

This gem is MIT-licensed. You are awesome.