kosmas58-cucumber 0.1.99.22 → 0.1.99.23

data/lib/cucumber/ast.rb

@@ -0,0 +1,29 @@
+require 'cucumber/ast/comment'
+require 'cucumber/ast/tags'
+require 'cucumber/ast/features'
+require 'cucumber/ast/feature'
+require 'cucumber/ast/scenario'
+require 'cucumber/ast/scenario_outline'
+require 'cucumber/ast/background'
+require 'cucumber/ast/steps'
+require 'cucumber/ast/step'
+require 'cucumber/ast/table'
+require 'cucumber/ast/py_string'
+require 'cucumber/ast/outline_table'
+require 'cucumber/ast/examples'
+require 'cucumber/ast/visitor'
+require 'cucumber/ast/filter'
+
+module Cucumber
+  # Classes in this module represent the Abstract Syntax Tree (AST)
+  # that gets built when feature files are parsed.
+  #
+  # AST classes don't expose any internal data directly. This is
+  # in order to encourage a less coupled design in the classes
+  # that operate on the AST. The only public method is #accept.
+  #
+  # The AST can be traversed with a visitor. See Cucumber::Format::Pretty
+  # for an example.
+  module Ast
+  end
+end

data/lib/cucumber/ast/background.rb

@@ -0,0 +1,88 @@
+module Cucumber
+  module Ast
+    class Background < Scenario
+
+      attr_accessor :world
+      attr_reader :status
+
+      def initialize(comment, line, keyword, steps)
+        @record_executed_steps = true
+        super(comment, Tags.new(1, []), line, keyword, "", steps)
+      end
+
+      def accept(visitor)
+        @world = visitor.new_world
+        if already_visited_steps?
+          @status = execute_steps(visitor)
+        else
+          @status = visit_background_and_steps(visitor, @steps)
+          @steps_visited = true
+        end
+      end
+
+      def step_executed(step)
+        @feature.step_executed(step) if @feature && @record_executed_steps
+      end
+
+      def already_visited_steps?
+        @steps_visited
+      end
+
+      def to_sexp #:nodoc:
+        sexp = [:background, @line, @keyword]
+        comment = @comment.to_sexp
+        sexp += [comment] if comment
+        tags = @tags.to_sexp
+        sexp += tags if tags.any?
+        steps = @steps.map{|step| step.to_sexp}
+        sexp += steps if steps.any?
+        sexp
+      end
+      
+      private
+
+      def visit_background_and_steps(visitor, steps)
+        visitor.visit_comment(@comment)
+        visitor.visit_scenario_name(@keyword, @name, file_line(@line), source_indent(text_length))
+
+        previous = :passed
+        steps.each do |step|
+          step.previous = previous
+          step.world    = @world
+          visitor.visit_step(step)
+          previous = step.status
+        end
+        previous
+      end
+      
+      def execute_steps(visitor)
+        previous = :passed
+        executed_steps = []
+        exception = nil
+        @steps.each do |step|
+          executed_step, previous, _ = step.execute_as_new(@world, previous, visitor, @line)
+          executed_steps << executed_step
+          exception ||= executed_step.exception
+        end
+        @steps = executed_steps
+        
+        if exception && @status != :failed
+          without_recording_steps do
+            @steps_visited = false
+            #Since the steps have already been executed they will not be re-run, they will just be displayed
+            visitor.visit_background(self)
+          end 
+        end
+
+        previous
+      end
+
+      def without_recording_steps
+        @record_executed_steps = false
+        yield
+        @record_executed_steps = true
+      end
+
+    end
+  end
+end

data/lib/cucumber/ast/comment.rb

@@ -0,0 +1,26 @@
+module Cucumber
+  module Ast
+    # Holds the value of a comment parsed from a feature file:
+    #
+    #   # Lorem ipsum
+    #   # dolor sit amet
+    #
+    # This gets parsed into a Comment with value <tt>"# Lorem ipsum\n# dolor sit amet\n"</tt>
+    #
+    class Comment
+      def initialize(value)
+        @value = value
+      end
+
+      def accept(visitor)
+        @value.split("\n").each do |line|
+          visitor.visit_comment_line(line.strip)
+        end
+      end
+      
+      def to_sexp
+        (@value.nil? || @value == '') ? nil : [:comment, @value]
+      end
+    end
+  end
+end

data/lib/cucumber/ast/examples.rb

@@ -0,0 +1,26 @@
+module Cucumber
+  module Ast
+    class Examples
+      def initialize(line, keyword, name, outline_table)
+        @keyword, @name, @outline_table = keyword, name, outline_table
+      end
+
+      def accept(visitor)
+        visitor.visit_examples_name(@keyword, @name)
+        visitor.visit_outline_table(@outline_table)
+      end
+
+      def each_example_row(&proc)
+        @outline_table.each_cells_row(&proc)
+      end
+
+      def at_lines?(lines)
+        lines.empty? || lines.index(@line) || @outline_table.at_lines?(lines)
+      end
+
+      def to_sexp
+        [:examples, @keyword, @name, @outline_table.to_sexp]
+      end
+    end
+  end
+end

