rbs_protobuf 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d8369a09563679a8a6c334efe056f6ef462bc1fc9bbd14af108fea7d4996cdb
-  data.tar.gz: 7f0e46181747c4f0ee8209496c16a29a81264ccbca39faf1803de6e2a6e3b535
+  metadata.gz: 563169bcedcc8c4392d8ad6c428c8fd4f31b5ca3373705439fa94a0e3f05b138
+  data.tar.gz: a55dd8d55cc9b866b101e51bb90ba88aa5e138251c3083b010671b03346d9db8
 SHA512:
-  metadata.gz: e70f6e59b9f9d3de0676dc1d6d6bf2ed7715649fe428e5edb8740247df0b6e12e21b26e2e9361443c80343563160da00841d1e90c35ae906db786aca676645d9
-  data.tar.gz: 901ca653bdd3c03f9f09086c194c2f60180b693d2b43830335a2d34f39053dfd1e9b974d7f598377493e8121d27cadecdc9ef959b26ca14a186633a6b4dd05b4
+  metadata.gz: d0ea93fd55f7b9efb4a864156e428033da4116499c99ef8f222949ae301b16fe302cd00c022ce2ad91ac9216dca508a084a9c59fb5b296dbd5e41d4d8dd6b205
+  data.tar.gz: c143b93fce43ede0ff094a26f2e51d3d72e6b35853852cc11e1b571f74abbe68ec7f579af206bec8213c908bb34d1421986f57a6f14417d316d7b666491c04ce

data/.github/workflows/test.yml

@@ -12,12 +12,12 @@ jobs:
     strategy:
       matrix:
         container_tag:
-          - 2.6-bionic
           - 2.7-bionic
           - 3.0-focal
+          - 3.1-focal
         protoc_version:
-          - 3.13.0
-          - 3.14.0
+          - 3.18.2
+          - 3.19.4
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
@@ -30,7 +30,9 @@ 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
+        with:
+          submodules: true
       - name: Run test
         run: |
           ruby -v
@@ -38,5 +40,3 @@ jobs:
           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

@@ -7,4 +7,4 @@
 /spec/reports/
 /tmp/
 /example/protobuf-gem/
