gherkin-ruby 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,8 @@
+env:
+ - RBXOPT=-X19 JRUBY_OPTS="--1.9"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx-head
+  - jruby

data/Gemfile

@@ -2,3 +2,4 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in gherkin.gemspec
 gemspec
+gem 'rake'

data/Readme.md

@@ -1,6 +1,25 @@
 # gherkin-ruby
 Gherkin-ruby is a pure Ruby implementation of a [Gherkin](http://github.com/cucumber/gherkin) parser, using [Parslet](http://github.com/kschiess/parslet).
 
+## Why this one over the official, fast, Ragel-based Gherkin parser?
+
+* Less than 200 LOC.
+* No C-exts
+* No Java/.NET crap.
+* Fast enough for our purposes (using it for the [Spinach](http://github.com/codegram/spinach) project)
+
+## Install
+
+    $ gem install gherkin-ruby
+
+Or in your Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'gherkin-ruby'
+```
+
 ## Usage
 You can easily implement your own visitors to traverse the Abstract Syntax Tree. The following example just prints the step names to standard output:
 

data/lib/gherkin/ast.rb

@@ -33,8 +33,10 @@ module Gherkin
       include Enumerable
 
       def initialize(steps=[])
-        @line   = steps.first.line - 1
-        @column = 3
+        if steps.any?
+          @line   = steps.first.line - 1
+          @column = 3
+        end
 
         @steps = steps
       end
@@ -63,11 +65,12 @@ module Gherkin
     end
 
     class Step < Node
-      attr_reader :name
-      def initialize(name)
+      attr_reader :name, :keyword
+      def initialize(name, keyword)
         @line, @column = name.line_and_column
 
-        @name = name.to_s
+        @name    = name.to_s
+        @keyword = keyword.to_s
       end
     end
 

data/lib/gherkin/parser.rb

@@ -14,14 +14,17 @@ module Gherkin
 
     rule(:feature_line)  { str('Feature:') >> space? >> text.as(:name) }
     rule(:scenario_line) { indent(2) >> str('Scenario:') >> space? >> text.as(:name) }
-    rule(:background_line) { indent(2) >> str('Background:') }
 
     rule(:step_keyword) { str('Given') | str('When') | str('Then') | str('And') | str('But') }
 
     rule(:comment) { str('#') >> text.as(:comment) }
-    rule(:description) { indent(2) >> text.as(:description) }
 
-    rule(:step) { indent(4) >> step_keyword >> space? >> text.as(:name) }
+    rule(:description_text) { (str('Background:') | str('Scenario:') | str('@')).absent? >> text }
+    rule(:description) { (indent(2) >> description_text >> newline).repeat }
+
+    rule(:background_line) { indent(2) >> str('Background:') }
+
+    rule(:step) { indent(4) >> step_keyword.as(:keyword) >> space? >> text.as(:name) }
     rule(:steps) { (step.as(:step) >> newline.maybe).repeat }
 
     rule(:tags) { indent(2) >> (str('@') >> identifier.as(:tag) >> str(' ').maybe).repeat(1) }
@@ -31,7 +34,7 @@ module Gherkin
 
     rule(:background) { background_line >> newline >> steps.as(:steps) }
 
-    rule(:feature) { feature_line >> newline >> background.as(:background).maybe >> scenarios.as(:scenarios) }
+    rule(:feature) { feature_line >> newline >> description >> background.as(:background).maybe >> scenarios.as(:scenarios) }
 
     rule(:main) { feature.as(:feature) }
 

data/lib/gherkin/transform.rb

@@ -39,8 +39,9 @@ module Gherkin
     rule(
       step: {
         name: simple(:name),
+        keyword: simple(:keyword),
       }
-    ) { AST::Step.new(name) }
+    ) { AST::Step.new(name, keyword) }
 
     rule(
       tag: simple(:name)

data/lib/gherkin/version.rb

@@ -1,3 +1,3 @@
 module Gherkin
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/gherkin/ast_test.rb

@@ -26,7 +26,7 @@ module Gherkin
       end
     end
 
-    [Feature, Scenario, Step, Tag].each do |node|
+    [Feature, Scenario, Tag].each do |node|
       describe node do
         it 'is a Node' do
           node.ancestors.must_include Node
@@ -82,21 +82,54 @@ module Gherkin
     end
 
     describe Background do
-      it 'is a Node' do
-        Background.ancestors.must_include Node
-      end
-
-      it 'is Enumerable' do
+      let(:steps) do
         steps = [
           OpenStruct.new(line: 4),
           OpenStruct.new(line: 5),
         ]
+      end
 
+      it 'is a Node' do
+        Background.ancestors.must_include Node
+      end
+
+      it 'is Enumerable' do
         instance = Background.new(steps)
-        instance.line.must_equal 3
-        instance.column.must_equal 3
         instance.each.to_a.must_equal steps
       end
+
+      describe 'when there are background steps' do
+        it 'records line and column' do
+          instance = Background.new(steps)
+          instance.line.must_equal 3
+          instance.column.must_equal 3
+        end
+      end
+
+      describe 'otherwise' do
+        it 'does not' do
+          instance = Background.new([])
+          instance.line.must_equal nil
+          instance.column.must_equal nil
+        end
+      end
+    end
+
+    describe Step do
+      it 'is a Node' do
+        Step.ancestors.must_include Node
+      end
+
+      it 'has a line and column' do
+        name = OpenStruct.new(line_and_column: [2, 13])
+        def name.to_s; 'Name'; end
+
+        instance = Step.new(name, 'Given')
+        instance.name.must_equal 'Name'
+        instance.keyword.must_equal 'Given'
+        instance.line.must_equal 2
+        instance.column.must_equal 13
+      end
     end
   end
 end

data/test/gherkin/parser_test.rb

@@ -19,23 +19,33 @@ module Gherkin
 
     describe 'Steps' do
       it 'parses a Given step' do
-        p(:step, "    Given I have an empty array", :name).must_equal "I have an empty array"
+        step = "    Given I have an empty array"
+        p(:step, step, :name).must_equal "I have an empty array"
+        p(:step, step, :keyword).must_equal "Given"
       end
 
       it 'parses a When step' do
-        p(:step, "    When I have an empty array", :name).must_equal "I have an empty array"
+        step = "    When I have an empty array"
+        p(:step, step, :name).must_equal "I have an empty array"
+        p(:step, step, :keyword).must_equal "When"
       end
 
       it 'parses a Then step' do
-        p(:step, "    Then I have an empty array", :name).must_equal "I have an empty array"
+        step = "    Then I have an empty array"
+        p(:step, step, :name).must_equal "I have an empty array"
+        p(:step, step, :keyword).must_equal "Then"
       end
 
       it 'parses an And step' do
-        p(:step, "    And I have an empty array", :name).must_equal "I have an empty array"
+        step = "    And I have an empty array"
+        p(:step, step, :name).must_equal "I have an empty array"
+        p(:step, step, :keyword).must_equal "And"
       end
 
       it 'parses a But step' do
-        p(:step, "    But I have an empty array", :name).must_equal "I have an empty array"
+        step = "    But I have an empty array"
+        p(:step, step, :name).must_equal "I have an empty array"
+        p(:step, step, :keyword).must_equal "But"
       end
     end
   end
@@ -47,10 +57,13 @@ module Gherkin
   end
 
   describe 'Description parsing' do
-    it 'parses descriptions ignoring their content' do
-      p(:description, "  In order to know what the heck is Gherkin").size.must_be :>, 0
-      p(:description, "  As a developer").size.must_be :>, 0
-      p(:description, "  I want it to behave in an expected way").size.must_be :>, 0
+    it 'parses multiline descriptions' do
+      description = """  In order to know what the heck is Gherkin
+  As a developer
+  I want it to behave in an expected way
+"""
+      parser = Gherkin::Parser.new
+      parser.description.parse(description)
     end
   end
 

data/test/gherkin/transform_test.rb

@@ -5,6 +5,9 @@ module Gherkin
   describe 'Feature parsing' do
     before do
       @scenario = """Feature: My Feature
+  In order to do something
+  As a developer
+  I want to be happy
 
   Background:
     Given something happens before anything else happens
@@ -32,34 +35,40 @@ module Gherkin
 
       background = @result.background
       background.must_be_kind_of AST::Background
-      background.line.must_equal 3
+      background.line.must_equal 6
       background.column.must_equal 3
+      background.steps.first.keyword.must_equal 'Given'
       background.steps.first.name.must_equal 'something happens before anything else happens'
-      background.steps.first.line.must_equal 4
+      background.steps.first.line.must_equal 7
+      background.steps.last.keyword.must_equal 'And'
       background.steps.last.name.must_equal 'more things happens before anything else happens'
-      background.steps.last.line.must_equal 5
+      background.steps.last.line.must_equal 8
 
       first_scenario = @result.scenarios.first
       first_scenario.must_be_kind_of AST::Scenario
-      first_scenario.line.must_equal 7
+      first_scenario.line.must_equal 10
       first_scenario.name.must_equal 'something happens'
+      first_scenario.steps.first.keyword.must_equal 'Given'
       first_scenario.steps.first.name.must_equal 'something happens'
-      first_scenario.steps.first.line.must_equal 8
+      first_scenario.steps.first.line.must_equal 11
+      first_scenario.steps.last.keyword.must_equal 'Then'
       first_scenario.steps.last.name.must_equal 'something cooler happens'
-      first_scenario.steps.last.line.must_equal 9
+      first_scenario.steps.last.line.must_equal 12
 
       last_scenario = @result.scenarios.last
       last_scenario.must_be_kind_of AST::Scenario
-      last_scenario.line.must_equal 12
+      last_scenario.line.must_equal 15
       last_scenario.name.must_equal 'something else happens'
 
       last_scenario.tags.first.name.must_equal 'javascript'
       last_scenario.tags.last.name.must_equal 'wip'
 
+      last_scenario.steps.first.keyword.must_equal 'Given'
       last_scenario.steps.first.name.must_equal 'foo'
-      last_scenario.steps.first.line.must_equal 13
+      last_scenario.steps.first.line.must_equal 16
+      last_scenario.steps.last.keyword.must_equal 'Then'
       last_scenario.steps.last.name.must_equal 'bar'
-      last_scenario.steps.last.line.must_equal 14
+      last_scenario.steps.last.line.must_equal 17
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gherkin-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-09 00:00:00.000000000 Z
+date: 2011-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &2160498080 !ruby/object:Gem::Requirement
+  requirement: &2156944000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160498080
+  version_requirements: *2156944000
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2160497620 !ruby/object:Gem::Requirement
+  requirement: &2156943540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160497620
+  version_requirements: *2156943540
 description: Gherkin-ruby is a Gherkin parser in pure Ruby using Parslet
 email:
 - marcdivc@gmail.com
@@ -43,6 +43,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Rakefile
 - Readme.md