gherkin 2.0.2 → 2.1.0

data/History.txt

@@ -1,3 +1,15 @@
+== 2.1.0 (2010-07-12)
+
+=== New Features
+* Pirate! (anteaya)
+* Tag limits for negative tags (Aslak Hellesøy)
+
+=== Changed Features
+* The formatter API has changed and the listener API is now only used internally. (Aslak Hellesøy)
+
+=== Removed Features
+* FilterListener has been replaced with FilterFormatter. Currently only in Ruby (no Java impl yet). (Aslak Hellesøy)
+
 == 2.0.2 (2010-06-16)
 
 === New Features

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy
+Copyright (c) 2009-2010 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -45,7 +45,7 @@ http://crossgcc.rts-software.org/doku.php - just add the bin folder to your PATH
 == Note on Patches/Pull Requests
  
 * Fork the project.
-* Run rake ragel:rb to generate all the I18N lexers
+* Run rake ragel:rb to generate all the I18n lexers
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
@@ -56,4 +56,4 @@ http://crossgcc.rts-software.org/doku.php - just add the bin folder to your PATH
 
 == Copyright
 
-Copyright (c) 2009 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy. See LICENSE for details.
+Copyright (c) 2009-2010 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy. See LICENSE for details.

data/Rakefile

@@ -19,8 +19,8 @@ begin
     gem.authors = ["Mike Sassak", "Gregory Hnatiuk", "Aslak Hellesøy"]
     gem.executables = ["gherkin"]
     gem.add_dependency "trollop", "~> 1.16.2"
-    gem.add_development_dependency 'rspec', '~> 2.0.0.beta.11'
-    gem.add_development_dependency "cucumber", "~> 0.8.1"
+    gem.add_development_dependency 'rspec', '~> 2.0.0.beta.15'
+    gem.add_development_dependency "cucumber", "~> 0.8.4"
     gem.add_development_dependency "rake-compiler", "~> 0.7.0" unless defined?(JRUBY_VERSION)
 
     gem.files -= FileList['ikvm/**/*']

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 2
-:minor: 0
+:minor: 1
+:patch: 0
 :build: 
-:patch: 2

data/features/json_formatter.feature

@@ -17,10 +17,9 @@ Feature: JSON formatter
       """
       {
         "comments": ["# language: no", "# Another comment"],
-        "description": "",
         "keyword": "Egenskap",
         "name": "Kjapp",
-        "tags": [],
+        "line": 3,
         "uri": "test.feature"
       }
       """
