bryanl-gherkin 2.11.1.1

data/spec/gherkin/shared/row_group.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module Gherkin
+  module Lexer
+    shared_examples_for "a Gherkin lexer lexing rows" do
+      def scan(gherkin)
+        @lexer.scan(gherkin)
+      end
+
+      rows = {
+        "|a|b|\n"        => %w{a b},
+        "|a|b|c|\n"      => %w{a b c},
+      }
+    
+      rows.each do |text, expected|
+        it "should parse #{text}" do
+          @listener.should_receive(:row).with(r(expected), 1)
+          scan(text.dup)
+        end
+      end
+
+      it "should parse a row with many cells" do
+        @listener.should_receive(:row).with(r(%w{a b c d e f g h i j k l m n o p}), 1)
+        scan("|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|\n")
+      end
+    
+      it "should parse multicharacter cell content" do
+        @listener.should_receive(:row).with(r(%w{foo bar}), 1)
+        scan("| foo | bar |\n")
+      end
+
+      it "should escape backslashed pipes" do
+        @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)
+        scan("| Dill pickle | Valencia orange |\n")
+      end
+      
+      it "should allow utf-8" do
+        scan(" | ůﻚ | 2 | \n")
+        @listener.to_sexp.should == [
+          [:row, ["ůﻚ", "2"], 1],
+          [:eof]
+        ]
+      end 
+
+      it "should allow utf-8 using should_receive" do
+        @listener.should_receive(:row).with(r(['繁體中文  而且','並且','繁體中文  而且','並且']), 1)
+        scan("| 繁體中文  而且|並且| 繁體中文  而且|並且|\n")
+      end
+
+      it "should parse a 2x2 table" do
+        @listener.should_receive(:row).with(r(%w{1 2}), 1)
+        @listener.should_receive(:row).with(r(%w{3 4}), 2)
+        scan("| 1 | 2 |\n| 3 | 4 |\n")
+      end
+
+      it "should parse a 2x2 table with empty cells" do
+        @listener.should_receive(:row).with(r(['1', '']), 1)
+        @listener.should_receive(:row).with(r(['', '4']), 2)
+        scan("| 1 |  |\n|| 4 |\n")
+      end
+
+      it "should parse a row with empty cells" do
+        @listener.should_receive(:row).with(r(['1', '']), 1).twice
+        scan("| 1 |  |\n")
+        scan("|1||\n")
+      end
+    
+      it "should parse a 1x2 table that does not end in a newline" do
+        @listener.should_receive(:row).with(r(%w{1 2}), 1)
+        scan("| 1 | 2 |")
+      end
+
+      it "should parse a row without spaces and with a newline" do
+        @listener.should_receive(:row).with(r(%w{1 2}), 1)
+        scan("|1|2|\n")
+      end
+      
+      it "should parse a row with whitespace after the rows" do
+        @listener.should_receive(:row).with(r(%w{1 2}), 1)
+        scan("| 1 | 2 | \n ")
+      end
+      
+      it "should parse a row with lots of whitespace" do
+        @listener.should_receive(:row).with(r(["abc", "123"]), 1)
+        scan("  \t| \t   abc\t| \t123\t \t\t| \t\t   \t \t\n  ")
+      end
+
+      it "should parse a table with a commented-out row" do
+        @listener.should_receive(:row).with(r(["abc"]), 1)
+        @listener.should_receive(:comment).with("#|123|", 2)
+        @listener.should_receive(:row).with(r(["def"]), 3)
+        scan("|abc|\n#|123|\n|def|\n") 
+      end
+      
+      it "should raise LexingError for rows that aren't closed" do
+        lambda { 
+          scan("|| oh hello \n") 
+        }.should raise_error(/Lexing error on line 1: '\|\| oh hello/)
+      end
+
+      it "should raise LexingError for rows that are followed by a comment" do
+        lambda { 
+          scan("|hi| # oh hello \n") 
+        }.should raise_error(/Lexing error on line 1: '\|hi\| # oh hello/)
+      end
+
+      it "should raise LexingError for rows that aren't closed" do
+        lambda { 
+          scan("|| oh hello \n  |Shoudn't Get|Here|") 
+        }.should raise_error(/Lexing error on line 1: '\|\| oh hello/)
+      end
+    end
+  end
+end

data/spec/gherkin/shared/tags_group.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module Gherkin
+  module Lexer
+    shared_examples_for "a Gherkin lexer lexing tags" do
+      def scan(gherkin)
+        @lexer.scan(gherkin)
+      end
+
+      it "should lex a single tag" do
+        @listener.should_receive(:tag).with("@dog", 1)
+        scan("@dog\n")
+      end
+  
+      it "should lex multiple tags" do
+        @listener.should_receive(:tag).twice
+        scan("@dog @cat\n")
+      end
+  
+      it "should lex UTF-8 tags" do
+        @listener.should_receive(:tag).with("@シナリオテンプレート", 1)
+        scan("@シナリオテンプレート\n")
+      end
+        
+      it "should lex mixed tags" do
+        @listener.should_receive(:tag).with("@wip", 1).ordered
+        @listener.should_receive(:tag).with("@Значения", 1).ordered
+        scan("@wip @Значения\n")
+      end
+  
+      it "should lex wacky identifiers" do
+        @listener.should_receive(:tag).exactly(4).times
+        scan("@BJ-x98.77 @BJ-z12.33 @O_o" "@#not_a_comment\n")
+      end
+
+      # TODO: Ask on ML for opinions about this one
+      it "should lex tags without spaces between them?" do
+        @listener.should_receive(:tag).twice
+        scan("@one@two\n")
+      end
+    
+      it "should not lex tags beginning with two @@ signs" do
+        @listener.should_not_receive(:tag)
+        lambda { scan("@@test\n") }.should raise_error(/Lexing error on line 1/)
+      end
+    
+      it "should not lex a lone @ sign" do
+        @listener.should_not_receive(:tag)
+        lambda { scan("@\n") }.should raise_error(/Lexing error on line 1/)
+      end
+    end
+  end
+end

data/spec/gherkin/tag_expression_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+require 'gherkin/tag_expression'
+require 'gherkin/formatter/model'
+
+module Gherkin
+  describe TagExpression do
+    def tag(name)
+      Formatter::Model::Tag.new(name, 0)
+    end
+    
+    context "no tags" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new([])
+      end
+
+      it "should match @foo" do
+        @e.eval([tag('@foo')]).should == true
+      end
+
+      it "should match empty tags" do
+        @e.eval([]).should == true
+      end
+    end
+
+    context "@foo" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new(['@foo'])
+      end
+
+      it "should match @foo" do
+        @e.eval([tag('@foo')]).should == true
+      end
+
+      it "should not match @bar" do
+        @e.eval([tag('@bar')]).should == false
+      end
+
+      it "should not match no tags" do
+        @e.eval([]).should == false
+      end
+    end
+
+    context "!@foo" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new(['~@foo'])
+      end
+
+      it "should match @bar" do
+        @e.eval([tag('@bar')]).should == true
+      end
+
+      it "should not match @foo" do
+        @e.eval([tag('@foo')]).should == false
+      end
+    end
+
+    context "@foo || @bar" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new(['@foo,@bar'])
+      end
+
+      it "should match @foo" do
+        @e.eval([tag('@foo')]).should == true
+      end
+
+      it "should match @bar" do
+        @e.eval([tag('@bar')]).should == true
+      end
+
+      it "should not match @zap" do
+        @e.eval([tag('@zap')]).should == false
+      end
+    end
+
+    context "(@foo || @bar) && !@zap" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new(['@foo,@bar', '~@zap'])
+      end
+
+      it "should match @foo" do
+        @e.eval([tag('@foo')]).should == true
+      end
+
+      it "should not match @foo @zap" do
+        @e.eval([tag('@foo'), tag('@zap')]).should == false
+      end
+    end
+
+    context "(@foo:3 || !@bar:4) && @zap:5" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new(['@foo:3,~@bar','@zap:5'])
+      end
+
+      it "should count tags for positive tags" do
+        rubify_hash(@e.limits).should == {'@foo' => 3, '@zap' => 5}
+      end
+
+      it "should match @foo @zap" do
+        @e.eval([tag('@foo'), tag('@zap')]).should == true
+      end
+    end
+
+    context "Parsing '@foo:3,~@bar', '@zap:5'" do
+      before(:each) do
+        @e = Gherkin::TagExpression.new([' @foo:3 , ~@bar ', ' @zap:5 '])
+      end
+
+      unless defined?(JRUBY_VERSION)
+        it "should split and trim (ruby implementation detail)" do
+          @e.__send__(:ruby_expression).should == "(!vars['@bar']||vars['@foo'])&&(vars['@zap'])"
+        end
+      end
+
+      it "should have limits" do
+        rubify_hash(@e.limits).should == {"@zap"=>5, "@foo"=>3}
+      end
+    end
+
+    context "Tag limits" do
+      it "should be counted for negative tags" do
+        @e = Gherkin::TagExpression.new(['~@todo:3'])
+        rubify_hash(@e.limits).should == {"@todo"=>3}
+      end
+
+      it "should be counted for positive tags" do
+        @e = Gherkin::TagExpression.new(['@todo:3'])
+        rubify_hash(@e.limits).should == {"@todo"=>3}
+      end
+
+      it "should raise an error for inconsistent limits" do
+        lambda do
+          @e = Gherkin::TagExpression.new(['@todo:3', '~@todo:4'])
+        end.should raise_error(/Inconsistent tag limits for @todo: 3 and 4/)
+      end
+
+      it "should allow duplicate consistent limits" do
+        @e = Gherkin::TagExpression.new(['@todo:3', '~@todo:3'])
+        rubify_hash(@e.limits).should == {"@todo"=>3}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+if RUBY_VERSION =~ /1.9/
+  Encoding.default_external = Encoding::UTF_8
+  Encoding.default_internal = Encoding::UTF_8
+end
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'gherkin'
+require 'stringio'
+require 'gherkin/sexp_recorder'
+require 'gherkin/output_stream_string_io'
+require 'gherkin/shared/bom_group'
+require 'gherkin/shared/lexer_group'
+require 'gherkin/shared/tags_group'
+require 'gherkin/shared/doc_string_group'
+require 'gherkin/shared/row_group'
+$:.unshift(File.dirname(__FILE__))
+
+module GherkinSpecHelper
+  def scan_file(file)
+    @lexer.scan(fixture(file))
+  end
+
+  def fixture(file)
+    File.new(File.dirname(__FILE__) + "/gherkin/fixtures/" + file).read
+  end
+
+  def rubify_hash(hash)
+    if defined?(JRUBY_VERSION)
+      h = {}
+      hash.keySet.each{|key| h[key] = hash[key]}
+      h
+    else
+      hash
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include(GherkinSpecHelper)
+end
+
+# Allows comparison of Java List with Ruby Array (rows)
+RSpec::Matchers.define :r do |expected|
+  match do |row|
+    def row.inspect
+      "r " + self.map{|cell| cell}.inspect
+    end
+    row.map{|cell| cell}.should == expected
+  end
+end
+
+RSpec::Matchers.define :a do |expected|
+  match do |array|
+    def array.inspect
+      "a " + self.map{|e| e.to_sym}.inspect
+    end
+    array.map{|e| e.to_sym}.should == expected
+  end
+end
+
+RSpec::Matchers.define :sym do |expected|
+  match do |actual|
+    expected.to_s == actual.to_s
+  end
+end
+
+RSpec::Matchers.define :allow do |event|
+  match do |parser|
+    parser.expected.index(event)
+  end  
+end

data/tasks/bench.rake

@@ -0,0 +1,184 @@
+%w{/../lib /bench}.each do |l| 
+  $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + l)
+end
+
+require 'benchmark'
+
+GENERATED_FEATURES = File.expand_path(File.dirname(__FILE__) + "/bench/generated")
+
+class RandomFeatureGenerator
+  def initialize(number)
+    require 'faker'
+    require 'feature_builder'
+    
+    @number = number
+  end
+  
+  def generate
+    @number.times do
+      name = catch_phrase
+      feature = FeatureBuilder.new(name) do |f|
+        num_scenarios = rand_in(1..10)
+        num_scenarios.times do
+          f.scenario(bs) do |steps|
+            num_steps = rand_in(3..10)
+            num_steps.times do
+              steps.step(sentence, self)
+            end
+          end
+        end
+      end      
+      write feature.to_s, name
+    end    
+  end
+  
+  def write(content, name)
+    File.open(GENERATED_FEATURES + "/#{name.downcase.gsub(/[\s\-\/]/, '_')}.feature", "w+") do |file|
+      file << content
+    end
+  end
+  
+  def rand_in(range)
+    ary = range.to_a
+    ary[rand(ary.length - 1)]
+  end
+  
+  def catch_phrase
+    Faker::Company.catch_phrase
+  end
+  
+  def bs
+    Faker::Company.bs.capitalize
+  end
+  
+  def sentence
+    Faker::Lorem.sentence
+  end
+
+  def table_cell
+    Faker::Lorem.words(rand(2)+1).join(" ")
+  end
+end
+
+class Benchmarker
+  def initialize
+    @features = Dir[GENERATED_FEATURES + "/**/*feature"]
+  end
+  
+  def report(lexer)
+    Benchmark.bm do |x|
+      x.report("#{lexer}:") { send :"run_#{lexer}" }
+    end
+  end
+  
+  def report_all 
+    Benchmark.bmbm do |x|
+      x.report("native_gherkin:") { run_native_gherkin }
+      x.report("native_gherkin_no_parser:") { run_native_gherkin_no_parser }
+      x.report("rb_gherkin:") { run_rb_gherkin }
+      x.report("cucumber:") { run_cucumber }
+      x.report("tt:") { run_tt }
+    end
+  end
+  
+  def run_cucumber
+    require 'cucumber'
+    require 'logger'
+    step_mother = Cucumber::StepMother.new
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::INFO
+    step_mother.log = logger
+    step_mother.load_plain_text_features(@features)
+  end
+  
+  def run_tt
+    require 'cucumber'
+    # Using Cucumber's Treetop lexer, but never calling #build to build the AST
+    lexer = Cucumber::Parser::NaturalLanguage.new(nil, 'en').parser
+    @features.each do |file|
+      source = IO.read(file)
+      parse_tree = lexer.parse(source)
+      if parse_tree.nil?
+        raise Cucumber::Parser::SyntaxError.new(lexer, file, 0)
+      end
+    end
+  end
+
+  def run_rb_gherkin    
+    require 'gherkin'
+    require 'null_formatter'
+    parser = Gherkin::Parser::Parser.new(NullFormatter.new, true, "root", true)
+    @features.each do |feature|
+      parser.parse(File.read(feature), feature, 0)
+    end
+  end
+
+  def run_native_gherkin
+    require 'gherkin'
+    require 'null_listener'
+    parser = Gherkin::Parser::Parser.new(NullFormatter.new, true, "root", false)
+    @features.each do |feature|
+      parser.parse(File.read(feature), feature, 0)
+    end
+  end
+
+  def run_native_gherkin_no_parser
+    require 'gherkin'
+    require 'gherkin/lexer/i18n_lexer'
+    require 'null_listener'
+    lexer = Gherkin::Lexer::I18nLexer.new(NullListener.new, false)
+    @features.each do |feature|
+      lexer.scan(File.read(feature), feature, 0)
+    end
+  end
+end
+
+desc "Generate 500 random features and benchmark Cucumber, Treetop and Gherkin with them"
+task :bench => ["bench:clean", "bench:gen"] do
+  benchmarker = Benchmarker.new
+  benchmarker.report_all
+end
+
+namespace :bench do
+  desc "Generate [number] features with random content, or 500 features if number is not provided"
+  task :gen, :number do |t, args|
+    args.with_defaults(:number => 500)
+    generator = RandomFeatureGenerator.new(args.number.to_i)
+    generator.generate    
+  end
+
+  desc "Benchmark Cucumber AST building from the features in tasks/bench/generated"
+  task :cucumber do
+    benchmarker = Benchmarker.new
+    benchmarker.report("cucumber")
+  end
+  
+  desc "Benchmark the Treetop parser with the features in tasks/bench/generated"
+  task :tt do
+    benchmarker = Benchmarker.new
+    benchmarker.report("tt")
+  end
+
+  desc "Benchmark the Ruby Gherkin lexer+parser with the features in tasks/bench/generated"
+  task :rb_gherkin do
+    benchmarker = Benchmarker.new
+    benchmarker.report("rb_gherkin")
+  end
+
+  desc "Benchmark the ntive Gherkin lexer+parser with the features in tasks/bench/generated"
+  task :native_gherkin do
+    benchmarker = Benchmarker.new
+    benchmarker.report("native_gherkin")
+  end
+
+  desc "Benchmark the native Gherkin lexer (no parser) with the features in tasks/bench/generated"
+  task :native_gherkin_no_parser do
+    benchmarker = Benchmarker.new
+    benchmarker.report("native_gherkin_no_parser")
+  end
+
+  desc "Remove all generated features in tasks/bench/generated"
+  task :clean do
+    rm_f FileList[GENERATED_FEATURES + "/**/*feature"]
+  end
+end