rbs_protobuf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d8369a09563679a8a6c334efe056f6ef462bc1fc9bbd14af108fea7d4996cdb
+  data.tar.gz: 7f0e46181747c4f0ee8209496c16a29a81264ccbca39faf1803de6e2a6e3b535
+SHA512:
+  metadata.gz: e70f6e59b9f9d3de0676dc1d6d6bf2ed7715649fe428e5edb8740247df0b6e12e21b26e2e9361443c80343563160da00841d1e90c35ae906db786aca676645d9
+  data.tar.gz: 901ca653bdd3c03f9f09086c194c2f60180b693d2b43830335a2d34f39053dfd1e9b974d7f598377493e8121d27cadecdc9ef959b26ca14a186633a6b4dd05b4

data/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        container_tag:
+          - 2.6-bionic
+          - 2.7-bionic
+          - 3.0-focal
+        protoc_version:
+          - 3.13.0
+          - 3.14.0
+    container:
+      image: rubylang/ruby:${{ matrix.container_tag }}
+    steps:
+      - name: Install protoc
+        run: |
+          cd /tmp
+          apt-get update
+          apt-get -y install curl unzip
+          curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v${{ matrix.protoc_version }}/protoc-${{ matrix.protoc_version }}-linux-x86_64.zip
+          unzip protoc-${{ matrix.protoc_version }}-linux-x86_64.zip
+          mv bin/protoc /usr/local/bin/protoc
+          protoc --version
+      - uses: actions/checkout@v1
+      - name: Run test
+        run: |
+          ruby -v
+          gem install bundler
+          bin/setup
+          bundle exec rake
+          bundle exec rake install
+          mkdir -p tmp/out
+          RBS_PROTOBUF_BACKEND=protobuf protoc --rbs_out=tmp/out -Iexample example/*.proto

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/example/protobuf-gem/
+/Gemfile.lock

data/.protoc-version

@@ -0,0 +1 @@
+3.9.0-square-1.0

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build rbs_protobuf-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install rbs_protobuf-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install rbs_protobuf-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push rbs_protobuf-0.1.0.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run tests" fullCmd="test" taksId="test" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rbs_protobuf.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "steep"
+
+gem "protobuf", "~> 3.10"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Soutaro Matsumoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,138 @@
+# rbs_protobuf
+
+rbs_protobuf is a [RBS](https://github.com/ruby/rbs) generator for Protocol Buffer messages. It parses `.proto` files and generates RBS type signature.
+
+It works as a `protoc` plugin and generates RBSs for `protobuf` gem. (We plan to support `google-protobuf` gem too.)
+
+## Example
+
+This is an example .proto file.
+
+```proto
+syntax = "proto2";
+
+package protobuf.example;
+
+message SearchRequest {
+  required string query = 1;
+  optional int32 page_number = 2;
+  optional int32 result_per_page = 3;
+}
+```
+
+rbs_protobuf will generate the following RBS file including method definitions for each attribute with correct types. 
+
+```rbs
+module Protobuf
+  module Example
+    class SearchRequest < ::Protobuf::Message
+      attr_reader query(): ::String
+
+      attr_writer query(): ::String?
+
+      attr_reader page_number(): ::Integer
+
+      attr_writer page_number(): ::Integer?
+
+      attr_reader result_per_page(): ::Integer
+
+      attr_writer result_per_page(): ::Integer?
+
+      def initialize: (?query: ::String?, ?page_number: ::Integer?, ?result_per_page: ::Integer?) -> void
+
+      def []: (:query) -> ::String
+            | (:page_number) -> ::Integer
+            | (:result_per_page) -> ::Integer
+            | (::Symbol) -> untyped
+
+      def []=: (:query, ::String?) -> ::String?
+             | (:page_number, ::Integer?) -> ::Integer?
+             | (:result_per_page, ::Integer?) -> ::Integer?
+             | (::Symbol, untyped) -> untyped
+    end
+  end
+end
+```
+
+And you can type check your Ruby program using the classes with RBS above. 💪
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'rbs_protobuf', require: false
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rbs_protobuf
+
+## Usage
+
+Run `protoc` with `--rbs_out` option.
+
+    $ RBS_PROTOBUF_BACKEND=protobuf protoc --rbs_out=sig/protos protos/a.proto
+
+You may need `bundle exec protoc ...` to let bundler set up PATH.
+
+## Type checking
+
+To type check the output, you need to configure your tools to import [gem_rbs_collection](https://github.com/ruby/gem_rbs_collection).
+
+    $ git submodule add https://github.com/ruby/gem_rbs_collection.git vendor/rbs/gem_rbs_collection
+
+If you want to validate your RBS files with `rbs validate`, specify `--repo` option.
+
+    $ rbs --repo=vendor/rbs/gem_rbs_collection/gems -rprotobuf validate
+
+If you want to type check your Ruby program using Steep, add `repo_path` and `library` calls in your `Steepfile`.
+
+```ruby
+target :app do
+  repo_path "vendor/rbs/gem_rbs_collection/gems"
+  library "protobuf"
+end
+```
+
+### Options
+
+* `RBS_PROTOBUF_BACKEND` specifies the Ruby code generator gem. Supported value is `protobuf`. (We will add `google-protobuf` for `google-protobuf` gem.)
+* `PB_UPCASE_ENUMS` is for `protobuf` gem support. Specify the environment variable to make enum value constants upper case.
+* `RBS_PROTOBUF_NO_NESTED_NAMESPACE` is to make the RBS declarations flat.
+
+## Supported features
+
+| Protocol Buffer Feature | Support for `protobuf` gem |
+|-------------------------|----------------------------|
+| Messages                | ✓                          |
+| Enums                   | ✓                          |
+| Packages                | ✓                          |
+| Nested messages         | ✓                          |
+| Maps                    | ✓                          |
+| Extensions              | ✓                          |
+| Services                | Only generates classes     |
+| Oneof                   | No support in `protobuf` gem |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test example:typecheck` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+The gem works as a plugin of `protoc` command, so `protoc` command should be available for development.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/square/rbs_protobuf.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,43 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.warning = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => [:test, "example:typecheck"]
+
+namespace :example do
+  desc "Generate Ruby code with protobuf-gem"
+  task :protobufgem do
+    sh("rm -rf example/protobuf-gem")
+    sh("mkdir", "-p", "example/protobuf-gem")
+    sh(
+      { "PB_NO_TAG_WARNINGS" => "1" },
+      "protoc",
+      "--plugin=protoc-gen-ruby-protobuf=#{__dir__}/bin/protoc-gen-ruby",
+      "--ruby-protobuf_out=example/protobuf-gem",
+      "-Iexample",
+      "example/a.proto",
+      "example/b.proto"
+    )
+    sh(
+      { "RBS_PROTOBUF_BACKEND" => "protobuf" },
+      "protoc",
+      "--rbs_out=example/protobuf-gem",
+      "-Iexample",
+      "example/a.proto",
+      "example/b.proto"
+    )
+  end
+
+  desc "Type check generated code"
+  task :typecheck => ["example:protobufgem"] do
+    Dir.chdir "example" do
+      sh(*%w(steep check))
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rbs_protobuf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/protoc-gen-dumper

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(__dir__, "../lib")
+
+require "rbs_protobuf"
+
+input = STDIN.read()
+File.write(ENV["PROTOC_DUMPER_OUT"] || "a.pb.out", input)
+
+response = Google::Protobuf::Compiler::CodeGeneratorResponse.new
+print Google::Protobuf::Compiler::CodeGeneratorResponse.encode(response)

data/bin/protoc-gen-ruby

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'protoc-gen-ruby' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("protobuf", "protoc-gen-ruby")

data/bin/rpc_server

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rpc_server' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("protobuf", "rpc_server")

data/bin/setup

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+echo ">>> Installing dependencies... 🏋️‍♂️"
+bundle install
+
+echo ">>> Checking if protoc is available... 👀"
+protoc --version
+
+echo ">>> Setting up gem_rbs_collection... 💎"
+REPODIR=$(cd $(dirname $0)/..; pwd)/tmp/rbs/gem_rbs_collection
+if [ -e $REPODIR ]; then
+  echo "      ${REPODIR} exists"
+else
+  echo "      Cloning git repo into ${REPODIR}..."
+  mkdir -p $REPODIR/..
+  git clone https://github.com/ruby/gem_rbs_collection.git ${REPODIR}
+fi

data/example/Steepfile

@@ -0,0 +1,9 @@
+repo = (Pathname(__dir__) + "../tmp/rbs/gem_rbs_collection/gems").to_s
+
+target :protobuf_gem do
+  check "protobuf_gem_example.rb", "protobuf-gem"
+  signature "protobuf-gem"
+
+  repo_path repo
+  library "protobuf"
+end

data/example/a.proto

@@ -0,0 +1,54 @@
+syntax = "proto2";
+
+package rbs_protobuf.example;
+
+message SearchRequest {
+  required string query = 1;
+  optional int32 page_number = 2;
+  optional int32 result_per_page = 3;
+  enum Corpus {
+    UNIVERSAL = 0;
+    WEB = 1;
+    IMAGES = 2;
+    LOCAL = 3;
+    NEWS = 4;
+    PRODUCTS = 5;
+    VIDEO = 6;
+  }
+  optional Corpus corpus = 4 [default = UNIVERSAL];
+}
+
+enum EnumAllowingAlias {
+  option allow_alias = true;
+  Unknown = 0;
+  Started = 1;
+  Running = 1;
+}
+
+message SearchResponse {
+  message Result {
+    required string url = 1;
+    optional string title = 2;
+    repeated string snippets = 3;
+  }
+  repeated Result result = 1;
+}
+
+message SampleMessage {
+  oneof test_oneof {
+    string name = 4;
+    SubMessage sub_message = 9;
+  }
+}
+
+message SubMessage {
+}
+
+message Project {
+  map<string, Project> projects = 3;
+  extensions 100 to max;
+}
+
+service SearchService {
+  rpc SearchUser(SearchRequest) returns (SearchResponse);
+}