spinach 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3695a752a99edd4e91fd72df976576aef38a93a
-  data.tar.gz: 8148e0be9f45bd1808f0091edd87630967db287e
+  metadata.gz: 1f75603856e6e68fb9f7eb16a287062659034e02
+  data.tar.gz: a6ea70aaa3ef522f10e6b5c729671c94c84bc67c
 SHA512:
-  metadata.gz: f57752557ea737923da6ab5356f7e76c1374590bc0c16dc22142cad4355f17513dac875f13e833dbecb126cb69e7b0515afc3306c2dcd651e6eb0a660484e7b1
-  data.tar.gz: 7452e29f5d8c40f6ba0883c27fbc6ddb93fa24aa53a05ab36a9313765abc651546cc33897c01a4b82177829a0a587bfaaa7ca2a4ba47f8bd3d886fd17c459690
+  metadata.gz: c5f580a7a0bc2c9f4ce8901b78f1f63da2a72d14f8233ade3ebd423f6bf0989441b318970266610422b6e53de854fd6cf1ce868f53e80064f6606396d9c39c3f
+  data.tar.gz: 349c9aa0672871576ea8ff8f86944c24816048ccbee2ca3a360b446feed8d6ede0ab2671a8db2505ea4cfd80a0f3e5e66f55578e88d69db215981d37970c06a3

data/Gemfile

@@ -4,6 +4,7 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
+gem 'pry-byebug', platforms: [:ruby]
 
 group :docs do
   gem 'yard'

data/README.markdown

