gherkin 1.0.3 → 1.0.4

data/History.txt

@@ -1,27 +1,36 @@
-== In Git
+== 1.0.4 (2009-04-07)
 
-== Bugfixes
+=== New features
+* Pure java releases of Gherkin at http://cukes.info/maven
+* A FilterListener in Ruby that is the last missing piece to plug Gherkin into Cucumber. (Gregory Hnatiuk, Aslak Hellesøy, Matt Wynne, Mike Sassak)
+
+=== Changed features
+* The Lexer now emits the '@' for tags. (Aslak Hellesøy)
+
+== 1.0.3 (2009-03-31)
+
+=== Bugfixes
 * The C lexer correctly instantiates a new array for each table, instead of reusing the old one. (Aslak Hellesøy)
 * Emit keywords with space instead of stripping (< keywords are emmitted without space) (Aslak Hellesøy)
 * gherkin reformat now prints comments, and does it with proper indentation (Aslak Hellesøy)
 * .NET resource files are now automatically copied into the .dll (#46 Aslak Hellesøy)
 
-== New features
+=== New features
 * The Pure Java implementation now has a simple main method that pretty prints a feature. (#39 Aslak Hellesøy) 
 * Writing code generated i18n syntax highlighters for Gherkin is a lot easier thanks to several convenience methods in Gherkin::I18n. (Aslak Hellesøy)
 * .NET (C#) port (#36, #37 Attila Sztupak)
 * Tables parsed and sent by row rather than by table. (Mike Sassak)
 
-== Changed features
+=== Changed features
 * Switced to ISO 639-1 (language) and ISO 3166 alpha-2 (region - if applicable). Applies to Catalan,
   Swedish, Welsh, Romanian and Serbian. (Aslak Hellesøy)
 
 == 1.0.2 (2009-12-30)
 
-== Bugfixes
+=== Bugfixes
 * Build passes on Ruby 1.9.2 (Aslak Hellesøy)
 
-== New features
+=== New features
 * New command line based on trollop. Commands: reformat, stats. (Aslak Hellesøy)
 * I18nLexer#scan sets #language to the I18n for the language scanned (Mike Sassak)
 * I18n#adverbs, brings I18n to parity with Cucumber::Parser::NaturalLanguage (Mike Sassak)

data/README.rdoc

@@ -5,6 +5,20 @@ Fast Gherkin lexer and parser based on Ragel. Gherkin is two things:
 * The language that has evolved out of the Cucumber project.
 * This library
 
+== Generating and building the code
+
+You'll need MRI (any version) if you want to build for MRI. To build the Java implementation you'll need JRuby.
+You'll also need Ragel installed and on your PATH.
+Finally you'll need the jeweler gem. (Jeweler will tell you what other gems you need when you run rake)
+
+=== MRI
+
+  rake clean compile
+
+=== Java
+
+  rake clean jar
+
 == Running RSpec and Cucumber tests
 
 rake clean spec cucumber
@@ -23,6 +37,15 @@ E.g. in Bash, export RL_LANG="en,fr,no". This can be quite helpful when modifyin
 * rake gemcutter:release
 * ./nativegems.sh
 * gem push pkg/... (for each native gem)
+* cd java && mvn deploy
+
+== Configuring Rake-Compiler for cross compilation
+In order to build Windows binaries (so we can release Windows gems from OS X/Linux) we need to set up rake-compiler.
+
+http://github.com/luislavena/rake-compiler/
+
+I didn't want to install macports (I'm on homebrew) and I couldn't figure out how to build MinGW myself. I got prebuilt binaries:
+http://crossgcc.rts-software.org/doku.php - just add the bin folder to your PATH
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -21,6 +21,7 @@ begin
     gem.add_development_dependency "albacore", ">= 0.1.0"
     
     gem.files -= FileList['dotnet/**/*']
+    gem.files -= FileList['java/**/*']
     case ENV['PLATFORM']
     when 'java'
       gem.platform = 'java'

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 0
-:patch: 3
+:patch: 4
 :major: 1

data/features/step_definitions/gherkin_steps.rb

@@ -1,5 +1,5 @@
 Given /^a "([^\"]*)" "([^\"]*)" parser$/ do |ruby_or_native, parser_name|
-  parser = Gherkin::Parser.new(@listener, false, parser_name)
+  parser = Gherkin::Parser::Parser.new(@listener, false, parser_name)
   @lexer = Gherkin::I18nLexer.new(parser, ruby_or_native == "ruby")
 end
 

data/features/step_definitions/{pretty_printer_steps.rb → pretty_listener_step.rb}

@@ -1,11 +1,11 @@
 require 'stringio'
 require 'gherkin'
-require 'gherkin/tools/pretty_listener'
+require 'gherkin/formatter/pretty_listener'
 
 module PrettyPlease
   def pretty(source)
     io       = StringIO.new
-    listener = Gherkin::Tools::PrettyListener.new(io)
+    listener = Gherkin::Formatter::PrettyListener.new(io)
     parser   = Gherkin::Parser.new(listener, true)
     lexer    = Gherkin::I18nLexer.new(parser)
     lexer.scan(source)

data/gherkin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gherkin}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mike Sassak", "Gregory Hnatiuk", "Aslak Helles\303\270y"]
-  s.date = %q{2010-03-30}
+  s.date = %q{2010-04-07}
   s.default_executable = %q{gherkin}
   s.description = %q{A fast Gherkin lexer/parser based on the Ragel State Machine Compiler.}
   s.email = %q{cukes@googlegroups.com}
@@ -77,45 +77,33 @@ Gem::Specification.new do |s|
      "features/parser_with_native_lexer.feature",
      "features/pretty_printer.feature",
      "features/step_definitions/gherkin_steps.rb",
-     "features/step_definitions/pretty_printer_steps.rb",
+     "features/step_definitions/pretty_listener_step.rb",
      "features/steps_parser.feature",
      "features/support/env.rb",
      "gherkin.gemspec",
      "java/.gitignore",
      "java/Gherkin.iml",
-     "java/build.xml",
-     "java/src/gherkin/FixJava.java",
-     "java/src/gherkin/I18nLexer.java",
-     "java/src/gherkin/Lexer.java",
-     "java/src/gherkin/LexingError.java",
-     "java/src/gherkin/Listener.java",
-     "java/src/gherkin/Main.java",
-     "java/src/gherkin/ParseError.java",
-     "java/src/gherkin/Parser.java",
-     "java/src/gherkin/formatter/Argument.java",
-     "java/src/gherkin/formatter/ArgumentFormat.java",
-     "java/src/gherkin/formatter/Colors.java",
-     "java/src/gherkin/formatter/Formatter.java",
-     "java/src/gherkin/formatter/PrettyFormatter.java",
-     "java/src/gherkin/lexer/.gitignore",
-     "java/src/gherkin/parser/StateMachineReader.java",
-     "java/test/gherkin/formatter/ArgumentTest.java",
+     "java/src/main/java/gherkin/lexer/.gitignore",
      "lib/.gitignore",
      "lib/gherkin.rb",
      "lib/gherkin/c_lexer.rb",
      "lib/gherkin/cli/main.rb",
      "lib/gherkin/core_ext/array.rb",
      "lib/gherkin/csharp_lexer.rb",
-     "lib/gherkin/format/argument.rb",
-     "lib/gherkin/format/monochrome_format.rb",
+     "lib/gherkin/formatter/argument.rb",
+     "lib/gherkin/formatter/colors.rb",
+     "lib/gherkin/formatter/monochrome_format.rb",
+     "lib/gherkin/formatter/pretty_listener.rb",
      "lib/gherkin/i18n.rb",
      "lib/gherkin/i18n.yml",
      "lib/gherkin/i18n_lexer.rb",
-     "lib/gherkin/lexer.rb",
-     "lib/gherkin/parser.rb",
+     "lib/gherkin/parser/filter_listener.rb",
      "lib/gherkin/parser/meta.txt",
+     "lib/gherkin/parser/parser.rb",
      "lib/gherkin/parser/root.txt",
+     "lib/gherkin/parser/sexp.rb",
      "lib/gherkin/parser/steps.txt",
+     "lib/gherkin/parser/tag_expression.rb",
      "lib/gherkin/rb_lexer.rb",
      "lib/gherkin/rb_lexer/.gitignore",
      "lib/gherkin/rb_lexer/README.rdoc",
@@ -160,11 +148,8 @@ Gem::Specification.new do |s|
      "lib/gherkin/rb_lexer/vi.rb",
      "lib/gherkin/rb_lexer/zhCN.rb",
      "lib/gherkin/rb_lexer/zhTW.rb",
-     "lib/gherkin/rb_parser.rb",
      "lib/gherkin/tools.rb",
-     "lib/gherkin/tools/colors.rb",
      "lib/gherkin/tools/files.rb",
-     "lib/gherkin/tools/pretty_listener.rb",
      "lib/gherkin/tools/reformat.rb",
      "lib/gherkin/tools/stats.rb",
      "lib/gherkin/tools/stats_listener.rb",
@@ -187,19 +172,21 @@ Gem::Specification.new do |s|
      "spec/gherkin/fixtures/simple.feature",
      "spec/gherkin/fixtures/simple_with_comments.feature",
      "spec/gherkin/fixtures/simple_with_tags.feature",
-     "spec/gherkin/format/argument_spec.rb",
+     "spec/gherkin/formatter/argument_spec.rb",
+     "spec/gherkin/formatter/colors_spec.rb",
+     "spec/gherkin/formatter/pretty_listener_spec.rb",
      "spec/gherkin/i18n_lexer_spec.rb",
      "spec/gherkin/i18n_spec.rb",
      "spec/gherkin/java_lexer_spec.rb",
-     "spec/gherkin/parser_spec.rb",
+     "spec/gherkin/parser/filter_listener_spec.rb",
+     "spec/gherkin/parser/parser_spec.rb",
+     "spec/gherkin/parser/tag_expression_spec.rb",
      "spec/gherkin/rb_lexer_spec.rb",
      "spec/gherkin/sexp_recorder.rb",
      "spec/gherkin/shared/lexer_spec.rb",
      "spec/gherkin/shared/py_string_spec.rb",
      "spec/gherkin/shared/row_spec.rb",
      "spec/gherkin/shared/tags_spec.rb",
-     "spec/gherkin/tools/colors_spec.rb",
-     "spec/gherkin/tools/pretty_listener_spec.rb",
      "spec/spec_helper.rb",
      "tasks/bench.rake",
      "tasks/bench/feature_builder.rb",
@@ -219,19 +206,21 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/gherkin/c_lexer_spec.rb",
      "spec/gherkin/csharp_lexer_spec.rb",
-     "spec/gherkin/format/argument_spec.rb",
+     "spec/gherkin/formatter/argument_spec.rb",
+     "spec/gherkin/formatter/colors_spec.rb",
+     "spec/gherkin/formatter/pretty_listener_spec.rb",
      "spec/gherkin/i18n_lexer_spec.rb",
      "spec/gherkin/i18n_spec.rb",
      "spec/gherkin/java_lexer_spec.rb",
-     "spec/gherkin/parser_spec.rb",
+     "spec/gherkin/parser/filter_listener_spec.rb",
+     "spec/gherkin/parser/parser_spec.rb",
+     "spec/gherkin/parser/tag_expression_spec.rb",
      "spec/gherkin/rb_lexer_spec.rb",
      "spec/gherkin/sexp_recorder.rb",
      "spec/gherkin/shared/lexer_spec.rb",
      "spec/gherkin/shared/py_string_spec.rb",
      "spec/gherkin/shared/row_spec.rb",
      "spec/gherkin/shared/tags_spec.rb",
-     "spec/gherkin/tools/colors_spec.rb",
-     "spec/gherkin/tools/pretty_listener_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/java/Gherkin.iml

@@ -1,22 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
+<module org.jetbrains.idea.maven.project.MavenProjectsManager.isMavenModule="true" type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="false">
+    <output url="file://$MODULE_DIR$/target/classes" />
+    <output-test url="file://$MODULE_DIR$/target/test-classes" />
     <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="module-library" scope="TEST">
-      <library>
-        <CLASSES>
-          <root url="jar://$APPLICATION_HOME_DIR$/lib/junit-4.7.jar!/" />
-        </CLASSES>
-        <JAVADOC />
-        <SOURCES />
-      </library>
-    </orderEntry>
+    <orderEntry type="library" scope="TEST" name="Maven: junit:junit:4.8.1" level="project" />
   </component>
 </module>
 

data/lib/gherkin.rb

@@ -1,2 +1,2 @@
 require 'gherkin/i18n_lexer'
-require 'gherkin/parser'
+require 'gherkin/parser/parser'

data/lib/gherkin/c_lexer.rb

@@ -1,7 +1,7 @@
 module Gherkin
   module CLexer
-    def self.[](i18n_language)
-      name = i18n_language.gsub(/[\s-]/, '')
+    def self.[](i18n_language_name)
+      name = i18n_language_name.gsub(/[\s-]/, '')
       require "gherkin_lexer_#{name}"
       i18n_lexer_class_name = name.capitalize
       const_get(i18n_lexer_class_name)

data/lib/gherkin/{format → formatter}/argument.rb

@@ -1,5 +1,5 @@
 module Gherkin
-  module Format
+  module Formatter
     class Argument
       attr_reader :byte_offset, :val
 

data/lib/gherkin/{tools → formatter}/colors.rb

@@ -1,7 +1,7 @@
 require 'term/ansicolor'
 
 module Gherkin
-  module Tools
+  module Formatter
     # Defines aliases for coloured output. You don't invoke any methods from this
     # module directly, but you can change the output colours by defining
     # a <tt>GHERKIN_COLORS</tt> variable in your shell, very much like how you can

data/lib/gherkin/{format → formatter}/monochrome_format.rb

@@ -1,5 +1,5 @@
 module Gherkin
-  module Format
+  module Formatter
     class MonochromeFormat
       def format_argument(arg)
         arg

data/lib/gherkin/{tools → formatter}/pretty_listener.rb

@@ -1,14 +1,13 @@
 # encoding: utf-8
 
-require 'gherkin/tools/colors'
-require 'gherkin/format/monochrome_format'
+require 'gherkin/formatter/colors'
+require 'gherkin/formatter/monochrome_format'
+require 'gherkin/formatter/argument'
 
 module Gherkin
-  module Tools
-    # TODO: Rename to Gherkin::Pretty::PrettyReporter - that's what this class *does*
-    # (The fact that it conforms to the Gherkin Listener interface is secondary)
+  module Formatter
     class PrettyListener
-      include Gherkin::Tools::Colors
+      include Colors
       
       class << self
         def new(io, monochrome=false)
@@ -24,14 +23,14 @@ module Gherkin
       def initialize(io, monochrome=false)
         @io = io
         @monochrome = monochrome
-        @format = @monochrome ? Format::MonochromeFormat.new : Format::AnsiColorFormat.new
+        @format = @monochrome ? MonochromeFormat.new : AnsiColorFormat.new
         @tags = nil
         @comments = nil
       end
 
       def tag(name, line)
         @tags ||= []
-        @tags << "@#{name}"
+        @tags << name
       end
 
       def comment(content, line)
@@ -65,7 +64,7 @@ module Gherkin
       def step(keyword, name, line, status=nil, arguments=nil, location=nil)
         flush_table
         status_param = "#{status}_param" if status
-        name = Gherkin::Format::Argument.format(name, @format, (arguments || [])) 
+        name = Gherkin::Formatter::Argument.format(name, @format, (arguments || [])) 
         #{|arg| status_param ? self.__send__(status_param, arg, @monochrome) : arg} if arguments
 
         step = "#{keyword}#{indent(name, '    ')}"

data/lib/gherkin/i18n.rb

@@ -46,6 +46,33 @@ module Gherkin
       @keywords['grammar_name'] = @keywords['name'].gsub(/\s/, '')
     end
 
+    def lexer(listener, force_ruby)
+      begin
+        if force_ruby
+          rb(listener)
+        else
+          begin
+            c(listener)
+          rescue NameError, LoadError => e
+            warn("WARNING: #{e.message}. Reverting to Ruby lexer.")
+            rb(listener)
+          end
+        end
+      rescue LoadError => e
+        raise I18nLexerNotFound, "No lexer was found for #{i18n_language_name} (#{e.message}). Supported languages are listed in gherkin/i18n.yml."
+      end
+    end
+
+    def c(listener)
+      require 'gherkin/c_lexer'
+      CLexer[@key].new(listener)
+    end
+
+    def rb(listener)
+      require 'gherkin/rb_lexer'
+      RbLexer[@key].new(listener)
+    end
+
     def sanitized_key
       @key.gsub(/[\s-]/, '')
     end
@@ -95,11 +122,6 @@ module Gherkin
       @keywords[key].split('|').map{|kw| space ? keyword_space(kw) : kw}
     end
 
-    def adverbs
-      # TODO: looks very similar to #step_keywords. Lose this? Where is it used from?
-      %w{given when then and but}.map{|keyword| @keywords[keyword].split('|').map{|w| w.gsub(/[\s<']/, '')}}.flatten
-    end
-
     private
 
     def keyword_space(val)

data/lib/gherkin/i18n_lexer.rb

@@ -11,63 +11,37 @@ module Gherkin
     attr_reader :i18n_language
 
     class << self
-      def new(parser, force_ruby)
+      def new(listener, force_ruby)
         if !force_ruby && defined?(JRUBY_VERSION)
           require 'gherkin.jar'
-          Java::Gherkin::I18nLexer.new(parser)
+          Java::Gherkin::I18nLexer.new(listener)
         else
           super
         end
       end
+    end
 
-      def lexer_class(i18n_lang, force_ruby)
-        begin
-          if force_ruby
-            rb[i18n_lang]
-          else
-            begin
-              c[i18n_lang]
-            rescue NameError, LoadError => e
-              warn("WARNING: #{e.message}. Reverting to Ruby lexer.")
-              rb[i18n_lang]
-            end
-          end
-        rescue LoadError => e
-          raise I18nLexerNotFound, "No lexer was found for #{i18n_lang} (#{e.message}). Supported languages are listed in gherkin/i18n.yml."
-        end
-      end
-
-      def i18n_language(source)
-        line_one = source.split(/\n/)[0]
-        match = LANGUAGE_PATTERN.match(line_one)
-        I18n.get(match ? match[1] : 'en').key
-      end
+    def initialize(listener, force_ruby)
+      @listener = listener
+      @force_ruby = force_ruby
+    end
 
-      def c
-        require 'gherkin/c_lexer'
-        CLexer
-      end
+    def scan(source)
+      create_delegate(source).scan(source)
+    end
 
-      def csharp
-        require 'gherkin/csharp_lexer'
-        CSharpLexer
-      end
+  private
 
-      def rb
-        require 'gherkin/rb_lexer'
-        RbLexer
-      end
+    def create_delegate(source)
+      @i18n_language = lang(source)
+      @i18n_language.lexer(@listener, @force_ruby)
     end
 
-    def initialize(parser, force_ruby)
-      @parser = parser
-      @force_ruby = force_ruby
+    def lang(source)
+      line_one = source.split(/\n/)[0]
+      match = LANGUAGE_PATTERN.match(line_one)
+      I18n.get(match ? match[1] : 'en')
     end
 
-    def scan(source)
-      @i18n_language = self.class.i18n_language(source) 
-      delegate = self.class.lexer_class(@i18n_language, @force_ruby).new(@parser)
-      delegate.scan(source)
-    end
   end
 end