turnip 1.0.0 → 1.1.0

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+bundler_stubs
 Gemfile.lock
 pkg/*
 .rvmrc

data/.travis.yml

@@ -3,4 +3,7 @@ rvm:
  - 1.9.3
  - ruby-head
  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
 

data/README.md

@@ -1,6 +1,7 @@
 # Turnip
 
 [![Build Status](https://secure.travis-ci.org/jnicklas/turnip.png)](http://travis-ci.org/jnicklas/turnip)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jnicklas/turnip)
 
 Turnip is a [Gherkin](https://github.com/cucumber/cucumber/wiki/Gherkin)
 extension for RSpec. It allows you to write tests in Gherkin and run them
@@ -206,6 +207,11 @@ you were to put your steps in `spec/steps`, you could load them like this:
 Dir.glob("spec/steps/**/*steps.rb") { |f| load f, true }
 ```
 
+Before loading your `spec_helper`, Turnip also tries to load a file called
+`turnip_helper` where you can setup anything specific to your turnip examples.
+You might find it beneficial to load your steps from this file so that they
+don't have to be loaded when you run your other tests.
+
 ### Calling steps from other steps
 
 Since steps are Ruby methods you can call them like other Ruby methods.
@@ -238,36 +244,20 @@ step "the value is the magic number"
 end
 ```
 
-### Calling steps manually
-
-This is a more esoteric feature of Turnip, of use mostly to people who want to
-do crazy stuff. You can use `send` to call any Turnip step, no matter where it
-is defined or included. Additionally, the `Turnip::Execute` module has a method
-called `step`, this method executes a step, given a string as it might appear
-in a feature file. This is the same `step` method you used above to call steps
-from within other steps.
+### Methods as steps
 
-For example:
+You can mark an existing method as a step. This will make it available in your
+Turnip features. For example:
 
 ``` ruby
-class Monster
-  include Turnip::Execute
-
-  step("sing a song") { "Arrrghghggh" }
-  step("eat :count villager(s)") { Villager.eat(count) }
+module MonsterSteps
+  def create_monster(name)
+    @monster = Monster.new(:name => name)
+  end
+  step :create_monster, "there is a monster called :name"
 end
-
-monster = Monster.new
-monster.step("sing a song")
-monster.step("eat 1 villager")
-monster.step("eat 5 villagers")
-monster.send("eat :count villager(s)", 5)
 ```
 
-Note that in this case `step` from `Turnip::Execute` is an *instance* method,
-whereas `step` used to define the step is a *class* method, they are *not* the
-same method.
-
 ## Custom step placeholders
 
 Do you want to be more specific in what to match in your step placeholders? Do

data/examples/scenario_outline_table_substitution.feature

@@ -0,0 +1,12 @@
+Feature: using scenario outlines
+  Scenario Outline: a simple outline
+    Given there is a monster with hitpoints:
+      | hit_points |
+      | <hp>       |
+   When I attack the monster and do <damage> points damage
+    Then the monster should be <state>
+
+    Examples:
+      | hp   | damage | state   |
+      | 10   | 13     | dead    |
+      | 8    | 5      | alive   |

data/lib/turnip.rb

@@ -24,7 +24,7 @@ module Turnip
   end
 end
 
-Turnip.type = :turnip
+Turnip.type = :feature
 
 Module.send(:include, Turnip::Define)
 

data/lib/turnip/builder.rb

@@ -81,12 +81,22 @@ module Turnip
         rows.map do |row|
           Scenario.new(@raw).tap do |scenario|
             scenario.steps = steps.map do |step|
-              new_description = step.description.gsub(/<([^>]*)>/) { |_| Hash[headers.zip(row)][$1] }
-              Step.new(new_description, step.extra_args, step.line)
+              new_description = substitute(step.description, headers, row)
+              new_extra_args = step.extra_args.map do |ea|
+                next ea unless ea.instance_of?(Turnip::Table)
+                Turnip::Table.new(ea.map {|t_row| t_row.map {|t_col| substitute(t_col, headers, row) } })
+              end
+              Step.new(new_description, new_extra_args, step.line)
             end
           end
         end
       end
+
+      private
+
+      def substitute(text, headers, row)
+        text.gsub(/<([^>]*)>/) { |_| Hash[headers.zip(row)][$1] }
+      end
     end
 
     class Step < Struct.new(:description, :extra_args, :line)
@@ -106,7 +116,7 @@ module Turnip
       def build(feature_file)
         Turnip::Builder.new.tap do |builder|
           parser = Gherkin::Parser::Parser.new(builder, true)
-          parser.parse(File.read(feature_file), nil, 0)
+          parser.parse(File.read(feature_file), feature_file, 0)
         end
       end
     end