-/Gemfile.lock
+.gem_rbs_collection

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/gem_rbs_collection"]
+	path = vendor/gem_rbs_collection
+	url = git@github.com:ruby/gem_rbs_collection.git

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# CHANGELOG
+
+## 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))
+* Add `!` methods type definitions ([\#14](https://github.com/square/rbs_protobuf/pull/14))
+
+## 0.2.0 (2022-03-18)
+
+This is a maintenance release to support the latest version of RBS.
+
+* Update to the latest RBS ([#11](https://github.com/square/rbs_protobuf/pull/11))
+* Type check with Steep ([#11](https://github.com/square/rbs_protobuf/pull/11))
+* Drop Ruby 2.6 support ([#11](https://github.com/square/rbs_protobuf/pull/11))

data/Gemfile

@@ -6,5 +6,6 @@ gemspec
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "steep"
+gem "rbs"
 
 gem "protobuf", "~> 3.10"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    rbs_protobuf (1.0.0)
+      activesupport (>= 4.0)
+      rbs (>= 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.2.3)
+      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)
+    ffi (1.15.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    middleware (0.1.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    protobuf (3.10.5)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    rainbow (3.1.1)
+    rake (12.3.3)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.3.2)
+    steep (0.52.1)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    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)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  protobuf (~> 3.10)
+  rake (~> 12.0)
+  rbs
+  rbs_protobuf!
+  steep
+
+BUNDLED WITH
+   2.3.11

data/README.md

@@ -20,7 +20,7 @@ message SearchRequest {
 }
 ```
 
-rbs_protobuf will generate the following RBS file including method definitions for each attribute with correct types. 
+rbs_protobuf will generate the following RBS file including method definitions for each attribute with correct types.
 
 ```rbs
 module Protobuf
@@ -84,28 +84,26 @@ 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).
+To type check the output, you need to configure your tools to import [gem_rbs_collection](https://github.com/ruby/gem_rbs_collection) with `rbs collection` command.
 
-    $ 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.
+```yaml
+# Add the dependency in rbs_collection.yaml
+gems:
+  - name: rbs_protobuf
+```
 
-    $ rbs --repo=vendor/rbs/gem_rbs_collection/gems -rprotobuf validate
+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).
 
-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
-```
+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
 
@@ -116,10 +114,36 @@ end
 | Packages                | ✓                          |
 | Nested messages         | ✓                          |
 | Maps                    | ✓                          |
-| Extensions              | ✓                          |
+| Extensions              | Read next section          |
 | Services                | Only generates classes     |
 | Oneof                   | No support in `protobuf` gem |
 
+### Extensions
+
+Adding extensions may cause problems if the name of new attribute conflicts.
+
+```proto
+extend SearchRequest {
+  // This extension defines an attribute.
+  optional string option = 100;
+}
+
+extend SearchRequest {
+  // Another extension defines another attribute with same name.
+  optional string option = 101;
+}
+```
+
+In this case, defining two `option` attributes in RBS causes an error.
+So, rbs_protobuf allows ignoring extensions for this case.
+
+You can control the behavior with `RBS_PROTOBUF_EXTENSION` environment variable.
+
+* `false`: Ignores extensions.
+* `print`: Prints RBS for extensions instead of writing them to files. You can copy or modify the printed RBS, and put them in some RBS files.
+* Any value else: Generates RBS for extensions.
+* undefined: Ignores extensions but print messages to ask you to specify a value.
+
 ## 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.
@@ -132,7 +156,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 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

@@ -13,6 +13,9 @@ task :default => [:test, "example:typecheck"]
 namespace :example do
   desc "Generate Ruby code with protobuf-gem"
   task :protobufgem do
+    spec = Gem::Specification.find_by_name("protobuf")
+    proto_path = File.join(spec.gem_dir, "proto")
+
     sh("rm -rf example/protobuf-gem")
     sh("mkdir", "-p", "example/protobuf-gem")
     sh(
@@ -21,17 +24,27 @@ namespace :example do
       "--plugin=protoc-gen-ruby-protobuf=#{__dir__}/bin/protoc-gen-ruby",
       "--ruby-protobuf_out=example/protobuf-gem",
       "-Iexample",
+      "-I#{proto_path}",
       "example/a.proto",
-      "example/b.proto"
+      "example/b.proto",
+      "example/c.proto"
     )
     sh(
-      { "RBS_PROTOBUF_BACKEND" => "protobuf" },
+      { "RBS_PROTOBUF_BACKEND" => "protobuf", "RBS_PROTOBUF_EXTENSION" => "true" },
       "protoc",
       "--rbs_out=example/protobuf-gem",
       "-Iexample",
       "example/a.proto",
       "example/b.proto"
     )
+    sh(
+      { "RBS_PROTOBUF_BACKEND" => "protobuf", "RBS_PROTOBUF_EXTENSION" => "true", "RUBYOPT" => "-rbundler/setup -Iexample/protobuf-gem -rc.pb" },
+      "protoc",
+      "--rbs_out=example/protobuf-gem",
+      "-Iexample",
+      "-I#{proto_path}",
+      "example/c.proto"
+    )
   end
 
   desc "Type check generated code"

data/Steepfile

@@ -0,0 +1,13 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  signature "vendor/gem_rbs_collection/gems/protobuf"
+  check "lib"
+
+  configure_code_diagnostics do |hash|
+    hash[D::Ruby::FallbackAny] = :hint
+    hash[D::Ruby::MethodDefinitionMissing] = :hint
+    hash[D::Ruby::UnknownConstant] = :information
+  end
+end

data/bin/setup

@@ -17,3 +17,5 @@ else
   mkdir -p $REPODIR/..
   git clone https://github.com/ruby/gem_rbs_collection.git ${REPODIR}
 fi
+
+bundle exec rbs collection install

data/bin/steep

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+BINSTUB_DIR=$(cd $(dirname $0); pwd)
+GEMFILE=$(readlink -f ${BINSTUB_DIR}/../Gemfile)
+ROOT_DIR=$(readlink -f ${BINSTUB_DIR}/..)
+
+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 ${ROOT_DIR} do ${STEEP}"
+  fi
+fi
+
+exec $STEEP $@

data/example/Steepfile

@@ -1,9 +1,15 @@
-repo = (Pathname(__dir__) + "../tmp/rbs/gem_rbs_collection/gems").to_s
+D = Steep::Diagnostic
+
+target :lib do
+  collection_config "../rbs_collection.yaml"
 
-target :protobuf_gem do
-  check "protobuf_gem_example.rb", "protobuf-gem"
   signature "protobuf-gem"
+  signature "../vendor/gem_rbs_collection/gems/protobuf"
+  check "protobuf_gem_example.rb"
 
-  repo_path repo
-  library "protobuf"
+  configure_code_diagnostics do |hash|
+    hash[D::Ruby::FallbackAny] = :hint
+    hash[D::Ruby::MethodDefinitionMissing] = :hint
+    hash[D::Ruby::UnknownConstant] = :information
+  end
 end

data/example/c.proto

@@ -0,0 +1,12 @@
+syntax = "proto2";
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FieldOptions {
+  optional bool super_custom_option = 22300;
+}
+
+message Message {
+  option deprecated = true;
+  optional string name = 1 [(super_custom_option) = true];
+}

data/exe/protoc-gen-rbs

@@ -19,11 +19,25 @@ translator = case backend
              when "protobuf"
                upcase_enum = ENV.key?("PB_UPCASE_ENUMS")
                no_nested_namespace = ENV.key?("RBS_PROTOBUF_NO_NESTED_NAMESPACE")
+               extension = case ENV["RBS_PROTOBUF_EXTENSION"]
+                           when "false"
+                             false
+                           when nil
+                             nil
+                           when "print"
+                             :print
+                           else
+                             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
+                 nested_namespace: !no_nested_namespace,
+                 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/rbs_factory.rb

@@ -8,7 +8,7 @@ module RBSProtobuf
       *path, name = string.delete_prefix("::").split("::").map(&:to_sym)
 
       TypeName.new(
-        name: name,
+        name: name || raise,
         namespace: Namespace.new(path: path, absolute: absolute)
       )
     end
@@ -72,7 +72,7 @@ module RBSProtobuf
                     type_name(name)
                   end
 
-      Types::Alias.new(name: type_name, location: nil)
+      Types::Alias.new(name: type_name, args: [], location: nil)
     end
 
     def function(return_type = Types::Bases::Void.new(location: nil))
@@ -87,7 +87,7 @@ module RBSProtobuf
     end
 
     def block(function, required: true)
-      MethodType::Block.new(
+      Types::Block.new(
         type: function,
         required: required
       )
@@ -98,8 +98,12 @@ module RBSProtobuf
     end
 
     def method_type(params: [], type:, block: nil, location: nil)
+      type_params = params.map do |name|
+        AST::TypeParam.new(name: name, variance: :invariant, upper_bound: nil, location: nil)
+      end
+
       MethodType.new(
-        type_params: params,
+        type_params: type_params,
         type: type,
         block: block,
         location: location
@@ -114,10 +118,14 @@ module RBSProtobuf
     end
 
     def optional_type(type, location: nil)
-      Types::Optional.new(
-        type: type,
-        location: location
-      )
+      if type.is_a?(Types::Optional)
+        type
+      else
+        Types::Optional.new(
+          type: type,
+          location: location
+        )
+      end
     end
 
     def type_var(name, location: nil)
@@ -128,12 +136,8 @@ module RBSProtobuf
     end
 
     def module_type_params(*params)
-      params.each.with_object(AST::Declarations::ModuleTypeParams.empty) do |param, type_params|
-        type_params.add(AST::Declarations::ModuleTypeParams::TypeParam.new(
-          name: param,
-          variance: :invariant,
-          skip_validation: false
-        ))
+      params.map do |name|
+        AST::TypeParam.new(name: name, variance: :invariant, upper_bound: nil, location: nil)
       end
     end
 

data/lib/rbs_protobuf/translator/base.rb

@@ -42,10 +42,12 @@ module RBSProtobuf
         raise NotImplementedError
       end
 
-      def comment_for_path(source_code_info, path)
+      def comment_for_path(source_code_info, path, options:)
         loc = source_code_info.location.find {|loc| loc.path == path }
+
+        comments = []
+
         if loc
-          comments = []
           if loc.leading_comments.length > 0
             comments << loc.leading_comments.strip
           end
@@ -55,9 +57,31 @@ module RBSProtobuf
           if comments.empty? && !loc.leading_detached_comments.empty?
             comments << loc.leading_detached_comments.join("\n\n").strip
           end
+        end
+
+        if options
+          # @type var opts: Array[[Symbol, untyped]]
+          opts = []
+          options.each_field do |key, value|
+            if options.field?(key.fully_qualified_name)
+              opts << [key.fully_qualified_name, value]
+            end
+          end
+
+          unless opts.empty?
+            unless comments.empty?
+              comments << "----"
+            end
+            comments << "Protobuf options:"
+            list = opts.map {|key, value| "- `#{key} = #{value.inspect}`" }
+            comments << list.join("\n")
+          end
+        end
+
+        unless comments.empty?
           RBS::AST::Comment.new(
             location: nil,
-            string: comments.join("\n\n")
+            string: comments.join("\n\n") + "\n\n"
           )
         end
       end
@@ -76,8 +100,7 @@ module RBSProtobuf
         when FieldDescriptorProto::Type::TYPE_DOUBLE, FieldDescriptorProto::Type::TYPE_FLOAT
           RBS::BuiltinNames::Float.instance_type
         when FieldDescriptorProto::Type::TYPE_BOOL
-          factory.union_type(factory.literal_type(true),
-                             factory.literal_type(false))
+          factory.bool_type()
         else
           raise "Unknown base type: #{type}"
         end
@@ -88,6 +111,8 @@ module RBSProtobuf
 
         *path, name = string.delete_prefix(".").split(".").map {|s| ActiveSupport::Inflector.upcase_first(s).to_sym }
 
+        name or raise
+
         factory.instance_type(
           RBS::TypeName.new(
             name: name,