spinach 0.5.0 → 0.5.1

data/features/reporting/pending_feature_reporting.feature

@@ -0,0 +1,10 @@
+Feature: Pending feature reporting
+  In order to be aware of what features are still pending
+  As a developer
+  I want spinach to tell me which of them I still need to implement
+
+  Scenario: Pending feature
+    Given I've written a pending scenario
+    When I run spinach
+    Then I should see a message telling me that there's a pending scenario
+    And I should see a message showing me the reason of the pending scenario

data/features/steps/reporting/pending_feature_reporting.rb

@@ -0,0 +1,41 @@
+class PendingFeatureReporting < Spinach::FeatureSteps
+
+  feature "Pending feature reporting"
+
+  include Integration::SpinachRunner
+
+  Given "I've written a pending scenario" do
+    write_file(
+      'features/pending_feature.feature',
+      """
+      Feature: A pending feature
+
+      Scenario: This scenario is pending 
+        Given I have a pending step 
+      """)
+
+    write_file(
+      'features/steps/pending_feature.rb',
+      'class APendingFeature < Spinach::FeatureSteps
+
+         feature "A pending feature"
+
+         Given "I have a pending step" do
+           pending "This step is pending."
+         end
+       end')
+    @feature = "features/pending_feature.feature"
+  end
+
+  When "I run spinach" do
+    run_feature @feature
+  end
+
+  Then "I should see a message telling me that there's a pending scenario" do
+    @stdout.must_include("(1) Pending")
+  end
+
+  And "I should see a message showing me the reason of the pending scenario" do
+    @stderr.must_include("This step is pending")
+  end
+end

data/lib/spinach/dsl.rb

@@ -73,6 +73,7 @@ module Spinach
       def feature(name)
         @feature_name = name
       end
+
     end
 
     # Instance methods to include in the host class.
@@ -107,6 +108,21 @@ module Spinach
       def name
         self.class.feature_name
       end
+
+      # Raises an exception that defines the current step as a pending one.
+      #
+      # @api public
+      #
+      # @param [String] reason
+      #   The reason why the step is set to pending
+      #
+      # @raise [Spinach::StepPendingException]
+      #   Raising the exception tells the scenario runner the current step is
+      #   pending.
+      def pending(reason)
+        raise Spinach::StepPendingException.new(reason)
+      end
+
     end
   end
 end

data/lib/spinach/exceptions.rb

@@ -3,12 +3,12 @@ module Spinach
   # for a {FeatureSteps}.
   #
   class StepNotDefinedException < StandardError
-    attr_reader :feature, :step
+    attr_reader :step
 
     # @param [Hash] step
     #   The missing step.
     #
-    # @api pulic
+    # @api public
     def initialize(step)
       @step = step
     end
@@ -21,4 +21,25 @@ module Spinach
       "Step '#{@step.name}' not found"
     end
   end
+
+  class StepPendingException < StandardError
+    attr_reader :reason
+    attr_accessor :step
+
+    # @param [String] reason
+    #   The reason why the step is set to pending
+    #
+    # @api public
+    def initialize(reason)
+      @reason = reason
+    end
+
+    # @return [String]
+    #   A custom message when scenario steps are pending.
+    #
+    # @api public
+    def message
+      "Step '#{@step.name}' pending"
+    end
+  end
 end

data/lib/spinach/generators/step_generator.rb

@@ -15,7 +15,7 @@ module Spinach
     def generate
       result = StringIO.new
       result.puts "#{@step.keyword} '#{Spinach::Support.escape_single_commas @step.name}' do"
-      result.puts "  raise 'step not implemented'"
+      result.puts "  pending 'step not implemented'"
       result.puts "end"
       result.string
     end

data/lib/spinach/hooks.rb

@@ -128,6 +128,15 @@ module Spinach
     #   end
     hook :on_undefined_step
 
+    # Runs every time a pending step is called
+    #
+    # @example
+    #   Spinach.hooks.on_pending_step do |step_data, exception|
+    #     # step_data contains a hash with this step's data
+    #     # exception contains the raised exception containing the pending message
+    #   end
+    hook :on_pending_step
+
     # Runs every time a step is skipped because there has been an unsuccessful
     # one just before.
     #

data/lib/spinach/reporter.rb

@@ -15,13 +15,14 @@ module Spinach
       @undefined_steps = []
       @failed_steps = []
       @error_steps = []
+      @pending_steps = []
     end
 
     # A Hash with options for the reporter
     #
     attr_reader :options, :current_feature, :current_scenario
 
-    attr_reader :undefined_steps, :failed_steps, :error_steps, :undefined_features, :successful_steps
+    attr_reader :pending_steps, :undefined_steps, :failed_steps, :error_steps, :undefined_features, :successful_steps
 
     # Hooks the reporter to the runner endpoints
     def bind
@@ -35,6 +36,7 @@ module Spinach
         hooks.after_scenario { |*args| after_scenario_run(*args) }
         hooks.on_successful_step { |*args| on_successful_step(*args) }
         hooks.on_undefined_step { |*args| on_undefined_step(*args) }
+        hooks.on_pending_step { |*args| on_pending_step(*args) }
         hooks.on_failed_step { |*args| on_failed_step(*args) }
         hooks.on_error_step { |*args| on_error_step(*args) }
         hooks.on_skipped_step { |*args| on_skipped_step(*args) }
@@ -59,6 +61,7 @@ module Spinach
     def on_failed_step(*args); end;
     def on_error_step(*args); end;
     def on_undefined_step(*args); end;
+    def on_pending_step(*args); end;
     def on_skipped_step(*args); end;
 
     # Stores the current feature

data/lib/spinach/reporter/stdout.rb

@@ -117,6 +117,17 @@ module Spinach
         undefined_steps << scenario_error
       end
 
+      # Adds an undefined step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON Gherkin format
+      #
+      def on_pending_step(step, failure)
+        output_step('P', step, :yellow)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        pending_steps << scenario_error
+      end
+
       # Adds a feature not found message to the output buffer.
       #
       # @param [Hash] feature
@@ -198,10 +209,11 @@ module Spinach
       def run_summary
         successful_summary = format_summary(:green,  successful_steps, 'Successful')
         undefined_summary  = format_summary(:yellow, undefined_steps,  'Undefined')
+        pending_summary    = format_summary(:yellow, pending_steps,    'Pending')
         failed_summary     = format_summary(:red,    failed_steps,     'Failed')
         error_summary      = format_summary(:red,    error_steps,      'Error')
 
-        out.puts "Steps Summary: #{successful_summary}, #{undefined_summary}, #{failed_summary}, #{error_summary}\n\n"
+        out.puts "Steps Summary: #{successful_summary}, #{undefined_summary}, #{pending_summary}, #{failed_summary}, #{error_summary}\n\n"
       end
 
       # Constructs the full step definition

data/lib/spinach/reporter/stdout/error_reporting.rb

@@ -12,26 +12,25 @@ module Spinach
           report_failed_steps
           report_undefined_features
           report_undefined_steps
+          report_pending_steps
         end
 
-        # Prints the steps that raised an error.
-        #
         def report_error_steps
           report_errors('Errors', error_steps, :light_red) if error_steps.any?
         end
 
-        # Prints failing steps.
-        #
         def report_failed_steps
           report_errors('Failures', failed_steps, :light_red) if failed_steps.any?
         end
 
-        # Prints undefined steps.
-        #
         def report_undefined_steps
           report_errors('Undefined steps', undefined_steps, :yellow) if undefined_steps.any?
         end
 
+        def report_pending_steps
+          report_errors('Pending steps', pending_steps, :yellow) if pending_steps.any?
+        end
+
         def report_undefined_features
           if undefined_features.any?
             error.puts "  Undefined features (#{undefined_features.length})".light_yellow
@@ -96,6 +95,9 @@ module Spinach
           summary = "    #{feature.name} :: #{scenario.name} :: #{full_step step}"
           if exception.kind_of?(Spinach::StepNotDefinedException)
             summary.yellow
+          elsif exception.kind_of?(Spinach::StepPendingException)
+            summary += "\n      Reason: '#{exception.reason}'\n"
+            summary.yellow
           else
             summary.red
           end
@@ -123,6 +125,9 @@ module Spinach
               output << "          #{line}\n".yellow
             end
             output << "\n"
+          elsif exception.kind_of?(Spinach::StepPendingException)
+            output << "        Reason: '#{exception.reason}'".yellow
+            output << "\n"
           else
             if options[:backtrace]
               output += "\n"
@@ -152,6 +157,8 @@ module Spinach
 
           if exception.kind_of?(Spinach::StepNotDefinedException)
             output.yellow
+          elsif exception.kind_of?(Spinach::StepPendingException)
+            output.yellow
           else
             output.red
           end

data/lib/spinach/runner/scenario_runner.rb

@@ -80,6 +80,10 @@ module Spinach
       rescue Spinach::StepNotDefinedException => e
         @exception = e
         Spinach.hooks.run_on_undefined_step step, @exception, step_definitions
+      rescue Spinach::StepPendingException => e
+        e.step = step
+        @exception = e
+        Spinach.hooks.run_on_pending_step step, @exception
       rescue Exception => e
         @exception = e
         Spinach.hooks.run_on_error_step step, @exception, step_location, step_definitions

data/lib/spinach/version.rb

@@ -1,4 +1,4 @@
 module Spinach
   # Spinach version.
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/test/spinach/generators/feature_generator_test.rb

@@ -38,7 +38,7 @@ Feature: Cheezburger can I has
       it "generates an entire feature_steps class definition" do
         result = subject.generate
         result.must_match /Given 'I haz a sad' do/
-        result.must_match /raise 'step not implemented'/
+        result.must_match /pending 'step not implemented'/
       end
     end
 

data/test/spinach/generators/step_generator_test.rb

@@ -15,6 +15,10 @@ module Spinach::Generators
       it "generates a step" do
         subject.generate.must_match /Given.*I has a sad/
       end
+
+      it "generates a pending step" do
+        subject.generate.must_include "pending 'step not implemented'"
+      end
     end
 
   end

data/test/spinach/reporter/stdout/error_reporting_test.rb

@@ -32,6 +32,7 @@ describe Spinach::Reporter::Stdout do
       @reporter.expects(:report_failed_steps).once
       @reporter.expects(:report_undefined_steps).once
       @reporter.expects(:report_undefined_features).once
+      @reporter.expects(:report_pending_steps).once
 
       @reporter.error_summary
 
@@ -107,6 +108,25 @@ describe Spinach::Reporter::Stdout do
     end
   end
 
+  describe '#report_pending_steps' do
+    describe 'when some steps have pending' do
+      it 'outputs the pending steps' do
+        steps = [anything]
+        @reporter.stubs(:pending_steps).returns(steps)
+        @reporter.expects(:report_errors).with('Pending steps', steps, :yellow)
+
+        @reporter.report_pending_steps
+      end
+    end
+
+    describe 'when there are no pending steps' do
+      it 'does nothing' do
+        @reporter.expects(:report_errors).never
+        @reporter.report_pending_steps
+      end
+    end
+  end
+
   describe '#report_undefined_features' do
     describe 'when some features are undefined' do
       it 'outputs the undefined features' do

data/test/spinach/reporter/stdout_test.rb

@@ -133,13 +133,11 @@ describe Spinach::Reporter::Stdout do
 
     it 'sets the current scenario error' do
       @reporter.on_error_step(step, anything, step_location)
-
       @reporter.scenario_error.must_include step
     end
 
     it 'adds the step to the error steps' do
       @reporter.on_error_step(step, anything, step_location)
-
       @reporter.error_steps.last.must_include step
     end
   end
@@ -168,6 +166,28 @@ describe Spinach::Reporter::Stdout do
     end
   end
 
+  describe '#on_pending_step' do
+    let(:step) { stub(keyword: 'Given', name: 'I wrote a pending step') }
+
+    it 'adds the step to the output buffer' do
+     @reporter.on_pending_step(step, anything)
+
+     @out.string.must_include 'P'
+     @out.string.must_include 'Given'
+     @out.string.must_include 'I wrote a pending step'
+    end
+
+    it 'sets the current scenario error' do
+      @reporter.on_pending_step(step, anything)
+      @reporter.scenario_error.must_include step
+    end
+
+    it 'adds the step to the pending steps' do
+      @reporter.on_pending_step(step, anything)
+      @reporter.pending_steps.last.must_include step
+    end
+  end
+
   describe "#on_feature_not_found" do
     before do
       @feature = stub(name: 'This feature does not exist', scenarios: [], background_steps: [])

data/test/spinach/runner/scenario_runner_test.rb

@@ -118,6 +118,25 @@ module Spinach
           end
         end
 
+        describe 'when the step is pending' do
+          before do
+            @step_definitions.
+              stubs(:execute).
+              with(@step).
+              raises Spinach::StepPendingException, @step
+          end
+
+          it 'sets the exception' do
+            subject.run_step(@step)
+            subject.instance_variable_get(:@exception).must_be_kind_of(Spinach::StepPendingException)
+          end
+
+          it 'runs the pending hooks' do
+            Spinach.hooks.expects(:run_on_pending_step).with(@step, kind_of(Spinach::StepPendingException))
+            subject.run_step(@step)
+          end
+        end
+
         describe 'when the step raises an error' do
           before do
             @step_definitions.stubs(:execute).with(@step).raises StandardError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinach
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin-ruby
-  requirement: &2168662800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,10 +24,15 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168662800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &2168662100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +40,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168662100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2168661120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +56,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168661120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2168660500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +72,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168660500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2168687040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +88,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168687040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2168686600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +104,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168686600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2168686180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +120,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168686180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2168685760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +136,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168685760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168685340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +152,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168685340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2168684920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,10 +168,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168684920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &2168684500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,7 +184,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168684500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Spinach is a BDD framework on top of gherkin
 email:
 - info@codegram.com
@@ -162,6 +217,7 @@ files:
 - features/feature_name_guessing.feature
 - features/reporting/display_run_summary.feature
 - features/reporting/error_reporting.feature
+- features/reporting/pending_feature_reporting.feature
 - features/reporting/show_step_source_location.feature
 - features/reporting/undefined_feature_reporting.feature
 - features/rspec_compatibility.feature
@@ -171,6 +227,7 @@ files:
 - features/steps/feature_name_guessing.rb
 - features/steps/reporting/display_run_summary.rb
 - features/steps/reporting/error_reporting.rb
+- features/steps/reporting/pending_feature_reporting.rb
 - features/steps/reporting/show_step_source_location.rb
 - features/steps/reporting/undefined_feature_reporting.rb
 - features/steps/rspec_compatibility.rb
@@ -249,21 +306,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2039979269723833359
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2039979269723833359
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Spinach is a BDD framework on top of gherkin
@@ -274,6 +325,7 @@ test_files:
 - features/feature_name_guessing.feature
 - features/reporting/display_run_summary.feature
 - features/reporting/error_reporting.feature
+- features/reporting/pending_feature_reporting.feature
 - features/reporting/show_step_source_location.feature
 - features/reporting/undefined_feature_reporting.feature
 - features/rspec_compatibility.feature
@@ -283,6 +335,7 @@ test_files:
 - features/steps/feature_name_guessing.rb
 - features/steps/reporting/display_run_summary.rb
 - features/steps/reporting/error_reporting.rb
+- features/steps/reporting/pending_feature_reporting.rb
 - features/steps/reporting/show_step_source_location.rb
 - features/steps/reporting/undefined_feature_reporting.rb
 - features/steps/rspec_compatibility.rb