data/lib/turnip/capybara.rb

@@ -1,7 +1,5 @@
 require 'capybara/rspec'
 
-Turnip.type = :request
-
 RSpec.configure do |config|
   config.before do
     if self.class.include?(Capybara::DSL) and example.metadata[:turnip]

data/lib/turnip/define.rb

@@ -1,9 +1,12 @@
 module Turnip
   module Define
-    def step(expression, &block)
-      step = Turnip::StepDefinition.new(expression, &block)
+    def step(method_name=nil, expression, &block)
+      if method_name and block
+        raise ArgumentError, "can't specify both method name and a block for a step"
+      end
+      step = Turnip::StepDefinition.new(expression, method_name, caller.first, &block)
       send(:define_method, "match: #{expression}") { |description| step.match(description) }
-      send(:define_method, expression, &block)
+      send(:define_method, expression, &block) if block
     end
   end
 end

data/lib/turnip/execute.rb

@@ -7,9 +7,17 @@ module Turnip
         next unless method.to_s.start_with?("match: ")
         send(method.to_s, description.to_s)
       end.compact
-      raise Turnip::Pending, description if matches.length == 0
-      raise Turnip::Ambiguous, description if matches.length > 1
-      send(matches.first.expression, *(matches.first.params + extra_args))
+
+      if matches.length == 0
+        raise Turnip::Pending, description
+      end
+
+      if matches.length > 1
+        msg = ['Ambiguous step definitions'].concat(matches.map(&:trace)).join("\r\n")
+        raise Turnip::Ambiguous, msg
+      end
+
+      send(matches.first.method_name, *(matches.first.params + extra_args))
     end
   end
 end

data/lib/turnip/rspec.rb

@@ -12,15 +12,23 @@ module Turnip
     module Loader
       def load(*a, &b)
         if a.first.end_with?('.feature')
-          begin
-            require 'spec_helper'
-          rescue LoadError
-          end
+          require_if_exists 'turnip_helper'
+          require_if_exists 'spec_helper'
+
           Turnip::RSpec.run(a.first)
         else
           super
         end
       end
+
+      private
+
+      def require_if_exists(filename)
+        require filename
+      rescue LoadError => e
+        # Don't hide LoadErrors raised in the spec helper.
+        raise unless e.message.include?(filename)
+      end
     end
 
     ##
@@ -74,7 +82,7 @@ end
 ::RSpec::Core::Configuration.send(:include, Turnip::RSpec::Loader)
 
 ::RSpec.configure do |config|
-  config.include Turnip::RSpec::Execute
-  config.include Turnip::Steps
+  config.include Turnip::RSpec::Execute, turnip: true
+  config.include Turnip::Steps, turnip: true
   config.pattern << ",**/*.feature"
 end

data/lib/turnip/step_definition.rb

@@ -2,12 +2,20 @@ module Turnip
   class StepDefinition
     class Match < Struct.new(:step_definition, :params, :block)
       def expression; step_definition.expression; end
+      def method_name; step_definition.method_name; end
+      def called_from; step_definition.called_from; end
+
+      def trace
+        trace = %{  - "#{expression}" (#{called_from})}
+      end
     end
 
-    attr_reader :expression, :block
+    attr_reader :expression, :block, :method_name, :called_from
 
-    def initialize(expression, &block)
+    def initialize(expression, method_name=nil, called_from=nil, &block)
       @expression = expression
+      @method_name = method_name || expression
+      @called_from = called_from
       @block = block
     end
 

data/lib/turnip/version.rb

@@ -1,3 +1,3 @@
 module Turnip
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/builder_spec.rb

@@ -27,4 +27,23 @@ describe Turnip::Builder do
       ])
     end
   end
+
+  context "with example tables in scenario outlines" do
+    let(:feature_file) { File.expand_path('../examples/scenario_outline_table_substitution.feature', File.dirname(__FILE__)) }
+    let(:builder) { Turnip::Builder.build(feature_file) }
+    let(:feature) { builder.features.first }
+
+    it "replaces placeholders in tables in steps" do
+      feature.scenarios[0].steps.map(&:description).should eq([
+        "there is a monster with hitpoints:",
+        "I attack the monster and do 13 points damage",
+        "the monster should be dead"
+      ])
+      table = feature.scenarios[0].steps[0].extra_args.find {|a| a.instance_of?(Turnip::Table)}
+      table.hashes[0]['hit_points'].should == '10'
+      table = feature.scenarios[1].steps[0].extra_args.find {|a| a.instance_of?(Turnip::Table)}
+      table.hashes[0]['hit_points'].should == '8'
+    end
+
+  end
 end