@@ -310,6 +310,14 @@ class Spinach::Features::SessionTimeout < Spinach::FeatureSteps
 end
 ```
 
+## RSpec mocks
+
+If you need access to the [rspec-mocks](https://github.com/rspec/rspec-mocks) methods in your steps, add this line to your `env.rb`:
+
+```ruby
+require 'spinach/rspec/mocks'
+```
+
 ## Reporters
 
 Spinach supports two kinds of reporters by default: `stdout` and `progress`.

data/features/reporting/customized_reporter.feature

@@ -7,3 +7,9 @@ Feature: Use customized reporter
     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
+
+  Scenario: Multiple reporters
+    Given I have a feature that has one failure
+    When I run it using two custom reporters
+    Then I see one reporter's output on the screen
+    And I see the other reporter's output in a file

data/features/running_specific_scenarios.feature

@@ -0,0 +1,24 @@
+Feature: Running Specific Scenarios
+  In order to test only specific scenarios
+  As a developer
+  I want spinach to run only the scenarios I specify
+
+  Scenario: Specifying line numbers
+    Given I have a feature with 2 scenarios
+    When I specify that only the second should be run
+    Then One will succeed and none will fail
+
+  Scenario: Including tags
+    Given I have a tagged feature with 2 scenarios
+    When I include the tag of the failing scenario
+    Then None will succeed and one will fail
+
+  Scenario: Excluding tags
+    Given I have a tagged feature with 2 scenarios
+    When I exclude the tag of the passing scenario
+    Then None will succeed and one will fail
+
+  Scenario: Combining tags
+    Given I have a tagged feature with 2 scenarios
+    When I include the tag of the feature and exclude the tag of the failing scenario
+    Then One will succeed and none will fail

data/features/steps/reporting/use_customized_reporter.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 class UseCustomizedReporter < Spinach::FeatureSteps
 
   feature "Use customized reporter"
@@ -88,6 +90,28 @@ class ASuccessFeature < Spinach::FeatureSteps
                @feature = "features/success_feature.feature"
   end
 
+  Given 'I have a feature that has one failure' do
+    write_file('features/failure_feature.feature', """
+Feature: A failure feature
+
+  Scenario: This is scenario will fail
+    Then I fail
+               """)
+
+               write_file('features/steps/failure_feature.rb',
+                          <<-EOF
+    require_relative "../../test_reporter"
+class AFailureFeature < Spinach::FeatureSteps
+      feature "A failure feature"
+      Then "I fail" do
+        assert false
+      end
+     end
+     EOF
+)
+               @feature = "features/failure_feature.feature"
+  end
+
   When 'I run it using the new reporter' do
     run_feature @feature, append: "-r test_reporter"
   end
@@ -95,4 +119,19 @@ class ASuccessFeature < Spinach::FeatureSteps
   Then 'I see the desired output' do
     @stdout.must_include("The customized class")
   end
+
+  When 'I run it using two custom reporters' do
+    @failure_filename = "tmp/custom-reporter-#{SecureRandom.hex}.txt"
+    @expected_path = "tmp/fs/#{@failure_filename}"
+    run_feature @feature, append: "-r failure_file,test_reporter", env: { 'SPINACH_FAILURE_FILE' => @failure_filename }
+  end
+    
+  Then 'I see one reporter\'s output on the screen' do
+    @stdout.must_include("The customized class")
+  end
+  
+  Then 'I see the other reporter\'s output in a file' do
+    assert File.exist?(@expected_path), "Reporter should have created an output file: #{@expected_path}"
+    File.open(@expected_path).read.must_equal "features/failure_feature.feature:4"
+  end
 end

data/features/steps/running_specific_scenarios.rb

@@ -0,0 +1,46 @@
+class Spinach::Features::RunningSpecificScenarios < Spinach::FeatureSteps
+  include Integration::SpinachRunner
+
+  Given 'I have a feature with 2 scenarios' do
+    @feature = Integration::FeatureGenerator.failure_feature_with_two_scenarios
+  end
+
+  When 'I specify that only the second should be run' do
+    feature_file = Pathname.new(Filesystem.dirs.first).join(@feature)
+    step_lines   = feature_file.each_line.with_index.select do |line, index|
+      line.match(/^\s*Then/)
+    end
+
+    line_number = step_lines[1].last
+
+    run_feature("#{@feature}:#{line_number}")
+  end
+
+  Then 'One will succeed and none will fail' do
+    @stdout.must_match("(1) Successful")
+    @stdout.must_match("(0) Failed")
+    @stdout.must_match("(0) Pending")    
+  end
+
+  Given 'I have a tagged feature with 2 scenarios' do
+    @feature = Integration::FeatureGenerator.tagged_failure_feature_with_two_scenarios
+  end
+
+  When 'I include the tag of the failing scenario' do
+    run_feature(@feature, {append: "-t @failing"})
+  end
+
+  Then 'None will succeed and one will fail' do
+    @stdout.must_match("(0) Successful")
+    @stdout.must_match("(1) Failed")
+    @stdout.must_match("(0) Pending")
+  end
+
+  When 'I exclude the tag of the passing scenario' do
+    run_feature(@feature, {append: "-t ~@passing"})
+  end
+
+  When 'I include the tag of the feature and exclude the tag of the failing scenario' do
+    run_feature(@feature, {append: "-t @feature,~@failing"})
+  end
+end

data/features/support/env.rb

@@ -1,7 +1,6 @@
 require 'minitest/autorun'
 require 'minitest/spec'
 require_relative 'filesystem'
-
 require 'simplecov'
 
 if ENV['CI'] && !defined?(Rubinius)

data/features/support/feature_generator.rb

@@ -10,8 +10,8 @@ module Integration
       #
       # @api private
       def success_feature
-        feature= success_scenario_title + success_scenario
-        steps = success_step_class_str + success_step + "\nend"
+        feature = success_scenario_title + success_scenario
+        steps   = success_step_class_str + success_step + "\nend"
         write_feature 'features/success_feature.feature', feature,
           'features/steps/success_feature.rb', steps
       end
@@ -37,12 +37,37 @@ module Integration
       #
       # @api private
       def failure_feature_with_two_scenarios
-        feature = failure_feature_title + failure_sceario + success_scenario
+        feature = failure_feature_title + failure_scenario + success_scenario
         steps = failure_step + success_step + "\nend"
         write_feature failure_filename, feature,
           failure_step_filename, steps
       end
 
+      # Generate a tagged feature that has 2 tagged scenarios.
+      # 1 should pass, and 1 should fail.
+      #
+      # @return feature_filename
+      #   The feature file name
+      #
+      # @api private
+      def tagged_failure_feature_with_two_scenarios
+        feature = "@feature\n" +
+          failure_feature_title +
+          "  @failing" +
+          failure_scenario + "\n" +
+          "  @passing\n" +
+          "  " + success_scenario
+
+        steps = failure_step +
+          success_step + "\n" +
+          "end"
+
+        write_feature(
+          failure_filename, feature,
+          failure_step_filename, steps
+        )
+      end
+
       # Generate a feature with 1 scenario that should fail
       #
       # @return feature_filename
@@ -50,7 +75,7 @@ module Integration
       #
       # @api private
       def failure_feature
-        feature = failure_feature_title + failure_sceario
+        feature = failure_feature_title + failure_scenario
         write_feature failure_filename, feature,
           failure_step_filename, failure_step + "\nend"
       end
@@ -141,11 +166,10 @@ module Integration
         "Feature: A failure feature\n\n"
       end
 
-      def failure_sceario
-        """
+      def failure_scenario
+        "
   Scenario: This is scenario will fail
-    Then I fail
-        """
+    Then I fail\n"
       end
     end
   end

data/features/support/filesystem.rb

@@ -46,11 +46,14 @@ module Filesystem
   #
   # @param [String] command
   #   The command to run.
+  # @param [Hash] env
+  #   Hash of environment variables to use with command
   #
   # @api public
-  def run(command)
+  def run(command, env = nil)
     in_current_dir do
       args = command.strip.split(" ")
+      args = args.unshift(env) if env
       @stdout, @stderr, @last_exit_status = Open3.capture3(*args)
     end
 

data/features/support/spinach_runner.rb

@@ -20,7 +20,7 @@ module Integration
       use_minitest if options[:framework] == :minitest
       use_rspec if options[:framework] == :rspec
       spinach = File.expand_path("bin/spinach")
-      run "#{ruby} #{spinach} #{feature} #{options[:append]}"
+      run "#{ruby} #{spinach} #{feature} #{options[:append]}", options[:env]
     end
 
     def ruby

data/lib/spinach/cli.rb

@@ -125,9 +125,10 @@ module Spinach
             config[:features_path] = path
           end
 
-          opts.on('-r', '--reporter CLASS_NAME',
-                  'Formatter class name') do |class_name|
-            config[:reporter_class] = reporter_class(class_name)
+          opts.on('-r', '--reporter CLASS_NAMES',
+                  'Formatter class names, separated by commas') do |class_names|
+            names = class_names.split(',').map { |c| reporter_class(c) }
+            config[:reporter_classes] = names
           end
 
           opts.on_tail('--fail-fast',

data/lib/spinach/config.rb

@@ -31,7 +31,7 @@ module Spinach
                 :tags,
                 :generate,
                 :save_and_open_page_on_failure,
-                :reporter_class,
+                :reporter_classes,
                 :reporter_options,
                 :fail_fast,
                 :audit
@@ -48,18 +48,18 @@ module Spinach
       @features_path || 'features'
     end
 
-    # The "reporter class" holds the reporter class name
-    # Default to Spinach::Reporter::Stdout
+    # The "reporter classes" holds an array of reporter class name
+    # Default to ["Spinach::Reporter::Stdout"]
     #
-    # @return [reporter object]
-    #    The reporter that responds to specific messages.
+    # @return [Array<reporter object>]
+    #    The reporters that respond to specific messages.
     #
     # @api public
-    def reporter_class
-      @reporter_class || "Spinach::Reporter::Stdout"
+    def reporter_classes
+      @reporter_classes || ["Spinach::Reporter::Stdout"]
     end
 
-    # The "reporter_options" holds the options of reporter_class
+    # The "reporter_options" holds the options passed to reporter_classes
     #
     # @api public
     def reporter_options

data/lib/spinach/exceptions.rb

@@ -22,6 +22,9 @@ module Spinach
     end
   end
 
+  # This class represents the exception raised when Spinach find a step
+  # which claims to be pending for a {FeatureSteps}.
+  #
   class StepPendingException < StandardError
     attr_reader :reason
     attr_accessor :step
@@ -42,4 +45,27 @@ module Spinach
       "Step '#{@step.name}' pending"
     end
   end
+
+  # This class represents the exception raised when Spinach detects
+  # that the around_scenario hook does not yield.
+  #
+  class HookNotYieldException < StandardError
+    attr_reader :hook
+
+    # @param [String] hook
+    #   The hook which did not yield
+    #
+    # @api public
+    def initialize(hook)
+      @hook = hook
+    end
+
+    # @return [String]
+    #   A custom message when a hook did not yield.
+    #
+    # @api public
+    def message
+      "#{@hook} hooks *must* yield"
+    end
+  end
 end

data/lib/spinach/feature.rb

@@ -1,21 +1,27 @@
 module Spinach
   class Feature
-    attr_accessor :filename, :lines
+    attr_accessor :filename
     attr_accessor :name, :scenarios, :tags
     attr_accessor :background
     attr_accessor :description
+    attr_reader   :lines_to_run
 
     def initialize
-      @scenarios = []
-      @tags = []
+      @scenarios    = []
+      @tags         = []
+      @lines_to_run = []
     end
 
     def background_steps
       @background.nil? ? [] : @background.steps
     end
 
-    def lines=(value)
-      @lines = value.map(&:to_i) if value
+    def lines_to_run=(lines)
+      @lines_to_run = lines.map(&:to_i) if lines && lines.any?
+    end
+
+    def run_every_scenario?
+      lines_to_run.empty?
     end
 
     # Run the provided code for every step

data/lib/spinach/hooks.rb

@@ -57,6 +57,7 @@ module Spinach
     hook :before_scenario
 
     # Runs around every scenario
+    #
     # @example
     #   Spinach.hooks.around_scenario do |scenario_data, step_definitions, &block|
     #     # feature_data is a hash of the parsed scenario data
@@ -80,6 +81,15 @@ module Spinach
     #   end
     hook :before_step
 
+    # Runs around every step
+    #
+    # @example
+    #   Spinach.hooks.around_step do |step_data, step_definitions, &block|
+    #     # step_data contains a hash with this step's data
+    #     block.call
+    #   end
+    around_hook :around_step
+
     # Runs after every step execution
     #
     # @example

data/lib/spinach/parser/visitor.rb

@@ -5,7 +5,7 @@ module Spinach
     #
     # @example
     #
-    #   ast     = GherkinRuby.parse(File.read('some.feature')
+    #   ast     = GherkinRuby.parse(File.read('some.feature'))
     #   visitor = Spinach::Parser::Visitor.new
     #   feature = visitor.visit(ast)
     #
@@ -25,7 +25,8 @@ module Spinach
       #
       # @api public
       def visit(ast)
-        ast.accept self
+        ast.accept(self)
+
         @feature
       end
 
@@ -36,12 +37,13 @@ module Spinach
       #
       # @api public
       def visit_Feature(node)
-        @feature.name = node.name
+        @feature.name        = node.name
         @feature.description = node.description
+
         node.background.accept(self) if node.background
 
         @current_tag_set = @feature
-        node.tags.each  { |tag|  tag.accept(self)  }
+        node.tags.each { |tag| tag.accept(self) }
         @current_tag_set = nil
 
         node.scenarios.each { |scenario| scenario.accept(self) }
@@ -54,7 +56,7 @@ module Spinach
       #
       # @api public
       def visit_Background(node)
-        background = Background.new(@feature)
+        background      = Background.new(@feature)
         background.line = node.line
 
         @current_step_set = background
@@ -71,12 +73,15 @@ module Spinach
       #
       # @api public
       def visit_Scenario(node)
-        scenario      = Scenario.new(@feature)
-        scenario.name = node.name
-        scenario.line = node.line
+        scenario       = Scenario.new(@feature)
+        scenario.name  = node.name
+        scenario.lines = [
+          node.line,
+          *node.steps.map(&:line)
+        ].uniq.sort
 
         @current_tag_set = scenario
-        node.tags.each  { |tag|  tag.accept(self)  }
+        node.tags.each { |tag| tag.accept(self) }
         @current_tag_set = nil
 
         @current_step_set = scenario
@@ -103,7 +108,7 @@ module Spinach
       #
       # @api public
       def visit_Step(node)
-        step = Step.new(@current_scenario)
+        step         = Step.new(@current_step_set)
         step.name    = node.name
         step.line    = node.line
         step.keyword = node.keyword