gherkin 1.0.14 → 1.0.15

data/History.txt

@@ -1,3 +1,11 @@
+== 1.0.15 (2010-04-19)
+
+=== New Features
+* Implemented more functionality in I18n.java. (Aslak Hellesøy)
+
+=== Changed Features
+* Java methods are no longer throwing Exception (but RuntimeException). (Aslak Hellesøy)
+
 == 1.0.14 (2010-04-18)
 (Something went wrong when releasing 1.0.13)
 

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 1
 :minor: 0
 :build: 
-:patch: 14
+:patch: 15

data/java/src/main/resources/gherkin/.gitignore

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

data/lib/gherkin/c_lexer.rb

@@ -1,8 +1,8 @@
 module Gherkin
   module CLexer
-    def self.[](i18n_sanitized_key)
-      require "gherkin_lexer_#{i18n_sanitized_key}"
-      const_get(i18n_sanitized_key.capitalize)
+    def self.[](i18n_underscored_iso_code)
+      require "gherkin_lexer_#{i18n_underscored_iso_code}"
+      const_get(i18n_underscored_iso_code.capitalize)
     end
   end
 end

data/lib/gherkin/i18n.rb

@@ -1,20 +1,29 @@
 require 'yaml'
+require 'gherkin/rubify'
 
 module Gherkin
   class I18n
-    KEYWORD_KEYS = %w{name native feature background scenario scenario_outline examples given when then and but}
+    unless defined?(BYPASS_JAVA_IMPL)
+      require 'gherkin/java_impl'
+      java_impl('gherkin.jar')
+    end
+
+    ALL_KEYS = %w{name native feature background scenario scenario_outline examples given when then and but}
+    KEYWORD_KEYS = ALL_KEYS - %w{name native}
     STEP_KEYWORD_KEYS = %w{given when then and but}
     GWT_KEYWORD_KEYS = %w{given when then}
     LANGUAGES    = YAML.load_file(File.dirname(__FILE__) + '/i18n.yml')
 
     class << self
+      include Rubify
+
       # Used by code generators for other lexer tools like pygments lexer and textmate bundle
       def all
-        LANGUAGES.keys.sort.map{|key| get(key)}
+        LANGUAGES.keys.sort.map{|iso_code| get(iso_code)}
       end
 
-      def get(key)
-        languages[key] ||= new(key)
+      def get(iso_code)
+        languages[iso_code] ||= new(iso_code)
       end
 
       # Returns all keyword translations and aliases of +keywords+, escaped and joined with <tt>|</tt>.
@@ -25,9 +34,9 @@ module Gherkin
       # The +keywords+ arguments can be one of <tt>:feature</tt>, <tt>:background</tt>, <tt>:scenario</tt>, 
       # <tt>:scenario_outline</tt>, <tt>:examples</tt>, <tt>:step</tt>.
       def keyword_regexp(*keywords)
-        unique_keywords = all.map do |lang|
+        unique_keywords = all.map do |i18n|
           keywords.map do |keyword|
-            lang.__send__("#{keyword}_keywords".to_sym)
+            i18n.__send__("#{keyword}_keywords".to_sym)
           end
         end
         
@@ -35,7 +44,7 @@ module Gherkin
       end
 
       def code_keywords
-        all.map{|i18n| i18n.code_keywords}.flatten.uniq.sort
+        rubify(all.map{|i18n| i18n.code_keywords}).flatten.uniq.sort
       end
 
       def code_keyword_for(gherkin_keyword)
@@ -45,12 +54,26 @@ module Gherkin
       def language_table
         require 'stringio'
         require 'gherkin/formatter/pretty_formatter'
-        io = StringIO.new
+        io = defined?(JRUBY_VERSION) ? Java.java.io.StringWriter.new : StringIO.new
         pf = Gherkin::Formatter::PrettyFormatter.new(io, true)
-        all.each{|i18n| pf.row([i18n.key, i18n.name, i18n.native], 0)}
+        all.each{|i18n| pf.row([i18n.iso_code, i18n.keywords('name')[0], i18n.keywords('native')[0]], 0)}
         pf.flush_table
