Skip to content

linearregression/scrooge

 
 

Repository files navigation

Scrooge

Build status Coverage status Project status Gitter Maven Central

Scrooge is a thrift code generator written in Scala, which currently generates code for Scala and Java.

It's meant to be a replacement for the apache thrift code generator, and generates conforming, compatible binary codecs by building on top of libthrift.

Since Scala is API-compatible with Java, you can use the apache thrift code generator to generate Java files and use them from within Scala, but the generated code uses Java collections and mutable "bean" classes, causing some annoying boilerplate conversions to be hand-written. This is an attempt to bypass the problem by generating Scala code directly. It also uses Scala syntax so the generated code is much more compact.

There is a fairly comprehensive set of unit tests, which actually generate code, compile it, and execute it to verify expectations.

Status

This project is used in production at Twitter (and many other organizations), and is being actively developed and maintained.

Quick-start

There are a couple of classes needed by the generated code. These have been moved out of scrooge into a separate jar to keep dependencies small. Maven users need to add the following to the pom.xml file:

<dependency>
  <groupId>com.twitter</groupId>
  <artifactId>scrooge-core_2.9.2</artifactId>
  <version>3.3.2</version>
</dependency>

SBT users need this:

val scroogeCore = "com.twitter" %% "scrooge-core" % "3.3.2"

Building the develop branch locally

You will need the develop branches of util, ostrich, and finagle. Finagle depends on scrooge-core, so the order in which you build dependencies should be:

  • in util: ./sbt publish-local
  • in ostrich: ./sbt publish-local
  • in scrooge: ./sbt 'project scrooge-core' publish-local
  • in finagle: ./sbt publish-local

Then you can build the entire scrooge package.

Full Documentation

https://twitter.github.io/scrooge/

Packages

No packages published

Languages

  • Scala 67.5%
  • HTML 9.6%
  • Thrift 8.1%
  • Java 7.5%
  • Objective-C 3.5%
  • Shell 2.6%
  • Other 1.2%