spinach 0.0.2 → 0.0.4

data/lib/spinach/support.rb

@@ -0,0 +1,19 @@
+require 'active_support/inflector/methods'
+
+module Spinach
+  # A module to offer common helpers
+  module Support
+    # A helper to camelize string that proxies ActiveSupport#camelize
+    #
+    # @param [String] name
+    #
+    # @returns [String]
+    #
+    # @example
+    #   Spinach::Support.camelize('User authentication')
+    #   => 'UserAuthentication'
+    def self.camelize(name)
+      ActiveSupport::Inflector.camelize(name.to_s.downcase.strip.squeeze(' ').gsub(' ','_'))
+    end
+  end
+end

data/lib/spinach/version.rb

@@ -1,3 +1,3 @@
 module Spinach
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/spinach.rb

@@ -1,11 +1,14 @@
 require_relative 'spinach/version'
 require_relative 'spinach/config'
+require_relative 'spinach/support'
+require_relative 'spinach/exceptions'
 require_relative 'spinach/runner'
 require_relative 'spinach/parser'
 require_relative 'spinach/dsl'
 require_relative 'spinach/feature'
 require_relative 'spinach/reporter'
 
+
 # Spinach is a BDD framework in top of gherkin. Its main goals are:
 #   * No magic: All features are implemented using actual classes.
 #   * Reusability: Steps are methods, so they can be put inside modules.
@@ -35,8 +38,10 @@ module Spinach
   #   the feature name
   #
   def self.find_feature(name)
+    klass = Spinach::Support.camelize(name)
     @@features.detect do |feature|
-      feature.feature_name.to_s == name.to_s
-    end
+      feature.feature_name.to_s == name.to_s ||
+      feature.name == klass
+    end || raise(Spinach::FeatureNotFoundException, [klass, name])
   end
 end

data/spinach.gemspec

