Beefcake

A pure-Ruby Google Protocol Buffers library. It's all about being Buf; ProtoBuf.

Installation

gem install beefcake

Usage

require'beefcake'classVarietyincludeBeefcake::Message# Requiredrequired:x,:int32,1required:y,:int32,2# Optionaloptional:tag,:string,3# Repeatedrepeated:ary,:fixed64,4repeated:pary,:fixed64,5,:packed=>true# Enums - Simply use a Module (NOTE: defaults are optional)moduleFoonumA=1B=2end# As per the spec, defaults are only set at the end# of decoding a message, not on object creation.optional:foo,Foonum,6,:default=>Foonum::Bend# You can create a new message with hash arguments:x=Variety.new(:x=>1,:y=>2)# You can set fields individually using accessor methods:x=Variety.newx.x=1x.y=2# And you can access fields using Hash syntax:x[:x]# => 1x[:y]=4x# => <Variety x: 1, y: 4>

Encoding

Any object responding to << can accept encoding

# see code example above for the definition of Varietyx=Variety.new(:x=>1,:y=>2)# For example, you can encode into a String:s=""x.encode(s)s# => "\b\x01\x10\x02)\0"# If you don't encode into anything, a new Beefcake::Buffer will be returned:x.encode# => #<Beefcake::Buffer:0x007fbfe1867ab0 @buf="\b\x01\x10\x02)\0"># And that buffer can be converted to a String:x.encode.to_s# => "\b\x01\x10\x02)\0"

Decoding

# see code example above for the definition of Varietyx=Variety.new(:x=>1,:y=>2)# You can decode from a Beefcake::Bufferencoded=x.encodeVariety.decode(encoded)# => <Variety x: 1, y: 2, pary: [], foo: B(2)># Decoding from a String works the same way:Variety.decode(encoded.to_s)# => <Variety x: 1, y: 2, pary: [], foo: B(2)># You can update a Beefcake::Message instance with new data too:new_data=Variety.new(x: 12345,y: 2).encodeVariety.decoded(new_data,x)x# => <Variety x: 12345, y: 2, pary: [], foo: B(2)>

Generate code from .proto file

protoc --beefcake_out output/path -I path/to/proto/files/dir path/to/file.proto

You can set the BEEFCAKE_NAMESPACE variable to generate the classes under a desired namespace. (i.e. App::Foo::Bar)

About

Ruby deserves and needs first-class ProtoBuf support. Other libs didn't feel very "Ruby" to me and were hard to parse.

This library was built with EventMachine in mind. Not just blocking-IO.

Source: https://github.com/protobuf-ruby/beefcake

Support Features

• Optional fields
• Required fields
• Repeated fields
• Packed Repeated Fields
• Varint fields
• 32-bit fields
• 64-bit fields
• Length-delimited fields
• Embedded Messages
• Unknown fields are ignored (as per spec)
• Enums
• Defaults (i.e. optional :foo, :string, :default => "bar")
• Varint-encoded length-delimited message streams

Future

• Imports
• Use package in generation
• Groups (would be nice for accessing older protos)

Further Reading

http://code.google.com/apis/protocolbuffers/docs/encoding.html

Testing

rake test

Beefcake conducts continuous integration on Travis CI. The current build status for HEAD is .

All pull requests automatically trigger a build request. Please ensure that tests succeed.

Currently Beefcake is tested and working on:

• Ruby 1.9.3
• Ruby 2.0.0
• Ruby 2.1.0
• Ruby 2.1.1
• Ruby 2.1.2
• JRuby in 1.9 mode

Thank You

• Keith Rarick (kr) for help with encoding/decoding.
• Aman Gupta (tmm1) for help with cross VM support and performance enhancements.