Giter Club home page Giter Club logo

gherkin's Introduction

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

  • Bump version in the VERSION file and:

** java/pom.xml ** ikvm/Gherkin/Gherkin.csproj

  • Commit changes.

  • rake gems:prepare && ./build_native_gems.sh && rake release:ALL

  • Announce on Cucumber list, IRC and Twitter.

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 (version 4.3.0): 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 © 2009-2010 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy. See LICENSE for details.

gherkin's People

Contributors

aslakhellesoy avatar msassak avatar ghnatiuk avatar mattwynne avatar gaffo avatar sztupi avatar josephwilk avatar nordringrayhide avatar antono avatar gbence avatar graza avatar anteaya avatar

Stargazers

Naeem Khedarun avatar

Watchers

Naeem Khedarun avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.