goby

README

goby (rooby)

Goby is a Ruby-like object oriented language written in Go. And it's not a new Ruby implementation. Instead, it should be a language that help developer create api server or microservice efficiently.

It will have Ruby's syntax (I'll try to support all common syntaxes) but without most of Ruby's meta-programming magic to make the VM simple. It will also have built in http library that is built upon Go's efficient http package. And I'm planning to do more optimization by using goroutine directly.

Supporting Goby by sending your first PR!

Or support by donation

(We'll release first beta version in August, please checkout this issue for what features goby will support.)

Questions

A lot people have questions about goby since it's a new language and you may get confused by the way I describe it (sorry for that 😢). Here's a list of frequently asked questions.

Supported features

• Can be compiled into bytecode (with .gbbc extension)
• Can evaluate bytecode directly
• Everything is object
• Support comment
• Object and Class
  • Top level main object
  • Constructor
  • Support class methods
  • Support inheritance
  • Support instance variable
  • Support self
• Module
• Namespace
• Variables
  • Constant
  • Local variable
  • Instance variable
• Method
  • Support evaluation with arguments
  • Support evaluation without arguments
  • Support evaluation with block (closure)
• BuiltIn Data Types (All of them are classes 😀)
  • Class
  • Integer
  • String
  • Boolean
  • nil
  • Hash
  • Array
• Flow control
  • If statement
  • while statement
• Import other files
  • require_relative
• IO
  • puts
  • ARGV

(You can open an issue for any feature request)

Something different from Ruby

Method call syntax

For now, all method call needs to use parentheses to wrap their arguments. Including methods like require, include which we normally won't do this.

It'll look like:

require("foo")

class Bar
  include(Foo)
end

There's two reason for this:

I want to make Goby's syntax more consistent than Ruby

In Ruby you can write most of things in many different ways, and that can cause some confusion so we need style guide(s) to tell programmers write code consistently.

But in some programming languages like go, the syntax is very limited which in sometimes is very verbose, but this also makes program more easy to understand and maintain.

This requires a parser generator

Since our parser is handcrafted, supporting this feature would be hard and can easily cause bugs on some edge cases.

Although we definitely will replace current parser with a parser generator, this is not our top priority now.

If you have any thought on this, please join our discussion in this issue. We would love to hear some user's feedback 😁

Install

1. You must have Golang installed
2. You must have set $GOPATH
3. Add your $GOPATH/bin into $PATH
4. Run following command

$ go get github.com/goby-lang/goby

Usage

Execute goby file using VM

(might see errors on sample-6 since vm hasn't support block yet)

$ goby ./samples/sample-1.gb
#=> 16

Compile goby code

$ goby -c ./samples/sample-1.gb

You'll see sample-1.gbbc in ./samples

Execute bytecode

$ goby ./samples/sample-1.gbbc

Try it!

See sample directory for sample code snippets

$ goby ./samples/sample-1.gb
$ goby ./samples/sample-2.gb
$ goby .....

API Documentation

Check out our API Documentation.

There is still a lot of document to add. Feel free to contribute following this guide.

Development & Contribute

See the guideline.

TODO & WIP

Checkout this issue for what we will work on before first release.

Also see huboard

References

I can't build this project without these resources, and I highly recommend you to check them out if you're interested in building your own languages:

• Write An Interpreter In Go
• Nand2Tetris II
• Ruby under a microscope
• YARV's instruction table

Maintainers

• @st0012
• @janczer
• @adlerhsieh