gherkin 2.2.5-x86-mswin32

data/lib/gherkin/formatter/escaping.rb

@@ -0,0 +1,15 @@
+module Gherkin
+  module Formatter
+    module Escaping
+      # Escapes a pipes and backslashes:
+      #
+      # * | becomes \|
+      # * \ becomes \\
+      #
+      # This is used in the pretty formatter.
+      def escape_cell(s)
+        s.gsub(/\|/, "\\|").gsub(/\\(?!\|)/, "\\\\\\\\")
+      end
+    end
+  end
+end

data/lib/gherkin/formatter/filter_formatter.rb

@@ -0,0 +1,136 @@
+require 'gherkin/tag_expression'
+require 'gherkin/formatter/regexp_filter'
+require 'gherkin/formatter/line_filter'
+require 'gherkin/formatter/tag_filter'
+require 'gherkin/formatter/model'
+require 'gherkin/native'
+
+module Gherkin
+  module Formatter
+    class FilterFormatter
+      native_impl('gherkin')
+      
+      def initialize(formatter, filters)
+        @formatter = formatter
+        @filter    = detect_filter(filters)
+
+        @feature_tags           = []
+        @feature_element_tags   = []
+        @examples_tags          = []
+
+        @feature_events         = []
+        @background_events      = []
+        @feature_element_events = []
+        @examples_events        = []
+      end
+
+      def uri(uri)
+        @formatter.uri(uri)
+      end
+
+      def feature(feature)
+        @feature_tags   = feature.tags
+        @feature_name   = feature.name
+        @feature_events = [feature]
+      end
+
+      def background(background)
+        @feature_element_name   = background.name
+        @feature_element_range  = background.line_range
+        @background_events      = [background]
+      end
+
+      def scenario(scenario)
+        replay!
+        @feature_element_tags   = scenario.tags
+        @feature_element_name   = scenario.name
+        @feature_element_range  = scenario.line_range
+        @feature_element_events = [scenario]
+      end
+
+      def scenario_outline(scenario_outline)
+        replay!
+        @feature_element_tags   = scenario_outline.tags
+        @feature_element_name   = scenario_outline.name
+        @feature_element_range  = scenario_outline.line_range
+        @feature_element_events = [scenario_outline]
+      end
+
+      def examples(examples)
+        replay!
+        @examples_tags = examples.tags
+        @examples_name = examples.name
+
+        table_body_range = examples.rows[1].line..examples.rows[-1].line
+        @examples_range = examples.line_range.first..table_body_range.last
+        if(@filter.eval([], [], [table_body_range]))
+          examples.rows = @filter.filter_table_body_rows(examples.rows)
+        end
+        @examples_events = [examples]
+      end
+
+      def step(step)
+        if @feature_element_events.any?
+          @feature_element_events << step
+        else
+          @background_events << step
+        end
+
+        @feature_element_range = @feature_element_range.first..step.line_range.last
+      end
+
+      def eof
+        replay!
+        @formatter.eof
+      end
+
+    private
+
+      def detect_filter(filters)
+        raise "Inconsistent filters: #{filters.inspect}" if filters.map{|filter| filter.class}.uniq.length > 1
+        case(filters[0])
+        when Fixnum 
+          LineFilter.new(filters)
+        when Regexp 
+          RegexpFilter.new(filters)
+        when String 
+          TagFilter.new(filters)
+        end
+      end
+
+      def replay!
+        feature_element_ok = @filter.eval(
+          (@feature_tags + @feature_element_tags), 
+          [@feature_name, @feature_element_name].compact, 
+          [@feature_element_range].compact
+        )
+        examples_ok = @filter.eval(
+          (@feature_tags + @feature_element_tags + @examples_tags), 
+          [@feature_name, @feature_element_name, @examples_name].compact, 
+          [@feature_element_range, @examples_range].compact
+        )
+
+        if feature_element_ok || examples_ok
+          replay_events!(@feature_events)
+          replay_events!(@background_events)
+          replay_events!(@feature_element_events)
+
+          if examples_ok
+            replay_events!(@examples_events)
+          end
+        end
+
+        @examples_events.clear
+        @examples_tags.clear
+        @examples_name = nil
+      end
+
+      def replay_events!(events)
+        events.each do |event|
+          event.replay(@formatter)
+        end
+        events.clear
+      end
+    end
+  end
+end

