Spinach is a high-level BDD framework that leverages the expressive Gherkin language (used by Cucumber) to help you define executable specifications of your application or library's acceptance criteria.
Conceived as an alternative to Cucumber, here are some of its design goals:
Step maintanability: since features map to their own classes, their steps are just methods of that class. This encourages step encapsulation.
Step reusability: In case you want to reuse steps across features, you can always wrap those in plain ol' Ruby modules.
Spinach is tested against MRI 1.9.2, 1.9.3. Rubinius 2.0 support is on the works.
We are not planning to make it compatible with MRI 1.8.7 since, you know, this would be irresponsible :)
Start by adding spinach to your Gemfile:
group :test do gem 'spinach' # along with gem 'minitest' or gem 'rspec' end
Spinach works with your favorite test suite, you just have to tell it which
one are you going to use in
# If you want to use minitest: require 'minitest/spec' # If you want to use rspec: require 'rspec'
Now create a
features folder in your app or library and write your first
## features/test_how_spinach_works.feature Feature: Test how spinach works In order to know what the heck is spinach As a developer I want it to behave in an expected way Scenario: Formal greeting Given I have an empty array And I append my first name and my last name to it When I pass it to my super-duper method Then the output should contain a formal greeting Scenario: Informal greeting Given I have an empty array And I append only my first name to it When I pass it to my super-duper method Then the output should contain a casual greeting
Now for the steps file. Remember that in Spinach steps are just Ruby classes, following a camelcase naming convention. Spinach generator will do some scaffolding for you:
$ spinach --generate
Spinach will detect your features and generate the following class:
## features/steps/test_how_spinach_works.rb class TestHowSpinachWorks < Spinach::FeatureSteps Given 'I have an empty array' do end And 'I append my first name and my last name to it' do end When 'I pass it to my super-duper method' do end Then 'the output should contain a formal greeting' do end And 'I append only my first name to it' do end Then 'the output should contain a casual greeting' do end end
Then, you can fill it in with your logic - remember, it's just a class, you can use private methods, mix in modules or whatever!
class TestHowSpinachWorks < Spinach::FeatureSteps Given 'I have an empty array' do @array = Array.new end And 'I append my first name and my last name to it' do @array += ["John", "Doe"] end When 'I pass it to my super-duper method' do @output = capture_output do Greeter.greet(@array) end end Then 'the output should contain a formal salutation' do @output.must_include "Hello, mr. John Doe" end And 'I append only my first name to it' do @array += ["John"] end Then 'the output should contain a casual salutation' do @output.must_include "Yo, John! Whassup?" end private def capture_output out = StreamIO.new $stdout = out $stderr = out yield $stdout = STDOUT $stderr = STDERR out.string end end
Then run your feature again running
spinach and watch it all turn green! :)
You can easily contribute to Spinach. Its codebase is simple and extensively documented.
- Fork the project.
- Make your feature addition or bug fix.
- Add specs for it. This is important so we don't break it in a future version unintentionally.
- Commit, do not mess with rakefile, version, or history. If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.
- Send me a pull request. Bonus points for topic branches.