data/lib/cucumber/ast/feature.rb

@@ -0,0 +1,66 @@
+module Cucumber
+  module Ast
+    # Represents the root node of a parsed feature.
+    class Feature
+      attr_accessor :file
+      attr_writer :features, :lines
+
+      def initialize(comment, tags, name, feature_elements, background = nil)
+        @comment, @tags, @name, @feature_elements, @background = comment, tags, name, feature_elements, background
+        feature_elements.each do |feature_element| 
+          feature_element.feature = self
+          feature_element.background = background if background
+        end
+        background.feature = self if background
+        @lines = []
+      end
+
+      def tagged_with?(tag_names, check_elements=true)
+        @tags.among?(tag_names) || 
+        (check_elements && @feature_elements.detect{|e| e.tagged_with?(tag_names)})
+      end
+      
+      def matches_scenario_names?(scenario_names)
+        @feature_elements.detect{|e| e.matches_scenario_names?(scenario_names)}
+      end
+
+      def accept(visitor)
+        visitor.current_feature_lines = @lines
+        visitor.visit_comment(@comment)
+        visitor.visit_tags(@tags)
+        visitor.visit_feature_name(@name)
+        
+        @feature_elements.each do |feature_element|
+          visitor.visit_feature_element(feature_element) if @features.visit?(feature_element, @lines)
+        end
+      end
+
+      def scenario_executed(scenario)
+        @features.scenario_executed(scenario) if @features
+      end
+
+      def step_executed(step)
+        @features.step_executed(step) if @features
+      end
+
+      def backtrace_line(step_name, line)
+        "#{file_line(line)}:in `#{step_name}'"
+      end
+
+      def file_line(line)
+        "#{@file}:#{line}"
+      end
+
+      def to_sexp
+        sexp = [:feature, @name]
+        comment = @comment.to_sexp
+        sexp += [comment] if comment
+        tags = @tags.to_sexp
+        sexp += tags if tags.any?
+        sexp += [@background.to_sexp] if @background
+        sexp += @feature_elements.map{|e| e.to_sexp}
+        sexp
+      end
+    end
+  end
+end

data/lib/cucumber/ast/features.rb

@@ -0,0 +1,39 @@
+module Cucumber
+  module Ast
+    class Features
+      attr_reader :steps, :scenarios
+
+      def initialize(filter)
+        @filter = filter
+
+        @features = []
+        @scenarios = []
+        @steps = Hash.new{|steps, status| steps[status] = []}
+      end
+
+      def add_feature(feature)
+        feature.features = self
+        @features << feature
+      end
+
+      def visit?(node, lines)
+        @filter.matched?(node) &&
+        (lines.empty? ? true : node.at_lines?(lines))
+      end
+
+      def scenario_executed(scenario)
+        @scenarios << scenario
+      end
+      
+      def step_executed(step)
+        @steps[step.status] << step
+      end
+
+      def accept(visitor)
+        @features.each do |feature|
+          visitor.visit_feature(feature) if visit?(feature, [])
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/ast/filter.rb

@@ -0,0 +1,22 @@
+module Cucumber
+  module Ast
+    class Filter
+      def initialize(options)
+        @options = options
+      end
+      
+      def matched?(node)
+        matched_by_tags?(node) &&
+        matched_by_scenario_names?(node)
+      end
+      
+      def matched_by_tags?(node)
+        @options[:tags].empty? || node.tagged_with?(@options[:tags])
+      end
+
+      def matched_by_scenario_names?(node)
+        @options[:scenario_names].empty? || node.matches_scenario_names?(@options[:scenario_names])
+      end
+    end
+  end
+end

data/lib/cucumber/ast/outline_table.rb

@@ -0,0 +1,49 @@
+module Cucumber
+  module Ast
+    class OutlineTable < Table
+      def initialize(raw, scenario_outline)
+        super(raw)
+        @scenario_outline = scenario_outline
+        @cells_class = ExampleCells
+      end
+
+      def accept(visitor, status)
+        cells_rows.each_with_index do |row, n|
+          should_visit = n == 0 || 
+            row.at_lines?(visitor.current_feature_lines) ||
+            @scenario_outline.at_header_or_step_lines?(visitor.current_feature_lines)
+
+          if should_visit
+            visitor.visit_table_row(row, status)
+          end
+        end
+        nil
+      end
+
+      def execute_row(cells, visitor, &proc)
+        @scenario_outline.execute_row(cells, visitor, &proc)
+      end
+
+      class ExampleCells < Cells
+        def accept(visitor, status)
+          if header?
+            @cells.each do |cell|
+              visitor.visit_table_cell(cell, :thead)
+            end
+            nil
+          else
+            exception = @table.execute_row(self, visitor) do |cell, status|
+              visitor.visit_table_cell(cell, status)
+            end
+          end
+        end
+
+        private
+
+        def header?
+          index == 0
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/ast/py_string.rb

