Add RBS support for Ruby 3+

.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
     - spec/fixtures/**/*
     - spec/pb/**/*
     - spec/demo_server
+    - ./**/*.rbs
 require:
   - rubocop-performance
   - rubocop-rspec

CHANGELOG.md

@@ -2,6 +2,8 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+- Add RBS support for Ruby 3.0
+
 ### 2.10.0
 
 - Drop support for Ruby 2.4/2.5 to align with Ruby EOL schedule, supporting 2.6+ only

lib/gruf.rbs

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  VERSION: ::String
+end

lib/gruf/cli/executor.rb

@@ -25,6 +25,10 @@ module Cli
     class Executor
       ##
       # @param [Hash|ARGV]
+      # @param [::Gruf::Server|NilClass] server
+      # @param [::Array|NilClass] services
+      # @param [::Gruf::Hooks::Executor|NilClass] hook_executor
+      # @param [::Logger|NilClass] logger
       #
       def initialize(
         args = ARGV,

lib/gruf/cli/executor.rbs

@@ -0,0 +1,28 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Cli
+    class Executor
+      def initialize: (?(Hash | ::ARGV) args, ?server: ::Gruf::Server? server, ?services: Array? services, ?hook_executor: ::Gruf::Hooks::Executor? hook_executor, ?logger: ::Logger? logger) -> void
+      def run: () -> void
+
+      private
+
+      def setup!: () -> void
+      def parse_options: () -> ::Slop::Result
+    end
+  end
+end

lib/gruf/client.rb

@@ -151,7 +151,8 @@ def rpc_desc(request_method)
     #
     # @param [Symbol] request_method The method name being called on the remote service
     # @param [Hash] params (Optional) A hash of parameters that will populate the request object
-    # @return [Class] The request object that corresponds to the method being called
+    # @return [Object] The request object that corresponds to the method being called
+    # @return [NilClass]
     #
     def request_object(request_method, params = {})
       desc = rpc_desc(request_method)
@@ -162,6 +163,7 @@ def request_object(request_method, params = {})
     # Properly find the appropriate call signature for the GRPC::GenericService given the request method name
     #
     # @return [Symbol]
+    # @return [NilClass]
     #
     def call_signature(request_method)
       desc = rpc_desc(request_method)
@@ -224,6 +226,8 @@ def error_deserializer_class
     # @param [mixed] timeout
     # @return [Float]
     # @return [GRPC::Core::TimeSpec]
+    # @return [Numeric]
+    # @return [Integer]
     #
     def parse_timeout(timeout)
       if timeout.nil?

lib/gruf/client.rbs

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  class Client < ::SimpleDelegator
+    attr_reader base_klass: ::Class
+    attr_reader service_klass: ::Class
+    attr_reader opts: ::Hash[::Symbol, ::Object]
+
+    def initialize: (service: ::Module service, ?options: ::Hash[::Symbol, ::Object] options, ?client_options: ::Hash[::Symbol, ::Object] client_options) -> void
+    def call: (::Symbol request_method, ?::Hash[::Symbol, ::Object] params, ?::Hash[::Symbol, ::Object] metadata, ?::Hash[::Symbol, ::Object] opts) { () -> ::Object } -> ::Gruf::Response
+    def timeout: () -> ( Integer | Float | Numeric | ::GRPC::Core::TimeSpec | nil )
+
+    private
+
+    def streaming_request?: (Symbol request_method) -> bool
+    def execute: (::Symbol call_sig, ?Object req, ?Hash[::Symbol, ::Object] metadata, ?::Hash[::Symbol, ::Object] opts) { () -> Object } -> ::Array[::Gruf::Timer::Result, ::GRPC::ActiveCall::Operation]
+    def rpc_desc: (::Symbol request_method) -> ::GRPC::RpcDesc
+    def request_object: (::Symbol request_method, ?::Hash[::Symbol, ::Object] params) -> ( ::Class | nil )
+    def call_signature: (::Symbol request_method) -> ( ::Symbol | nil )
+    def build_metadata: (?::Hash[::Symbol, ::Object] metadata) -> ::Hash[::Symbol, ::Object]
+    def build_ssl_credentials: () -> ( Symbol | GRPC::Core::ChannelCredentials)
+    def error_deserializer_class: () -> ::Class
+    def parse_timeout: (untyped timeout) -> ( ::Float | ::Numeric | ::Integer | ::GRPC::Core::TimeSpec )
+  end
+end

lib/gruf/client/error.rbs

@@ -0,0 +1,82 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  class Client < ::SimpleDelegator
+    class Error < ::StandardError
+      attr_reader error: Object
+      def initialize: (Object error) -> void
+    end
+
+    module Errors
+      class Base < Gruf::Client::Error
+      end
+
+      class Error < Base
+      end
+
+      class Validation < Base
+      end
+
+      class Ok < Base
+      end
+
+      class InvalidArgument < Validation
+      end
+
+      class NotFound < Validation
+      end
+
+      class AlreadyExists < Validation
+      end
+
+      class OutOfRange < Validation
+      end
+
+      class Cancelled < Error
+      end
+
+      class DataLoss < Error
+      end
+
+      class DeadlineExceeded < Error
+      end
+
+      class FailedPrecondition < Error
+      end
+
+      class Internal < Error
+      end
+
+      class PermissionDenied < Error
+      end
+
+      class ResourceExhausted < Error
+      end
+
+      class Unauthenticated < Error
+      end
+
+      class Unavailable < Error
+      end
+
+      class Unimplemented < Error
+      end
+
+      class Unknown < Error
+      end
+    end
+  end
+end

lib/gruf/client/error_factory.rb

@@ -43,7 +43,9 @@ def initialize(
       # coalesce them.
       #
       # @param [Exception] exception
-      # @return [Gruf::Client::Errors::Base|SignalException]
+      # @return [Gruf::Client::Errors::Base]
+      # @return [SignalException]
+      # @return [Exception]
       #
       def from_exception(exception)
         # passthrough on Signals, we don't want to mess with these
@@ -78,7 +80,7 @@ def deserialize(exception)
 
       ##
       # @param [Exception] exception
-      # @return [Gruf::Client::Errors::Base]
+      # @return [::Class]
       #
       def determine_class(exception)
         error_class = Gruf::Client::Errors.const_get(exception.class.name.demodulize)

lib/gruf/client/error_factory.rbs

@@ -0,0 +1,29 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  class Client < ::SimpleDelegator
+    class ErrorFactory
+      def initialize: (?default_class: ::Class? default_class, ?deserializer_class: ::Class? deserializer_class, ?metadata_key: (Symbol | String)? metadata_key) -> void
+      def from_exception: (::Exception exception) -> ( ::Gruf::Client::Errors::Base | SignalException | Exception )
+
+      private
+
+      def deserialize: (::Gruf::Client::Errors::Base exception) -> String
+      def determine_class: (::Exception exception) -> ::Class
+      def default_serializer: () -> ::Gruf::Serializers::Errors::Base
+    end
+  end
+end

lib/gruf/configuration.rbs

@@ -0,0 +1,32 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Configuration
+    VALID_CONFIG_KEYS: ::Hash[::Symbol, ::Object]
+
+    def self.extended: (::Gruf::Configuration base) -> void
+
+    def configure: () { () -> ::Gruf::Configuration } -> ::Gruf::Configuration
+
+    def options: () -> ::Hash
+
+    def reset: () -> ::Hash
+
+    private
+
+    def environment: () -> ::String
+  end
+end

lib/gruf/controllers/base.rb

@@ -26,13 +26,16 @@ module Controllers
     class Base
       include Gruf::Errors::Helpers
 
-      # @var [Gruf::Controller::Request] request
+      # @!attribute request
+      #   @return [Gruf::Controller::Request]
       attr_reader :request
-      # @var [Gruf::Error] error
+      # @!attribute error
+      #   @return [Gruf::Error]
       attr_reader :error
 
       class << self
-        # @var [GRPC::GenericService] bound_service
+        # @!attribute bound_service
+        #   @return [GRPC::GenericService]
         attr_reader :bound_service
       end
 

lib/gruf/controllers/base.rbs

@@ -0,0 +1,29 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Controllers
+    class Base
+      attr_reader request: ::Gruf::Controller::Request
+      attr_reader error: ::Gruf::Error
+      attr_reader self.bound_service: ::GRPC::GenericService
+
+      def initialize: (method_key: ::Symbol method_key, service: ::GRPC::GenericService service, rpc_desc: ::GRPC::RpcDesc rpc_desc, active_call: ::GRPC::ActiveCall active_call, message: ::Object message) -> void
+      def self.bind: (::GRPC::GenericService service) -> void
+      def process_action: (::Symbol method_key) { () -> ::Object } -> ::Object
+      def call: (::Symbol method_key) { () -> ::Object } -> ::Object
+    end
+  end
+end

lib/gruf/controllers/request.rb

@@ -106,6 +106,7 @@ def method_name
       # Return all messages for this request, properly handling different request types
       #
       # @return [Enumerable<Object>] All messages for this request
+      # @return [Object] A single object for bidi streams
       #
       def messages
         if client_streamer?