rbs_protobuf 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9efd6a721c3cb1a7b88eb3281087e1ead753b4412976417734522f0418e91127
-  data.tar.gz: c4182e3be30b8882b8f706e0885d6dbfc0bbb218655056bea90a6753311b05bf
+  metadata.gz: 36689cc81f238ec33c07f1485ab4ff50f73fe365c1e84fcb925d34b0159859d3
+  data.tar.gz: a149120654ab2387721383d723bf3c54923385a66feff3a755ebce1056bf014c
 SHA512:
-  metadata.gz: 4d2183fb59feb4511635bf5fd85801721ecb120dd10a0fa7bd0757bfeed71a047ec6a849e96c66cfdc07101bf396f98d4e8d965c968fc379ccf3fc92ea2ab541
-  data.tar.gz: f865435271dcf8fc3c9945400e932c84f32da998d56625c5039912ab9256bcc01b8801906e4a008be0788fa1e0153b76f61994712f346d2eeb5e3a865561a23a
+  metadata.gz: f2bc3a51198e70d9617edf6df9c40e9fbfbac8061d3b849d6cf2ec21b839bd379bea6bf94d5a63dc134af173c773338f7b937b53597906e1bb3e85dd6c965c3c
+  data.tar.gz: 349c294046f6c7665dad74a0461311bf4c7edb58d9c8f804bd70b6c6ed11442d295086a59b9990465d478195c87c96e54180237e8fdd1a73c202e48ffde73b60

data/.github/workflows/test.yml

@@ -12,12 +12,13 @@ jobs:
     strategy:
       matrix:
         container_tag:
-          - 2.7-bionic
-          - 3.0-focal
-          - 3.1-focal
+          - 3.0-dev-focal
+          - 3.1-dev-jammy
+          - 3.2-dev-jammy
         protoc_version:
