604f5b5b33
Our :thrift compiler is now implemented in terms of our Elixir code generation framework. This drops our dependency on the Apache Thrift compiler binary. The new Thrift.Generator.targets/1 function is used to determine the full set of generated output files for a given input .thrift file. This ensures that we only generate Elixir source code for stale outputs. It can now do everything that `thrift.generate` could do, so we can retire the latter.
2.6 KiB
Thrift Utilities for Elixir
This package contains a handful of useful utilities for working with Thrift in Elixir.
Setup
Start by adding this package to your project as a dependency:
{:thrift, "~> 1.3"}
Or to track the GitHub master branch:
{:thrift, github: "pinterest/elixir-thrift"}
Mix
This package includes a Mix compiler task that can be used to automate Thrift
code generation. Start by adding :thrift to your project's :compilers list.
For example:
compilers: [:thrift | Mix.compilers]
It's important to add :thrift before the :elixir entry. The Thrift
compiler will generate Elixir source files, and we currently rely on this
ordering to ensure those generated source files get compiled.
Next, define the list of :thrift_files that should be compiled. In this
example, we gather all of the .thrift files under the thrift directory:
thrift_files: Mix.Utils.extract_files(["thrift"], [:thrift])
By default, the generated source files will be written to the lib directory,
but you can change that using the thrift_output option.
Thrift IDL Parsing
This package also contains experimental support for parsing Thrift IDL files. It is built on a low-level Erlang lexer and parser:
{:ok, tokens, _} = :thrift_lexer.string('enum Colors { RED, GREEN, BLUE}')
{:ok,
[{:enum, 1}, {:ident, 1, 'Colors'}, {:symbol, 1, '{'}, {:ident, 1, 'RED'},
{:symbol, 1, ','}, {:ident, 1, 'GREEN'}, {:symbol, 1, ','},
{:ident, 1, 'BLUE'}, {:symbol, 1, '}'}], 1}
{:ok, schema} = :thrift_parser.parse(tokens)
{:ok,
%Thrift.Parser.Models.Schema{constants: %{},
enums: %{Colors: %Thrift.Parser.Models.TEnum{name: :Colors,
values: [RED: 1, GREEN: 2, BLUE: 3]}}, exceptions: %{}, includes: [],
namespaces: %{}, services: %{}, structs: %{}, thrift_namespace: nil,
typedefs: %{}, unions: %{}}}
But also provides a high-level Elixir parsing interface:
Thrift.Parser.parse("enum Colors { RED, GREEN, BLUE}")
%Thrift.Parser.Models.Schema{constants: %{},
enums: %{Colors: %Thrift.Parser.Models.TEnum{name: :Colors,
values: [RED: 1, GREEN: 2, BLUE: 3]}}, exceptions: %{}, includes: [],
namespaces: %{}, services: %{}, structs: %{}, thrift_namespace: nil,
typedefs: %{}, unions: %{}}