cucumber 0.1.16 → 0.2.0

data/lib/cucumber/ast/scenario.rb

@@ -0,0 +1,64 @@
+require 'cucumber/ast/feature_element'
+
+module Cucumber
+  module Ast
+    class Scenario
+      include FeatureElement
+      
+      def initialize(background, comment, tags, line, keyword, name, steps)
+        @background, @comment, @tags, @line, @keyword, @name = background, comment, tags, line, keyword, name
+        attach_steps(steps)
+        
+        step_invocations = steps.map{|step| step.step_invocation}
+        if @background
+          @steps = @background.step_collection(step_invocations)
+        else
+          @steps = StepCollection.new(step_invocations)
+        end
+      end
+
+      def feature=(feature)
+        @feature = feature
+        @background.feature = feature if @background
+      end
+
+      def descend?(visitor)
+        visitor.matches_lines?(self) &&
+        visitor.included_by_tags?(self) &&
+        !visitor.excluded_by_tags?(self) &&
+        visitor.matches_scenario_names?(self)
+      end
+
+      def accept(visitor)
+        visitor.visit_comment(@comment)
+        visitor.visit_tags(@tags)
+        visitor.visit_scenario_name(@keyword, @name, file_colon_line(@line), source_indent(text_length))
+
+        skip = @background && @background.failed?
+        skip_invoke! if skip
+        visitor.step_mother.before_and_after(self, skip) do
+          visitor.visit_steps(@steps)
+        end
+      end
+
+      def skip_invoke!
+        @steps.each{|step_invocation| step_invocation.skip_invoke!}
+        @feature.next_feature_element(self) do |next_one|
+          next_one.skip_invoke!
+        end
+      end
+
+      def to_sexp
+        sexp = [:scenario, @line, @keyword, @name]
+        comment = @comment.to_sexp
+        sexp += [comment] if comment
+        tags = @tags.to_sexp
+        sexp += tags if tags.any?
+        steps = @steps.to_sexp
+        sexp += steps if steps.any?
+        sexp
+      end
+
+    end
+  end
+end

data/lib/cucumber/ast/scenario_outline.rb

@@ -0,0 +1,90 @@
+module Cucumber
+  module Ast
+    class ScenarioOutline
+      include FeatureElement
+
+      # The +example_sections+ argument must be an Array where each element is another array representing
+      # an Examples section. This array has 3 elements:
+      #
+      # * Examples keyword
+      # * Examples section name
+      # * Raw matrix
+      def initialize(background, comment, tags, line, keyword, name, steps, example_sections)
+        @background, @comment, @tags, @line, @keyword, @name = background, comment, tags, line, keyword, name
+        attach_steps(steps)
+        @steps = StepCollection.new(steps)
+
+        @examples_array = example_sections.map do |example_section|
+          examples_line       = example_section[0]
+          examples_keyword    = example_section[1]
+          examples_name       = example_section[2]
+          examples_matrix     = example_section[3]
+
+          examples_table = OutlineTable.new(examples_matrix, self)
+          Examples.new(examples_line, examples_keyword, examples_name, examples_table)
+        end
+      end
+
+      def feature=(feature)
+        @feature = feature
+        @background.feature = feature if @background
+      end
+
+      def descend?(visitor)
+        @examples_array.detect { |examples| examples.descend?(visitor) }
+      end
+
+      def matches_tags_and_name?(visitor)
+        visitor.included_by_tags?(self) &&
+        !visitor.excluded_by_tags?(self) &&
+        visitor.matches_scenario_names?(self)
+      end
+
+      def accept(visitor)
+        visitor.visit_comment(@comment)
+        visitor.visit_tags(@tags)
+        visitor.visit_scenario_name(@keyword, @name, file_colon_line(@line), source_indent(text_length))
+        visitor.visit_steps(@steps)
+
+        skip_invoke! if @background && @background.failed?
+        @examples_array.each do |examples|
+          visitor.visit_examples(examples) if examples.descend?(visitor)
+        end
+      end
+
+      def skip_invoke!
+        @examples_array.each{|examples| examples.skip_invoke!}
+        @feature.next_feature_element(self) do |next_one|
+          next_one.skip_invoke!
+        end
+      end
+
+      def step_invocations(cells)
+        step_invocations = @steps.step_invocations_from_cells(cells)
+        if @background
+          @background.step_collection(step_invocations)
+        else
+          StepCollection.new(step_invocations)
+        end
+      end
+
+      def each_example_row(&proc)
+        @examples_array.each do |examples|
+          examples.each_example_row(&proc)
+        end
+      end
+
+      def to_sexp
+        sexp = [:scenario_outline, @keyword, @name]
+        comment = @comment.to_sexp
+        sexp += [comment] if comment
+        tags = @tags.to_sexp
+        sexp += tags if tags.any?
+        steps = @steps.to_sexp
+        sexp += steps if steps.any?
+        sexp += @examples_array.map{|e| e.to_sexp}
+        sexp
+      end
+    end
+  end
+end

