rbs_protobuf 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56ace4b5dcb20700d6a42b22cac53d5a2fd7a73db0ce0817352c19ac02653aa1
-  data.tar.gz: cbb834ca61e52d95574a4136332ceccfae623a64d438e3fec552dfc9d8250190
+  metadata.gz: 9efd6a721c3cb1a7b88eb3281087e1ead753b4412976417734522f0418e91127
+  data.tar.gz: c4182e3be30b8882b8f706e0885d6dbfc0bbb218655056bea90a6753311b05bf
 SHA512:
-  metadata.gz: d652ba346051a94d4b3364047cbe3b6d02048a3dd5bcc911eb6041480d7b2f24f94fd4eaf306fad73e199066da4aafc18b745045da4025d11dec8854924b2aee
-  data.tar.gz: 61660f34ee55a04ed35b2f05f94b9f6ffcbacc93abc1666185f06ba66dd9079a6fdbc47f626b51fb859cfaa57d85b55267b222271d7903a60c6afd50d006620a
+  metadata.gz: 4d2183fb59feb4511635bf5fd85801721ecb120dd10a0fa7bd0757bfeed71a047ec6a849e96c66cfdc07101bf396f98d4e8d965c968fc379ccf3fc92ea2ab541
+  data.tar.gz: f865435271dcf8fc3c9945400e932c84f32da998d56625c5039912ab9256bcc01b8801906e4a008be0788fa1e0153b76f61994712f346d2eeb5e3a865561a23a

data/.github/workflows/test.yml

@@ -38,5 +38,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,3 +7,4 @@
 /spec/reports/
 /tmp/
 /example/protobuf-gem/
+.gem_rbs_collection

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 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.

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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs_protobuf (0.2.0)
+    rbs_protobuf (0.3.0)
       activesupport (>= 4.0)
       rbs (>= 2.2.0)
 
@@ -14,7 +14,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     ffi (1.15.5)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
@@ -24,7 +24,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     middleware (0.1.0)
     minitest (5.15.0)
-    parallel (1.21.0)
+    parallel (1.22.1)
     parser (3.1.1.0)
       ast (~> 2.4.1)
     protobuf (3.10.5)
@@ -37,15 +37,15 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.2.2)
-    steep (0.49.1)
+    rbs (2.3.1)
+    steep (0.52.0)
       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.2.0)
+      rbs (>= 2.3.0)
       terminal-table (>= 2, < 4)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -62,6 +62,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   protobuf (~> 3.10)
   rake (~> 12.0)
+  rbs
   rbs_protobuf!
   steep
 

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,8 +24,10 @@ 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_EXTENSION" => "true" },
@@ -32,6 +37,14 @@ namespace :example do
       "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

@@ -4,18 +4,9 @@ target :lib do
   signature "sig"
   check "lib"
 
-  library "rbs"
-  library "monitor"
-  library "logger"
-  library "set"
-  library "json"
-  library "tsort"
-  library "pathname"
-  library "optparse"
-  library "rubygems"
-
   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/example/Steepfile

@@ -1,9 +1,14 @@
-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"
+  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/lib/rbs_protobuf/rbs_factory.rb

@@ -118,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)

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

data/lib/rbs_protobuf/translator/protobuf_gem.rb

@@ -146,7 +146,7 @@ module RBSProtobuf
           super_class: message_base_class,
           type_params: [],
           location: nil,
-          comment: comment_for_path(source_code_info, path),
+          comment: comment_for_path(source_code_info, path, options: message.options),
           members: [],
           annotations: []
         ).tap do |class_decl|
@@ -182,7 +182,7 @@ module RBSProtobuf
 
           message.field.each_with_index do |field, index|
             field_name = field.name.to_sym
-            comment = comment_for_path(source_code_info, path + [2, index])
+            comment = comment_for_path(source_code_info, path + [2, index], options: field.options)
 
             read_type, write_type = field_type(field, maps)
 