-        io.rewind
-        io.read
+        if defined?(JRUBY_VERSION)
+          io.getBuffer.toString
+        else
+          io.rewind
+          io.read
+        end
+      end
+
+      def unicode_escape(word, prefix="\\u")
+        word = word.unpack("U*").map do |c|
+          if c > 127 || c == 32
+            "#{prefix}%04x" % c
+          else
+            c.chr
+          end
+        end.join
       end
 
       private
@@ -60,12 +83,12 @@ module Gherkin
       end
     end
 
-    attr_reader :key
+    attr_reader :iso_code
 
-    def initialize(key)
-      @key = key
-      @keywords = LANGUAGES[key]
-      raise "Language not supported: #{key.inspect}" if @key.nil?
+    def initialize(iso_code)
+      @iso_code = iso_code
+      @keywords = LANGUAGES[iso_code]
+      raise "Language not supported: #{iso_code.inspect}" if @iso_code.nil?
       @keywords['grammar_name'] = @keywords['name'].gsub(/\s/, '')
     end
 
@@ -88,57 +111,25 @@ module Gherkin
 
     def c(listener)
       require 'gherkin/c_lexer'
-      CLexer[sanitized_key].new(listener)
+      CLexer[underscored_iso_code].new(listener)
     end
 
     def rb(listener)
       require 'gherkin/rb_lexer'
-      RbLexer[sanitized_key].new(listener)
-    end
-
-    def sanitized_key
-      @key.gsub(/[\s-]/, '_').downcase
-    end
-
-    def incomplete?
-      KEYWORD_KEYS.detect{|key| @keywords[key].nil?}
-    end
-
-    def feature_keywords
-      keywords('feature')
+      RbLexer[underscored_iso_code].new(listener)
     end
 
-    def scenario_keywords
-      keywords('scenario')
-    end
-
-    def scenario_outline_keywords
-      keywords('scenario_outline')
-    end
-
-    def background_keywords
-      keywords('background')
-    end
-
-    def examples_keywords
-      keywords('examples')
-    end
-
-    def but_keywords
-      keywords('but')
-    end
-
-    def and_keywords
-      keywords('and')
+    def underscored_iso_code
+      @iso_code.gsub(/[\s-]/, '_').downcase
     end
 
     # Keywords that can be used in Gherkin source
     def step_keywords
-      STEP_KEYWORD_KEYS.map{|key| keywords(key)}.flatten.uniq
+      STEP_KEYWORD_KEYS.map{|iso_code| keywords(iso_code)}.flatten.uniq
     end
 
     def gwt_keywords
-      GWT_KEYWORD_KEYS.map{|key| keywords(key)}.flatten.uniq
+      GWT_KEYWORD_KEYS.map{|iso_code| keywords(iso_code)}.flatten.uniq
     end
 
     # Keywords that can be used in code
@@ -148,17 +139,9 @@ module Gherkin
       result
     end
 
-    def name
-      @keywords['name']
-    end
-
-    def native
-      @keywords['native']
-    end
-
-    def keywords(key)
-      raise "No #{key} in #{@keywords.inspect}" if @keywords[key].nil?
-      @keywords[key].split('|').map{|keyword| keyword_space(key, keyword)}
+    def keywords(iso_code)
+      raise "No #{iso_code} in #{@keywords.inspect}" if @keywords[iso_code].nil?
+      @keywords[iso_code].split('|').map{|keyword| keyword_space(iso_code, keyword)}
     end
 
     def keyword_table
@@ -167,12 +150,12 @@ module Gherkin
       io = StringIO.new
       pf = Gherkin::Formatter::PrettyFormatter.new(io, true)
 
-      (KEYWORD_KEYS - %w{name native}).each do |key|
+      KEYWORD_KEYS.each do |key|
         pf.row([key, keywords(key).map{|keyword| %{"#{keyword}"}}.join(', ')], 0)
       end