data/lib/cucumber/ast/step.rb

@@ -0,0 +1,122 @@
+require 'cucumber/step_definition'
+require 'cucumber/core_ext/string'
+
+module Cucumber
+  module Ast
+    class Step
+      attr_reader :line, :keyword, :name, :multiline_arg
+      attr_writer :step_collection, :options
+      attr_accessor :feature_element, :exception
+
+      def initialize(line, keyword, name, multiline_arg=nil)
+        @line, @keyword, @name, @multiline_arg = line, keyword, name, multiline_arg
+      end
+
+      def background?
+        false
+      end
+
+      def step_invocation
+        StepInvocation.new(self, @name, @multiline_arg, [])
+      end
+
+      def step_invocation_from_cells(cells)
+        matched_cells = matched_cells(cells)
+
+        delimited_arguments = delimit_argument_names(cells.to_hash)
+        name                = replace_name_arguments(delimited_arguments)
+        multiline_arg       = @multiline_arg.nil? ? nil : @multiline_arg.arguments_replaced(delimited_arguments)
+
+        StepInvocation.new(self, name, multiline_arg, matched_cells)
+      end
+
+      def accept(visitor)
+        # The only time a Step is visited is when it is in a ScenarioOutline.
+        # Otherwise it's always StepInvocation that gest visited instead.
+        visit_step_details(visitor, first_match(visitor), @multiline_arg, :skipped, nil, nil)
+      end
+      
+      def visit_step_details(visitor, step_match, multiline_arg, status, exception, background)
+        visitor.visit_step_name(@keyword, step_match, status, source_indent, background)
+        visitor.visit_multiline_arg(@multiline_arg) if @multiline_arg
+        visitor.visit_exception(exception, status) if exception
+      end
+
+      def first_match(visitor)
+        # @feature_element is always a ScenarioOutline in this case
+        @feature_element.each_example_row do |cells|
+          argument_hash       = cells.to_hash
+          delimited_arguments = delimit_argument_names(argument_hash)
+          name                = replace_name_arguments(delimited_arguments)
+          step_match          = visitor.step_mother.step_match(name, @name) rescue nil
+          return step_match if step_match
+        end
+        NoStepMatch.new(self)
+      end
+
+      def to_sexp
+        [:step, @line, @keyword, @name, (@multiline_arg.nil? ? nil : @multiline_arg.to_sexp)].compact
+      end
+
+      def matches_lines?(lines)
+        lines.index(@line) || (@multiline_arg && @multiline_arg.matches_lines?(lines))
+      end
+
+      def source_indent
+        @feature_element.source_indent(text_length)
+      end
+
+      def text_length
+        @keyword.jlength + @name.jlength + 2 # Add 2 because steps get indented 2 more than scenarios
+      end
+
+      def backtrace_line
+        @backtrace_line ||= @feature_element.backtrace_line("#{@keyword} #{@name}", @line) unless @feature_element.nil?
+      end
+
+      def file_colon_line
+        @file_colon_line ||= @feature_element.file_colon_line(@line) unless @feature_element.nil?
+      end
+
+      def actual_keyword
+        if [Cucumber.keyword_hash['and'], Cucumber.keyword_hash['but']].index(@keyword) && previous_step
+          previous_step.actual_keyword
+        else
+          @keyword
+        end
+      end
+
+      protected
+
+      # TODO: Remove when we use StepCollection everywhere
+      def previous_step
+        @feature_element.previous_step(self)
+      end
+
+      private
+
+      def matched_cells(cells)
+        cells.select do |cell|
+          @name.index(delimited(cell.header_cell.value))
+        end
+      end
+
+      def delimit_argument_names(argument_hash)
+        argument_hash.inject({}) { |h,(name,value)| h[delimited(name)] = value; h }
+      end
+
+      def delimited(s)
+        "<#{s}>"
+      end
+
+      def replace_name_arguments(argument_hash)
+        name_with_arguments_replaced = @name
+        argument_hash.each do |name, value|
+          value ||= ''
+          name_with_arguments_replaced = name_with_arguments_replaced.gsub(name, value) if value
+        end
+        name_with_arguments_replaced
+      end
+    end
+  end
+end

data/lib/cucumber/ast/step_collection.rb

