cucumber 0.3.96 → 0.3.97

data/lib/cucumber/formatter/tag_cloud.rb

@@ -1,6 +1,7 @@
 module Cucumber
   module Formatter
-    # Custom formatter that prints a tag cloud
+    # The formatter used for <tt>--format tag_cloud</tt>
+    # Custom formatter that prints a tag cloud as a table.
     class TagCloud < Cucumber::Ast::Visitor
       def initialize(step_mother, io, options)
         super(step_mother)

data/lib/cucumber/formatter/unicode.rb

@@ -12,7 +12,7 @@ if Cucumber::WINDOWS_MRI && `chcp` =~ /(\d+)/
     Cucumber::CODEPAGE = "cp#{codepage}"
   
     require 'iconv'
-    module Kernel
+    module Kernel #:nodoc:
       alias cucumber_print print
       def print(*a)
         begin

data/lib/cucumber/formatter/usage.rb

@@ -2,6 +2,7 @@ require 'cucumber/formatter/progress'
 
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format usage</tt>
     class Usage < Ast::Visitor
       include Console
 

data/lib/cucumber/language_support.rb

@@ -0,0 +1,30 @@
+module Cucumber
+  # This module defines the API for programming panguage support in Cucumber.
+  # While Cucumber itself is written in Ruby, any programming language can
+  # be supported by implementing this API.
+  #
+  # For the sake of illustration we'll consider an imaginary language called
+  # _why. _why files have the .why extension, so we need to put support for
+  # this language in the <tt>Cucumber::WhySupport::WhyLanguage</tt>. This
+  # class must be defined in a file called <tt>cucumber/why_support/why_language.rb</tt>
+  # and be available on Ruby's <tt>$LOAD_PATH</tt>:
+  #
+  #   module Cucumber
+  #     module WhySupport
+  #       class WhyLanguage
+  #
+  #         # Uses whatever available language bridge to load
+  #         # +why_file+ and returns an Array of StepDefinition.
+  #         def load_code_file(why_file)
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  # Each language implementation manages its own hooks, and must execute them
+  # at appropriate times.
+  #   
+  #
+  module LanguageSupport
+  end
+end

data/lib/cucumber/language_support/language_methods.rb

@@ -2,35 +2,57 @@ module Cucumber
   module LanguageSupport
     module LanguageMethods
       def before(scenario)
-        step_mother.begin_scenario
+        begin_scenario
         execute_before(scenario)
       end
 
       def after(scenario)
         execute_after(scenario)
-        step_mother.end_scenario
+        end_scenario
+      end
+
+      def execute_after_step(scenario)
+        hooks_for(:after_step, scenario).each do |hook|
+          invoke(hook, 'AfterStep', scenario, false)
+        end
+      end
+
+      def add_hook(phase, hook)
+        hooks[phase.to_sym] << hook
+        hook
+      end
+
+      def add_step_definition(step_definition)
+        step_definitions << step_definition
+        step_definition
+      end
+
+      def step_definitions
+        @step_definitions ||= []
+      end
+
+      def hooks_for(phase, scenario) #:nodoc:
+        hooks[phase.to_sym].select{|hook| scenario.accept_hook?(hook)}
+      end
+
+      private
+
+      def hooks
+        @hooks ||= Hash.new{|h,k| h[k] = []}
       end
 
       def execute_before(scenario)
-        step_mother.hooks_for(:before, scenario).each do |hook|
+        hooks_for(:before, scenario).each do |hook|
           invoke(hook, 'Before', scenario, true)
         end
       end
 
       def execute_after(scenario)
-        step_mother.hooks_for(:after, scenario).each do |hook|
+        hooks_for(:after, scenario).each do |hook|
           invoke(hook, 'After', scenario, true)
         end
       end
 
-      def execute_after_step(scenario)
-        step_mother.hooks_for(:after_step, scenario).each do |hook|
-          invoke(hook, 'AfterStep', scenario, false)
-        end
-      end
-
-      private
-
       def invoke(hook, location, scenario, exception_fails_scenario)
         begin
           hook.invoke(location, scenario)

data/lib/cucumber/parser/feature.rb

