API Roadmap

This roadmap is not a definitive list of features or fixes I intend to add in the future, just the prominent ones that I'd like users to be aware may be coming. Any timeline or feature completeness is obviously subject to change.

---

Version 3.x

• Remove all evented (eventmachine-related) code from the gem. You should be using socket or zmq transport (#116).
• Introduce plugin-style Server and Client interfaces.
• Extract ZMQ server/client transport into a gem that can be included and would conform to said plugin interface.
• Add config module and railtie for less janky integration for both client and server modes.
• More complete examples, wiki guides, and YARD documentation.

Probably gonna happen

• Support symbols in Message.define for the basic types (e.g. :string instead of Protobuf::Field::StringField). User-defined types would still be the fully qualified constant.
• Group encode/decode support (#84).
• Custom options compiler support, the first option of which is ruby file encoding. If you have any custom options you think would make sense for this gem let me know by creating an issue.
• YARD plugin (possibly different gem) that understands the message and service API and can produce good documentation on compiled classes.

Maybe gonna happen

• Extend generator interface so you can support your own file generation format, probably template based.

---

Next: Installation
Back: Wiki Home