gherkin 1.0.25 → 1.0.26

data/.gitattributes

@@ -1 +1,2 @@
 spec/gherkin/fixtures/dos_line_endings.feature -crlf
+spec/gherkin/fixtures/with_bom.feature -crlf

data/History.txt

@@ -1,3 +1,8 @@
+== 1.0.26 (2010-05-09)
+
+=== New Features
+* Ignore the BOM that many retarded Windows editors insist on sticking in the beginning of a file. (Aslak Hellesøy)
+
 == 1.0.25 (2010-05-02)
 
 === Bugfixes

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 1
 :minor: 0
 :build: 
-:patch: 25
+:patch: 26

data/ragel/lexer_common.rl.erb

@@ -39,8 +39,9 @@
   StartPyString = '"""' >start_pystring space* :>> EOL; 
   EndPyString = (space* '"""') >next_keyword_start; 
   PyString = space* StartPyString %begin_pystring_content (^EOL | EOL)* :>> EndPyString %store_pystring_content space* EOL+;
+  BOM = 0xEF 0xBB 0xBF; # http://en.wikipedia.org/wiki/Byte_order_mark
   
-  Tokens = (space | EOL)* (Tags | Comment | FeatureHeading | BackgroundHeading | ScenarioHeading | ScenarioOutlineHeading | ExamplesHeading | Step | Row | PyString)* (space | EOL)* EOF;
+  Tokens = BOM? (space | EOL)* (Tags | Comment | FeatureHeading | BackgroundHeading | ScenarioHeading | ScenarioOutlineHeading | ExamplesHeading | Step | Row | PyString)* (space | EOL)* EOF;
 
   main := Tokens %end_feature @!end_feature;
 }%%

data/spec/gherkin/fixtures/with_bom.feature

@@ -0,0 +1,3 @@
+Feature: Feature Text
+  Scenario: Reading a Scenario
+    Given there is a step

data/spec/gherkin/shared/lexer_spec.rb

@@ -477,48 +477,56 @@ Given I am a step
         end        
       end
       
-      context "DOS line endings" do
-        describe "A complex feature with tags, comments, multiple scenarios, and multiple steps and tables" do
-          it "should find things in the right order" do
-            scan_file("dos_line_endings.feature")
-            @listener.to_sexp.should == [
-              [:comment, "#Comment on line 1", 1],
-              [:comment, "#Comment on line 2", 2],
-              [:tag, "@tag1", 3],
-              [:tag, "@tag2", 3],
-              [:feature, "Feature", "Feature Text\r\nIn order to test multiline forms\r\nAs a ragel writer\r\nI need to check for complex combinations", 4],
-              [:comment, "#Comment on line 9", 9],
-              [:comment, "#Comment on line 11", 11],
-              [:background, "Background", "", 13],
-              [:step, "Given ", "this is a background step", 14],
-              [:step, "And ", "this is another one", 15],
-              [:tag, "@tag3", 17],
-              [:tag, "@tag4", 17],
-              [:scenario, "Scenario", "Reading a Scenario", 18],
-              [:step, "Given ", "there is a step", 19],
-              [:step, "But ", "not another step", 20],
-              [:tag, "@tag3", 22],
-              [:scenario, "Scenario", "Reading a second scenario\r\nWith two lines of text", 23],
-              [:comment, "#Comment on line 24", 25],
-              [:step, "Given ", "a third step with a table", 26],
-              [:row, %w{a b}, 27],
-              [:row, %w{c d}, 28],
-              [:row, %w{e f}, 29],
-              [:step, "And ", "I am still testing things", 30],
-              [:row, %w{g h}, 31],
-              [:row, %w{e r}, 32],
-              [:row, %w{k i}, 33],
-              [:row, ['n', ''], 34], 
-              [:step, "And ", "I am done testing these tables", 35],
-              [:comment, "#Comment on line 29", 36],
-              [:step, "Then ", "I am happy", 37],
-              [:scenario, "Scenario", "Hammerzeit", 39],
-              [:step, "Given ", "All work and no play", 40],
-              [:py_string, "Makes Homer something something\r\nAnd something else", 41],
-              [:step, "Then ", "crazy", 45],
-              [:eof]
-            ]
-          end        
+      describe "Windows stuff" do
+        it "should find things in the right order for CRLF features" do
+          scan_file("dos_line_endings.feature")
+          @listener.to_sexp.should == [
+            [:comment, "#Comment on line 1", 1],
+            [:comment, "#Comment on line 2", 2],
+            [:tag, "@tag1", 3],
+            [:tag, "@tag2", 3],
+            [:feature, "Feature", "Feature Text\r\nIn order to test multiline forms\r\nAs a ragel writer\r\nI need to check for complex combinations", 4],
+            [:comment, "#Comment on line 9", 9],
+            [:comment, "#Comment on line 11", 11],
+            [:background, "Background", "", 13],
+            [:step, "Given ", "this is a background step", 14],
+            [:step, "And ", "this is another one", 15],
+            [:tag, "@tag3", 17],
+            [:tag, "@tag4", 17],
+            [:scenario, "Scenario", "Reading a Scenario", 18],
+            [:step, "Given ", "there is a step", 19],
+            [:step, "But ", "not another step", 20],
+            [:tag, "@tag3", 22],
+            [:scenario, "Scenario", "Reading a second scenario\r\nWith two lines of text", 23],
+            [:comment, "#Comment on line 24", 25],
+            [:step, "Given ", "a third step with a table", 26],
+            [:row, %w{a b}, 27],
+            [:row, %w{c d}, 28],
+            [:row, %w{e f}, 29],
+            [:step, "And ", "I am still testing things", 30],
+            [:row, %w{g h}, 31],
+            [:row, %w{e r}, 32],
+            [:row, %w{k i}, 33],
+            [:row, ['n', ''], 34], 
+            [:step, "And ", "I am done testing these tables", 35],
+            [:comment, "#Comment on line 29", 36],
+            [:step, "Then ", "I am happy", 37],
+            [:scenario, "Scenario", "Hammerzeit", 39],
+            [:step, "Given ", "All work and no play", 40],
+            [:py_string, "Makes Homer something something\r\nAnd something else", 41],
+            [:step, "Then ", "crazy", 45],
+            [:eof]
+          ]
+        end
+
+        it "should cope with the retarded BOM that many Windows editors insert at the beginning of a file" do
+          scan_file("with_bom.feature")
+          @listener.to_sexp.should == [
+            [:feature, "Feature", "Feature Text", 1],
+            [:scenario, "Scenario", "Reading a Scenario", 2],
+            [:step, "Given ", "there is a step", 3],
+            [:eof]
+          ]
         end
       end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 25
-  version: 1.0.25
+  - 26
+  version: 1.0.26
 platform: ruby
 authors: 
 - Mike Sassak
@@ -276,9 +276,9 @@ files:
 - spec/gherkin/fixtures/i18n_fr.feature
 - spec/gherkin/fixtures/i18n_no.feature
 - spec/gherkin/fixtures/i18n_zh-CN.feature
-- spec/gherkin/fixtures/simple.feature
 - spec/gherkin/fixtures/simple_with_comments.feature
 - spec/gherkin/fixtures/simple_with_tags.feature
+- spec/gherkin/fixtures/with_bom.feature
 - spec/gherkin/formatter/argument_spec.rb
 - spec/gherkin/formatter/colors_spec.rb
 - spec/gherkin/formatter/pretty_formatter_spec.rb

data/spec/gherkin/fixtures/simple.feature

@@ -1,3 +0,0 @@
-Feature: Feature Text
-  Scenario: Reading a Scenario
-    Given there is a step