gherkin 2.1.5 → 2.2.0

data/History.txt

@@ -1,3 +1,19 @@
+== 2.2.0 (2010-07-26)
+
+This release breaks some APIs since the previous 2.1.5 release. If you install gherkin 2.2.0 you must also upgrade to
+Cucumber 0.9.0.
+
+=== Bugfixes
+* I18nLexer doesn't recognise language header with \r\n on OS X. (#70 Aslak Hellesøy)
+
+=== New Features
+* Pure Java FilterFormatter. (Aslak Hellesøy)
+* Pure Java JSONFormatter. (Aslak Hellesøy)
+
+=== Changed Features
+* All formatter events take exactly one argument. Each argument is a single object with all data. (Aslak Hellesøy)
+* Several java classes have moved to a different package in order to improve separation of concerns. (Aslak Hellesøy)
+
 == 2.1.5 (2010-07-17)
 
 === Bugfixes

data/README.rdoc

@@ -32,6 +32,7 @@ E.g. in Bash, export RL_LANG="en,fr,no". This can be quite helpful when modifyin
 ** java/pom.xml
 ** ikvm/Gherkin/Gherkin.csproj
 * Make sure both JRuby and MRI has the latest Cucumber installed (from source) otherwise the jruby gem might not get the jar inside it.
+** Install cucumber without gherkin dep: gem install --ignore-dependencies pkg/cucumber
 * rake release:ALL
 * Announce on Cucumber list, IRC and Twitter.
 

data/Rakefile

@@ -21,7 +21,7 @@ begin
     gem.add_dependency "trollop", "~> 1.16.2"
     gem.add_development_dependency 'awesome_print', '~> 0.2.1'
     gem.add_development_dependency 'rspec', '~> 2.0.0.beta.17'
-    gem.add_development_dependency "cucumber", "~> 0.8.5"
+    gem.add_development_dependency "cucumber", "~> 0.9.0"
     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: 1
-:patch: 5
+:minor: 2
+:patch: 0
 :build: 

data/features/json_formatter.feature

@@ -16,13 +16,11 @@ Feature: JSON formatter
     Then the outputted JSON should be:
       """
       {
-        "type": "feature", 
         "comments": [{"value": "# language: no", "line": 1}, {"value": "# Another comment", "line": 2}],
         "keyword": "Egenskap",
         "name": "Kjapp",
         "description": "",
-        "line": 3,
-        "uri": "test.feature"
+        "line": 3
       }
       """
 
