rbs_protobuf 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9efd6a721c3cb1a7b88eb3281087e1ead753b4412976417734522f0418e91127
-  data.tar.gz: c4182e3be30b8882b8f706e0885d6dbfc0bbb218655056bea90a6753311b05bf
+  metadata.gz: 563169bcedcc8c4392d8ad6c428c8fd4f31b5ca3373705439fa94a0e3f05b138
+  data.tar.gz: a55dd8d55cc9b866b101e51bb90ba88aa5e138251c3083b010671b03346d9db8
 SHA512:
-  metadata.gz: 4d2183fb59feb4511635bf5fd85801721ecb120dd10a0fa7bd0757bfeed71a047ec6a849e96c66cfdc07101bf396f98d4e8d965c968fc379ccf3fc92ea2ab541
-  data.tar.gz: f865435271dcf8fc3c9945400e932c84f32da998d56625c5039912ab9256bcc01b8801906e4a008be0788fa1e0153b76f61994712f346d2eeb5e3a865561a23a
+  metadata.gz: d0ea93fd55f7b9efb4a864156e428033da4116499c99ef8f222949ae301b16fe302cd00c022ce2ad91ac9216dca508a084a9c59fb5b296dbd5e41d4d8dd6b205
+  data.tar.gz: c143b93fce43ede0ff094a26f2e51d3d72e6b35853852cc11e1b571f74abbe68ec7f579af206bec8213c908bb34d1421986f57a6f14417d316d7b666491c04ce

data/.github/workflows/test.yml

@@ -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

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

@@ -1,5 +1,17 @@
 # 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))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs_protobuf (0.3.0)
+    rbs_protobuf (1.0.0)
       activesupport (>= 4.0)
       rbs (>= 2.2.0)
 
@@ -25,7 +25,7 @@ GEM
     middleware (0.1.0)
     minitest (5.15.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     protobuf (3.10.5)
       activesupport (>= 3.2)
@@ -37,15 +37,15 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.3.1)
-    steep (0.52.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.0)
+      rbs (>= 2.3.2)
       terminal-table (>= 2, < 4)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -67,4 +67,4 @@ DEPENDENCIES
   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/Steepfile

@@ -2,6 +2,7 @@ D = Steep::Diagnostic
 
 target :lib do
   signature "sig"
+  signature "vendor/gem_rbs_collection/gems/protobuf"
   check "lib"
 
   configure_code_diagnostics do |hash|

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/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