data/spec/{define_and_execute.rb → define_and_execute_spec.rb}

@@ -19,6 +19,22 @@ describe Turnip::Execute do
     obj.send("a :test step", "cool").should == "COOL"
   end
 
+  it "can use an existing method as a step" do
+    mod.module_eval do
+      def a_test_step(test)
+        test.upcase
+      end
+    end
+    mod.step(:a_test_step, "a :test step")
+    obj.step("a cool step").should == "COOL"
+  end
+
+  it "raises an argument error when both method name and block given" do
+    expect do
+      mod.step(:a_test_step, "a :test step") { "foo" }
+    end.to raise_error(ArgumentError)
+  end
+
   it "sends in extra arg from a builder step" do
     mod.step("a :test step") { |test, foo| test.upcase + foo }
     obj.step("a cool step", "foo").should == "COOLfoo"
@@ -35,4 +51,20 @@ describe Turnip::Execute do
     mod.step("a :test step") { |test, foo| test.upcase + foo }
     obj.step(builder_step).should == "COOLfoo"
   end
+
+  it "defines ambiguous steps and run a matching step" do
+    mod.step("an ambiguous step") {}
+    mod.step("an :ambiguous step") {}
+    expect {
+      obj.step("an ambiguous step")
+    }.to raise_error(Turnip::Ambiguous)
+  end
+
+  it "shows useful information on the ambiguous steps" do
+    mod.step("an ambiguous step") {}
+    mod.step("an :ambiguous step") {}
+    expect {
+      obj.step("an ambiguous step")
+    }.to raise_error(Turnip::Ambiguous, %r{(ambiguous).*(define_and_execute_spec.rb)})
+  end
 end

data/spec/integration_spec.rb

@@ -11,7 +11,7 @@ describe 'The CLI', :type => :integration do
   end
 
   it "prints out failures and successes" do
-    @result.should include('33 examples, 3 failures, 3 pending')
+    @result.should include('35 examples, 3 failures, 5 pending')
   end
 
   it "includes features in backtraces" do

data/spec/step_definition_spec.rb

@@ -1,3 +1,5 @@
+require "spec_helper"
+
 describe Turnip::StepDefinition do
   let(:all_steps) { [] }
 
@@ -31,9 +33,11 @@ describe Turnip::StepDefinition do
 
     it "can reuse the same custom placeholder multiple times" do
       Turnip::Placeholder.stub(:resolve).with(:count).and_return(/\d+/)
+      Turnip::Placeholder.stub(:apply).with(:count, "3").and_return(3)
+      Turnip::Placeholder.stub(:apply).with(:count, "2").and_return(2)
       step = Turnip::StepDefinition.new(":count monsters and :count knights") {}
       match = step.match("3 monsters and 2 knights")
-      match.params.should eq(["3", "2"])
+      match.params.should eq([3, 2])
     end
 
     it "does search for the same custom placeholder several times" do

data/spec/table_spec.rb

@@ -8,6 +8,11 @@ describe Turnip::Table do
     it 'returns the raw table' do
       table.raw.should == [['foo', 'bar'], ['quox', '42']]
     end
+
+    it 'reflects changes in the raw table' do
+      table.raw[1][1] = '55'
+      table.raw.should == [['foo', 'bar'], ['quox', '55']]
+    end
   end
 
   describe '#to_a' do
@@ -71,4 +76,5 @@ describe Turnip::Table do
       table.map(&:first).should == ['moo', 'quox']
     end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turnip
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153019360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153019360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2153018640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '2.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2153018640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153018120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153018120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides the ability to define steps and run Gherkin files from with
   RSpec
 email:
@@ -66,6 +81,7 @@ files:
 - examples/multiline_string.feature
 - examples/pending.feature
 - examples/scenario_outline.feature
+- examples/scenario_outline_table_substitution.feature
 - examples/simple_feature.feature
 - examples/step_calling.feature
 - examples/steps/alignment_steps.rb
@@ -95,7 +111,7 @@ files:
 - lib/turnip/table.rb
 - lib/turnip/version.rb
 - spec/builder_spec.rb
-- spec/define_and_execute.rb
+- spec/define_and_execute_spec.rb
 - spec/dsl_spec.rb
 - spec/integration_spec.rb
 - spec/placeholder_spec.rb
@@ -123,13 +139,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: turnip
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Gherkin extension for RSpec
 test_files:
 - spec/builder_spec.rb
-- spec/define_and_execute.rb
+- spec/define_and_execute_spec.rb
 - spec/dsl_spec.rb
 - spec/integration_spec.rb
 - spec/placeholder_spec.rb