cucumber 0.1.7 → 0.1.8

data/lib/cucumber.rb

@@ -6,6 +6,7 @@ require 'treetop/ruby_extensions'
 require 'cucumber/version'
 require 'cucumber/step_methods'
 require 'cucumber/tree'
+require 'cucumber/model'
 require 'cucumber/executor'
 require 'cucumber/step_mother'
 require 'cucumber/formatters'

data/lib/cucumber/cli.rb

@@ -23,7 +23,7 @@ module Cucumber
     end
     
     attr_reader :options
-    FORMATS = %w{pretty progress html}
+    FORMATS = %w{pretty profile progress html}
 
     def initialize
       @paths = []
@@ -33,7 +33,14 @@ module Cucumber
       return parse_args_from_profile('default') if args.empty?
       args.extend(OptionParser::Arguable)
 
-      @options ||= { :require => nil, :lang => 'en', :format => 'pretty', :dry_run => false, :source => true }
+      @options ||= { 
+        :require => nil, 
+        :lang    => 'en', 
+        :format  => 'pretty', 
+        :dry_run => false, 
+        :source  => true,
+        :out     => STDOUT
+      }
       args.options do |opts|
         opts.banner = "Usage: cucumber [options] FILES|DIRS"
         opts.on("-r LIBRARY|DIR", "--require LIBRARY|DIR", "Require files before executing the features.",
@@ -68,6 +75,9 @@ module Cucumber
         opts.on("-n", "--no-source", "Don't show the file and line of the step definition with the steps.") do
           @options[:source] = false
         end
+        opts.on("-o", "--out=FILE", "Write output to a file instead of STDOUT.") do |v|
+          @options[:out] = File.open(v, 'w')
+        end
         opts.on_tail("--version", "Show version") do
           puts VERSION::STRING
           exit
@@ -145,11 +155,15 @@ module Cucumber
     def formatter(step_mother)
       case @options[:format]
       when 'pretty'
-        Formatters::PrettyFormatter.new(STDOUT, step_mother, @options)
+        Formatters::PrettyFormatter.new(@options[:out], step_mother, @options)
       when 'progress'
-        Formatters::ProgressFormatter.new(STDOUT)
+        Formatters::ProgressFormatter.new(@options[:out])
+       when 'profile'
+        Formatters::ProfileFormatter.new(@options[:out], step_mother)
       when 'html'
-        Formatters::HtmlFormatter.new(STDOUT, step_mother)
+        Formatters::HtmlFormatter.new(@options[:out], step_mother)
+      else
+        raise "Unknown formatter: #{@options[:format]}"
       end
     end
     

data/lib/cucumber/core_ext/proc.rb

@@ -24,16 +24,19 @@ module Cucumber
       end
 
       def to_backtrace_line
-        "#{file}:in `#{name}'"
+        "#{file_colon_line}:in `#{name}'"
       end
       
       def to_comment_line
-        "# #{file}"
+        "# #{file_colon_line}"
       end
       
-      def file
-        file = to_s.match(/[\d\w]+@(.*)>/)[1]
-        file =~ /^\.\/(.*)/ ? $1 : file
+      def file_colon_line
+        path, line = *to_s.match(/[\d\w]+@(.*):(.*)>/)[1..2]
+        path = File.expand_path(path)
+        pwd = Dir.pwd
+        path = path[pwd.length+1..-1]        
+        "#{path}:#{line}"
       end
 
       def meth

data/lib/cucumber/executor.rb

@@ -46,6 +46,7 @@ module Cucumber
     end
 
     def visit_feature(feature)
+      formatter.visit_feature(feature) if formatter.respond_to?(:visit_feature)
       feature.accept(self)
     end
 
@@ -62,7 +63,7 @@ module Cucumber
     end
 
     def visit_scenario(scenario)
-      if @line.nil? || scenario.at_line?(@line)
+      if accept?(scenario)
         @error = nil
         @pending = nil
 
@@ -77,6 +78,10 @@ module Cucumber
         formatter.scenario_executed(scenario) if formatter.respond_to?(:scenario_executed)
       end
     end
+    
+    def accept?(scenario)
+      @line.nil? || scenario.at_line?(@line)
+    end
 
     def visit_row_step(step)
       visit_step(step)
@@ -90,6 +95,7 @@ module Cucumber
       unless @pending || @error
         begin
           regexp, args, proc = step.regexp_args_proc(@step_mother)
+          formatter.step_executing(step, regexp, args) if formatter.respond_to?(:step_executing)
           step.execute_in(@world, regexp, args, proc)
           @after_step_procs.each{|p| p.call_in(@world, *[])}
           formatter.step_passed(step, regexp, args)

data/lib/cucumber/formatters.rb

@@ -1 +1 @@
-%w{html pretty progress}.each{|n| require "cucumber/formatters/#{n}_formatter"}
+%w{html pretty progress profile}.each{|n| require "cucumber/formatters/#{n}_formatter"}

data/lib/cucumber/formatters/html_formatter.rb

@@ -5,6 +5,7 @@ module Cucumber
         @io = io
         @step_mother = step_mother
         @errors = []
+        @scenario_table_header = []
       end
 
       def visit_features(features)
@@ -52,6 +53,7 @@ HTML
       end
 
       def visit_regular_scenario(scenario)
+        @scenario_table_header = scenario.table_header
         @io.puts %{          <dl class="new">}
         @io.puts %{            <dt>#{Cucumber.language['scenario']}: #{scenario.name}</dt>}
         @io.puts %{            <dd>}
@@ -66,11 +68,12 @@ HTML
         @io.puts %{          <dl class="new">}
         @io.puts %{            <dt>#{Cucumber.language['scenario']}: #{scenario.name}</dt>}
         @io.puts %{            <dd>}
-        @io.puts %{              <table>}
+        @io.puts %{              <table cellpadding="3">}
         @io.puts %{                <thead>}
         @io.puts %{                  <tr>}
-        @io.puts %{                    <th>COL 1</th>}
-        @io.puts %{                    <th>COL 2</th>}
+        @scenario_table_header.each do |column_header|
+          @io.puts %{                    <th>#{column_header}</th>}
+        end
         @io.puts %{                  </tr>}
         @io.puts %{                </thead>}
         @io.puts %{                <tbody>}

data/lib/cucumber/formatters/pretty_formatter.rb

@@ -17,12 +17,24 @@ module Cucumber
         @pending = []
         @skipped = []
       end
-    
+ 
+      def visit_feature(feature)
+        @feature = feature
+      end
+ 
       def header_executing(header)
         @io.puts if @feature_newline
         @feature_newline = true
-        @io.puts passed(header)
-        @io.puts
+
+        header_lines = header.split("\n")
+        header_lines.each_with_index do |line, index|
+          @io.print line
+          if @options[:source] && index==0
+            @io.print padding_spaces(@feature)
+            @io.print comment("# #{@feature.file}") 
+          end
+          @io.puts
+        end
       end
   
       def scenario_executing(scenario)
@@ -30,7 +42,12 @@ module Cucumber
         if scenario.row?
           @io.print "    |"
         else
-          @io.puts passed("  #{Cucumber.language['scenario']}: #{scenario.name}")
+          @io.print passed("  #{Cucumber.language['scenario']}: #{scenario.name}")
+          if @options[:source]
+            @io.print padding_spaces(scenario)
+            @io.print comment("# #{scenario.file}:#{scenario.line}")
+          end
+          @io.puts
         end
       end
 
@@ -99,7 +116,12 @@ module Cucumber
           args.each{|arg| @io.print pending(arg) ; @io.print "|"}
         else
           @pending << step
-          @io.puts pending("    #{step.keyword} #{step.name}")
+          @io.print pending("    #{step.keyword} #{step.name}")
+          if @options[:source]
+            @io.print padding_spaces(step)
+            @io.print comment("# #{step.file}:#{step.line}")
+          end
+          @io.puts
         end
       end
       
@@ -147,8 +169,8 @@ module Cucumber
         comment(proc.to_comment_line)
       end
       
-      def padding_spaces(step)
-        " " * step.padding_length
+      def padding_spaces(tree_item)
+        " " * tree_item.padding_length
       end
     end
   end

data/lib/cucumber/formatters/profile_formatter.rb

@@ -0,0 +1,92 @@
+module Cucumber
+  module Formatters
+    class ProfileFormatter < ProgressFormatter
+      NUMBER_OF_STEP_DEFINITONS_TO_SHOW = 10
+      NUMBER_OF_STEP_INVOCATIONS_TO_SHOW = 5
+
+      def initialize(io, step_mother)
+        super(io)
+        @step_mother = step_mother
+        @step_times = Hash.new { |k,v| k[v] = [] }
+        @step_keywords = {}
+      end
+
+      def visit_features(features)
+        @io.puts "Profiling enabled.\n"
+      end
+
+      def step_executing(step, regexp, args)
+        @step_time = Time.now
+      end
+
+      def step_passed(step, regexp, args)
+        execution_time = Time.now - @step_time
+        super
+        @step_keywords[regexp] ||= step.actual_keyword unless step.row?
+        invocation_comment = ''
+        definition_comment = ''
+
+        if step.row?
+          description = ''
+          args.each do |arg|
+            description +=  %{|#{arg}|}
+          end
+        else
+          description = "#{step.keyword} #{step.format(regexp){|param| underline(param)}}"
+          definition_comment = source(step)
+        end
+        invocation_comment = "# #{step.file}:#{step.line}"
+        @step_times["#{@step_keywords[regexp]} #{regexp.inspect}"] << [description, invocation_comment, definition_comment, execution_time]
+      end
+
+      def dump
+        super
+        @io.puts "\n\nTop #{NUMBER_OF_STEP_DEFINITONS_TO_SHOW} average slowest steps with #{NUMBER_OF_STEP_INVOCATIONS_TO_SHOW} slowest matches:\n"
+
+        mean_times = map_to_mean_times(@step_times)
+        mean_times = mean_times.sort_by { |step_profiles, keyword_regexp, mean_execution_time| mean_execution_time }.reverse
+
+        mean_times[0...NUMBER_OF_STEP_DEFINITONS_TO_SHOW].each do |step_profiles, keyword_regexp, mean_execution_time|
+          print_step_definition(step_profiles, keyword_regexp, mean_execution_time)
+          step_profiles = step_profiles.sort_by { |description, invocation_comment, definition_comment, execution_time| execution_time }.reverse
+          print_step_invocations(step_profiles, keyword_regexp)
+        end
+      end
+
+      private
+      def map_to_mean_times(step_times)
+        mean_times = []
+        step_times.each do |regexp, step_profiles|
+          mean_execution_time = (step_profiles.inject(0) { |sum, step_details| step_details[3] + sum } / step_profiles.length)
+          mean_times << [step_profiles, regexp, mean_execution_time]
+        end
+        mean_times
+      end
+
+      def print_step_definition(step_profiles, keyword_regexp, mean_execution_time)
+        unless step_profiles.empty?
+          _, _, definition_comment, _ = step_profiles.first
+          @io.print red(sprintf("%.7f",  mean_execution_time))
+          @io.print "  #{keyword_regexp}"
+          @io.print "  #{comment(definition_comment)}"
+          @io.puts
+        end
+      end
+
+      def print_step_invocations(step_profiles, keyword_regexp)
+        step_profiles[0...NUMBER_OF_STEP_INVOCATIONS_TO_SHOW].each do |description, invocation_comment, definition_comment, execution_time|
+          @io.print "  #{yellow(sprintf("%.7f", execution_time))}"
+          @io.print "  #{description}"
+          @io.print "  #{comment(invocation_comment)}"
+          @io.puts
+        end
+      end
+
+      def source(step)
+        _, _, proc = step.regexp_args_proc(@step_mother)
+        proc.to_comment_line
+      end
+
+    end
+  end
+end

data/lib/cucumber/languages.yml

@@ -1,6 +1,21 @@
 # http://en.wikipedia.org/wiki/IETF_language_tag
 # http://www.iana.org/assignments/language-subtag-registry
 # http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt (Use this I think)
+"en":
+  feature: Feature
+  scenario: Scenario
+  more_examples: More Examples
+  given_scenario: GivenScenario
+  given: Given
+  when: When
+  then: Then
+  and: And
+  but: But
+# Please help us keeping the languages below uptodate. The parsers for a language 
+# that is missing a keyword will expect the English word until the missing word(s)
+# are added.
+#
+# Please keep the grammars in alphabetical order from here and down.
 "da":
   feature: Egenskab
   scenario: Scenarie
@@ -19,18 +34,10 @@
   then: Dann
   and: Und
   but: Aber
-"en":
-  feature: Feature
-  scenario: Scenario
-  given_scenario: GivenScenario
-  given: Given
-  when: When
-  then: Then
-  and: And
-  but: But
 "es":
   feature: Característica
   scenario: Escenario
+  more_examples: Más ejemplos
   given_scenario: DadoElEscenario
   given: Dado
   when: Cuando
@@ -40,15 +47,27 @@
 "fr":
   feature: Fonction
   scenario: Scenario
+  more_examples: Plus d'exemples
   given_scenario: SoitScenario
   given: Soit
   when: Lorsque
   then: Alors
   and: Et
   but: Mais
+"nl":
+  feature: Functionaliteit
+  scenario: Scenario
+  more_examples: Meer voorbeelden
+  given_scenario: GegevenScenario
+  given: Gegeven
+  when: Als
+  then: Dan
+  and: En
+  but: Maar
 "no":
   feature: Egenskap
   scenario: Scenario
+  more_examples: Flere eksempler
   given_scenario: GittScenario
   given: Gitt
   when: Når
@@ -76,9 +95,9 @@
 "se":
   feature: Egenskap
   scenario: Scenario
-  given_scenario: GittScenario
-  given: Gitt
-  when: Når
+  given_scenario: GivetScenario
+  given: Givet
+  when: När
   then: Så
   and: Och
   but: Men
@@ -91,3 +110,11 @@
   then: Siis
   and: Ja
   but: Kuid
+"zh-CN":
+  scenario: 场景
+  given_scenario: 引用场景
+  given: 假如
+  when: 当
+  then: 那么
+  and: 而且
+  but: 但是

data/lib/cucumber/model.rb

@@ -0,0 +1 @@
+%w{table}.each{|f| require "cucumber/model/#{f}"}

data/lib/cucumber/model/table.rb

@@ -0,0 +1,28 @@
+module Cucumber
+  module Model
+    class Table
+      attr_accessor :raw
+      
+      # Creates a new table. The +raw+ argument should be an array
+      # of arrays
+      def initialize(raw)
+        @raw = raw
+      end
+      
+      # Turn the table into an array of Hash where each Hash
+      # has keys corresponding to the table header (first line)
+      # and the values are the individual row cells.
+      def hashes
+        header = @raw[0]
+        @raw[1..-1].map do |row|
+          h = {}
+          row.each_with_index do |v,n|
+            key = header[n]
+            h[key] = v
+          end
+          h
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/rails/world.rb

@@ -22,7 +22,7 @@ Dispatcher.class_eval do
 end
 
 # So that Test::Unit doesn't launch at the end - makes it think it has already been run.
-Test::Unit.run = true
+Test::Unit.run = true if Test::Unit.respond_to?(:run=)
 
 $main = self
 
@@ -71,5 +71,3 @@ end
 World do
   Cucumber::Rails::World.new
 end
-
-ActionMailer::Base.delivery_method = :test if defined?(ActionMailer::Base)