gherkin 2.3.5-universal-dotnet → 2.3.6-universal-dotnet

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "js/example/ace"]
+	path = js/example/ace
+	url = git://github.com/cucumber/ace.git

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 gemspec
 
-unless ENV['TM_RUBY']
+if !ENV['TM_RUBY'] && File.directory?('../cucumber')
   @dependencies.reject!{|dep| dep.name == 'cucumber'}
   gem 'cucumber', :path => '../cucumber'
 end

data/History.txt

@@ -1,3 +1,12 @@
+== 2.3.6 (2011-04-19)
+
+=== New Features
+* Javascript implementation (#38 Aslak Hellesøy)
+
+=== Bugfixes
+* Fix compilation error on Arch Linux (#98,#99 Ben Hamill)
+* Corrected Russian translation (#97 Vagif Abilov)
+
 == 2.3.5 (2011-03-20)
 
 === Changes

data/README.rdoc

@@ -9,9 +9,9 @@ Supported platforms:
 
 * Ruby 1.8.6-1.9.2 (MRI, JRuby, REE, Rubinius)
 * Pure Java
+* Javascript (Tested with V8/node.js/Chrome, but might work on other Javascript engines)
 * .NET
 * IronRuby (experimental)
-* Javascript (coming soon)
 
 == Installing the toolchain
 
@@ -67,6 +67,36 @@ Now you can build the jar with:
 
   rake clean jar
 
+=== Javascript
+
+In order to build and test Gherkin for Javascript you must install:
+
+* Node.js (0.4.6 or higher)
+* NPM (0.3.18 or higher)
+* Ragel with Javascript support: http://github.com/dominicmarks/ragel-js
+* Define the GHERKIN_JS environment variable in your shell (any value will do)
+
+Now you can build the Javascript with:
+
+  rake js
+  cd js
+  npm install
+
+And you can try it out with node.js:
+
+  node js/example/print.js spec/gherkin/fixtures/1.feature
+
+You can also try out Gherkin running in the browser (likely to move to a separate project):
+
+  # Pull in the Ace (http://ace.ajax.org/) editor:
+  git submodule update --init
+  # Open a sample Gherkin-powered editor in Chrome
+  open js/example/index.html
+
+If you're hacking and just want to rebuild the English parser:
+
+  rake js/lib/gherkin/lexer/en.js
+
 === .NET and IronRuby
 
 You must install Mono and IKVM to build the pure .NET dll and the IronRuby gem:
@@ -125,9 +155,11 @@ Make sure you have openssl installed first.
 
 == Release process
 
+* Make sure GHERKIN_JS is defined (see Javascript section above)
 * Bump version in the VERSION file and:
 ** java/pom.xml
-** ikvm/Gherkin/Gherkin.csproj
+** ikvm/Gherkin/Gherkin.csproj (2 places)
+** js/package.json
 * Commit changes.
 * rake gems:prepare && ./build_native_gems.sh && rake release:ALL
 * Announce on Cucumber list, IRC and Twitter.

data/VERSION

@@ -1 +1 @@
-2.3.5
+2.3.6

data/features/step_definitions/pretty_formatter_steps.rb

@@ -59,6 +59,7 @@ When /^I send each prettified original through the "([^"]*)" machinery$/ do |mac
   @error = false
   @feature_paths.each do |feature_path|
     begin
+      next if feature_path =~ /iso-8859-1\.feature/
       original = pretty_machinery(IO.read(feature_path), feature_path)
       via_machinery = self.__send__("#{machinery}_machinery", original, feature_path)
       via_machinery.should == original

data/gherkin.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name        = "gherkin"
   s.version     = Gherkin::VERSION
   s.authors     = ["Mike Sassak", "Gregory Hnatiuk", "Aslak Hellesøy"]
-  s.description = "A fast Gherkin lexer/parser based on the Ragel State Machine Compiler."
+  s.description = "A fast Gherkin lexer/parser for based on the Ragel State Machine Compiler."
   s.summary     = "gherkin-#{Gherkin::VERSION}"
   s.email       = "cukes@googlegroups.com"
   s.homepage    = "http://github.com/aslakhellesoy/gherkin"
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
 
   s.files -= Dir['ikvm/**/*']
   s.files -= Dir['java/**/*']
+  s.files -= Dir['js/**/*']
   s.files -= Dir['ext/**/*']
   s.files -= Dir['lib/gherkin.jar']
   s.files -= Dir['lib/**/*.dll']
@@ -55,6 +56,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency('bundler', '>= 1.0.10')
   s.add_development_dependency('rspec', '>= 2.5.0')
   s.add_development_dependency('awesome_print', '>= 0.3')
+  s.add_development_dependency('therubyracer', '>= 0.8.2.pre2') if ENV['GHERKIN_JS'] && !defined?(JRUBY_VERSION)
+
   # Only needed by Cucumber. Remove when Cucumber no longer needs those.
   s.add_development_dependency('term-ansicolor', '>= 1.0.5')
   s.add_development_dependency('builder', '>= 3.0.0')

data/js/.gitignore

@@ -0,0 +1 @@
+gherkin.*.js

data/js/.npmignore

@@ -0,0 +1 @@
+example

data/js/lib/gherkin/lexer/.gitignore

@@ -0,0 +1 @@
+*.js

data/lib/gherkin/i18n.rb

@@ -118,6 +118,11 @@ module Gherkin
       RbLexer[underscored_iso_code].new(listener)
     end
 
+    def js(listener)
+      require 'gherkin/js_lexer'
+      JsLexer[underscored_iso_code].new(listener)
+    end
+
     def underscored_iso_code
       @iso_code.gsub(/[\s-]/, '_').downcase
     end

data/lib/gherkin/i18n.yml

@@ -446,11 +446,11 @@
 "ru":
   name: Russian
   native: русский
-  feature: Функционал|Фича
-  background: Предыстория
+  feature: Функция|Функционал|Свойство
+  background: Предыстория|Контекст
   scenario: Сценарий
   scenario_outline: Структура сценария
-  examples: Значения
+  examples: Примеры
   given: "*|Допустим|Дано|Пусть"
   when: "*|Если|Когда"
   then: "*|То|Тогда"

data/lib/gherkin/js_lexer.rb

@@ -0,0 +1,20 @@
+require 'v8'
+
+module Gherkin
+  # Thin adapter for the Javascript lexer, primarily used for testing.
+  class JsLexer
+    def self.[](i18n_underscored_iso_code)
+      cxt = V8::Context.new
+      cxt['exports'] = {}
+
+      # Mimic Node.js / Firebug console.log
+      cxt['console'] = STDOUT
+      def STDOUT.log(*a)
+        p a
+      end
+
+      cxt.load(File.dirname(__FILE__) + "/../../js/lib/gherkin/lexer/#{i18n_underscored_iso_code}.js")
+      cxt['exports']['Lexer']
+    end
+  end
+end

data/lib/gherkin/lexer/i18n_lexer.rb

@@ -32,7 +32,7 @@ module Gherkin
 
       def lang(source)
         key = 'en'
-        source.split(/\n/).each do |line|
+        source.each_line do |line|
           break unless COMMENT_OR_EMPTY_LINE_PATTERN =~ line
           if LANGUAGE_PATTERN =~ line
             key = $1

data/lib/gherkin/rubify.rb

@@ -15,6 +15,13 @@ module Gherkin
           o
         end
       end
+    elsif defined?(V8)
+      case(o)
+      when V8::Array
+        o.map{|e| rubify(e)}
+      else
+        o
+      end
     else
       def rubify(o)
         o

data/ragel/lexer.c.rl.erb

@@ -195,45 +195,43 @@ static VALUE rb_eGherkinLexingError;
   action end_feature {
     int line;
     if (cs < lexer_first_final) {
-      if (raise_lexer_error != NULL) {
-        size_t count = 0;
-    	VALUE newstr_val;
-        char *newstr;
-        int newstr_count = 0;        
-        size_t len;
-        const char *buff;
-        if (lexer->last_newline != 0) {
-          len = LEN(last_newline, eof);
-          buff = PTR_TO(last_newline);
-        } else {
-          len = strlen(data);
-          buff = data;
-        }
+      size_t count = 0;
+      VALUE newstr_val;
+      char *newstr;
+      int newstr_count = 0;        
+      size_t len;
+      const char *buff;
+      if (lexer->last_newline != 0) {
+        len = LEN(last_newline, eof);
+        buff = PTR_TO(last_newline);
+      } else {
+        len = strlen(data);
+        buff = data;
+      }
 
-        // Allocate as a ruby string so that it gets cleaned up by GC
-        newstr_val = rb_str_new(buff, len);
-        newstr = RSTRING_PTR(newstr_val);
+      // Allocate as a ruby string so that it gets cleaned up by GC
+      newstr_val = rb_str_new(buff, len);
+      newstr = RSTRING_PTR(newstr_val);
 
 
-        for (count = 0; count < len; count++) {
-          if(buff[count] == 10) {
-            newstr[newstr_count] = '\0'; // terminate new string at first newline found
-            break;
+      for (count = 0; count < len; count++) {
+        if(buff[count] == 10) {
+          newstr[newstr_count] = '\0'; // terminate new string at first newline found
+          break;
+        } else {
+          if (buff[count] == '%') {
+            newstr[newstr_count++] = buff[count];
+            newstr[newstr_count] = buff[count];
           } else {
-            if (buff[count] == '%') {
-              newstr[newstr_count++] = buff[count];
-              newstr[newstr_count] = buff[count];
-            } else {
-              newstr[newstr_count] = buff[count];
-            }
+            newstr[newstr_count] = buff[count];
           }
-          newstr_count++;
         }
-
-	line = lexer->line_number;
-        lexer_init(lexer); // Re-initialize so we can scan again with the same lexer
-        raise_lexer_error(newstr, line);
+        newstr_count++;
       }
+
+      line = lexer->line_number;
+      lexer_init(lexer); // Re-initialize so we can scan again with the same lexer
+      raise_lexer_error(newstr, line);
     } else {
       rb_funcall(listener, rb_intern("eof"), 0);
     }

data/ragel/lexer.js.rl.erb

@@ -0,0 +1,208 @@
+;(function() {
+
+%%{
+  machine lexer;
+
+  action begin_content {
+    this.content_start = p;
+    this.current_line = this.line_number;
+    this.start_col = p - this.last_newline - (this.keyword+':').length;
+  }
+
+  action start_pystring {
+    this.current_line = this.line_number;
+    this.start_col = p - this.last_newline;
+  }
+  
+  action begin_pystring_content {
+    this.content_start = p;
+  }
+
+  action store_pystring_content {
+    var con = this.unindent(
+      this.start_col, 
+      this.bytesToString(data.slice(this.content_start, this.next_keyword_start-1)).replace(/(\r?\n)?([\t ])*$/, '').replace(/ESCAPED_TRIPLE_QUOTE/mg, '"""')
+    );
+    this.listener.py_string(con, this.current_line); 
+  }
+
+  action store_feature_content {
+    p = this.store_keyword_content('feature', data, p, eof);
+  }
+
+  action store_background_content {
+    p = this.store_keyword_content('background', data, p, eof);
+  }
+
+  action store_scenario_content {
+    p = this.store_keyword_content('scenario', data, p, eof);
+  }
+
+  action store_scenario_outline_content {
+    p = this.store_keyword_content('scenario_outline', data, p, eof);
+  }
+
+  action store_examples_content {
+    p = this.store_keyword_content('examples', data, p, eof);
+  }
+
+  action store_step_content {
+    var con = this.bytesToString(data.slice(this.content_start, p)).trim();
+    this.listener.step(this.keyword, con, this.current_line);
+  }
+
+  action store_comment_content {
+    var con = this.bytesToString(data.slice(this.content_start, p)).trim();
+    this.listener.comment(con, this.line_number);
+    this.keyword_start = null;
+  }
+
+  action store_tag_content {
+    var con = this.bytesToString(data.slice(this.content_start, p)).trim();
+    this.listener.tag(con, this.line_number);
+    this.keyword_start = null;
+  }
+
+  action inc_line_number {
+    this.line_number++;
+  }
+
+  action last_newline {
+    this.last_newline = p + 1;
+  }
+
+  action start_keyword {
+    this.keyword_start = this.keyword_start || p;
+  }
+
+  action end_keyword {
+    this.keyword = this.bytesToString(data.slice(this.keyword_start, p)).replace(/:$/, '');
+    this.keyword_start = null;
+  }
+
+  action next_keyword_start {
+    this.next_keyword_start = p;
+  }
+
+  action start_row {
+    p = p - 1;
+    current_row = [];
+    this.current_line = this.line_number;
+  }
+
+  action begin_cell_content {
+    this.content_start = p;
+  }
+
+  action store_cell_content {
+    var con = this.bytesToString(data.slice(this.content_start, p)).trim();
+    current_row.push(con.replace(/\\\|/, "|").replace(/\\n/, "\n").replace(/\\\\/, "\\"));
+  }
+
+  action store_row {
+    this.listener.row(current_row, this.current_line);
+  }
+
+  action end_feature {
+    if(this.cs < lexer_first_final) {
+      var content = this.current_line_content(data, p);
+      throw "Lexing error on line " + this.line_number + ": '" + content + "'. See http://wiki.github.com/aslakhellesoy/gherkin/lexingerror for more information.";
+    } else {
+      this.listener.eof();
+    }
+    
+  }
+
+  include lexer_common "lexer_common.<%= @i18n.underscored_iso_code %>.rl"; 
+}%%
+
+%% write data;
+%% access this.;
+%% variable data data;
+
+var Lexer = function(listener) {
+  // Check that listener has the required functions
+  var events = ['comment', 'tag', 'feature', 'background', 'scenario', 'scenario_outline', 'examples', 'step', 'py_string', 'row', 'eof'];
+  for(e in events) {
+    var event = events[e];
+    if(typeof listener[event] != 'function') {
+      "Error. No " + event + " function exists on " + JSON.stringify(listener);
+    }
+  }
+  this.listener = listener;  
+};
+
+Lexer.prototype.scan = function(data) {
+  var ending = "\n%_FEATURE_END_%";
+  if(typeof data == 'string') {
+    data = this.stringToBytes(data + ending);
+  } else if(typeof Buffer != 'undefined' && Buffer.isBuffer(data)) {
+    // Node.js
+    var buf = new Buffer(data.length + ending.length);
+    data.copy(buf, 0, 0);
+    new Buffer(ending).copy(buf, data.length, 0);
+    data = buf;
+  }
+  var eof = pe = data.length;
+  var p = 0;
+
+  this.line_number = 1;
+  this.last_newline = 0;
+
+  %% write init;
+  %% write exec;
+};
+
+Lexer.prototype.bytesToString = function(bytes) {
+  if(typeof bytes.write == 'function') {
+    // Node.js
+    return bytes.toString('utf-8');
+  } else {
+    var result = "";
+    for(var b in bytes) {
+      result += String.fromCharCode(bytes[b]);
+    }
+    return result;
+  }
+};
+
+Lexer.prototype.stringToBytes = function(string) {
+  var bytes = [];
+  for(var i = 0; i < string.length; i++) {
+    bytes[i] = string.charCodeAt(i);
+  }
+  return bytes;
+};
+
+Lexer.prototype.unindent = function(startcol, text) {
+  startcol = startcol || 0;
+  return text.replace(new RegExp('^[\t ]{0,' + startcol + '}', 'gm'), ''); 
+};
+
+Lexer.prototype.store_keyword_content = function(event, data, p, eof) {
+  var end_point = (!this.next_keyword_start || (p == eof)) ? p : this.next_keyword_start;
+  var content = this.unindent(this.start_col + 2, this.bytesToString(data.slice(this.content_start, end_point))).trimRight();
+  var content_lines = content.split("\n")
+  var name = content_lines.shift() || "";
+  name = name.trim();
+  var description = content_lines.join("\n");
+  this.listener[event](this.keyword, name, description, this.current_line);
+  var nks = this.next_keyword_start;
+  this.next_keyword_start = null;
+  return nks ? nks - 1 : p;
+};
+
+Lexer.prototype.current_line_content = function(data, p) {
+  var rest = data.slice(this.last_newline, -1);
+  var end = rest.indexOf(10) || -1;
+  return this.bytesToString(rest.slice(0, end)).trim();
+};
+
+if(typeof exports != 'undefined') {
+  exports.Lexer = Lexer;
+}
+if(typeof window != 'undefined') {
+  window.Lexer = Lexer;
+}
+
+})();