spinach 0.5.2 → 0.6.0

data/.gitignore

@@ -4,7 +4,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -17,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 capybara-*.html
+Gemfile.lock

data/Gemfile

@@ -9,7 +9,7 @@ group :test do
   gem 'guard'
   gem 'guard-minitest'
   gem 'guard-spinach'
-  gem 'capybara'
+  gem 'capybara', '~> 1.1.3'
 end
 
 group :darwin do

data/README.markdown

@@ -22,117 +22,130 @@ would be irresponsible :)
 
 Start by adding spinach to your Gemfile:
 
-    group :test do
-      gem 'spinach'
-      # gem 'rspec'
-    end
+```ruby
+group :test do
+  gem 'spinach'
+  # gem 'rspec'
+end
+```
 
 Spinach works out-of-the-box with your favorite test suite, but you can also
 use it with RSpec as well if you put the following in `features/support/env.rb`:
 
-    require 'rspec'
+```ruby
+require 'rspec'
+```
 
 Now create a `features` folder in your app or library and write your first
 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
+```cucumber
+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
+```shell
+$ 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
+```ruby
+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
+  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
+  When 'I pass it to my super-duper method' do
+  end
 
-      Then 'the output should contain a formal greeting' do
-      end
+  Then 'the output should contain a formal greeting' do
+  end
 
-      And 'I append only my first name to it' 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 '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 greeting' 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 greeting' do
-        @output.must_include "Yo, John! Whassup?"
-      end
-
-      private
-
-      def capture_output
-        out = StringIO.new
-        $stdout = out
-        $stderr = out
-        yield
-        $stdout = STDOUT
-        $stderr = STDERR
-        out.string
-      end
+```ruby
+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
-    module Greeter
-      def self.greet(name)
-        if name.length > 1
-          puts "Hello, mr. #{name.join(' ')}"
-        else
-          puts "Yo, #{name.first}! Whassup?"
-        end
-      end
+  end
+
+  Then 'the output should contain a formal greeting' 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 greeting' do
+    @output.must_include "Yo, John! Whassup?"
+  end
+
+  private
+
+  def capture_output
+    out = StringIO.new
+    $stdout = out
+    $stderr = out
+    yield
+    $stdout = STDOUT
+    $stderr = STDERR
+    out.string
+  end
+end
+
+module Greeter
+  def self.greet(name)
+    if name.length > 1
+      puts "Hello, mr. #{name.join(' ')}"
+    else
+      puts "Yo, #{name.first}! Whassup?"
     end
+  end
+end
+```
 
 Then run your feature again running `spinach` and watch it all turn green! :)
 
@@ -143,47 +156,59 @@ used for different purposes:
 
 - applying some actions using hooks (eg: `@javascript`, `@transaction`, `@vcr`)
 
-        # When using Capybara, you can switch the driver to use another one with
-        # javascript capabilities (Selenium, Poltergeist, capybara-webkit, ...)
-        #
-        # Spinach already integrates with Capybara if you add
-        # `require spinach/capybara` in `features/support/env.rb`.
-        #
-        # This example is extracted from this integration.
-        Spinach.hooks.on_tag("javascript") do
-          ::Capybara.current_driver = ::Capybara.javascript_driver
-        end
+```ruby
+# When using Capybara, you can switch the driver to use another one with
+# javascript capabilities (Selenium, Poltergeist, capybara-webkit, ...)
+#
+# Spinach already integrates with Capybara if you add
+# `require spinach/capybara` in `features/support/env.rb`.
+#
+# This example is extracted from this integration.
+Spinach.hooks.on_tag("javascript") do
+  ::Capybara.current_driver = ::Capybara.javascript_driver
+end
+```
 
 - filtering (eg: `@module-a`, `@customer`, `@admin`, `@bug-12`, `@feat-1`)
 
-        # Given a feature file with this content
+```cucumber
+# Given a feature file with this content
 
-        @feat-1
-        Feature: So something great
+@feat-1
+Feature: So something great
 
-          Scenario: Make it possible
+  Scenario: Make it possible
 
-          @bug-12
-          Scenario: Ensure no regression on this
+  @bug-12
+  Scenario: Ensure no regression on this
+```
 
   Then you can run all Scenarios in your suite related to `@feat-1` using:
 
-        spinach --tags @feat-1
+```shell
+$ spinach --tags @feat-1
+```
 
   Or only Scenarios related to `@feat-1` and `@bug-12` using:
 
-        spinach --tags @feat-1,@bug-12
+```shell
+$ spinach --tags @feat-1,@bug-12
+```
 
   Or only Scenarios related to `@feat-1` excluding `@bug-12` using:
 
-        spinach --tags @feat-1,~@bug-12
+```shell
+$ spinach --tags @feat-1,~@bug-12
+```
 
 By default Spinach will ignore Scenarios marked with the tag `@wip` or whose
 Feature is marked with the tag `@wip`. Those are meant to be work in progress,
 scenarios that are pending while you work on them. To explicitly run those, use
 the `--tags` option:
 
-    spinach --tags @wip
+```shell
+$ spinach --tags @wip
+```
 
 ## Hook architecture
 
@@ -192,22 +217,44 @@ after any feature, scenario or step execution.
 
 So, for example, you could:
 
-    Spinach.hooks.before_scenario do |scenario|
-      clear_database
-    end
+```ruby
+Spinach.hooks.before_scenario do |scenario|
+  clear_database
+end
 