@@ -73,13 +71,11 @@ Feature: JSON formatter
     Then the outputted JSON should be:
       """
       {
-        "type": "feature", 
         "tags": [{"name": "@one", "line":1}],
         "keyword": "Feature",
         "name": "OH HAI",
         "description": "",
         "line": 2,
-        "uri": "test.feature",
         "elements":[
           {
             "type": "scenario",
@@ -136,13 +132,12 @@ Feature: JSON formatter
             ],
             "examples": [
               {
-                "type": "examples", 
                 "tags": [{"name": "@five", "line":17}],
                 "keyword": "Examples",
                 "name": "Real life",
                 "description": "",
                 "line": 18,
-                "table": [
+                "rows": [
                   {
                     "cells": ["boredom"],
                     "line": 19
@@ -209,13 +204,12 @@ Feature: JSON formatter
             ],
             "examples": [
               {
-                "type": "examples", 
                 "comments": [{"value": "# comments", "line": 36}, {"value": "# everywhere", "line": 37}],
                 "keyword": "Examples",
                 "name": "An example",
                 "description": "",
                 "line": 38,
-                "table": [
+                "rows": [
                   {
                     "comments": [{"value": "# I mean", "line": 39}],
                     "line": 40,
@@ -244,12 +238,10 @@ Feature: JSON formatter
     Then the outputted JSON should be:
       """
       {
-        "type": "feature", 
         "keyword": "Feature",
         "name": "Kjapp",
         "description": "",
         "line": 1,
-        "uri": "test.feature",
         "elements": [
           {
             "type": "background",

data/features/json_parser.feature

@@ -10,7 +10,6 @@ Feature: JSON lexer
     Given the following JSON is parsed:
       """
       {
-        "type": "feature",
         "comments": [
           {"value": "# language: no"}, 
           {"value": "# Another comment"}
@@ -33,7 +32,6 @@ Feature: JSON lexer
     Given the following JSON is parsed:
       """
       {
-        "type": "feature",
         "comments": [],
         "keyword": "Feature",
         "name": "OH HAI",
@@ -112,7 +110,7 @@ Feature: JSON lexer
                 "name": "Real life",
                 "description": "",
                 "line": 18,
-                "table": [
+                "rows": [
                   {
                     "comments": [],
                     "cells": ["boredom"],
@@ -195,7 +193,7 @@ Feature: JSON lexer
                 "name": "An example",
                 "description": "",
                 "line": 38,
-                "table": [
+                "rows": [
                   {
                     "comments": [{"value": "# I mean"}],
                     "line": 40,
@@ -263,7 +261,6 @@ Feature: JSON lexer
     Given the following JSON is parsed:
       """
       {
-        "type": "feature",
         "comments": [],
         "description": "",
         "keyword": "Feature",

data/features/step_definitions/json_lexer_steps.rb

@@ -12,7 +12,7 @@ Given /^a JSON lexer$/ do
 end
 
 Given /^the following JSON is parsed:$/ do |text|
-  @json_parser.parse(JSON.pretty_generate(JSON.parse(text)))
+  @json_parser.parse(JSON.pretty_generate(JSON.parse(text)), "unknown.json")
 end
 
 Then /^the outputted text should be:$/ do |expected_text|

data/features/step_definitions/pretty_formatter_steps.rb

@@ -23,7 +23,7 @@ module PrettyPlease
     result              = StringIO.new
     pretty_formatter    = Gherkin::Formatter::PrettyFormatter.new(result, false)
     json_parser         = Gherkin::JSONParser.new(pretty_formatter)
-    json_parser.parse(json.string)
+    json_parser.parse(json.string, "#{feature_path}.json")
     
     result.string
   end

data/features/support/env.rb

@@ -3,8 +3,9 @@
   $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + path)
 end
 require 'gherkin'
-require "gherkin/sexp_recorder"
+require 'gherkin/sexp_recorder'
 require 'gherkin/output_stream_string_io'
+require 'gherkin/json'
 
 module TransformHelpers
   def tr_line_number(step_arg)

data/lib/gherkin.rb

@@ -1,2 +1,2 @@
-require 'gherkin/i18n_lexer'
+require 'gherkin/lexer/i18n_lexer'
 require 'gherkin/parser/parser'

data/lib/gherkin/formatter/filter_formatter.rb

@@ -1,19 +1,19 @@
-require 'gherkin/rubify'
 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
-      include Rubify
+      native_impl('gherkin')
       
       def initialize(formatter, filters)
         @formatter = formatter
         @filter    = detect_filter(filters)
 
-
         @feature_tags           = []
         @feature_element_tags   = []
         @examples_tags          = []
@@ -24,67 +24,59 @@ module Gherkin
         @examples_events        = []
       end
 
-      def feature(statement, uri)
-        @feature_tags   = statement.tags
-        @feature_name   = statement.name
-        @feature_events = [[:feature, statement, uri]]
+      def uri(uri)
+        @formatter.uri(uri)
+      end
+
+      def feature(feature)
+        @feature_tags   = feature.tags
+        @feature_name   = feature.name
+        @feature_events = [feature]
       end
 
-      def background(statement)
-        @feature_element_name   = statement.name
-        @feature_element_range  = statement.line_range
-        @background_events      = [[:background, statement]]
+      def background(background)
+        @feature_element_name   = background.name
+        @feature_element_range  = background.line_range
+        @background_events      = [background]
       end
 
-      def scenario(statement)
+      def scenario(scenario)
         replay!
-        @feature_element_tags   = statement.tags
-        @feature_element_name   = statement.name
-        @feature_element_range  = statement.line_range
-        @feature_element_events = [[:scenario, statement]]
-        @examples_events.clear
+        @feature_element_tags   = scenario.tags
+        @feature_element_name   = scenario.name
+        @feature_element_range  = scenario.line_range
+        @feature_element_events = [scenario]
       end
 
-      def scenario_outline(statement)
+      def scenario_outline(scenario_outline)
         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
+        @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(statement, examples_rows)
+      def examples(examples)
         replay!
-        @examples_tags = statement.tags
-        @examples_name = statement.name
+        @examples_tags = examples.tags
+        @examples_name = examples.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)
+        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, statement, examples_rows]]
+        @examples_events = [examples]
       end
 
-      def step(statement, multiline_arg, result)
-        args = [:step, statement, multiline_arg, result]
+      def step(step)
         if @feature_element_events.any?
-          @feature_element_events << args
+          @feature_element_events << step
         else
-          @background_events << args
+          @background_events << step
         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
+        @feature_element_range = @feature_element_range.first..step.line_range.last
       end
 
       def eof
@@ -102,22 +94,21 @@ module Gherkin
         when Regexp 
           RegexpFilter.new(filters)
         when String 
-          TagExpression.new(filters)
+          TagFilter.new(filters)
         end
       end
 
       def replay!
-        case @filter
-        when TagExpression
-          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
-          feature_element_ok = @filter.eval([@feature_element_name])
-          examples_ok        = @filter.eval([@feature_element_name, @examples_name]) if @examples_name
-        when LineFilter
-          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
+        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)
@@ -128,15 +119,15 @@ module Gherkin
             replay_events!(@examples_events)
           end
         end
-      end
 
-      def tag_names(tags)
-        tags.to_a.uniq.map{|tag| tag.name}
+        @examples_events.clear
+        @examples_tags.clear
+        @examples_name = nil
       end
 
       def replay_events!(events)
         events.each do |event|
-          @formatter.__send__(*event)
+          event.replay(@formatter)
         end
         events.clear
       end

data/lib/gherkin/formatter/json_formatter.rb

@@ -1,132 +1,64 @@
 require 'json'
 require 'json/pure' # Needed to make JSON.generate work.
-require 'gherkin/rubify'
 require 'gherkin/formatter/model'
+require 'gherkin/native'
 
 module Gherkin
   module Formatter
     class JSONFormatter
-      include Rubify
+      native_impl('gherkin')
       
       def initialize(io)
         @io = io
       end
 
-      def feature(statement, uri)
-        @json_hash = statement_hash('feature', statement)
-        @json_hash['uri'] = uri
+      def uri(uri)
       end
 
-      def background(statement)
-        add_step_container('background', statement)
+      def feature(feature)
+        @feature_hash = feature.to_hash
       end
 
-      def scenario(statement)
-        add_step_container('scenario', statement)
+      def background(background)
+        feature_elements << background.to_hash
       end
 
-      def scenario_outline(statement)
-        add_step_container('scenario_outline', statement)
+      def scenario(scenario)
+        feature_elements << scenario.to_hash
       end
 
-      def examples(statement, examples_rows)
-        @table_container = add_examples(statement)
-        @table_container['table'] = to_hash_array(examples_rows)
+      def scenario_outline(scenario_outline)
+        feature_elements << scenario_outline.to_hash
       end
 
-      def step(statement, multiline_arg, result)
-        @table_container = statement_hash(nil, statement).merge(step_arg_to_hash(multiline_arg))
-        last_element['steps'] ||= []
-        last_element['steps'] << @table_container
+      def examples(examples)
+        all_examples << examples.to_hash
       end
 
-      def eof
-        @io.write(@json_hash.to_json)
-      end
-
-    private
-
-      def statement_hash(type, statement)
-        element = {
-          'keyword' => statement.keyword, 
-          'name' => statement.name, 
-          'line' => statement.line,
-        }
-        element['type'] = type if type
-        add_comments(element, statement)
-        add_tags(element, statement)
-        element['description'] = statement.description if statement.description
-        element
-      end
-
-      def add_comments(element, comment_holder)
-        if comment_holder.comments && comment_holder.comments.any?
-          element['comments'] = comment_holder.comments.map do |comment|
-            {'value' => comment.value, 'line' => comment.line}
-          end
-        end
-      end
-
-      def add_tags(element, statement)
-        if statement.tags && statement.tags.any?
-          element['tags'] = statement.tags.map do |tag|
-            {'name' => tag.name, 'line' => tag.line}
-          end
-        end
+      def step(step)
+        steps << step.to_hash
       end
 
-      def add_element(type, statement)
-        element = statement_hash(type, statement)
-        @json_hash['elements'] ||= []
-        @json_hash['elements'] << element
-        element
+      def eof
+        @io.write(@feature_hash.to_json)
       end
 
-      def add_examples(statement)
-        element = statement_hash('examples', statement)
-        last_element['examples'] ||= []
-        last_element['examples'] << element
-        element
-      end
+    private
 
-      def add_step_container(type, statement)
-        add_element(type, statement)
-        last_element['steps'] = []
+      def feature_elements
+        @feature_hash['elements'] ||= []
       end
 
-      def last_element
-        @json_hash['elements'][-1]
+      def feature_element
+        feature_elements[-1]
       end
 
-      def to_hash_array(rows)
-        rows.map do |row|
-          e = {"cells" => row.cells.to_a, "line" => row.line}
-          add_comments(e, row)
-          e
-        end
+      def all_examples
+        feature_element['examples'] ||= []
       end
 
-      def step_arg_to_hash(multiline_arg)
-        multiline_arg = rubify(multiline_arg)
-        case multiline_arg
-        when Array
-          {
-            "multiline_arg" => {
-              "type" => "table",
-              "value" => to_hash_array(multiline_arg)
-            }
-          }
-        when Model::PyString
-          {
-            "multiline_arg" => {
-              "type" => "py_string",
-              "value" => multiline_arg.value,
-              "line" => multiline_arg.line
-            }
-          }
-        else
-          {}
-        end
+      def steps
+        feature_element['steps'] ||= []
       end
     end
   end