@@ -72,30 +71,24 @@ Feature: JSON formatter
     Then the outputted JSON should be:
       """
       {
-        "comments": [],
         "keyword": "Feature",
         "name": "OH HAI",
         "tags": ["@one"],
+        "line": 2,
         "uri": "test.feature",
-        "description": "",
         "elements":[
           {
-            "comments": [],
-            "tags": [],
             "keyword": "Scenario",
             "name": "Fujin",
-            "description": "",
             "type": "scenario",
             "line": 4,
             "steps": [
               {
-                "comments": [],
                 "keyword": "Given ",
                 "name": "wind",
                 "line": 5
               },
               {
-                "comments": [],
                 "keyword": "Then ",
                 "name": "spirit",
                 "line": 6
@@ -103,22 +96,18 @@ Feature: JSON formatter
             ]
           },
           {
-            "comments": [],
             "tags": ["@two"],
             "keyword": "Scenario",
             "name": "_why",
-            "description": "",
             "type": "scenario",
             "line": 9,
             "steps": [
               {
-                "comments": [],
                 "keyword": "Given ",
                 "name": "chunky",
                 "line": 10
               },
               {
-                "comments": [],
                 "keyword": "Then ",
                 "name": "bacon",
                 "line": 11
@@ -126,16 +115,13 @@ Feature: JSON formatter
             ]
           },
           {
-            "comments": [],
             "tags": ["@three", "@four"],
             "keyword": "Scenario Outline",
             "name": "Life",
-            "description": "",
             "type": "scenario_outline",
             "line": 14,
             "steps": [
               {
-                "comments": [],
                 "keyword": "Given ",
                 "name": "some <boredom>",
                 "line": 15
@@ -143,25 +129,20 @@ Feature: JSON formatter
             ],
             "examples": [
               {
-                "comments": [],
                 "tags": ["@five"],
                 "keyword": "Examples",
                 "name": "Real life",
-                "description": "",
                 "line": 18,
                 "table": [
                   {
-                    "comments": [],
                     "cells": ["boredom"],
                     "line": 19
                   },
                   {
-                    "comments": [],
                     "cells": ["airport"],
                     "line": 20
                   },
                   {
-                    "comments": [],
                     "cells": ["meeting"],
                     "line": 21
                   }
@@ -170,29 +151,23 @@ Feature: JSON formatter
             ]
           },
           {
-            "comments": [],
-            "tags": [],
             "keyword": "Scenario",
             "name": "who stole my mojo?",
-            "description": "",
             "type": "scenario",
             "line": 23,
             "steps": [
               {
-                "comments": [],
                 "keyword": "When ",
                 "name": "I was",
                 "line": 24,
                 "table": [
                   {
-                    "comments": [],
                     "line": 25,
                     "cells": ["asleep"]
                   }
                 ]
               },
               {
-                "comments": [],
                 "keyword": "And ",
                 "name": "so",
                 "line": 26,
@@ -202,9 +177,7 @@ Feature: JSON formatter
           },
           {
             "comments": ["# The"],
-            "tags": [],
             "keyword": "Scenario Outline",
-            "description": "",
             "type": "scenario_outline",
             "line": 32,
             "name": "with",
@@ -219,10 +192,8 @@ Feature: JSON formatter
             "examples": [
               {
                 "comments": ["# comments", "# everywhere"],
-                "tags": [],
                 "keyword": "Examples",
                 "name": "An example",
-                "description": "",
                 "line": 38,
                 "table": [
                   {
@@ -253,21 +224,16 @@ Feature: JSON formatter
     Then the outputted JSON should be:
       """
       {
-        "comments": [],
-        "description": "",
         "keyword": "Feature",
         "name": "Kjapp",
-        "tags": [],
+        "line": 1,
         "uri": "test.feature",
         "background": {
-          "comments": [],
-          "description": "",
           "keyword": "Background",
           "line": 3,
           "name": "No idea what Kjapp means",
           "steps": [
             {
-              "comments": [],
               "keyword": "Given ",
               "line": 4,
               "name": "I Google it"
@@ -277,15 +243,11 @@ Feature: JSON formatter
         "elements": [
           {
             "comments": ["# Writing JSON by hand sucks"],
-            "tags": [],
             "keyword": "Scenario",
-            "name": "",
-            "description": "",
             "type": "scenario",
             "line": 7,
             "steps": [
               {
-                "comments": [],
                 "keyword": "Then ",
                 "name": "I think it means \"fast\"",
                 "line": 8

data/features/step_definitions/gherkin_steps.rb

@@ -1,18 +1,17 @@
-Given /^a "([^\"]*)" "([^\"]*)" parser$/ do |ruby_or_native, parser_name|
-  parser = Gherkin::Parser::Parser.new(@listener, false, parser_name)
-  @lexer = Gherkin::I18nLexer.new(parser, ruby_or_native == "ruby")
+Given /^a "(ruby|native)" "([^\"]*)" parser$/ do |ruby_or_native, parser_name|
+  @parser = Gherkin::Parser::Parser.new(@formatter, false, parser_name, ruby_or_native=="ruby")
 end
 
 Given "the following text is parsed:" do |text|
-  @lexer.scan(text, "test.feature", 0)
+  @parser.parse(text, "test.feature", 0)
 end
 
 Then "there should be no parse errors" do
-  @listener.errors.should == []
+  @formatter.errors.should == []
 end
 
 Then /^there should be a parse error on (line \d+)$/ do |line|
-  @listener.line(line).should include(:syntax_error, line)
+  @formatter.line(line).should include(:syntax_error, line)
 end
 
 Then /^there should be parse errors on (lines .*)$/ do |lines|

data/features/step_definitions/json_formatter_steps.rb

@@ -1,6 +1,6 @@
 require 'stringio'
 require 'gherkin/formatter/json_formatter'
-require 'gherkin/parser/formatter_listener'
+require 'gherkin/listener/formatter_listener'
 
 # Monkey patching so that Hash.to_json has a predictable result.
 class Hash
@@ -12,13 +12,14 @@ end
 
 Given /^a JSON formatter$/ do
   @io = StringIO.new
-  @listener = Gherkin::Parser::FormatterListener.new(Gherkin::Formatter::JSONFormatter.new(@io))
+  @formatter = Gherkin::Formatter::JSONFormatter.new(@io)
 end
 
 Then /^the outputted JSON should be:$/ do |expected_json|
   require 'json'
   expected = JSON.pretty_generate(JSON.parse(expected_json))
   actual   = JSON.pretty_generate(JSON.parse(@io.string))
+  announce actual
   begin
     actual.should == expected
   rescue # Haven't figured out how to order Hash on JRuby (JSON pure). Retry with possibly worse error message.

data/features/step_definitions/json_lexer_steps.rb

@@ -1,20 +1,20 @@
 require 'stringio'
 require 'gherkin/formatter/pretty_formatter'
-require 'gherkin/json_lexer'
+require 'gherkin/json_parser'
 
 Given /^a PrettyFormatter$/ do
   @io = StringIO.new
-  @formatter = Gherkin::Parser::FormatterListener.new(Gherkin::Formatter::PrettyFormatter.new(@io, true))
+  @formatter = Gherkin::Formatter::PrettyFormatter.new(@io, true)
 end
 
 Given /^a JSON lexer$/ do
-  @json_parser = Gherkin::JSONLexer.new(@formatter)
+  @json_parser = Gherkin::JSONParser.new(@formatter)
 end
 
 Given /^the following JSON is parsed:$/ do |text|
-  @json_parser.scan(JSON.pretty_generate(JSON.parse(text)))
+  @json_parser.parse(JSON.pretty_generate(JSON.parse(text)))
 end
 
 Then /^the outputted text should be:$/ do |expected_text|
-  expected_text.should == @io.string.strip
+  @io.string.strip.should == expected_text
 end

data/features/step_definitions/pretty_formatter_steps.rb

@@ -3,38 +3,34 @@ require 'fileutils'
 require 'gherkin'
 require 'gherkin/formatter/pretty_formatter'
 require 'gherkin/formatter/json_formatter'
-require 'gherkin/json_lexer'
+require 'gherkin/json_parser'
 
 module PrettyPlease
   def pretty_machinery(gherkin, feature_path)
     io        = StringIO.new
     formatter = Gherkin::Formatter::PrettyFormatter.new(io, false)
-    listener  = Gherkin::Parser::FormatterListener.new(formatter)
-    parser    = Gherkin::Parser::Parser.new(listener, true)
-    lexer     = Gherkin::I18nLexer.new(parser)
-    scan(lexer, gherkin, feature_path)
+    parser    = Gherkin::Parser::Parser.new(formatter, true)
+    parse(parser, gherkin, feature_path)
     io.string
   end
 
   def json_machinery(gherkin, feature_path)
     json                = StringIO.new
     json_formatter      = Gherkin::Formatter::JSONFormatter.new(json)
-    formatter_listener  = Gherkin::Parser::FormatterListener.new(json_formatter)
-    gherkin_lexer       = Gherkin::I18nLexer.new(formatter_listener)
-    scan(gherkin_lexer, gherkin, feature_path)
+    gherkin_parser      = Gherkin::Parser::Parser.new(json_formatter, true)
+    parse(gherkin_parser, gherkin, feature_path)
 
     result              = StringIO.new
     pretty_formatter    = Gherkin::Formatter::PrettyFormatter.new(result, false)
-    formatter_listener  = Gherkin::Parser::FormatterListener.new(pretty_formatter)
-    json_lexer          = Gherkin::JSONLexer.new(formatter_listener)
-    json_lexer.scan(json.string)
+    json_parser         = Gherkin::JSONParser.new(pretty_formatter)
+    json_parser.parse(json.string)
     
     result.string
   end
   
-  def scan(lexer, gherkin, feature_path)
+  def parse(parser, gherkin, feature_path)
     begin
-      lexer.scan(gherkin, feature_path, 0)
+      parser.parse(gherkin, feature_path, 0)
     rescue => e
       if e.message =~ /Lexing error/
         FileUtils.mkdir "tmp" unless File.directory?("tmp")

data/features/support/env.rb

@@ -24,7 +24,7 @@ class GherkinWorld
   include TransformHelpers
   
   def initialize
-    @listener = Gherkin::SexpRecorder.new
+    @formatter = Gherkin::SexpRecorder.new
   end
 end
 

data/lib/gherkin/formatter/argument.rb

@@ -11,6 +11,7 @@ module Gherkin
       end
       
       def self.format(string, argument_format, arguments)
+        arguments ||= []
         s = string.dup
         offset = past_offset = 0
         arguments.each do |arg|

data/lib/gherkin/formatter/filter_formatter.rb

@@ -0,0 +1,149 @@
+require 'gherkin/rubify'
+require 'gherkin/tag_expression'
+require 'gherkin/formatter/regexp_filter'
+require 'gherkin/formatter/line_filter'
+require 'gherkin/formatter/model'
+
+module Gherkin
+  module Formatter
+    class FilterFormatter
+      include Rubify
+      
+      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 feature(statement, uri)
+        @feature_tags   = statement.tags
+        @feature_name   = statement.name
+        @feature_events = [[:feature, statement, uri]]
+      end
+
+      def background(statement)
+        @feature_element_name   = statement.name
+        @feature_element_range  = statement.line_range
+        @background_events      = [[:background, statement]]
+      end
+
+      def scenario(statement)
+        replay!
+        @feature_element_tags   = statement.tags
+        @feature_element_name   = statement.name
+        @feature_element_range  = statement.line_range
+        @feature_element_events = [[:scenario, statement]]
+      end
+
+      def scenario_outline(statement)
+        replay!
+        @feature_element_tags   = statement.tags
+        @feature_element_name   = statement.name
+        @feature_element_range  = statement.line_range
+        @feature_element_events = [[:scenario_outline, statement]]
+        @examples_events.clear
+      end
+
+      def examples(statement, examples_rows)
+        replay!
+        @examples_tags = statement.tags
+        @examples_name = statement.name
+
+        table_body_range = examples_rows.to_a[1].line..examples_rows.to_a[-1].line
+        @examples_range = statement.line_range.first..table_body_range.last
+        if(LineFilter === @filter && @filter.eval([table_body_range]))
+          examples_rows = @filter.filter_table_body_rows(examples_rows)
+        end
+        @examples_events = [[:examples, statement, examples_rows]]
+      end
+
+      def step(statement, multiline_arg, result)
+        args = [:step, statement, multiline_arg, result]
+        if @feature_element_events.any?
+          @feature_element_events << args
+        else
+          @background_events << args
+        end
+
+        if LineFilter === @filter
+          step_range = statement.line_range
+          case rubify(multiline_arg)
+          when Model::PyString
+            step_range = step_range.first..multiline_arg.line_range.last
+          when Array
+            step_range = step_range.first..multiline_arg.to_a[-1].line
+          end
+          @feature_element_range = @feature_element_range.first..step_range.last
+        end
+      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 
+          TagExpression.new(filters)
+        end
+      end
+
+      def replay!
+        case @filter
+        when TagExpression
+          background_ok      = false
+          feature_element_ok = @filter.eval(tag_names(@feature_tags.to_a + @feature_element_tags.to_a))
+          examples_ok        = @filter.eval(tag_names(@feature_tags.to_a + @feature_element_tags.to_a + @examples_tags.to_a)) if @examples_tags
+        when RegexpFilter
+          background_ok      = @filter.eval([@background_name]) if @background_name
+          feature_element_ok = @filter.eval([@feature_element_name])
+          examples_ok        = @filter.eval([@feature_element_name, @examples_name]) if @examples_name
+        when LineFilter
+          background_ok      = @filter.eval([@background_range]) if @background_range
+          feature_element_ok = @filter.eval([@feature_element_range]) if @feature_element_range
+          examples_ok        = @filter.eval([@feature_element_range, @examples_range]) if @examples_range
+        end
+
+        if background_ok || feature_element_ok || examples_ok
+          replay_events!(@feature_events)
+          replay_events!(@background_events)
+
+          if feature_element_ok || examples_ok
+            replay_events!(@feature_element_events)
+            if examples_ok
+              replay_events!(@examples_events)
+            end
+          end
+        end
+      end
+
+      def tag_names(tags)
+        tags.to_a.uniq.map{|tag| tag.name}
+      end
+
+      def replay_events!(events)
+        events.each do |event|
+          @formatter.__send__(*event)
+        end
+        events.clear
+      end
+    end
+  end
+end