-    Spinach.hooks.on_successful_step do |step, location|
-      count_steps(step.scenario.steps)
-    end
+Spinach.hooks.on_successful_step do |step, location|
+  count_steps(step.scenario.steps)
+end
 
-    Spinach.hooks.after_run do |status|
-      send_mail if status == 0
-    end
+Spinach.hooks.after_run do |status|
+  send_mail if status == 0
+end
+```
 
 Full hook documentation is here:
 
 [Spinach's hook documentation on rubydoc](http://rubydoc.info/github/codegram/spinach/master/Spinach/Hooks)
 
+## Local Before and After Hooks
+
+Sometimes it feels awkward to add steps into feature file just because you need to do some test setup and cleanup. And it is equally awkward to add a global hooks for this purpose. For example, if you want to add a session timeout feature, to do so, you want to set the session timeout time to 1 second just for this feature, and put the normal timeout back after this feature. It doesn't make sense to add two steps in the feature file just to change the session timeout value. In this scenario, a ```before``` and ```after``` blocks are perfect for this kind of tasks. Below is an example implementation:
+
+```ruby
+class SessionTimeout < Spinach::FeatureSteps
+  attr_accessor :original_timeout_value
+  before do
+    self.original_timeout_value = session_timeout_value
+    change_session_timeout_to 1.second
+  end
+
+  after do
+    change_session_timeout_to original_timeout_value
+  end
+  
+  # remaining steps
+end
+```
+
 ## Wanna use it with Rails 3?
 
 Use [spinach-rails](http://github.com/codegram/spinach-rails)
@@ -258,4 +305,3 @@ You can easily contribute to Spinach. Its codebase is simple and
 ## License
 
 MIT License. Copyright 2011 [Codegram Technologies](http://codegram.com)
-

data/bin/spinach

@@ -12,5 +12,4 @@ rescue LoadError
 end
 
 cli = Spinach::Cli.new(ARGV)
-cli.init_reporter
 exit cli.run

data/features/before_and_after_hooks.feature

@@ -0,0 +1,10 @@
+Feature: Before and after hooks
+  In order to setup and clean the test environment for a single feature
+  As a developer
+  I want to be able to use before and after hooks within the step class
+
+  Scenario: Happy path
+    Then I can verify the variable setup in the before hook
+
+  Scenario: Inter-dependency - after hook cleans up (after happy path)
+    Then I can verify the variable setup in the before hook

data/features/before_and_after_hooks_inheritance.feature

@@ -0,0 +1,12 @@
+Feature: Before and after hooks inheritance
+  In order to maintain the super classes' before and after code
+  As a developer
+  I want to chain the before and after blocks
+
+  Scenario: Happy path
+    Then I can see the variable setup in the super class before hook
+    And I can see the variable being overridden in the subclass
+
+  Scenario: Inter-dependency - after hook cleans up (after happy path)
+    Then I can see the variable setup in the super class before hook
+    And I can see the variable being overridden in the subclass

data/features/reporting/customized_reporter.feature

@@ -0,0 +1,9 @@
+Feature: Use customized reporter
+  As a developer
+  I want to use a different reporter
+  So I can have different output
+
+  Scenario: Happy path
+    Given I have a feature that has no error or failure
+    When I run it using the new reporter
+    Then I see the desired output

data/features/reporting/show_step_source_location.feature

@@ -1,7 +1,7 @@
 Feature: Show step source location
   As a developer
   I want spinach to give me every step source location in output
-  So I can easyly know where I defined a step
+  So I can easily know where I defined a step
 
   Scenario: Show class steps source location in output when all is ok
     Given I have a feature that has no error or failure

data/features/steps/before_and_after_hooks.rb

@@ -0,0 +1,21 @@
+class BeforeAndAfterHooks < Spinach::FeatureSteps
+  class << self
+    attr_accessor :var1
+  end
+
+  before do
+    if self.class.var1.nil?
+      self.class.var1 = :clean
+    else
+      self.class.var1 = :dirty
+    end
+  end
+
+  after do
+    self.class.var1 = nil
+  end
+
+  Then 'I can verify the variable setup in the before hook' do
+    self.class.var1.must_equal :clean
+  end
+end