@@ -220,6 +220,20 @@ module RBSProtobuf
                 kind: :instance
               )
             end
+
+            class_decl.members << RBS::AST::Members::MethodDefinition.new(
+              name: :"#{field_name}!",
+              types: [
+                factory.method_type(
+                  type: factory.function(factory.optional_type(read_type))
+                )
+              ],
+              annotations: [],
+              comment: nil,
+              location: nil,
+              overload: false,
+              kind: :instance
+            )
           end
 
           class_decl.members << RBS::AST::Members::MethodDefinition.new(
@@ -414,7 +428,7 @@ module RBSProtobuf
           super_class: enum_base_class(),
           type_params: factory.module_type_params(),
           members: [],
-          comment: comment_for_path(source_code_info, path),
+          comment: comment_for_path(source_code_info, path, options: enum_type.options),
           location: nil,
           annotations: []
         ).tap do |enum_decl|
@@ -491,7 +505,7 @@ module RBSProtobuf
           )
 
           enum_type.value.each.with_index do |v, index|
-            comment = comment_for_path(source_code_info, path + [2, index])
+            comment = comment_for_path(source_code_info, path + [2, index], options: v.options)
 
             enum_decl.members << RBS::AST::Declarations::Constant.new(
               name: factory.type_name(enum_name(v.name).to_s),
@@ -608,7 +622,7 @@ module RBSProtobuf
           super_class: service_base_class,
           type_params: factory.module_type_params(),
           members: [],
-          comment: comment_for_path(source_code_info, path),
+          comment: comment_for_path(source_code_info, path, options: nil),
           location: nil,
           annotations: []
         )

data/lib/rbs_protobuf/version.rb

@@ -1,3 +1,3 @@
 module RBSProtobuf
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/rbs_collection.lock.yaml

@@ -0,0 +1,116 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: rbs
+  version: 2.3.1
+  source:
+    type: rubygems
+- name: activesupport
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: protobuf
+  version: 3.10.3
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: listen
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: set
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: rubygems
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,18 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+  - name: activesupport
+  - name: protobuf
+  - name: rbs_protobuf
+    ignore: true

data/sig/rbs_protobuf/translator/base.rbs

@@ -23,7 +23,9 @@ module RBSProtobuf
 
       def rbs_content: (String file) -> String
 
-      def comment_for_path: (untyped source_code_info, Array[Integer] path) -> RBS::AST::Comment?
+      def comment_for_path: (untyped source_code_info, Array[Integer] path, options: untyped) -> RBS::AST::Comment?
+
+      def each_options_field: (untyped) { (Symbol, untyped) -> void } -> void
 
       def base_type: (untyped `type`) -> RBS::Types::t
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_protobuf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -68,6 +68,7 @@ files:
 - example/Steepfile
 - example/a.proto
 - example/b.proto
+- example/c.proto
 - example/protobuf_gem_example.rb
 - exe/protoc-gen-rbs
 - lib/rbs_protobuf.rb
@@ -75,13 +76,14 @@ files:
 - lib/rbs_protobuf/translator/base.rb
 - lib/rbs_protobuf/translator/protobuf_gem.rb
 - lib/rbs_protobuf/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - rbs_protobuf.gemspec
 - sig/rbs_protobuf.rbs
 - sig/rbs_protobuf/rbs_factory.rbs
 - sig/rbs_protobuf/translator/base.rbs
 - sig/rbs_protobuf/translator/protobuf_gem.rbs
 - sig/rbs_protobuf/version.rbs
-- sig/stub/_activesupport.rbs
 homepage: https://github.com/square/rbs_protobuf
 licenses:
 - MIT
@@ -104,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generate RBS files from .proto files

data/sig/stub/_activesupport.rbs

@@ -1,7 +0,0 @@
-module ActiveSupport
-  module Inflector
-    def self?.upcase_first: (String) -> String
-
-    def self?.camelize: (String) -> String
-  end
-end