data/lib/gherkin/formatter/json_formatter.rb

@@ -0,0 +1,72 @@
+require 'json'
+require 'gherkin/formatter/model'
+require 'gherkin/native'
+
+module Gherkin
+  module Formatter
+    class JSONFormatter
+      native_impl('gherkin')
+      
+      attr_reader :gherkin_object
+      
+      # Creates a new instance that writes the resulting JSON to +io+.
+      # If +io+ is nil, the JSON will not be written, but instead a Ruby
+      # object can be retrieved with #gherkin_object
+      def initialize(io)
+        @io = io
+      end
+
+      def uri(uri)
+        # We're ignoring the uri - we don't want it as part of the JSON
+        # (The pretty formatter uses it just for visual niceness - comments)
+      end
+
+      def feature(feature)
+        @gherkin_object = feature.to_hash
+      end
+
+      def background(background)
+        feature_elements << background.to_hash
+      end
+
+      def scenario(scenario)
+        feature_elements << scenario.to_hash
+      end
+
+      def scenario_outline(scenario_outline)
+        feature_elements << scenario_outline.to_hash
+      end
+
+      def examples(examples)
+        all_examples << examples.to_hash
+      end
+
+      def step(step)
+        steps << step.to_hash
+      end
+
+      def eof
+        @io.write(@gherkin_object.to_json) if @io
+      end
+
+    private
+
+      def feature_elements
+        @gherkin_object['elements'] ||= []
+      end
+
+      def feature_element
+        feature_elements[-1]
+      end
+
+      def all_examples
+        feature_element['examples'] ||= []
+      end
+
+      def steps
+        feature_element['steps'] ||= []
+      end
+    end
+  end
+end
+

data/lib/gherkin/formatter/line_filter.rb

@@ -0,0 +1,26 @@
+module Gherkin
+  module Formatter
+    class LineFilter
+      def initialize(lines)
+        @lines = lines
+      end
+
+      def eval(tags, names, ranges)
+        ranges.detect do |range|
+          @lines.detect do |line|
+            range.include?(line)
+          end
+        end
+      end
+
+      def filter_table_body_rows(rows)
+        body = rows.to_a[1..-1].select do |row|
+          @lines.detect do |line|
+            row.line == line
+          end
+        end
+        [rows[0]] + body
+      end
+    end
+  end
+end

data/lib/gherkin/formatter/model.rb