@@ -1,3 +1,6 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
 module Cucumber
   module Parser
     # TIP: When you hack on the grammar, just delete feature.rb in this directory.
@@ -17,7 +20,7 @@ module Cucumber
       end
 
       module FeatureSub1
-        def white
+        def white1
           elements[0]
         end
 
@@ -25,7 +28,7 @@ module Cucumber
           elements[1]
         end
 
-        def white
+        def white2
           elements[2]
         end
 
@@ -33,7 +36,7 @@ module Cucumber
           elements[3]
         end
 
-        def white
+        def white3
           elements[4]
         end
 
@@ -424,7 +427,7 @@ module Cucumber
 
       module CommentLine0
         def line_to_eol
-          elements[1]
+          elements[2]
         end
       end
 
@@ -437,17 +440,30 @@ module Cucumber
         end
 
         i0, s0 = index, []
-        if has_terminal?('#', false, index)
-          r1 = instantiate_node(SyntaxNode,input, index...(index + 1))
-          @index += 1
-        else
-          terminal_parse_failure('#')
-          r1 = nil
+        s1, i1 = [], index
+        loop do
+          r2 = _nt_space
+          if r2
+            s1 << r2
+          else
+            break
+          end
         end
+        r1 = instantiate_node(SyntaxNode,input, i1...index, s1)
         s0 << r1
         if r1
-          r2 = _nt_line_to_eol
-          s0 << r2
+          if has_terminal?('#', false, index)
+            r3 = instantiate_node(SyntaxNode,input, index...(index + 1))
+            @index += 1
+          else
+            terminal_parse_failure('#')
+            r3 = nil
+          end
+          s0 << r3
+          if r3
+            r4 = _nt_line_to_eol
+            s0 << r4
+          end
         end
         if s0.last
           r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
@@ -664,7 +680,7 @@ module Cucumber
           elements[1]
         end
 
-        def white
+        def white1
           elements[2]
         end
 
@@ -676,7 +692,7 @@ module Cucumber
           elements[5]
         end
 
-        def white
+        def white2
           elements[6]
         end
 
@@ -684,7 +700,7 @@ module Cucumber
           elements[7]
         end
 
-        def white
+        def white3
           elements[8]
         end
       end
@@ -798,7 +814,7 @@ module Cucumber
           elements[1]
         end
 
-        def white
+        def white1
           elements[2]
         end
 
@@ -810,7 +826,7 @@ module Cucumber
           elements[5]
         end
 
-        def white
+        def white2
           elements[6]
         end
 
@@ -822,7 +838,7 @@ module Cucumber
           elements[8]
         end
 
-        def white
+        def white3
           elements[9]
         end
       end
@@ -1154,24 +1170,28 @@ module Cucumber
       end
 
       module Examples0
+        def comment
+          elements[0]
+        end
+
         def examples_keyword
-          elements[1]
+          elements[2]
         end
 
         def name
-          elements[3]
+          elements[4]
         end
 
         def eol
-          elements[4]
+          elements[5]
         end
 
         def table
-          elements[5]
+          elements[6]
         end
 
         def white
-          elements[6]
+          elements[7]
         end
       end
 
@@ -1198,7 +1218,7 @@ module Cucumber
         end
 
         def build(filter, scenario_outline)
-          [examples_keyword.line, examples_keyword.text_value, name.build, table.raw(filter, scenario_outline)]
+          [comment.build, examples_keyword.line, examples_keyword.text_value, name.build, table.raw(filter, scenario_outline)]
         end
       end
 
@@ -1211,49 +1231,53 @@ module Cucumber
         end
 
         i0, s0 = index, []
-        s1, i1 = [], index
-        loop do
-          r2 = _nt_space
-          if r2
-            s1 << r2
-          else
-            break
-          end
-        end
-        r1 = instantiate_node(SyntaxNode,input, i1...index, s1)
+        r1 = _nt_comment
         s0 << r1
         if r1
-          r3 = _nt_examples_keyword
-          s0 << r3
-          if r3
-            s4, i4 = [], index
-            loop do
-              r5 = _nt_space
-              if r5
-                s4 << r5
-              else
-                break
-              end
+          s2, i2 = [], index
+          loop do
+            r3 = _nt_space
+            if r3
+              s2 << r3
+            else
+              break
             end
