Gherkin

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

If the RL_LANG environment variable is set, only the parsers for the languages specified there will be built. E.g. in Bash, export RL_LANG=“en,fr,no”. This can be quite helpful when modifying the Ragel grammar.

Release process

  • Run “rake clean spec cucumber” for each platform (1.8.6, 1.8.7, 1.9, jruby) to make sure all is green.

  • rvm 1.8.7

  • Bump version in the VERSION file

  • rake clean jar compile

  • rake gemspec

  • git commit -a -m “Release vX.Y.Z”

  • 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.

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: crossgcc.rts-software.org/doku.php - just add the bin folder to your PATH

Note on Patches/Pull Requests

  • Fork the project.

  • Run rake ragel:rb to generate all the I18N lexers

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don't break it in a future version unintentionally.

  • Commit, do not mess with Rakefile, VERSION, or History.txt. (if you want to have your own version, that is fine but

    bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright © 2009 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy. See LICENSE for details.