hammer/src/bindings/ruby/README.md

hammer-parser

Ruby bindings for hammer, a parsing library.

Notes

• I called the gem hammer-parser, since there already is a gem named hammer.

Development

1. cd src/bindings/ruby.

2. Run bundle install to install dependencies.

3. Run irb -I ./lib -r hammer to open irb with hammer loaded.

4. To run tests, just run rake.

Installation

TODO

Examples

Building a parser

parser = Hammer::Parser.build {
  token 'Hello '
  choice {
    token 'Mom'
    token 'Dad'
  }
  token '!'
}

Also possible:

parser = Hammer::ParserBuilder.new
  .token('Hello ')
  .choice(Hammer::Parser.token('Mom'), Hammer::Parser.token('Dad'))
  .token('!')
  .build

More like hammer in C:

h = Hammer::Parser
parser = h.sequence(h.token('Hello '), h.choice(h.token('Mom'), h.token('Dad')), h.token('!'))

Parsing

parser.parse 'Hello Mom!'
=> true
parser.parse 'Hello Someone!'
=> false

Currently you only get true or false depending on whether the parse succeeded or failed. There's no way to access the parsed data yet.