-      %w{given when then}.each do |key|
-        code_keywords = keywords(key).reject{|kw| kw == '* '}.map do |kw|
-          %{"#{self.class.code_keyword_for(kw)}"}
+      GWT_KEYWORD_KEYS.each do |key|
+        code_keywords = keywords(key).reject{|keyword| keyword == '* '}.map do |keyword|
+          %{"#{self.class.code_keyword_for(keyword)}"}
         end.join(', ')
         pf.row(["#{key} (code)", code_keywords], 0)
       end
@@ -184,8 +167,8 @@ module Gherkin
 
     private
 
-    def keyword_space(key, keyword)
-      if(STEP_KEYWORD_KEYS.index(key))
+    def keyword_space(iso_code, keyword)
+      if(STEP_KEYWORD_KEYS.index(iso_code))
         (keyword + ' ').sub(/< $/,'')
       else
         keyword

data/lib/gherkin/i18n_lexer.rb

@@ -12,7 +12,7 @@ module Gherkin
     LANGUAGE_PATTERN = /language\s*:\s*(.*)/ #:nodoc:
     attr_reader :i18n_language
 
-    def initialize(listener, force_ruby)
+    def initialize(listener, force_ruby=false)
       @listener = listener
       @force_ruby = force_ruby
     end

data/lib/gherkin/rb_lexer.rb

@@ -1,8 +1,8 @@
 module Gherkin
   module RbLexer
-    def self.[](i18n_sanitized_key)
-      require "gherkin/rb_lexer/#{i18n_sanitized_key}"
-      const_get(i18n_sanitized_key.capitalize)
+    def self.[](i18n_underscored_iso_code)
+      require "gherkin/rb_lexer/#{i18n_underscored_iso_code}"
+      const_get(i18n_underscored_iso_code.capitalize)
     end
   end
 end

data/lib/gherkin/rubify.rb

@@ -0,0 +1,18 @@
+module Gherkin
+  module Rubify
+    if defined?(JRUBY_VERSION)
+      # Translate Java objects to Ruby.
+      def rubify(o)
+        if Java.java.util.Collection === o || Array === o
+          o.map{|e| rubify(e)}
+        else
+          o
+        end
+      end
+    else
+      def rubify(o)
+        o
+      end
+    end
+  end
+end

data/ragel/lexer.c.rl.erb

@@ -230,7 +230,7 @@ static VALUE rb_eGherkinLexingError;
     }
   }
 
-  include lexer_common "lexer_common.<%= @i18n.sanitized_key %>.rl";   
+  include lexer_common "lexer_common.<%= @i18n.underscored_iso_code %>.rl";   
 
 }%%
 
@@ -407,13 +407,13 @@ static VALUE CLexer_scan(VALUE self, VALUE input)
   }
 }
 