-            r4 = instantiate_node(SyntaxNode,input, i4...index, s4)
+          end
+          r2 = instantiate_node(SyntaxNode,input, i2...index, s2)
+          s0 << r2
+          if r2
+            r4 = _nt_examples_keyword
             s0 << r4
             if r4
-              r7 = _nt_lines_to_keyword
-              if r7
-                r6 = r7
-              else
-                r6 = instantiate_node(SyntaxNode,input, index...index)
+              s5, i5 = [], index
+              loop do
+                r6 = _nt_space
+                if r6
+                  s5 << r6
+                else
+                  break
+                end
               end
-              s0 << r6
-              if r6
-                r8 = _nt_eol
-                s0 << r8
+              r5 = instantiate_node(SyntaxNode,input, i5...index, s5)
+              s0 << r5
+              if r5
+                r8 = _nt_lines_to_keyword
                 if r8
-                  r9 = _nt_table
+                  r7 = r8
+                else
+                  r7 = instantiate_node(SyntaxNode,input, index...index)
+                end
+                s0 << r7
+                if r7
+                  r9 = _nt_eol
                   s0 << r9
                   if r9
-                    r10 = _nt_white
+                    r10 = _nt_table
                     s0 << r10
+                    if r10
+                      r11 = _nt_white
+                      s0 << r11
+                    end
                   end
                 end
               end

data/lib/cucumber/parser/feature.tt

@@ -78,7 +78,7 @@ module Cucumber
       end
 
       rule comment_line
-        '#' line_to_eol
+        space* '#' line_to_eol
       end
 
       rule background
@@ -262,7 +262,7 @@ module Cucumber
       end
 
       rule examples
-        space* examples_keyword space* name:lines_to_keyword? eol table white {
+        comment space* examples_keyword space* name:lines_to_keyword? eol table white {
           def at_line?(line)
             examples_keyword.line == line ||
             table.at_line?(line)
@@ -285,7 +285,7 @@ module Cucumber
           end
 
           def build(filter, scenario_outline)
-            [examples_keyword.line, examples_keyword.text_value, name.build, table.raw(filter, scenario_outline)]
+            [comment.build, examples_keyword.line, examples_keyword.text_value, name.build, table.raw(filter, scenario_outline)]
           end
         }
       end

data/lib/cucumber/parser/natural_language.rb

@@ -22,7 +22,7 @@ module Cucumber
 
       def register_adverbs(step_mother)
         adverbs = %w{given when then and but}.map{|keyword| @keywords[keyword].split('|').map{|w| w.gsub(/\s/, '')}}.flatten
-        step_mother.register_adverbs(adverbs)
+        step_mother.register_adverbs(adverbs) if step_mother
       end
 
       def parser

data/lib/cucumber/parser/table.rb

@@ -1,3 +1,6 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
 module Cucumber
   module Parser
     # TIP: When you hack on the grammar, just delete feature.rb in this directory.

data/lib/cucumber/parser/treetop_ext.rb

@@ -12,6 +12,7 @@ end
 
 module Cucumber
   module Parser
+    # Raised if Cucumber fails to parse a feature file
     class SyntaxError < StandardError
       def initialize(parser, file, line_offset)
         tf = parser.terminal_failures
@@ -22,7 +23,7 @@ module Cucumber
       end
     end
     
-    module TreetopExt
+    module TreetopExt #:nodoc:
       def parse_or_fail(source, file=nil, filter=nil, line_offset=0)
         parse_tree = parse(source)
         if parse_tree.nil?
@@ -37,15 +38,15 @@ module Cucumber
   end
 end
 
-module Treetop
-  module Runtime
-    class SyntaxNode
+module Treetop #:nodoc:
+  module Runtime #:nodoc:
+    class SyntaxNode #:nodoc:
       def line
         input.line_of(interval.first)
       end
     end
 
-    class CompiledParser
+    class CompiledParser #:nodoc:
       include Cucumber::Parser::TreetopExt
     end
   end