gherkin 2.3.1 → 2.3.2

data/History.txt

@@ -1,3 +1,12 @@
+== 2.3.2 (2010-12-05)
+
+(Somehow 2.3.1 was released improperly shortly after 2.3.0 - not sure what fixes went into that!)
+
+=== Bugfixes
+* Preserve whitespace in descriptions. Leading whitespace in descriptions are stripped upto preceding keyword + 2 spaces (#87 Matt Wynne, Gregory Hnatiuk, Aslak Hellesøy)
+* Fix incorrect indentation of Examples descriptions (Gregory Hnatiuk)
+* Can't define new line characters in Example Table Cell's Content. (#85 George Montana Harkin, Aslak Hellesøy)
+
 == 2.3.0 (2010-11-12)
 
 === New Features

data/README.rdoc

@@ -39,8 +39,8 @@ Running RSpec and Cucumber tests
 
   rake clean spec cucumber
 
-If the RL_LANG environment variable is set, only the parsers for the languages specified there will be built.
-E.g. in Bash, export RL_LANG="en,fr,no". This can be quite helpful when modifying the Ragel grammar.
+If the RL_LANGS environment variable is set, only the parsers for the languages specified there will be built.
+E.g. in Bash, export RL_LANGS="en,fr,no". This can be quite helpful when modifying the Ragel grammar.
 
 See subsections for building for a specific platform.
 

data/VERSION

@@ -1 +1 @@
-2.3.1
+2.3.2

data/features/json_formatter.feature

@@ -275,4 +275,103 @@ Feature: JSON formatter
         ]
       }
       """
+  
+  Scenario: Feature with a description
+
+    We want people to be able to put markdown formatting into their descriptions
+    but this means we need to respect whitespace at the start and end of lines
+    in the description.
+    
+    Pay close attention to the whitespace in this example.
     
+    Given the following text is parsed:
+      """
+      Feature: Foo
+        one line  
+        another line  
+        
+            some pre-formatted stuff
+        
+        Background: name
+            test  
+            test 
+        
+        Scenario: name
+            test  
+            test 
+        
+        Scenario Outline: name
+            test  
+            test 
+          
+          Given <foo> 
+            
+          Examples: name
+              test  
+              test 
+            | foo   |
+            | table |
+      """
+    Then the outputted JSON should be:
+      """
+      {
+        "keyword": "Feature",
+        "name": "Foo",
+        "description": "one line  \nanother line  \n\n    some pre-formatted stuff",
+        "line": 1,
+        "elements": [
+          {
+            "description": "  test  \n  test",
+            "keyword": "Background",
+            "line": 7,
+            "name": "name",
+            "type": "background"
+          },
+          {
+            "description": "  test  \n  test",
+            "keyword": "Scenario",
+            "line": 11,
+            "name": "name",
+            "type": "scenario"
+          },
+          {
+            "description": "  test  \n  test",
+            "examples": [
+              {
+                "description": "  test  \n  test",
+                "keyword": "Examples",
+                "line": 21,
+                "name": "name",
+                "rows": [
+                  {
+                    "cells": [
+                      "foo"
+                    ],
+                    "line": 24
+                  },
+                  {
+                    "cells": [
+                      "table"
+                    ],
+                    "line": 25
+                  }
+                ]
+              }
+            ],
+            "keyword": "Scenario Outline",
+            "line": 15,
+            "name": "name",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "line": 19,
+                "name": "<foo>"
+              }
+            ],
+            "type": "scenario_outline"
+          }
+        ]
+      }
+      """
+
+

data/features/step_definitions/json_parser_steps.rb

@@ -6,7 +6,7 @@ World(Gherkin::Formatter::Colors)
 
 Given /^a PrettyFormatter$/ do
   @io = StringIO.new
-  @formatter = Gherkin::Formatter::PrettyFormatter.new(@io, true)
+  @formatter = Gherkin::Formatter::PrettyFormatter.new(@io, true, false)
 end
 
 Given /^a JSON lexer$/ do

data/features/step_definitions/pretty_formatter_steps.rb

@@ -10,7 +10,7 @@ module PrettyPlease
   
   def pretty_machinery(gherkin, feature_path)
     io        = StringIO.new
-    formatter = Gherkin::Formatter::PrettyFormatter.new(io, true)
+    formatter = Gherkin::Formatter::PrettyFormatter.new(io, true, false)
     parser    = Gherkin::Parser::Parser.new(formatter, true)
     parse(parser, gherkin, feature_path)
     io.string
@@ -23,7 +23,7 @@ module PrettyPlease
     parse(gherkin_parser, gherkin, feature_path)
 
     io                  = StringIO.new
-    pretty_formatter    = Gherkin::Formatter::PrettyFormatter.new(io, true)
+    pretty_formatter    = Gherkin::Formatter::PrettyFormatter.new(io, true, false)
     json_parser         = Gherkin::JSONParser.new(pretty_formatter)
     json_parser.parse(json.string, "#{feature_path}.json", 0)
     

data/lib/gherkin/formatter/colors.rb

@@ -13,8 +13,8 @@ module Gherkin
     # <tt>undefined</tt>::     defaults to <tt>yellow</tt>
     # <tt>pending</tt>::       defaults to <tt>yellow</tt>
     # <tt>pending_arg</tt>::   defaults to <tt>yellow,bold</tt>
-    # <tt>executing</tt>::     defaults to <tt>magenta</tt>
-    # <tt>executing_arg</tt>:: defaults to <tt>magenta,bold</tt>
+    # <tt>executing</tt>::     defaults to <tt>grey</tt>
+    # <tt>executing_arg</tt>:: defaults to <tt>grey,bold</tt>
     # <tt>failed</tt>::        defaults to <tt>red</tt>
     # <tt>failed_arg</tt>::    defaults to <tt>red,bold</tt>
     # <tt>passed</tt>::        defaults to <tt>green</tt>
@@ -49,7 +49,7 @@ module Gherkin
       end.merge({
         'undefined' => 'yellow',
         'pending'   => 'yellow',
-        'executing' => 'magenta',
+        'executing' => 'grey',
         'failed'    => 'red',
         'passed'    => 'green',
         'outline'   => 'cyan',

data/lib/gherkin/formatter/escaping.rb

@@ -8,7 +8,7 @@ module Gherkin
       #
       # This is used in the pretty formatter.
       def escape_cell(s)
-        s.gsub(/\|/, "\\|").gsub(/\\(?!\|)/, "\\\\\\\\")
+        s.gsub(/\\(?!\|)/, "\\\\\\\\").gsub(/\n/, "\\n").gsub(/\|/, "\\|")
       end
     end
   end

data/lib/gherkin/formatter/json_formatter.rb

@@ -94,7 +94,7 @@ module Gherkin
 
       def encode64s(data)
         # Strip newlines
-        encode64(data).gsub(/\n/, '')
+        Base64.encode64(data).gsub(/\n/, '')
       end
     end
   end

data/lib/gherkin/formatter/pretty_formatter.rb

@@ -14,10 +14,11 @@ module Gherkin
       include Colors
       include Escaping
 
-      def initialize(io, monochrome=false)
+      def initialize(io, monochrome, executing)
         @io = io
         @step_printer = StepPrinter.new
         @monochrome = monochrome
+        @executing = executing
       end
 
       def uri(uri)
@@ -55,14 +56,19 @@ module Gherkin
         print_comments(examples.comments, '    ')
         print_tags(examples.tags, '    ')
         @io.puts "    #{examples.keyword}: #{examples.name}"
-        print_description(examples.description, '    ')
+        print_description(examples.description, '      ')
         table(examples.rows)
       end
 
       def step(step)
         @step = step
         @step_index += 1 if @step_index
-        match(Model::Match.new([], nil)) if @monochrome
+        # TODO: It feels a little funny to have this logic here in the formatter.
+        # We may have to duplicate it across formatters. So maybe we should move
+        # this out to the callers instead.
+        #
+        # Maybe it's a Filter!! ExecuteFilter and PrettyFilter
+        match(Model::Match.new([], nil)) unless @executing
       end
 
       def match(match)
@@ -225,4 +231,4 @@ module Gherkin
       end
     end
   end
-end
+end

data/lib/gherkin/i18n.rb

@@ -56,17 +56,13 @@ module Gherkin
         require 'stringio'
         require 'gherkin/formatter/pretty_formatter'
         require 'gherkin/formatter/model'
-        io = defined?(JRUBY_VERSION) ? Java.java.io.StringWriter.new : StringIO.new
-        pf = Gherkin::Formatter::PrettyFormatter.new(io)
+        io = StringIO.new
+        pf = Gherkin::Formatter::PrettyFormatter.new(io, false, false)
         table = all.map do |i18n|
           Formatter::Model::Row.new([], [i18n.iso_code, i18n.keywords('name')[0], i18n.keywords('native')[0]], nil)
         end
         pf.table(table)
-        if defined?(JRUBY_VERSION)
-          io.getBuffer.toString
-        else
-          io.string
-        end
+        io.string
       end
 
       def unicode_escape(word, prefix="\\u")
@@ -149,7 +145,7 @@ module Gherkin
       require 'gherkin/formatter/pretty_formatter'
       require 'gherkin/formatter/model'
       io = StringIO.new
-      pf = Gherkin::Formatter::PrettyFormatter.new(io)
+      pf = Gherkin::Formatter::PrettyFormatter.new(io, false, false)
 
       gherkin_keyword_table = KEYWORD_KEYS.map do |key|
         Formatter::Model::Row.new([], [key, keywords(key).map{|keyword| %{"#{keyword}"}}.join(', ')], nil)
@@ -163,8 +159,7 @@ module Gherkin
       end
       
       pf.table(gherkin_keyword_table + code_keyword_table)
-      io.rewind
-      io.read
+      io.string
     end
 
     private

data/lib/gherkin/json_parser.rb

@@ -78,7 +78,7 @@ module Gherkin
 
     def embeddings(o)
       (o['embeddings'] || []).each do |embedding|
-        @formatter.embedding(embedding['mime_type'], decode64(embedding['data']))
+        @formatter.embedding(embedding['mime_type'], Base64::decode64(embedding['data']))
       end
     end
 

data/ragel/lexer.c.rl.erb

@@ -20,11 +20,6 @@
     rb_str_new(ptr, len)
 #endif
 
-#define LF_FLAG      0
-#define CRLF_FLAG    1
-#define LF           "\n"
-#define CRLF         "\r\n"
-
 #ifndef RSTRING_PTR
 #define RSTRING_PTR(s) (RSTRING(s)->ptr)
 #endif
@@ -44,7 +39,6 @@ typedef struct lexer_state {
   int line_number;
   int current_line;
   int start_col;
-  int eol;
   size_t mark;
   size_t keyword_start;
   size_t keyword_end;
@@ -70,7 +64,7 @@ static VALUE rb_eGherkinLexingError;
   store_multiline_kw_con(listener, # EVENT, \
     PTR_TO(keyword_start), LEN(keyword_start, PTR_TO(keyword_end - 1)), \
     PTR_TO(content_start), LEN(content_start, PTR_TO(content_end)), \
-    lexer->current_line, lexer->eol); \
+    lexer->current_line, lexer->start_col); \
     if (lexer->content_end != 0) { \
       p = PTR_TO(content_end - 1); \
     } \
@@ -87,6 +81,7 @@ static VALUE rb_eGherkinLexingError;
   action begin_content {
 		MARK(content_start, p);
     lexer->current_line = lexer->line_number;
+    lexer->start_col = lexer->content_start - lexer->last_newline - (lexer->keyword_end - lexer->keyword_start) + 2;
   }
   
   action begin_pystring_content {
@@ -183,8 +178,10 @@ static VALUE rb_eGherkinLexingError;
     VALUE con = ENCODED_STR_NEW(PTR_TO(content_start), LEN(content_start, p));
     rb_funcall(con, rb_intern("strip!"), 0);
     VALUE re_pipe      = rb_reg_regcomp(rb_str_new2("\\\\\\|"));
+    VALUE re_newline   = rb_reg_regcomp(rb_str_new2("\\\\n"));
     VALUE re_backslash = rb_reg_regcomp(rb_str_new2("\\\\\\\\"));
     rb_funcall(con, rb_intern("gsub!"), 2, re_pipe,      rb_str_new2("|"));
+    rb_funcall(con, rb_intern("gsub!"), 2, re_newline,   rb_str_new2("\n"));
     rb_funcall(con, rb_intern("gsub!"), 2, re_backslash, rb_str_new2("\\"));
 
     rb_ary_push(current_row, con);
@@ -247,23 +244,16 @@ static VALUE rb_eGherkinLexingError;
 %% write data;
 
 static VALUE 
-strip_i(VALUE str, VALUE ary)
+unindent(VALUE con, int start_col)
 {
-  rb_funcall(str, rb_intern("strip!"), 0);
-  rb_ary_push(ary, str);
-  
+  // Gherkin will crash gracefully if the string representation of start_col pushes the pattern past 32 characters
+  char pat[32]; 
+  snprintf(pat, 32, "^[\t ]{0,%d}", start_col); 
+  VALUE re = rb_reg_regcomp(rb_str_new2(pat));
+  rb_funcall(con, rb_intern("gsub!"), 2, re, rb_str_new2(""));
+
   return Qnil;
-}
 
-static VALUE 
-multiline_strip(VALUE text)
-{
-  VALUE map = rb_ary_new();
-  VALUE split = rb_str_split(text, "\n");
-  
-  rb_iterate(rb_each, split, strip_i, map);
-  
-  return split;
 }
 
 static void 
@@ -283,18 +273,19 @@ static void
 store_multiline_kw_con(VALUE listener, const char * event_name,
                       const char * keyword_at, size_t keyword_length,
                       const char * at,         size_t length,
-                      int current_line, int eol)
+                      int current_line, int start_col)
 {
   VALUE con = Qnil, kw = Qnil, name = Qnil, desc = Qnil;
 
   kw = ENCODED_STR_NEW(keyword_at, keyword_length);
   con = ENCODED_STR_NEW(at, length);
 
-  VALUE split = multiline_strip(con);
+  unindent(con, start_col);
   
+  VALUE split = rb_str_split(con, "\n");
+
   name = rb_funcall(split, rb_intern("shift"), 0);
-  desc = rb_ary_join(split, rb_str_new2( \
-          eol == CRLF_FLAG ? CRLF : LF ));
+  desc = rb_ary_join(split, rb_str_new2( "\n" ));
 
   if( name == Qnil ) 
   {
@@ -305,7 +296,7 @@ store_multiline_kw_con(VALUE listener, const char * event_name,
     desc = rb_str_new2("");
   }
   rb_funcall(name, rb_intern("strip!"), 0);
-  rb_funcall(desc, rb_intern("strip!"), 0);
+  rb_funcall(desc, rb_intern("rstrip!"), 0);
   rb_funcall(listener, rb_intern(event_name), 4, kw, name, desc, INT2FIX(current_line)); 
 }
 
@@ -325,13 +316,11 @@ store_pystring_content(VALUE listener,
           int current_line)
 {
   VALUE con = ENCODED_STR_NEW(at, length);
-  // Gherkin will crash gracefully if the string representation of start_col pushes the pattern past 32 characters
-  char pat[32]; 
-  snprintf(pat, 32, "^[\t ]{0,%d}", start_col); 
-  VALUE re = rb_reg_regcomp(rb_str_new2(pat));
+
+  unindent(con, start_col);
+
   VALUE re2 = rb_reg_regcomp(rb_str_new2("\r\\Z"));
   VALUE unescape_escaped_quotes = rb_reg_regcomp(rb_str_new2("\\\\\"\\\\\"\\\\\""));
-  rb_funcall(con, rb_intern("gsub!"), 2, re, rb_str_new2(""));
   rb_funcall(con, rb_intern("sub!"), 2, re2, rb_str_new2(""));
   rb_funcall(con, rb_intern("gsub!"), 2, unescape_escaped_quotes, rb_str_new2("\"\"\""));
   rb_funcall(listener, rb_intern("py_string"), 2, con, INT2FIX(current_line));
@@ -343,20 +332,6 @@ raise_lexer_error(const char * at, int line)
   rb_raise(rb_eGherkinLexingError, "Lexing error on line %d: '%s'. See http://wiki.github.com/aslakhellesoy/gherkin/lexingerror for more information.", line, at);
 }
 
-static int 
-count_char(char char_to_count, char *str) {
-
-  int count = 0;
-  int i = 0;
-  while(str[i] != '\0') {
-    if(str[i] == char_to_count) {
-      count++;
-    }
-    i++;
-  }
-  return count;
-}
-
 static void lexer_init(lexer_state *lexer) {
   lexer->content_start = 0;
   lexer->content_end = 0;
@@ -369,7 +344,6 @@ static void lexer_init(lexer_state *lexer) {
   lexer->last_newline = 0;
   lexer->final_newline = 0;
   lexer->start_col = 0;
-  lexer->eol = LF_FLAG;
 }
 
 static VALUE CLexer_alloc(VALUE klass)
@@ -407,10 +381,6 @@ static VALUE CLexer_scan(VALUE self, VALUE input)
   char *data = RSTRING_PTR(input_copy);
   size_t len = RSTRING_LEN(input_copy);
   
-  if (count_char('\r', data) > (count_char('\n', data) / 2)) {
-    lexer->eol = CRLF_FLAG;
-  }
-  
   if (len == 0) { 
     rb_raise(rb_eGherkinLexingError, "No content to lex.");
   } else {

data/ragel/lexer.java.rl.erb

@@ -4,7 +4,6 @@ import java.io.UnsupportedEncodingException;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.regex.Pattern;
-import java.util.regex.Matcher;
 import gherkin.lexer.Lexer;
 import gherkin.lexer.Listener;
 import gherkin.lexer.LexingError;
@@ -17,6 +16,9 @@ public class <%= @i18n.underscored_iso_code.upcase %> implements Lexer {
     action begin_content {
       contentStart = p;
       currentLine = lineNumber;
+      if(keyword != null) {
+        startCol = p - lastNewline - (keyword.length() + 1);
+      }
     }
 
     action start_pystring {
@@ -34,35 +36,35 @@ public class <%= @i18n.underscored_iso_code.upcase %> implements Lexer {
     }
 
     action store_feature_content {
-      String[] nameDescription = nameAndDescriptionWithPlatformNewlinesIntact(keywordContent(data, p, eof, nextKeywordStart, contentStart));
+      String[] nameDescription = nameAndUnindentedDescription(startCol, keywordContent(data, p, eof, nextKeywordStart, contentStart));
       listener.feature(keyword, nameDescription[0], nameDescription[1], currentLine);
       if(nextKeywordStart != -1) p = nextKeywordStart - 1;
       nextKeywordStart = -1;
     }
 
     action store_background_content {
-      String[] nameDescription = nameAndDescriptionWithPlatformNewlinesIntact(keywordContent(data, p, eof, nextKeywordStart, contentStart));
+      String[] nameDescription = nameAndUnindentedDescription(startCol, keywordContent(data, p, eof, nextKeywordStart, contentStart));
       listener.background(keyword, nameDescription[0], nameDescription[1], currentLine);
       if(nextKeywordStart != -1) p = nextKeywordStart - 1;
       nextKeywordStart = -1;
     }
 
     action store_scenario_content {
-      String[] nameDescription = nameAndDescriptionWithPlatformNewlinesIntact(keywordContent(data, p, eof, nextKeywordStart, contentStart));
+      String[] nameDescription = nameAndUnindentedDescription(startCol, keywordContent(data, p, eof, nextKeywordStart, contentStart));
       listener.scenario(keyword, nameDescription[0], nameDescription[1], currentLine);
       if(nextKeywordStart != -1) p = nextKeywordStart - 1;
       nextKeywordStart = -1;
     }
 
     action store_scenario_outline_content {
-      String[] nameDescription = nameAndDescriptionWithPlatformNewlinesIntact(keywordContent(data, p, eof, nextKeywordStart, contentStart));
+      String[] nameDescription = nameAndUnindentedDescription(startCol, keywordContent(data, p, eof, nextKeywordStart, contentStart));
       listener.scenarioOutline(keyword, nameDescription[0], nameDescription[1], currentLine);
       if(nextKeywordStart != -1) p = nextKeywordStart - 1;
       nextKeywordStart = -1;
     }
 
     action store_examples_content {
-      String[] nameDescription = nameAndDescriptionWithPlatformNewlinesIntact(keywordContent(data, p, eof, nextKeywordStart, contentStart));
+      String[] nameDescription = nameAndUnindentedDescription(startCol, keywordContent(data, p, eof, nextKeywordStart, contentStart));
       listener.examples(keyword, nameDescription[0], nameDescription[1], currentLine);
       if(nextKeywordStart != -1) p = nextKeywordStart - 1;
       nextKeywordStart = -1;
@@ -115,7 +117,11 @@ public class <%= @i18n.underscored_iso_code.upcase %> implements Lexer {
 
     action store_cell_content {
       String con = substring(data, contentStart, p).trim();
-      currentRow.add(con.replaceAll("\\\\\\|", "|").replaceAll("\\\\\\\\", "\\\\"));
+      currentRow.add(con
+        .replaceAll("\\\\\\|", "|")
+        .replaceAll("\\\\n", "\n")
+        .replaceAll("\\\\\\\\", "\\\\")
+      );
     }
 
     action store_row {
@@ -173,37 +179,15 @@ public class <%= @i18n.underscored_iso_code.upcase %> implements Lexer {
     return substring(data, contentStart, endPoint);
   }
 
-  private static final Pattern CRLF_RE = Pattern.compile("\r\n");
-  private static final Pattern LF_RE = Pattern.compile("[^\r]\n");
-  private static final String CRLF = "\r\n";
-  private static final String LF = "\n";
-
-  private String[] nameAndDescriptionWithPlatformNewlinesIntact(String text) {
-    int crlfCount = matchCount(CRLF_RE.matcher(text));
-    int lfCount = matchCount(LF_RE.matcher(text));
-    String eol = crlfCount > lfCount ? CRLF : LF;
-
-    String name = null;
+  private String[] nameAndUnindentedDescription(int startCol, String text) {
+    String[] lines = text.split("\n");
+    String name = lines.length > 0 ? lines[0].trim() : "";
     StringBuffer description = new StringBuffer();
-    for(String s : text.split("\r?\n")) {
-      if(name == null) {
-        name = s.trim();
-      } else {
-        description.append(s.trim()).append(eol);
-      }
-    }
-    if(name == null) {
-      name = "";
-    }
-    return new String[]{name, description.toString().trim()};
-  }
-
-  private int matchCount(Matcher m) {
-    int count = 0;
-    while(m.find()) {
-      count++;
+    for(int i = 1; i < lines.length; i++) {
+      description.append(lines[i]);
+      description.append("\n");
     }
-    return count;
+    return new String[]{name, unindent(startCol+2, description.toString()).replaceAll("\\s+$", "")};
   }
 
   private String unindent(int startCol, String text) {

data/ragel/lexer.rb.rl.erb

@@ -5,10 +5,11 @@ module Gherkin
     class <%= @i18n.underscored_iso_code.capitalize %> #:nodoc:
       %%{
         machine lexer;
- 
+        
         action begin_content {
           @content_start = p
           @current_line = @line_number
+          @start_col = p - @last_newline - "#{@keyword}:".length
         }
 
         action start_pystring {
@@ -26,31 +27,32 @@ module Gherkin
         }
  
         action store_feature_content {
-          store_keyword_content(:feature, data, p, eof) { |con| multiline_strip(con) }
+          
+          store_keyword_content(:feature, data, p, eof) { |con| unindent(@start_col + 2, con).rstrip }
           p = @next_keyword_start - 1 if @next_keyword_start          
           @next_keyword_start = nil
         }
  
         action store_background_content {
-          store_keyword_content(:background, data, p, eof) { |con| multiline_strip(con) }
+          store_keyword_content(:background, data, p, eof) { |con| unindent(@start_col + 2, con).rstrip }
           p = @next_keyword_start - 1 if @next_keyword_start                    
           @next_keyword_start = nil
         }
 
         action store_scenario_content {
-          store_keyword_content(:scenario, data, p, eof) { |con| multiline_strip(con) }
+          store_keyword_content(:scenario, data, p, eof) { |con| unindent(@start_col + 2, con).rstrip }
           p = @next_keyword_start - 1 if @next_keyword_start                    
           @next_keyword_start = nil
         }
 
         action store_scenario_outline_content {
-          store_keyword_content(:scenario_outline, data, p, eof) { |con| multiline_strip(con) }
+          store_keyword_content(:scenario_outline, data, p, eof) { |con| unindent(@start_col + 2, con).rstrip }
           p = @next_keyword_start - 1 if @next_keyword_start                    
           @next_keyword_start = nil
         }
 
         action store_examples_content {
-          store_keyword_content(:examples, data, p, eof) { |con| multiline_strip(con) }
+          store_keyword_content(:examples, data, p, eof) { |con| unindent(@start_col + 2, con).rstrip }
           p = @next_keyword_start - 1 if @next_keyword_start                    
           @next_keyword_start = nil
         }
@@ -105,7 +107,7 @@ module Gherkin
 
         action store_cell_content {
           con = utf8_pack(data[@content_start...p]).strip
-          current_row << con.gsub(/\\\|/, "|").gsub(/\\\\/, "\\")
+          current_row << con.gsub(/\\\|/, "|").gsub(/\\n/, "\n").gsub(/\\\\/, "\\")
         }
 
         action store_row {
@@ -145,13 +147,6 @@ module Gherkin
       CRLF = "\r\n"
       LF = "\n"
 
-      def multiline_strip(text)
-        crlf_count = text.scan(CRLF_RE).size
-        lf_count = text.scan(LF_RE).size
-        eol = crlf_count > lf_count ? CRLF : LF
-        text.split(/\r?\n/).map{|s| s.strip}.join(eol).strip
-      end
-
       def unindent(startcol, text)
         text.gsub(/^[\t ]{0,#{startcol}}/, "")
       end

data/spec/gherkin/formatter/filter_formatter_spec.rb

@@ -18,7 +18,7 @@ module Gherkin
 
       def verify_filter(filters, *line_ranges)
         io = StringIO.new
-        pretty_formatter = Gherkin::Formatter::PrettyFormatter.new(io, true)
+        pretty_formatter = Gherkin::Formatter::PrettyFormatter.new(io, true, false)
         filter_formatter = Gherkin::Formatter::FilterFormatter.new(pretty_formatter, filters)
         parser = Gherkin::Parser::Parser.new(filter_formatter)
 

data/spec/gherkin/formatter/pretty_formatter_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'spec_helper'
 require 'gherkin/formatter/pretty_formatter'
 require 'gherkin/formatter/argument'
 require 'gherkin/formatter/model'
@@ -20,7 +21,7 @@ module Gherkin
       def assert_pretty(input, expected_output=input)
         [true, false].each do |force_ruby|
           io = StringIO.new
-          pf = Gherkin::Formatter::PrettyFormatter.new(io, true)
+          pf = Gherkin::Formatter::PrettyFormatter.new(io, true, false)
           parser = Gherkin::Parser::Parser.new(pf, true, "root", force_ruby)
           parser.parse(input, "test.feature", 0)
           output = io.string
@@ -30,7 +31,7 @@ module Gherkin
 
       before do
         @io = StringIO.new
-        @f = Gherkin::Formatter::PrettyFormatter.new(@io, false)
+        @f = Gherkin::Formatter::PrettyFormatter.new(@io, false, true)
       end
 
       it "should print comments when scenario is longer" do
@@ -60,9 +61,9 @@ module Gherkin
   World
 
   Scenario: The scenario #{grey('# features/foo.feature:4')}
-    #{magenta('Given ')}#{magenta('some stuff')}     #{grey('# features/step_definitions/bar.rb:56')}
+    #{grey('Given ')}#{grey('some stuff')}     #{grey('# features/step_definitions/bar.rb:56')}
 \033[1A    #{green('Given ')}#{green('some stuff')}     #{grey('# features/step_definitions/bar.rb:56')}
-    #{magenta('When ')}#{magenta('foo')}             #{grey('# features/step_definitions/bar.rb:96')}
+    #{grey('When ')}#{grey('foo')}             #{grey('# features/step_definitions/bar.rb:96')}
 \033[1A    #{green('When ')}#{green('foo')}             #{grey('# features/step_definitions/bar.rb:96')}
 })
       end
@@ -84,7 +85,7 @@ module Gherkin
   World
 
   Scenario: The scenario            #{grey('# features/foo.feature:4')}
-    #{magenta('Given ')}#{magenta('some stuff that is longer')} #{grey('# features/step_definitions/bar.rb:56')}
+    #{grey('Given ')}#{grey('some stuff that is longer')} #{grey('# features/step_definitions/bar.rb:56')}
 \033[1A    #{green('Given ')}#{green('some stuff that is longer')} #{grey('# features/step_definitions/bar.rb:56')}
 })
       end
@@ -102,12 +103,12 @@ module Gherkin
         if defined?(JRUBY_VERSION)
           # Not terribly readable. The result on Java is different because JANSI uses semicolons when there are several codes.
           assert_io(
-            "    \e[35mGiven \e[0m\e[35mI have \e[0m\e[35;1m999\e[0m\e[35m cukes in my belly\e[0m\n" +
-            "\033[1A    \e[32mGiven \e[0m\e[32mI have \e[0m\e[32;1m999\e[0m\e[32m cukes in my belly\e[0m\n"
+            "    \e[90mGiven \e[0m\e[90mI have \e[0m\e[90m\e[1m999\e[0m\e[90m cukes in my belly\e[0m\n" + 
+            "\e[1A    \e[32mGiven \e[0m\e[32mI have \e[0m\e[32;1m999\e[0m\e[32m cukes in my belly\e[0m\n"
           )
         else
           assert_io(
-            "    #{magenta('Given ')}#{magenta('I have ')}#{magenta(bold('999'))}#{magenta(' cukes in my belly')}\n" +
+            "    #{grey('Given ')}#{grey('I have ')}#{grey(bold('999'))}#{grey(' cukes in my belly')}\n" +
             "\033[1A    #{green('Given ')}#{green('I have ')}#{green(bold('999'))}#{green(' cukes in my belly')}\n"
           )
         end
@@ -167,8 +168,8 @@ Feature: Feature Description
 
       it "should escape backslashes and pipes" do
         io = StringIO.new
-        l = Gherkin::Formatter::PrettyFormatter.new(io, true)
-        l.__send__(:table, [Gherkin::Formatter::Model::Row.new([], ['|', '\\'], nil)])
+        f = Gherkin::Formatter::PrettyFormatter.new(io, true, false)
+        f.__send__(:table, [Gherkin::Formatter::Model::Row.new([], ['|', '\\'], nil)])
         io.string.should == '      | \\| | \\\\ |' + "\n"
       end
     end

data/spec/gherkin/shared/lexer_group.rb

@@ -96,24 +96,24 @@ module Gherkin
           ]
         end
         
-        it "should allow multiline names ending at eof" do
-          scan("Background: I have several\n   Lines to look at\n None starting with Given")
+        it "should allow multiline descriptions ending at eof" do
+          scan("Background: I have several\n   Lines to look at\n   None starting with Given")
           @listener.to_sexp.should == [
-            [:background, "Background", "I have several", "Lines to look at\nNone starting with Given", 1],
+            [:background, "Background", "I have several", " Lines to look at\n None starting with Given", 1],
             [:eof]
           ]
         end
          
-        it "should allow multiline names" do
+        it "should allow multiline descriptions, including whitespace" do
           scan(%{Feature: Hi
 Background: It is my ambition to say 
-            in ten sentences
-            what others say 
-            in a whole book.
+  in ten sentences
+    what others say 
+  in a whole book.
 Given I am a step})
           @listener.to_sexp.should == [
             [:feature, "Feature", "Hi", "", 1],
-            [:background, "Background", "It is my ambition to say", "in ten sentences\nwhat others say\nin a whole book.",2],
+            [:background, "Background", "It is my ambition to say", "in ten sentences\n  what others say \nin a whole book.",2],
             [:step, "Given ", "I am a step", 6],
             [:eof]
           ]
@@ -141,22 +141,22 @@ Given I am a step})
           ]
         end
         
-        it "should allow multiline names" do
+        it "should allow multiline descriptions, including whitespace" do
           scan(%{Scenario: It is my ambition to say
-                          in ten sentences
-                          what others say 
-                          in a whole book.
-                          Given I am a step
-                          })
+  in ten sentences
+  what others say 
+      in a whole book.
+  Given I am a step
+})
           @listener.to_sexp.should == [
-            [:scenario, "Scenario", "It is my ambition to say", "in ten sentences\nwhat others say\nin a whole book.", 1],
+            [:scenario, "Scenario", "It is my ambition to say", "in ten sentences\nwhat others say \n    in a whole book.", 1],
             [:step, "Given ", "I am a step", 5],
             [:eof]
           ]
         end
 
         it "should allow multiline names ending at eof" do
-          scan("Scenario: I have several\n       Lines to look at\n None starting with Given")
+          scan("Scenario: I have several\nLines to look at\n None starting with Given")
           @listener.to_sexp.should == [
             [:scenario, "Scenario", "I have several", "Lines to look at\nNone starting with Given", 1],
             [:eof]
@@ -165,9 +165,9 @@ Given I am a step})
   
         it "should ignore gherkin keywords embedded in other words" do
           scan(%{Scenario: I have a Button
-          Buttons are great
-  Given I have some
-  But I might not because I am a Charles Dickens character
+Buttons are great
+Given I have some
+But I might not because I am a Charles Dickens character
 })
           @listener.to_sexp.should == [
             [:scenario, "Scenario", "I have a Button", "Buttons are great", 1],
@@ -179,7 +179,7 @@ Given I am a step})
         
         it "should allow step keywords in Scenario names" do
           scan(%{Scenario: When I have when in scenario
-          I should be fine
+I should be fine
 Given I am a step
 })
           @listener.to_sexp.should == [
@@ -192,14 +192,15 @@ Given I am a step
 
       describe "Scenario Outlines" do
         it "should be parsed" do
-          scan(%{Scenario Outline: Hello
-                          With a description
-                          Given a <what> cucumber
-                          Examples: With a name
-                          and a description
-                          |what|
-                          |green|
-                          })
+          scan(<<-HERE)
+Scenario Outline: Hello
+  With a description
+  Given a <what> cucumber
+  Examples: With a name
+    and a description
+    |what|
+    |green|
+HERE
           @listener.to_sexp.should == [
             [:scenario_outline, "Scenario Outline", "Hello", "With a description", 1],
             [:step, "Given ", "a <what> cucumber", 3],
@@ -224,15 +225,15 @@ Given I am a step
         end
 
         it "should allow multiline description" do
-          scan(%{Scenario Outline: It is my ambition to say 
-                          in ten sentences
-                          what others say 
-                          in a whole book.
-                          Given I am a step
-
-                          })
-          @listener.to_sexp.should == [
-            [:scenario_outline, "Scenario Outline", "It is my ambition to say", "in ten sentences\nwhat others say\nin a whole book.", 1],
+          scan(<<-HERE)
+Scenario Outline: It is my ambition to say 
+  in ten sentences
+    what others say 
+  in a whole book.
+  Given I am a step
+HERE
+          @listener.to_sexp.should == [
+            [:scenario_outline, "Scenario Outline", "It is my ambition to say", "in ten sentences\n  what others say \nin a whole book.", 1],
             [:step, "Given ", "I am a step", 5],
             [:eof]
           ]
@@ -255,11 +256,11 @@ Given I am a step
         
         it "should parse multiline example names" do
           scan(%{Examples: I'm a multiline name
-                          and I'm ok
-                          f'real
-                          |x|
-                          |5|
-                          })
+and I'm ok
+f'real
+|x|
+|5|
+})
           @listener.to_sexp.should == [
             [:examples, "Examples", "I'm a multiline name", "and I'm ok\nf'real", 1],
             [:row, ["x"], 4],

data/spec/gherkin/shared/row_group.rb

@@ -34,6 +34,11 @@ module Gherkin
         @listener.should_receive(:row).with(r(['|', 'the', '\a', '\\', '|\\|']), 1)
         scan('| \| | the | \a | \\ |   \|\\\|    |' + "\n")
       end
+
+      it "should parse cells with newlines" do
+        @listener.should_receive(:row).with(r(["\n"]), 1)
+        scan("|\\n|" + "\n")
+      end
     
       it "should parse cells with spaces within the content" do
         @listener.should_receive(:row).with(r(["Dill pickle", "Valencia orange"]), 1)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 3
-  - 1
-  version: 2.3.1
+  - 2
+  version: 2.3.2
 platform: ruby
 authors: 
 - Mike Sassak
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 +00:00
+date: 2010-12-05 00:00:00 +00:00
 default_executable: gherkin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -471,7 +471,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: gherkin-2.3.1
+summary: gherkin-2.3.2
 test_files: 
 - features/escaped_pipes.feature
 - features/feature_parser.feature