ProtoBuf 1.0.0

.github/workflows/benchmark.yml

@@ -0,0 +1,25 @@
+name: Run benchmarks
+
+on:
+  pull_request:
+    types: [labeled, opened, synchronize, reopened]
+
+# Only trigger the benchmark job when you add `run benchmark` label to the PR
+jobs:
+  Benchmark:
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.labels.*.name, 'run benchmark')
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 1
+      - uses: julia-actions/julia-buildpkg@latest
+      - name: Install dependencies
+        run: julia --color=yes -e 'using Pkg; pkg"add PkgBenchmark [email protected]"'
+      - name: Run benchmarks
+        run: julia --color=yes -e 'using BenchmarkCI; BenchmarkCI.judge()'
+      - name: Print judgement
+        run: julia --color=yes -e 'using BenchmarkCI; BenchmarkCI.displayjudgement()'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -1,9 +1,12 @@
 name: CI
 on:
-  push:
-    branches: [master]
-    tags: ["*"]
   pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    tags: '*'
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -12,25 +15,14 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.3'
-          - '1' # automatically expands to the latest stable 1.x release of Julia
-          - nightly
+          - '1'
+          - 'nightly'
         os:
           - ubuntu-latest
+          - macOS-latest
+          - windows-latest
         arch:
           - x64
-          - x86
-        include:
-          # test macOS and Windows with latest Julia only
-          - os: macOS-latest
-            arch: x64
-            version: 1
-          - os: windows-latest
-            arch: x64
-            version: 1
-          - os: windows-latest
-            arch: x86
-            version: 1
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
@@ -53,3 +45,21 @@ jobs:
       - uses: codecov/codecov-action@v1
         with:
           file: lcov.info
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.gitignore

@@ -1,3 +1,10 @@
+Manifest.toml
+.vscode
+dev/
+test/test_protos/
+docs/build/
+docs/site/
 *.jl.cov
+*.jl.*.cov
 *.jl.mem
-out
+.DS_Store

LICENSE.md

@@ -1,6 +1,6 @@
 The ProtoBuf.jl package is licensed under the MIT "Expat" License:
 
-> Copyright (c) 2014-22: Julia Computing, Tanmay Mohapatra, and contributors
+> Copyright (c) 2022: RelationalAI, Tomáš Drvoštěp, and contributors
 >
 > Permission is hereby granted, free of charge, to any person obtaining
 > a copy of this software and associated documentation files (the

Project.toml

@@ -3,21 +3,26 @@ uuid = "3349acd9-ac6a-5e09-bcdb-63829b23a429"
 keywords = ["protobuf", "protoc"]
 license = "MIT"
 desc = "Julia protobuf implementation"
-version = "0.11.5"
+authors = ["Tomáš Drvoštěp <[email protected]>"]
+version = "1.0.0"
 
 [deps]
-Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
-protoc_jll = "c7845625-083e-5bbe-8504-b32d602b7110"
+BufferedStreams = "e1450e63-4bb3-523b-b2a4-4ffa8c0fd77d"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+EnumX = "4e289a0a-7415-4d19-859d-a7e5c4648b56"
+TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+TranscodingStreams = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
 
 [compat]
-julia = "1.3"
-protoc_jll = "3"
+BufferedStreams = "1.1"
+EnumX = "1"
+TranscodingStreams = "0.9"
+julia = "1.7"
 
 [extras]
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
-Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Serialization", "Test", "Random", "Sockets"]
+test = ["Aqua", "JET", "Test"]

README.md

@@ -1,14 +1,54 @@
 # ProtoBuf.jl
 
-[![Build Status](https://github.com/JuliaIO/ProtoBuf.jl/workflows/CI/badge.svg)](https://github.com/JuliaIO/ProtoBuf.jl/actions?query=workflow%3ACI+branch%3Amaster)
+[![][docs-dev-img]][docs-dev-url]
 
-[![codecov.io](http://codecov.io/github/JuliaIO/ProtoBuf.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaIO/ProtoBuf.jl?branch=master)
+This is a Julia package that provides a compiler and a codec for Protocol Buffers.
 
-[**Protocol buffers**](https://developers.google.com/protocol-buffers/docs/overview) are a language-neutral, platform-neutral, extensible way of serializing structured data for use in communications protocols, data storage, and more.
+[Protocol Buffers](https://developers.google.com/protocol-buffers) are a language-neutral, platform-neutral extensible mechanism for serializing structured data.
 
-**ProtoBuf.jl** is a Julia implementation for protocol buffers.
+## Example
 
-- [Generating Julia Code from .proto Specifications](PROTOC.md)
-- [Using ProtoBuf to Read and Write Messages](USAGE.md)
+Given a `test.proto` file in your current working directory:
+```protobuf
+syntax = "proto3";
 
-Both version 2 and 3 of the protobuf specification language are supported.
+message MyMessage {
+    sint32 a = 1;
+    repeated string b = 2;
+}
+```
+You can generate Julia bindings with the `protojl` function:
+```julia
+using ProtoBuf
+protojl("test.proto", ".", "output_dir")
+```
+
+This will create a Julia file at `output_dir/test_pb.jl` which you can simply `include` and start using it to encode and decode messages:
+
+```julia
+include("output_dir/test_pb.jl")
+# Main.test_pb
+
+io = IOBuffer();
+
+e = ProtoEncoder(io);
+
+encode(e, test_pb.MyMessage(-1, ["a", "b"]))
+# 8
+
+seekstart(io);
+
+d = ProtoDecoder(io);
+
+decode(d, test_pb.MyMessage)
+# Main.test_pb.MyMessage(-1, ["a", "b"])
+```
+## Acknowledgement
+
+We'd like to thank the authors of the following packages, as we took inspiration from their projects:
+
+* We used [Tokenize.jl](https://github.com/JuliaLang/Tokenize.jl) as a reference when implementing the Lexer/Parser.
+* We used the pre-1.0 version of `ProtoBuf.jl` as a giant shoulder to stand on:).
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://drvi.github.io/ProtoBuf.jl/dev/