@@ -0,0 +1,231 @@
+require 'gherkin/native'
+
+module Gherkin
+  module Formatter
+    module Model
+      class Hashable
+        def to_hash
+          instance_variables.inject({}) do |hash, ivar|
+            value = instance_variable_get(ivar)
+            value = value.to_hash if value.respond_to?(:to_hash)
+            if Array === value
+              value = value.map do |e|
+                e.respond_to?(:to_hash) ? e.to_hash : e
+              end
+            end
+            hash[ivar[1..-1]] = value unless [[], nil].index(value)
+            hash
+          end
+        end
+      end
+      
+      class BasicStatement < Hashable
+        attr_reader :comments, :keyword, :name, :line
+        
+        def initialize(comments, keyword, name, line)
+          @comments, @keyword, @name, @line = comments, keyword, name, line
+        end
+
+        def line_range
+          first = @comments.any? ? @comments[0].line : first_non_comment_line
+          first..line
+        end
+
+        def first_non_comment_line
+          @line
+        end
+      end
+
+      class DescribedStatement < BasicStatement
+        attr_reader :description
+
+        def initialize(comments, keyword, name, description, line)
+          super(comments, keyword, name, line)
+          @description = description
+        end
+      end
+
+      class TagStatement < DescribedStatement
+        attr_reader :tags
+
+        def initialize(comments, tags, keyword, name, description, line)
+          super(comments, keyword, name, description, line)
+          @tags = tags
+        end
+
+        def first_non_comment_line
+          @tags.any? ? @tags[0].line : @line
+        end
+      end
+
+      class Feature < TagStatement
+        native_impl('gherkin')
+
+        def initialize(comments, tags, keyword, name, description, line)
+          super(comments, tags, keyword, name, description, line)
+        end
+
+        def replay(formatter)
+          formatter.feature(self)
+        end
+      end
+
+      class Background < DescribedStatement
+        native_impl('gherkin')
+
+        def initialize(comments, keyword, name, description, line)
+          super(comments, keyword, name, description, line)
+          @type = "background"
+        end
+
+        def replay(formatter)
+          formatter.background(self)
+        end
+      end
+
+      class Scenario < TagStatement
+        native_impl('gherkin')
+
+        def initialize(comments, tags, keyword, name, description, line)
+          super(comments, tags, keyword, name, description, line)
+          @type = "scenario"
+        end
+
+        def replay(formatter)
+          formatter.scenario(self)
+        end
+      end
+
+      class ScenarioOutline < TagStatement
+        native_impl('gherkin')
+
+        def initialize(comments, tags, keyword, name, description, line)
+          super(comments, tags, keyword, name, description, line)
+          @type = "scenario_outline"
+        end
+
+        def replay(formatter)
+          formatter.scenario_outline(self)
+        end
+      end
+
+      class Examples < TagStatement
+        native_impl('gherkin')
+
+        attr_accessor :rows
+
+        def initialize(comments, tags, keyword, name, description, line, rows=nil)
+          super(comments, tags, keyword, name, description, line)
+          @rows = rows
+        end
+
+        def replay(formatter)
+          formatter.examples(self)
+        end
+      end
+
+      class Step < BasicStatement
+        native_impl('gherkin')
+
+        attr_accessor :multiline_arg, :result
+
+        def initialize(comments, keyword, name, line, multiline_arg=nil, result=nil)
+          super(comments, keyword, name, line)
+          @multiline_arg = multiline_arg
+          @result = result
+        end
+
+        def line_range
+          range = super
+          case multiline_arg
+          when Array
+            range = range.first..multiline_arg[-1].line
+          when Model::PyString
+            range = range.first..multiline_arg.line_range.last
+          end
+          range
+        end
+
+        def replay(formatter)
+          formatter.step(self)
+        end
+
+        def to_hash
+          hash = super
+          if Array === @multiline_arg
+            hash['multiline_arg'] = {
+              'type' => 'table',
+              'value' => hash['multiline_arg']
+            }
+          elsif PyString === @multiline_arg
+            hash['multiline_arg']['type'] = 'py_string'
+          end
+          hash
+        end
+      end
+
+      class Comment < Hashable
+        native_impl('gherkin')
+
+        attr_reader :value, :line
+        
+        def initialize(value, line)
+          @value, @line = value, line
+        end
+      end
+
+      class Tag < Hashable
+        native_impl('gherkin')
+
+        attr_reader :name, :line
+        
+        def initialize(name, line)
+          @name, @line = name, line
+        end
+        
+        def eql?(tag)
+          @name.eql?(tag.name)
+        end
+
+        def hash
+          @name.hash
+        end
+      end
+
+      class PyString < Hashable
+        native_impl('gherkin')
+
+        attr_reader :value, :line
+        
+        def initialize(value, line)
+          @value, @line = value, line
+        end
+
+        def line_range
+          line_count = value.split(/\r?\n/).length
+          line..(line+line_count+1)
+        end
+      end
+
+      class Row < Hashable
+        native_impl('gherkin')
+
+        attr_reader :comments, :cells, :line
+
+        def initialize(comments, cells, line)
+          @comments, @cells, @line = comments, cells, line
+        end
+      end
+
+      class Result
+        native_impl('gherkin')
+
+        attr_reader :status, :error_message, :arguments, :stepdef_location
+        
+        def initialize(status, error_message, arguments, stepdef_location)
+          @status, @error_message, @arguments, @stepdef_location = status, error_message, arguments, stepdef_location
+        end
+      end
+    end
+  end
+end