-          - 3.18.2
-          - 3.19.4
+          - "3.18.2"
+          - "3.19.4"
+          - "24.0"
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
@@ -30,7 +31,10 @@ jobs:
           unzip protoc-${{ matrix.protoc_version }}-linux-x86_64.zip
           mv bin/protoc /usr/local/bin/protoc
           protoc --version
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
+      - name: Set up git safe.directory
+        run: |
+          git config --global --add safe.directory /__w/rbs_protobuf/rbs_protobuf
       - name: Run test
         run: |
           ruby -v

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## 1.1.0 (2023-08-16)
+
+* Support optional fields in proto3 ([\#32](https://github.com/square/rbs_protobuf/pull/32))
+* Update Steep to 1.5 and RBS to 3.1 ([\#30](https://github.com/square/rbs_protobuf/pull/30))
+
+## 1.0.0 (2022-04-25)
+
+This is version 1.0.0. 🎉
+
+It includes changes on `nil` handling on required fields. Passing `nil` to required fields is prohibited by default, but there is an option to allow it, define `$RBS_PROTOBUF_ACCEPT_NIL_ATTR_WRITER` env var.
+
+* Stop accepting `nil` to required fields ([\#16](https://github.com/square/rbs_protobuf/pull/16))
+* Add an option to let required fields accept `nil` ([\#27](https://github.com/square/rbs_protobuf/pull/27))
+* Fix extension generator ([\#21](https://github.com/square/rbs_protobuf/pull/21))
+* Use overload for field write types ([\#22](https://github.com/square/rbs_protobuf/pull/22))
+* Generate helper types and use them ([\#24](https://github.com/square/rbs_protobuf/pull/24))
+
 ## 0.3.0 (2022-04-05)
 
 * Put protobuf _options_ in RBS comment ([\#15](https://github.com/square/rbs_protobuf/pull/15))

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
-gem "steep"
-gem "rbs"
+gem "steep", require: false
+gem "rbs", "~> 3.1"
 
 gem "protobuf", "~> 3.10"

data/Gemfile.lock

@@ -1,59 +1,72 @@
 PATH
   remote: .
   specs:
-    rbs_protobuf (0.3.0)
+    rbs_protobuf (1.1.0)
       activesupport (>= 4.0)
       rbs (>= 2.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
+    csv (3.2.7)
     ffi (1.15.5)
-    i18n (1.10.0)
+    fileutils (1.7.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    language_server-protocol (3.16.0.3)
-    listen (3.7.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
     middleware (0.1.0)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.1.1.0)
+    minitest (5.19.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     protobuf (3.10.5)
       activesupport (>= 3.2)
       middleware
       thor
       thread_safe
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    rb-fsevent (0.11.1)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.3.1)
-    steep (0.52.0)
+    rbs (3.1.3)
+    securerandom (0.2.2)
+    steep (1.5.3)
       activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
-      parallel (>= 1.0.0)
-      parser (>= 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.3.0)
+      rbs (>= 3.1.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
+    strscan (3.0.6)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
     thread_safe (0.3.6)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
@@ -62,9 +75,9 @@ DEPENDENCIES
   minitest (~> 5.0)
   protobuf (~> 3.10)
   rake (~> 12.0)
-  rbs
+  rbs (~> 3.1)
   rbs_protobuf!
   steep
 
 BUNDLED WITH
-   2.1.4
+   2.3.11

data/README.md

@@ -95,12 +95,15 @@ gems:
 We assume that you don't type check the generated `.pb.rb` code.
 If you want to type check them, you need the definition of `Google::Protobuf`, which can be generated from [`descriptor.proto`](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/descriptor.proto).
 
+Note: `rbs_protobuf` generates RBS files assuming some types added in [this PR](https://github.com/ruby/gem_rbs_collection/pull/145). Make sure you are using one of the newer versions of `rbs_gem_collection` definitions.
+
 ### 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.
 * `RBS_PROTOBUF_EXTENSION` specifies what to do for extensions.
+* `RBS_PROTOBUF_ACCEPT_NIL_ATTR_WRITER` is to allow passing `nil` to required fields.
 
 ## Supported features
 

data/Rakefile

@@ -27,7 +27,8 @@ namespace :example do
       "-I#{proto_path}",
       "example/a.proto",
       "example/b.proto",
-      "example/c.proto"
+      "example/c.proto",
+      "example/d.proto"
     )
     sh(
       { "RBS_PROTOBUF_BACKEND" => "protobuf", "RBS_PROTOBUF_EXTENSION" => "true" },
@@ -35,7 +36,8 @@ namespace :example do
       "--rbs_out=example/protobuf-gem",
       "-Iexample",
       "example/a.proto",
-      "example/b.proto"
+      "example/b.proto",
+      "example/d.proto"
     )
     sh(
       { "RBS_PROTOBUF_BACKEND" => "protobuf", "RBS_PROTOBUF_EXTENSION" => "true", "RUBYOPT" => "-rbundler/setup -Iexample/protobuf-gem -rc.pb" },

data/bin/protoc-gen-dumper

@@ -7,5 +7,7 @@ require "rbs_protobuf"
 input = STDIN.read()
 File.write(ENV["PROTOC_DUMPER_OUT"] || "a.pb.out", input)
 
-response = Google::Protobuf::Compiler::CodeGeneratorResponse.new
+response = Google::Protobuf::Compiler::CodeGeneratorResponse.new(
+  :supported_features => ::Google::Protobuf::Compiler::CodeGeneratorResponse::Feature::FEATURE_PROTO3_OPTIONAL.to_i
+)
 print Google::Protobuf::Compiler::CodeGeneratorResponse.encode(response)

data/bin/steep

@@ -1,15 +1,17 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
-REPO_ROOT=$(cd $(dirname $0); pwd)/..
+BINSTUB_DIR=$(cd $(dirname $0); pwd)
+GEMFILE=$(readlink -f ${BINSTUB_DIR}/../Gemfile)
+ROOT_DIR=$(readlink -f ${BINSTUB_DIR}/..)
 
-STEEP="bundle exec steep"
+STEEP="bundle exec --gemfile=${GEMFILE} steep"
 
 if type "rbenv" > /dev/null 2>&1; then
   STEEP="rbenv exec ${STEEP}"
 else
   if type "rvm" > /dev/null 2>&1; then
-    STEEP="rvm ${REPO_ROOT} do ${STEEP}"
+    STEEP="rvm ${ROOT_DIR} do ${STEEP}"
   fi
 fi
 
-exec $STEEP $*
+exec $STEEP $@

data/example/Steepfile

@@ -4,6 +4,7 @@ target :lib do
   collection_config "../rbs_collection.yaml"
 
   signature "protobuf-gem"
+  signature "../vendor/gem_rbs_collection/gems/protobuf"
   check "protobuf_gem_example.rb"
 
   configure_code_diagnostics do |hash|

data/example/d.proto

@@ -0,0 +1,6 @@
+syntax = "proto3";
+
+message Foo {
+  string bar = 2;
+  optional string baz = 1;
+}

data/exe/protoc-gen-rbs

@@ -30,11 +30,14 @@ translator = case backend
                              true
                            end
 
+               accept_nil_writer = ENV.key?("RBS_PROTOBUF_ACCEPT_NIL_ATTR_WRITER")
+
                RBSProtobuf::Translator::ProtobufGem.new(
                  input,
                  upcase_enum: upcase_enum,
                  nested_namespace: !no_nested_namespace,
-                 extension: extension
+                 extension: extension,
+                 accept_nil_writer: accept_nil_writer
                )
              when "google-protobuf"
                raise NotImplementedError

data/lib/rbs_protobuf/name.rb

@@ -0,0 +1,68 @@
+module RBSProtobuf
+  module Name
+    class Class
+      attr_reader :name
+
+      def initialize(name)
+        raise unless name.class?
+        @name = name
+      end
+
+      def instance_type(*args)
+        RBS::Types::ClassInstance.new(name: name, args: args, location: nil)
+      end
+
+      alias [] instance_type
+
+      def singleton_type
+        RBS::Types::ClassSingleton.new(name: name, location: nil)
+      end
+
+      def instance_type?(t)
+        t.is_a?(RBS::Types::ClassInstance) && t.name == name
+      end
+
+      def singleton_type?(t)
+        t.is_a?(RBS::Types::ClassSingleton) && t.name == name
+      end
+
+      def super_class(*args)
+        RBS::AST::Declarations::Class::Super.new(name: name, args: args, location: nil)
+      end
+    end
+
+    class Alias
+      attr_reader :name
+
+      def initialize(name)
+        raise unless name.alias?
+        @name = name
+      end
+
+      def [](*args)
+        RBS::Types::Alias.new(name: name, args: args, location: nil)
+      end
+
+      def type?(t)
+        t.is_a?(RBS::Types::Alias) && t.name == name
+      end
+    end
+
+    class Interface
+      attr_reader :name
+
+      def initialize(name)
+        raise unless name.interface?
+        @name = name
+      end
+
+      def [](*args)
+        RBS::Types::Interface.new(name: name, args: args, location: nil)
+      end
+
+      def type?(t)
+        t.is_a?(RBS::Types::Interface) && t.name == name
+      end
+    end
+  end
+end

data/lib/rbs_protobuf/translator/base.rb

@@ -14,7 +14,7 @@ module RBSProtobuf
       end
 
       def response
-        @response ||= Google::Protobuf::Compiler::CodeGeneratorResponse.new
+        @response ||= Google::Protobuf::Compiler::CodeGeneratorResponse.new(:supported_features => ::Google::Protobuf::Compiler::CodeGeneratorResponse::Feature::FEATURE_PROTO3_OPTIONAL.to_i)
       end
 
       def generate_rbs!