A Thrift parser/generator
Scala Java HTML Thrift Objective-C Shell Other
Latest commit 2e24bd0 Aug 26, 2016 @cacoco cacoco committed with jenkins twitter-oss: Prepare OSS libraries for release
Problem

We want to release the next versions our of Twitter OSS libraries:
 - util -> 6.36.0
 - ostrich -> 9.20
 - scrooge -> 4.9.0
 - finagle -> 6.37.0
 - twitter-server -> 1.22
 - finatra -> 2.3.0

Solution

Prepare libraries for their next releases.

RB_ID=865948
TBR=true
Permalink
Failed to load latest commit information.
.github Twitter OSS: Add ISSUE_TEMPLATE Jul 7, 2016
bin ostrich, scrooge, finagle, twitter-server, finatra: Update TravisCI c… Jul 22, 2016
demos/scrooge-maven-demo twitter-oss: Prepare OSS libraries for release Aug 26, 2016
doc/src/sphinx scrooge-docs: how to get scrooge-sbt-plugin Jun 6, 2016
project twitter-oss: Prepare OSS libraries for release Aug 26, 2016
scrooge-benchmark source: fix more unused imports for scala 2.11.8 Mar 29, 2016
scrooge-core [Scrooge]: Make struct field default value available in ThriftStructF… Jul 18, 2016
scrooge-generator-tests Remove ex-employees from OWNERS files. Jul 22, 2016
scrooge-generator Remove ex-employees from OWNERS files. Jul 22, 2016
scrooge-linter Pants release 1.1.0-rc9 Aug 26, 2016
scrooge-maven-plugin twitter-oss: Prepare OSS libraries for release Aug 26, 2016
scrooge-sbt-plugin scrooge-sbt-plugin: Include generated sources in packageSrc Aug 1, 2016
scrooge-serializer scrooge: cleanup various build warnings Dec 21, 2015
.gitignore [split] scrooge: Cache mustache resources to improve generation perfo… Oct 7, 2014
.travis.yml ostrich, scrooge, finagle, twitter-server, finatra: Update TravisCI c… Jul 22, 2016
CHANGES twitter-oss: Prepare OSS libraries for release Aug 26, 2016
CONFIG.ini [split] improve SocialGraphUtil exception logging Sep 11, 2014
CONTRIBUTING.md Twitter OSS: Add ISSUE_TEMPLATE Jul 7, 2016
GROUPS [split] improve SocialGraphUtil exception logging Sep 11, 2014
LICENSE [split] improve SocialGraphUtil exception logging Sep 11, 2014
OWNERS remove marius from OWNERS Aug 8, 2016
README.md scrooge-sbt-plugin, finagle: Handle compiling for multiple languages … Jun 29, 2016
pushsite.bash [split] improve SocialGraphUtil exception logging Sep 11, 2014
sbt Switch to Java 8 and Scala 2.11 May 9, 2016

README.md

Scrooge

Build status Codecov branch Project status Gitter Maven Central

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

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. It integrates with the finagle project, exporting stats and finagle APIs, and makes it easy to build high throughput, low latency, robust thrift servers and clients.

Part of the motivation behind scrooge's scala implementation is that 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. Scrooge bypasses the problem by generating Scala code directly. It also uses Scala syntax so the generated code is much more compact.

There is a comprehensive set of unit tests, which generate code, compile it, and execute it to verify expectations, as well as gold files to make it easy to review the effects of changes to the generator.

Status

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

Building the develop branch locally

You will need the develop branch of util.

Finagle depends on scrooge-core, so the order in which you build dependencies should be:

  • in util: ./sbt publishLocal
  • in scrooge: ./sbt publishLocal
  • in finagle: ./sbt publishLocal

You will need the develop branch of finagle to run tests in scrooge-generator-tests, but you do not need it to build scrooge otherwise.

Full Documentation

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