@@ -0,0 +1,66 @@
+module Cucumber
+  module Ast
+    # Holds an Array of Step or StepDefinition
+    class StepCollection
+      include Enumerable
+      
+      def initialize(steps)
+        @steps = steps
+        @steps.each{|step| step.step_collection = self}
+      end
+
+      def accept(visitor, &proc)
+        @steps.each do |step|
+          visitor.visit_step(step) if proc.nil? || proc.call(step)
+        end
+      end
+
+      def step_invocations(background = false)
+        StepCollection.new(@steps.map{ |step| 
+          i = step.step_invocation
+          i.background = background
+          i
+        })
+      end
+
+      def step_invocations_from_cells(cells)
+        @steps.map{|step| step.step_invocation_from_cells(cells)}
+      end
+
+      # Duplicates this instance and adds +step_invocations+ to the end
+      def dup(step_invocations = [])
+        StepCollection.new(@steps + step_invocations)
+      end
+
+      def each(&proc)
+        @steps.each(&proc)
+      end
+
+      def previous_step(step)
+        i = @steps.index(step) || -1
+        @steps[i-1]
+      end
+
+      def matches_lines?(lines)
+        @steps.detect {|step| step.matches_lines?(lines)}
+      end
+
+      def empty?
+        @steps.empty?
+      end
+
+      def max_line_length(feature_element)
+        lengths = (@steps + [feature_element]).map{|e| e.text_length}
+        lengths.max
+      end
+
+      def exception
+        @exception ||= ((failed = @steps.detect {|step| step.exception}) && failed.exception)
+      end
+
+      def to_sexp
+        @steps.map{|step| step.to_sexp}
+      end
+    end
+  end
+end

data/lib/cucumber/ast/step_invocation.rb

@@ -0,0 +1,110 @@
+module Cucumber
+  module Ast
+    class StepInvocation
+      attr_writer :step_collection, :background
+      attr_reader :name, :matched_cells, :status
+      attr_accessor :exception
+
+      def initialize(step, name, multiline_arg, matched_cells)
+        @step, @name, @multiline_arg, @matched_cells = step, name, multiline_arg, matched_cells
+        status!(:skipped)
+      end
+
+      def background?
+        @background
+      end
+
+      def skip_invoke!
+        @skip_invoke = true
+      end
+
+      def accept(visitor)
+        invoke(visitor.step_mother, visitor.options)
+        @step.visit_step_details(visitor, @step_match, @multiline_arg, @status, @exception, @background)
+      end
+
+      def invoke(step_mother, options)
+        find_step_match!(step_mother)
+        unless @skip_invoke || options[:dry_run] || exception || @step_collection.exception
+          @skip_invoke = true
+          begin
+            step_mother.current_world.__cucumber_current_step = self
+            @step_match.invoke(step_mother.current_world, @multiline_arg)
+            status!(:passed)
+          rescue Pending => e
+            failed(e, false)
+            status!(:pending)
+          rescue Undefined => e
+            failed(e, false)
+            status!(:undefined)
+          rescue Exception => e
+            failed(e, false)
+            status!(:failed)
+          end
+        end
+      end
+
+      def find_step_match!(step_mother)
+        return if @step_match
+        begin
+          @step_match = step_mother.step_match(@name)
+        rescue Undefined => e
+          failed(e, true)
+          status!(:undefined)
+          @step_match = NoStepMatch.new(@step)
+        rescue Ambiguous => e
+          failed(e, false)
+          status!(:failed)
+          @step_match = NoStepMatch.new(@step)
+        end
+        step_mother.step_visited(self)
+      end
+
+      def failed(exception, clear_backtrace)
+        @exception = exception
+        @exception.set_backtrace([]) if clear_backtrace
+        @exception.backtrace << @step.backtrace_line unless @step.backtrace_line.nil?
+      end
+
+      def status!(status)
+        @status = status
+        @multiline_arg.status = status if @multiline_arg
+        @matched_cells.each do |cell|
+          cell.status = status
+        end
+      end
+
+      def previous
+        @step_collection.previous_step(self)
+      end
+
+      def actual_keyword
+        if [Cucumber.keyword_hash['and'], Cucumber.keyword_hash['but']].index(@keyword) && previous
+          previous.actual_keyword
+        else
+          @step.keyword
+        end
+      end
+
+      def matches_lines?(lines)
+        @step.matches_lines?(lines)
+      end
+
+      def text_length
+        @step.text_length
+      end
+
+      def file_colon_line
+        @step.file_colon_line
+      end
+
+      def backtrace_line
+        @step.backtrace_line
+      end
+
+      def to_sexp
+        [:step_invocation, @step.line, @step.keyword, @name, (@multiline_arg.nil? ? nil : @multiline_arg.to_sexp)].compact
+      end
+    end
+  end
+end