@@ -0,0 +1,52 @@
+module Cucumber
+  module Ast
+    # Represents an inline argument in a step. Example:
+    #
+    #   Given the message
+    #     """
+    #     I like
+    #     Cucumber sandwich
+    #     """
+    #
+    # The text between the pair of <tt>"""</tt> is stored inside a PyString,
+    # which is yielded to the StepDefinition block as the last argument.
+    #
+    # The StepDefinition can then access the String via the #to_s method. In the
+    # example above, that would return: <tt>"I like\nCucumber sandwich"</tt>
+    #
+    # Note how the indentation from the source is stripped away.
+    #
+    class PyString
+      def initialize(start_line, end_line, string, quotes_indent)
+        @start_line, @end_line = start_line, end_line
+        @string, @quotes_indent = string.gsub(/\\"/, '"'), quotes_indent
+      end
+
+      def to_s
+        @string.indent(-@quotes_indent)
+      end
+
+      def at_lines?(lines)
+        lines.detect{|l| l >= @start_line && l <= @end_line}
+      end
+
+      def accept(visitor, status)
+        visitor.visit_py_string(to_s, status)
+      end
+      
+      def arguments_replaced(arguments) #:nodoc:
+        string = @string
+        arguments.each do |name, value|
+          string = string.gsub(name, value)
+        end
+        PyString.new(@start_line, @end_line, string, @quotes_indent)
+      end
+      
+      # For testing only
+      def to_sexp #:nodoc:
+        [:py_string, to_s]
+      end
+    
+    end
+  end
+end

data/lib/cucumber/ast/scenario.rb

@@ -0,0 +1,103 @@
+module Cucumber
+  module Ast
+    class Scenario
+      attr_writer :feature, :background
+
+      def initialize(comment, tags, line, keyword, name, steps)
+        @comment, @tags, @line, @keyword, @name = comment, tags, line, keyword, name
+        steps.each {|step| step.scenario = self}
+        @steps = steps
+        @steps_helper = Steps.new(self)
+      end
+
+      def status
+        @steps.map{|step| step.status}
+      end
+
+      def tagged_with?(tag_names)
+        @tags.among?(tag_names) || @feature.tagged_with?(tag_names, false)
+      end
+
+      def matches_scenario_names?(scenario_names)
+        scenario_names.detect{|name| @name == name}
+      end
+
+      def accept(visitor)
+        visitor.visit_background(@background) if @background
+        visitor.visit_comment(@comment)
+        visitor.visit_tags(@tags)
+        visitor.visit_scenario_name(@keyword, @name, file_line(@line), source_indent(text_length))
+        visitor.visit_steps(@steps_helper)
+
+        @feature.scenario_executed(self) if @feature && !@executed
+        @executed = true
+      end
+
+      def accept_steps(visitor)
+        prior_world = @background ? @background.world : nil
+        visitor.world(self, prior_world) do |world|
+          previous = @background ? @background.status : :passed
+          @steps.each do |step|
+            step.previous = previous
+            step.world    = world
+            visitor.visit_step(step)
+            previous = step.status
+          end
+        end
+      end
+
+      def source_indent(text_length)
+        max_line_length - text_length
+      end
+
+      def max_line_length
+        lengths = (@steps + [self]).map{|e| e.text_length}
+        lengths.max
+      end
+
+      def text_length
+        @keyword.jlength + @name.jlength
+      end
+
+      def at_lines?(lines)
+        at_header_or_step_lines?(lines)
+      end
+
+      def at_header_or_step_lines?(lines)
+        lines.empty? || lines.index(@line) || @steps.detect {|step| step.at_lines?(lines)} || @tags.at_lines?(lines)
+      end
+
+      def undefined?
+        @steps.empty?
+      end
+
+      def step_executed(step)
+        @feature.step_executed(step) if @feature
+      end
+
+      def backtrace_line(name = "#{@keyword} #{@name}", line = @line)
+        @feature.backtrace_line(name, line) if @feature
+      end
+
+      def file_line(line = @line)
+        @feature.file_line(line) if @feature
+      end
+
+      def previous_step(step)
+        i = @steps.index(step) || -1
+        @steps[i-1]
+      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.map{|step| step.to_sexp}
+        sexp += steps if steps.any?
+        sexp
+      end
+    end
+  end
+end