-void Init_gherkin_lexer_<%= @i18n.sanitized_key %>()
+void Init_gherkin_lexer_<%= @i18n.underscored_iso_code %>()
 {
   mGherkin = rb_define_module("Gherkin");
   rb_eGherkinLexingError = rb_const_get(mGherkin, rb_intern("LexingError"));
 
   mCLexer = rb_define_module_under(mGherkin, "CLexer");
-  cI18nLexer = rb_define_class_under(mCLexer, "<%= @i18n.sanitized_key.capitalize %>", rb_cObject);
+  cI18nLexer = rb_define_class_under(mCLexer, "<%= @i18n.underscored_iso_code.capitalize %>", rb_cObject);
   rb_define_alloc_func(cI18nLexer, CLexer_alloc);
   rb_define_method(cI18nLexer, "initialize", CLexer_init, 1);
   rb_define_method(cI18nLexer, "scan", CLexer_scan, 1);

data/ragel/lexer.java.rl.erb

@@ -8,7 +8,7 @@ import gherkin.Lexer;
 import gherkin.Listener;
 import gherkin.LexingError;
 
-public class <%= @i18n.sanitized_key.upcase %> implements Lexer {
+public class <%= @i18n.underscored_iso_code.upcase %> implements Lexer {
   %%{
     machine lexer;
     alphtype byte;
@@ -129,18 +129,18 @@ public class <%= @i18n.sanitized_key.upcase %> implements Lexer {
       }
     }
 
-    include lexer_common "lexer_common.<%= @i18n.sanitized_key %>.rl"; 
+    include lexer_common "lexer_common.<%= @i18n.underscored_iso_code %>.rl"; 
   }%%
 
   private final Listener listener;
 
-  public <%= @i18n.sanitized_key.upcase %>(Listener listener) {
+  public <%= @i18n.underscored_iso_code.upcase %>(Listener listener) {
     this.listener = listener;
   }
 
   %% write data noerror;
 
-  public void scan(CharSequence inputSequence) throws Exception {
+  public void scan(CharSequence inputSequence)  {
     String input = inputSequence.toString() + "\n%_FEATURE_END_%";
     byte[] data = input.getBytes();
     int cs, p = 0, pe = data.length;

data/ragel/lexer.rb.rl.erb

@@ -2,7 +2,7 @@ require 'gherkin/core_ext/array'
 
 module Gherkin
   module RbLexer
-    class <%= @i18n.sanitized_key.capitalize %> #:nodoc:
+    class <%= @i18n.underscored_iso_code.capitalize %> #:nodoc:
       %%{
         machine lexer;
  
@@ -121,7 +121,7 @@ module Gherkin
           end
         }
 
-        include lexer_common "lexer_common.<%= @i18n.sanitized_key %>.rl"; 
+        include lexer_common "lexer_common.<%= @i18n.underscored_iso_code %>.rl"; 
       }%%
  
       def initialize(listener)

data/ragel/lexer_common.rl.erb

@@ -2,12 +2,12 @@
   machine lexer_common;
 
   # Language specific
-  I18N_Feature = (<%= ragel_list(@i18n.feature_keywords) %> ':') >start_keyword %end_keyword; 
-  I18N_Background = (<%= ragel_list(@i18n.background_keywords) %> ':') >start_keyword %end_keyword;
-  I18N_ScenarioOutline = (<%= ragel_list(@i18n.scenario_outline_keywords) %> ':') >start_keyword %end_keyword;
-  I18N_Scenario = (<%= ragel_list(@i18n.scenario_keywords) %> ':') >start_keyword %end_keyword;
+  I18N_Feature = (<%= ragel_list(@i18n.keywords('feature')) %> ':') >start_keyword %end_keyword; 
+  I18N_Background = (<%= ragel_list(@i18n.keywords('background')) %> ':') >start_keyword %end_keyword;
+  I18N_ScenarioOutline = (<%= ragel_list(@i18n.keywords('scenario_outline')) %> ':') >start_keyword %end_keyword;
+  I18N_Scenario = (<%= ragel_list(@i18n.keywords('scenario')) %> ':') >start_keyword %end_keyword;
   I18N_Step = <%= ragel_list(@i18n.step_keywords) %> >start_keyword %end_keyword;
-  I18N_Examples = (<%= ragel_list(@i18n.examples_keywords) %> ':') >start_keyword %end_keyword;
+  I18N_Examples = (<%= ragel_list(@i18n.keywords('examples')) %> ':') >start_keyword %end_keyword;
 
   EOF = '%_FEATURE_END_%'; # Explicit EOF added before scanning begins 
   EOL = ('\n' | '\r\n') @inc_line_number @last_newline;

data/spec/gherkin/i18n_lexer_spec.rb

@@ -9,14 +9,14 @@ module Gherkin
 
     it "should store the i18n language of the last scanned feature" do
       @lexer.scan("# language: fr\n")
-      @lexer.i18n_language.key.should == "fr"
+      @lexer.i18n_language.iso_code.should == "fr"
       @lexer.scan("# language: no\n")
-      @lexer.i18n_language.key.should == "no"
+      @lexer.i18n_language.iso_code.should == "no"
     end
 
     it "should use English i18n by default" do
       @lexer.scan("Feature: foo\n")
-      @lexer.i18n_language.key.should == "en"
+      @lexer.i18n_language.iso_code.should == "en"
     end
 
     it "should === its ruby class, even when the impl is Java" do

data/spec/gherkin/i18n_spec.rb

@@ -68,6 +68,7 @@ module Gherkin
           end
         end
 
+        unless defined?(JRUBY_VERSION)
         it "should print available languages" do
           ("\n" + I18n.language_table).should == %{
       | ar        | Arabic                 | العربية              |
@@ -115,6 +116,7 @@ module Gherkin
       | zh-TW     | Chinese traditional    | 繁體中文                 |
 }
         end
+        end
 
         it "should print keywords for a given language" do
           ("\n" + I18n.get('fr').keyword_table).should == %{

data/tasks/compile.rake

@@ -1,4 +1,5 @@
 require File.dirname(__FILE__) + '/ragel_task'
+BYPASS_JAVA_IMPL = true
 require 'gherkin/i18n'
 
 CLEAN.include [
@@ -8,7 +9,8 @@ CLEAN.include [
   'ragel/i18n/*.rl',
   'lib/gherkin/rb_lexer/*.rb',
   'ext/**/*.c',
-  'java/src/main/java/gherkin/lexer/*.java'
+  'java/src/main/java/gherkin/lexer/*.java',
+  'java/src/main/resources/gherkin/*.properties',
 ]
 
 desc "Compile the Java extensions"
@@ -22,32 +24,44 @@ rl_langs = ENV['RL_LANGS'] ? ENV['RL_LANGS'].split(',') : []
 langs = Gherkin::I18n.all.select { |lang| rl_langs.empty? || rl_langs.include?(lang.key) }
 
 langs.each do |i18n|
-  java       = RagelTask.new('java', i18n)
-  rb         = RagelTask.new('rb', i18n)
+  java = RagelTask.new('java', i18n)
+  rb   = RagelTask.new('rb', i18n)
 
   file 'lib/gherkin.jar' => [java.target, rb.target]
 
   begin
-  unless defined?(JRUBY_VERSION)
+  if defined?(JRUBY_VERSION)
+    java_properties = "java/src/main/resources/gherkin/I18nKeywords_#{i18n.iso_code.gsub(/-/, '_')}.properties"
+    file java_properties => 'lib/gherkin/i18n.yml' do
+      File.open(java_properties, 'wb') do |io|
+        io.puts("# Generated file. Do not edit.")
+        Gherkin::I18n::KEYWORD_KEYS.each do |key|
+          value = Gherkin::I18n.unicode_escape(i18n.keywords(key).join("|"))
+          io.puts("#{key}:#{value}")
+        end
+      end
+    end
+    file 'lib/gherkin.jar' => java_properties
+  else
     require 'rake/extensiontask'
 
     c = RagelTask.new('c', i18n)
 
-    extconf = "ext/gherkin_lexer_#{i18n.sanitized_key}/extconf.rb"
+    extconf = "ext/gherkin_lexer_#{i18n.underscored_iso_code}/extconf.rb"
     file extconf do
       FileUtils.mkdir(File.dirname(extconf)) unless File.directory?(File.dirname(extconf))
       File.open(extconf, "w") do |io|
         io.write(<<-EOF)
 require 'mkmf'
 $CFLAGS << ' -O0 -Wall -Werror'
-dir_config("gherkin_lexer_#{i18n.sanitized_key}")
+dir_config("gherkin_lexer_#{i18n.underscored_iso_code}")
 have_library("c", "main")
-create_makefile("gherkin_lexer_#{i18n.sanitized_key}")
+create_makefile("gherkin_lexer_#{i18n.underscored_iso_code}")
 EOF
       end
     end
 
-    Rake::ExtensionTask.new("gherkin_lexer_#{i18n.sanitized_key}") do |ext|
+    Rake::ExtensionTask.new("gherkin_lexer_#{i18n.underscored_iso_code}") do |ext|
       if ENV['RUBY_CC_VERSION']
         ext.cross_compile = true
         ext.cross_platform = 'i386-mingw32'
@@ -56,9 +70,9 @@ EOF
 
     # The way tasks are defined with compile:xxx (but without namespace) in rake-compiler forces us
     # to use these hacks for setting up dependencies. Ugly!
-    Rake::Task["compile:gherkin_lexer_#{i18n.sanitized_key}"].prerequisites.unshift(extconf)
-    Rake::Task["compile:gherkin_lexer_#{i18n.sanitized_key}"].prerequisites.unshift(c.target)
-    Rake::Task["compile:gherkin_lexer_#{i18n.sanitized_key}"].prerequisites.unshift(rb.target)
+    Rake::Task["compile:gherkin_lexer_#{i18n.underscored_iso_code}"].prerequisites.unshift(extconf)
+    Rake::Task["compile:gherkin_lexer_#{i18n.underscored_iso_code}"].prerequisites.unshift(c.target)
+    Rake::Task["compile:gherkin_lexer_#{i18n.underscored_iso_code}"].prerequisites.unshift(rb.target)
 
     Rake::Task["compile"].prerequisites.unshift(extconf)
     Rake::Task["compile"].prerequisites.unshift(c.target)

data/tasks/ragel_task.rb

@@ -27,15 +27,15 @@ class RagelTask
 
   def target
     {
-      'c'    => "ext/gherkin_lexer_#{@i18n.sanitized_key}/gherkin_lexer_#{@i18n.sanitized_key}.c",
-      'java' => "java/src/main/java/gherkin/lexer/#{@i18n.sanitized_key.upcase}.java",
-      'rb'   => "lib/gherkin/rb_lexer/#{@i18n.sanitized_key}.rb",
-      'csharp'   => "tmp/#{@i18n.sanitized_key}.cs"
+      'c'    => "ext/gherkin_lexer_#{@i18n.underscored_iso_code}/gherkin_lexer_#{@i18n.underscored_iso_code}.c",
+      'java' => "java/src/main/java/gherkin/lexer/#{@i18n.underscored_iso_code.upcase}.java",
+      'rb'   => "lib/gherkin/rb_lexer/#{@i18n.underscored_iso_code}.rb",
+      'csharp'   => "tmp/#{@i18n.underscored_iso_code}.cs"
     }[@lang]
   end
 
   def common_ragel
-    RL_OUTPUT_DIR + "/lexer_common.#{@i18n.sanitized_key}.rl"
+    RL_OUTPUT_DIR + "/lexer_common.#{@i18n.underscored_iso_code}.rl"
   end
 
   def common_erb
@@ -43,7 +43,7 @@ class RagelTask
   end
 
   def lang_ragel
-    RL_OUTPUT_DIR + "/#{@i18n.sanitized_key}.#{@lang}.rl"
+    RL_OUTPUT_DIR + "/#{@i18n.underscored_iso_code}.#{@lang}.rl"
   end
 
   def lang_erb

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 14
-  version: 1.0.14
+  - 15
+  version: 1.0.15
 platform: ruby
 authors: 
 - Mike Sassak
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-18 00:00:00 +02:00
+date: 2010-04-20 00:00:00 +02:00
 default_executable: gherkin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -190,6 +190,7 @@ files:
 - ikvm/.gitignore
 - java/.gitignore
 - java/src/main/java/gherkin/lexer/.gitignore
+- java/src/main/resources/gherkin/.gitignore
 - lib/.gitignore
 - lib/gherkin.rb
 - lib/gherkin/c_lexer.rb
@@ -257,6 +258,7 @@ files:
 - lib/gherkin/rb_lexer/vi.rb
 - lib/gherkin/rb_lexer/zh_cn.rb
 - lib/gherkin/rb_lexer/zh_tw.rb
+- lib/gherkin/rubify.rb
 - lib/gherkin/tools.rb
 - lib/gherkin/tools/files.rb
 - lib/gherkin/tools/reformat.rb