@@ -2,7 +2,7 @@
 require File.expand_path('../lib/spinach/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Josep Jaume Rey", "Josep M. Bach", "Oriol Gual"]
+  gem.authors       = ["Josep Jaume Rey", "Josep M. Bach", "Oriol Gual", "Marc Divins Castellvi"]
   gem.email         = ["info@codegram.com"]
   gem.description   = %q{Spinach is a BDD framework on top of gherkin}
   gem.summary       = %q{Spinach is a BDD framework on top of gherkin}
@@ -11,11 +11,14 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'gherkin'
   gem.add_runtime_dependency 'minitest'
   gem.add_runtime_dependency 'colorize'
+  gem.add_runtime_dependency 'activesupport'
   gem.add_development_dependency 'purdytest'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'sinatra'
   gem.add_development_dependency 'capybara'
+  gem.add_development_dependency 'aruba'
+  gem.add_development_dependency 'pry'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/test/spinach/dsl_test.rb

@@ -3,30 +3,34 @@ require_relative '../test_helper'
 describe Spinach::DSL do
   before do
     @feature = Class.new do
-      extend Spinach::DSL
+      include Spinach::DSL
     end
   end
-  %w{When Given Then And But}.each do |connector|
-    describe "##{connector}" do
-      it "should define a method with the step name" do
-        @feature.send(connector, "I say goodbye") do
-          "You say hello"
+
+  describe 'class methods' do
+    describe "#When" do
+      it 'defines a method with the step name' do
+        @feature.When('I say goodbye') do
+          'You say hello'
         end
-        @feature.new.send("#{connector} I say goodbye").must_equal "You say hello"
+
+        @feature.new.send('I say goodbye').must_equal 'You say hello'
       end
     end
-  end
-  describe "#Given, #Then, #And, #But" do
-    it "should be #When aliases" do
-      %w{Given Then And But}.each do |m|
-        @feature.must_respond_to m
+
+    describe '#When, #Then, #And, #But' do
+      it 'are #Given aliases' do
+        %w{When Then And But}.each do |method|
+          @feature.must_respond_to method
+        end
       end
     end
-  end
-  describe "#feature" do
-    it "should set the name for this feature" do
-      @feature.feature("User salutes")
-      @feature.feature_name.must_equal "User salutes"
+
+    describe '#feature' do
+      it 'sets the name for this feature' do
+        @feature.feature('User salutes')
+        @feature.feature_name.must_equal 'User salutes'
+      end
     end
   end
 end

data/test/spinach/feature_test.rb

@@ -2,21 +2,51 @@ require_relative '../test_helper'
 
 describe Spinach::Feature do
   describe "ancestors" do
-    it "should include minitest helpers" do
+    it 'includes minitest helpers' do
       Spinach::Feature.ancestors.must_include MiniTest::Assertions
     end
-    it "should be extended by the DSL" do
-      (class << Spinach::Feature; self; end).ancestors.must_include Spinach::DSL
+
+    it 'is extended by the DSL' do
+      Spinach::Feature.ancestors.must_include Spinach::DSL
+    end
+  end
+
+  describe 'class methods' do
+    describe '#inherited' do
+      it 'registers any feature subclass' do
+        @feature1 = Class.new(Spinach::Feature)
+        @feature2 = Class.new(Spinach::Feature)
+        @feature3 = Class.new
+
+        Spinach.features.must_include @feature1
+        Spinach.features.must_include @feature2
+        Spinach.features.wont_include @feature3
+      end
     end
   end
-  describe "#inherited" do
-    it "should register any feature subclass" do
-      @feature1 = Class.new(Spinach::Feature)
-      @feature2 = Class.new(Spinach::Feature)
-      @feature3 = Class.new
-      Spinach.features.must_include @feature1
-      Spinach.features.must_include @feature2
-      Spinach.features.wont_include @feature3
+
+  describe 'instance methods' do
+    before do
+      @feature = Class.new(Spinach::Feature) do
+        When 'I go to the toilet' do
+          @pee = true
+        end
+        attr_reader :pee
+      end.new
+    end
+
+    describe 'execute_step' do
+      it 'runs defined step correctly' do
+        @feature.execute_step('I go to the toilet')
+
+        @feature.pee.must_equal true
+      end
+
+      it 'raises an exception if step is not defined' do
+        proc {
+          @feature.execute_step 'I am lost'
+        }.must_raise Spinach::StepNotDefinedException
+      end
     end
   end
 end

data/test/spinach/reporter/stdout_test.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+
+require_relative '../../test_helper'
+
+describe Spinach::Reporter::Stdout do
+  before do
+    @reporter = Spinach::Reporter::Stdout.new
+  end
+
+  describe "#feature" do
+    it "outputs a feature name" do
+      out = capture_stdout do
+        @reporter.feature "User authentication"
+      end
+      out.string.must_include "\nFeature: User authentication"
+    end
+  end
+
+  describe "#scenario" do
+    it "outputs a scenario name" do
+      out = capture_stdout do
+        @reporter.scenario "User logs in"
+      end
+      out.string.must_include "  Scenario: User logs in"
+    end
+  end
+
+  describe "#step" do
+    before do
+      @feature = stubs(name: "Some cool feature")
+    end
+    describe "when succeeding" do
+      it "outputs the step name" do
+        out = capture_stdout do
+          @reporter.step "Given", "I say goodbye", :success
+        end
+        out.string.must_include "✔"
+        out.string.must_include "Given I say goodbye"
+      end
+    end
+
+    describe "when undefined" do
+      it "outputs the step name with a question mark" do
+        out = capture_stdout do
+          @reporter.step "Given", "I say goodbye", :undefined_step
+        end
+        out.string.must_include "?"
+        out.string.must_include "Given I say goodbye"
+      end
+    end
+
+    describe "when failing" do
+      it "outputs the step name with a failure mark" do
+        out = capture_stdout do
+          @reporter.step "Given", "I say goodbye", :failure
+        end
+        out.string.must_include "✘"
+        out.string.must_include "Given I say goodbye"
+      end
+    end
+
+    describe "when failing" do
+      it "outputs the step name with a failure mark" do
+        out = capture_stdout do
+          @reporter.step "Given", "I say goodbye", :error
+        end
+        out.string.must_include "!"
+        out.string.must_include "Given I say goodbye"
+      end
+    end
+
+    describe "when skipping" do
+      it "outputs the step name with a failure mark" do
+        out = capture_stdout do
+          @reporter.step "Given", "I say nothing", :skip
+        end
+        out.string.must_include "~"
+        out.string.must_include "Given I say nothing"
+      end
+    end
+  end
+
+  describe "#end" do
+    it "outputs a blank line" do
+      out = capture_stdout do
+        @reporter.end
+      end
+      out.string.must_include "\n"
+    end
+  end
+
+  describe "#error_summary" do
+    it "outputs an error summary" do
+      make_error = proc do |message|
+        stub(
+          message: message,
+          backtrace: ["foo:1", "bar:2"]
+        )
+      end
+
+      make_scenario = proc do |name|
+        stub(
+          feature_name: name,
+          feature: stub_everything,
+          name: name
+        )
+      end
+
+      errors = [
+        [make_error.('omg'), "some_file", "3", make_scenario.('feature')],
+        [make_error.('wtf'), "other_file", "9", make_scenario.('feature')],
+      ]
+
+      out = capture_stdout do
+        @reporter.error_summary(errors)
+      end
+      out.string.must_include "omg"
+      out.string.must_include "some_file"
+      out.string.must_include "(line 3)"
+      out.string.must_include "wtf"
+      out.string.must_include "other_file"
+      out.string.must_include "(line 9)"
+
+      out.string.must_include "foo:1"
+      out.string.must_include "bar:2"
+    end
+  end
+end

data/test/spinach/reporter_test.rb

@@ -15,13 +15,15 @@ describe Spinach::Reporter do
         end
       end
     end
+
     describe "#step" do
       it "raises an error" do
         Proc.new{
-          @reporter.step("arbitrary name", :success)
+          @reporter.step("Given", "arbitrary name", :success)
         }.must_raise RuntimeError
       end
     end
+
     describe "#end" do
       it "raises an error" do
         Proc.new{
@@ -30,62 +32,5 @@ describe Spinach::Reporter do
       end
     end
   end
-  describe Spinach::Reporter::Stdout do
-    before do
-      @reporter = Spinach::Reporter::Stdout.new
-    end
-    describe "#feature" do
-      it "outputs a feature name" do
-        out = capture_stdout do
-          @reporter.feature "User authentication"
-        end
-        out.string.must_include "\nFeature: User authentication"
-      end
-    end
-    describe "#scenario" do
-      it "outputs a scenario name" do
-        out = capture_stdout do
-          @reporter.scenario "User logs in"
-        end
-        out.string.must_include "  Scenario: User logs in"
-      end
-    end
-    describe "#step" do
-      describe "when succeeding" do
-        it "outputs the step name" do
-          out = capture_stdout do
-            @reporter.step "Given I say goodbye", :success
-          end
-          out.string.must_include "✔"
-          out.string.must_include "Given I say goodbye"
-        end
-      end
-      describe "when failing" do
-        it "outputs the step name with a failure mark" do
-          out = capture_stdout do
-            @reporter.step "Given I say goodbye", :failure
-          end
-          out.string.must_include "✘"
-          out.string.must_include "Given I say goodbye"
-        end
-      end
-      describe "when skipping" do
-        it "outputs the step name with a failure mark" do
-          out = capture_stdout do
-            @reporter.step "Given I say nothing", :skip
-          end
-          out.string.must_include "~"
-          out.string.must_include "Given I say nothing"
-        end
-      end
-    end
-    describe "#end" do
-      it "outputs a blank line" do
-        out = capture_stdout do
-          @reporter.end
-        end
-        out.string.must_include "\n"
-      end
-    end
-  end
+
 end

data/test/spinach/runner/feature_test.rb

@@ -0,0 +1,108 @@
+require_relative '../../test_helper'
+
+describe Spinach::Runner::Feature do
+  before do
+    @filename = 'feature/a_cool_feature.feature'
+    @reporter = stub_everything
+    @feature = Spinach::Runner::Feature.new(@filename, @reporter)
+  end
+
+  describe '#initialize' do
+    it 'initializes the given filename' do
+      @feature.filename.must_equal @filename
+    end
+
+    it 'initializes the given reporter' do
+      @feature.reporter.must_equal @reporter
+    end
+
+    it 'initalizes the given scenario line' do
+      @filename = 'feature/a_cool_feature.feature:12'
+      @feature = Spinach::Runner::Feature.new(@filename, @reporter)
+
+      @feature.instance_variable_get(:@scenario_line).must_equal '12'
+    end
+  end
+
+  describe '#feature' do
+    it 'finds the feature given a feature name' do
+      feature = stub_everything
+      @feature.stubs(feature_name: 'A cool feature')
+      Spinach.expects(:find_feature).with('A cool feature').returns(feature)
+      @feature.feature
+    end
+  end
+
+  describe '#data' do
+    it 'returns the parsed data' do
+      parsed_data = {'name' => 'A cool feature'}
+      parser = stub(:parse => parsed_data)
+      Spinach::Parser.expects(:new).returns(parser)
+      @feature.data.must_equal parsed_data
+    end
+  end
+
+  describe '#scenarios' do
+    it 'returns the parsed scenarios' do
+      @feature.stubs(data: {'elements' => [1, 2, 3]})
+      @feature.scenarios.must_equal [1,2,3]
+    end
+  end
+
+  describe '#run' do
+    before do
+      @feature.stubs(data: {
+        'name' => 'A cool feature',
+        'elements' => [{'keyword'=>'Scenario', 'name'=>'Basic guess', 'line'=>6, 'description'=>'', 'type'=>'scenario'},
+                       {'keyword'=>'Scenario', 'name'=>'Basic guess II', 'line'=>12, 'description'=>'', 'type'=>'scenario'},
+                       {'keyword'=>'Scenario', 'name'=>'Basic guess III', 'line'=>18, 'description'=>'', 'type'=>'scenario'}]
+      })
+      @feature.stubs(feature: stub_everything)
+    end
+
+    it 'reports' do
+      Spinach::Runner::Scenario.stubs(new: stub_everything)
+
+      @reporter.expects(:feature).with('A cool feature')
+      @feature.run
+    end
+
+    it 'calls the steps as expected' do
+      seq = sequence('feature')
+      3.times do
+        @feature.feature.expects(:before).in_sequence(seq)
+        Spinach::Runner::Scenario.
+          expects(:new).
+          returns(stub_everything).
+          in_sequence(seq)
+        @feature.feature.expects(:after).in_sequence(seq)
+      end
+      @feature.run
+    end
+
+    it 'calls only the given scenario' do
+      @filename = 'feature/a_cool_feature.feature:12'
+      @feature = Spinach::Runner::Feature.new(@filename, @reporter)
+      @feature.stubs(data: {
+        'name' => 'A cool feature',
+        'elements' => [{'keyword'=>'Scenario', 'name'=>'Basic guess', 'line'=>6, 'description'=>'', 'type'=>'scenario'},
+                       {'keyword'=>'Scenario', 'name'=>'Basic guess II', 'line'=>12, 'description'=>'', 'type'=>'scenario'},
+                       {'keyword'=>'Scenario', 'name'=>'Basic guess III', 'line'=>18, 'description'=>'', 'type'=>'scenario'}]
+      })
+      @feature.stubs(feature: stub_everything)
+
+      Spinach::Runner::Scenario.expects(:new).with(anything, anything, @feature.scenarios[1], anything).once.returns(stub_everything)
+      @feature.run
+    end
+
+    it "calls an error summary if there are any failures" do
+      failure = stub('failure')
+      scenario = stub(run: failure)
+      Spinach::Runner::Scenario.stubs(:new).returns scenario
+
+      @reporter.expects(:error_summary).with [failure, failure, failure]
+
+      @feature.run
+    end
+  end
+end

data/test/spinach/runner/scenario_test.rb

@@ -0,0 +1,70 @@
+require_relative '../../test_helper'
+
+describe Spinach::Runner::Scenario do
+  before do
+    @data = {
+      'name' => 'A cool scenario',
+      'steps' => [
+        {'keyword' => 'Given', 'name' => 'I herd you like steps'},
+        {'keyword' => 'When', 'name' => 'I test steps'},
+        {'keyword' => 'Then', 'name' => 'I go step by step'}
+      ]
+    }
+    @feature = stub_everything
+    @feature_name = "My feature"
+    @reporter = stub_everything
+    @scenario = Spinach::Runner::Scenario.new(@feature_name, @feature, @data, @reporter)
+  end
+
+  describe '#initialize' do
+    it 'initializes a scenario name' do
+      @scenario.name.must_equal 'A cool scenario'
+    end
+
+    it 'lists all the steps' do
+      @scenario.steps.count.must_equal 3
+    end
+
+    it 'sets the reporter' do
+      @scenario.reporter.must_equal @reporter
+    end
+
+    it 'sets the feature' do
+      @scenario.feature.must_equal @feature
+    end
+  end
+
+  describe '#run' do
+    it 'calls the appropiate feature steps' do
+      @feature.expects(:execute_step).with('I herd you like steps')
+      @feature.expects(:execute_step).with('I test steps')
+      @feature.expects(:execute_step).with('I go step by step')
+      @scenario.run
+    end
+
+    describe 'rescues exceptions' do
+      it 'rescues a MiniTest::Assertion' do
+        @feature.expects(:execute_step).raises(MiniTest::Assertion)
+        @reporter.expects(:step).with(anything, anything, :failure)
+        @scenario.run
+      end
+
+      it 'rescues a Spinach::StepNotDefinedException' do
+        @feature.expects(:execute_step).raises(Spinach::StepNotDefinedException.new('foo', 'bar'))
+        @reporter.expects(:step).with(anything, anything, :undefined_step)
+        @scenario.run
+      end
+
+      it 'rescues any other error' do
+        @feature.expects(:execute_step).raises
+        @reporter.expects(:step).with(anything, anything, :error)
+        @scenario.run
+      end
+
+      it 'runs a step' do
+        @reporter.expects(:step).with(anything, anything, :success).times(3)
+        @scenario.run
+      end
+    end
+  end
+end