grape_sorbet 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aadd0dde4fcc5037da59fbc26226c5d54d94686cc4024875e9cf9e21e547df8
-  data.tar.gz: 9ca6394902e1aea0a6facfcb584c3bac8c03ff580f5a3c8501962fcb737d7154
+  metadata.gz: aa4f8d64cc6cbf5839f525d1c1e246386510695be350c4bf1ed1298b52b8c9a4
+  data.tar.gz: baeca4c981155f04394d3dab717a300c923f41aa063516c4eb0430943e0ba756
 SHA512:
-  metadata.gz: 212aad3e25427f5d9329061e20d308d54daea04584c65d6cd0c5f8d542b7396287cb43a76f93999fea67c24883610e6f9d56e399bf59f7a65737ad51b21b4b41
-  data.tar.gz: 56f4c190b13f6763ad0e2a4b051346011eb976c3664de34e5b915f886a2c2970054b8e1946b5738fa2f439c1ecb88fc1f094d80e63145529a0e9b861fb0faa69
+  metadata.gz: 9a7f6cb172c0c73adf41a2992b620f45962459baeeb7f19cc916036776a010018a28a5f0dac752a55a2e1c623ee4e394a6654fd3f2139750e73fdc278a5f8a6d
+  data.tar.gz: 59580b70030d1d8d013191c55671a82daa854e1a536ecc67acb1a1ee70e1e907086a76b9eddb5022eadb03161c0043c241c7fc5f8a831c4cdf0b1c0f12e09597

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.0.4 (2024-06-24)
+
+- Update `grape.rbi`
+
+## 0.0.3 (2024-06-05)
+
+- Better support for callbacks
+
 ## 0.0.2 (2024-06-05)
 
 - Added support for callbacks (`before`, `after`, etc.)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape_sorbet (0.0.2)
+    grape_sorbet (0.0.4)
       activesupport
       grape (~> 2.0)
       sorbet-runtime (~> 0.5.10741)

data/README.md

@@ -1,6 +1,7 @@
 # grape_sorbet
 
 [![Build Status](https://github.com/thatch-health/grape_sorbet/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/thatch-health/grape_sorbet/actions?query=branch%3Amain)
+[![Gem Version ](https://img.shields.io/gem/v/grape_sorbet.svg?style=flat)](https://rubygems.org/gems/grape_sorbet)
 
 grape_sorbet is a gem that provides hand written signatures and a Tapioca DSL compiler that makes it more pleasant to use the [Grape](https://github.com/ruby-grape/grape) API framework in Ruby projects that use the [Sorbet](https://sorbet.org/) typechecker.
 
@@ -90,7 +91,29 @@ module Twitter
 end
 ```
 
-At this point Sorbet is still reporting errors in the `get :home_timeline` block, because it doesn't know that these blocks are executed in a context where the `Helpers` module methods will be available. The Tapioca compiler provided by this gem will fix that. Run `bundle exec tapioca dsl`. This should generate a `sorbet/rbi/dsl/twitter/api.rbi` file (assuming the source file is in `lib/twitter/api.rb`). After this,
+At this point Sorbet is still reporting errors in the `get :home_timeline` block, because it doesn't know that these blocks are executed in a context where the `Helpers` module methods will be available. The Tapioca compiler provided by this gem will fix that. Run `bundle exec tapioca dsl`. This should generate a `sorbet/rbi/dsl/twitter/api.rbi` file (assuming the source file is in `lib/twitter/api.rb`).
+
+After this, Sorbet should no longer report any errors.
+
+## Limitations and known issues
+
+### Subclassing from `Grape::API::Instance` instead of `Grape::API`
+
+Grape overrides `Grape::API.new` and uses the `inherited` hook so that subclasses of `Grape::API` are really subclasses of `Grape::API::Instance`.
+
+This might be fixable in a future update of grape_sorbet, but is very low priority.
+
+### Not being able to call `helpers` with block arguments
+
+Possibly fixable in a future update.
+
+### Having to use `T.bind(self, T.any(Grape::Endpoint, <HelpersModuleName>))` in helper methods
+
+Possibly fixable in a future update.
+
+### Having to use `T.bind(self, T.any(Grape::Endpoint, <HelpersModuleName>))` in `before` and `after` callback blocks
+
+The compiler already generates proper signatures for callback methods so `T.bind` should not be needed (and is in fact unneeded for the other callback methods, `before_validation`, `after_validation` and `finally`). The reason it doesn't work for `before` and `after` is because of a [bug](https://github.com/sorbet/sorbet/issues/7950) in Sorbet itself.
 
 ## Development
 

data/lib/grape_sorbet/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module GrapeSorbet
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/tapioca/dsl/compilers/grape_endpoints.rb

@@ -80,13 +80,13 @@ module Tapioca
           end
         end
 
-        HTTP_VERB_METHODS = T.let(
-          [:get, :post, :put, :patch, :delete, :head, :options].freeze,
+        CALLBACKS_METHODS = T.let(
+          [:before, :before_validation, :after_validation, :after, :finally].freeze,
           T::Array[Symbol],
         )
 
-        CALLBACKS_METHODS = T.let(
-          [:before, :before_validation, :after_validation, :after, :finally].freeze,
+        HTTP_VERB_METHODS = T.let(
+          [:get, :post, :put, :patch, :delete, :head, :options].freeze,
           T::Array[Symbol],
         )
 
@@ -100,6 +100,14 @@ module Tapioca
           )
         end
 
+        sig { returns(RBI::Scope) }
+        def callbacks_methods_module
+          @callbacks_methods_module ||= T.let(
+            api.create_module(CallbacksMethodsModuleName),
+            T.nilable(RBI::Scope),
+          )
+        end
+
         sig { returns(RBI::Scope) }
         def routing_methods_module
           @routing_methods_module ||= T.let(
@@ -110,6 +118,7 @@ module Tapioca
 
         sig { void }
         def create_classes_and_includes
+          api.create_extend(CallbacksMethodsModuleName)
           api.create_extend(RoutingMethodsModuleName)
           create_api_class
           create_endpoint_class
@@ -141,6 +150,19 @@ module Tapioca
           end
         end
 
+        sig { void }
+        def create_callbacks_methods
+          CALLBACKS_METHODS.each do |callback|
+            callbacks_methods_module.create_method(
+              callback.to_s,
+              parameters: [
+                create_block_param("block", type: "T.proc.bind(#{EndpointClassName}).void"),
+              ],
+              return_type: "void",
+            )
+          end
+        end
+
         sig { void }
         def create_routing_methods
           HTTP_VERB_METHODS.each do |verb|
@@ -148,7 +170,7 @@ module Tapioca
               verb.to_s,
               parameters: [
                 create_rest_param("args", type: "T.untyped"),
-                create_block_param("blk", type: "T.nilable(T.proc.bind(#{EndpointClassName}).void)"),
+                create_block_param("block", type: "T.nilable(T.proc.bind(#{EndpointClassName}).void)"),
               ],
               return_type: "void",
             )
@@ -158,26 +180,12 @@ module Tapioca
             "route_param",
             parameters: [
               create_param("param", type: "Symbol"),
-              create_opt_param("options", type: "T.nilable(T::Hash[Symbol, T.untyped])", default: "nil"),
-              create_block_param("blk", type: "T.nilable(T.proc.bind(T.class_of(#{APIInstanceClassName})).void)"),
+              create_opt_param("options", type: "T::Hash[Symbol, T.untyped]", default: "{}"),
+              create_block_param("block", type: "T.nilable(T.proc.bind(T.class_of(#{APIInstanceClassName})).void)"),
             ],
             return_type: "void",
           )
         end
-
-        sig { void }
-        def create_callbacks_methods
-          CALLBACKS_METHODS.each do |callback|
-            routing_methods_module.create_method(
-              callback.to_s,
-              parameters: [
-                create_rest_param("args", type: "T.untyped"),
-                create_block_param("blk", type: "T.nilable(T.proc.bind(#{EndpointClassName}).void)"),
-              ],
-              return_type: "void",
-            )
-          end
-        end
       end
     end
   end

data/lib/tapioca/dsl/helpers/grape_constants_helper.rb

@@ -7,6 +7,7 @@ module Tapioca
       module GrapeConstantsHelper
         extend T::Sig
 
+        CallbacksMethodsModuleName = "GeneratedCallbacksMethods"
         RoutingMethodsModuleName = "GeneratedRoutingMethods"
 
         APIInstanceClassName = "PrivateAPIInstance"

data/rbi/grape.rbi

@@ -2,107 +2,122 @@
 # frozen_string_literal: true
 
 module Grape
-  module DSL::Callbacks::ClassMethods
-    sig { params(block: T.proc.bind(Grape::Endpoint).void).void }
-    def before(&block); end
-  end
-
-  module DSL::Desc
-    # grape evaluates config_block in the context of a dynamically created module that implements the DSL it exposes
-    # at runtime. There's no good way to represent this statically, so block is just typed as T.untyped to prevent
-    # Sorbet from complaining that the DSL methods don't exist.
-    sig do
-      params(
-        description: String,
-        options: T.nilable(T::Hash[Symbol, T.untyped]),
-        config_block: T.nilable(T.proc.bind(T.untyped).void),
-      ).void
+  module DSL
+    module Desc
+      # grape evaluates config_block in the context of a dynamically created module that implements the DSL it exposes
+      # at runtime. There's no good way to represent this statically, so block is just typed as T.untyped to prevent
+      # Sorbet from complaining that the DSL methods don't exist.
+      sig do
+        params(
+          description: String,
+          options: T.nilable(T::Hash[Symbol, T.untyped]),
+          config_block: T.nilable(T.proc.bind(T.untyped).void),
+        ).void
+      end
+      def desc(description, options = T.unsafe(nil), &config_block); end
     end
-    def desc(description, options = T.unsafe(nil), &config_block); end
-  end
 
-  module DSL::RequestResponse::ClassMethods
-    sig { params(args: T.untyped, block: T.proc.bind(Grape::Endpoint).void).void }
-    def rescue_from(*args, &block); end
-  end
-
-  module DSL::Routing::ClassMethods
-    # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
-    sig do
-      params(
-        args: T.untyped,
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
+    module Helpers
+      module BaseHelper
+        sig { params(name: Symbol, block: T.proc.bind(Grape::Validations::ParamsScope).void).void }
+        def params(name, &block); end
+      end
     end
-    def delete(*args, &block); end
 
-    # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
-    sig do
-      params(
-        args: T.untyped,
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
+    module RequestResponse
+      module ClassMethods
+        sig { params(args: T.untyped, block: T.proc.bind(Grape::Endpoint).void).void }
+        def rescue_from(*args, &block); end
+      end
     end
-    def get(*args, &block); end
 
-    # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
-    sig do
-      params(
-        args: T.untyped,
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
-    end
-    def options(*args, &block); end
+    module Routing
+      module ClassMethods
+        # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
+        sig do
+          params(
+            args: T.untyped,
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def delete(*args, &block); end
 
-    # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
-    sig do
-      params(
-        args: T.untyped,
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
-    end
-    def patch(*args, &block); end
+        # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
+        sig do
+          params(
+            args: T.untyped,
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def get(*args, &block); end
 
-    # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
-    sig do
-      params(
-        args: T.untyped,
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
-    end
-    def post(*args, &block); end
+        # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
+        sig do
+          params(
+            args: T.untyped,
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def options(*args, &block); end
 
-    # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
-    sig do
-      params(
-        args: T.untyped,
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
-    end
-    def put(*args, &block); end
+        # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
+        sig do
+          params(
+            args: T.untyped,
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def patch(*args, &block); end
+
+        # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
+        sig do
+          params(
+            args: T.untyped,
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def post(*args, &block); end
+
+        # @shim: https://github.com/ruby-grape/grape/blob/v2.0.0/lib/grape/dsl/routing.rb#L148-L154
+        sig do
+          params(
+            args: T.untyped,
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def put(*args, &block); end
+
+        sig do
+          params(
+            methods: T.any(Symbol, String, T::Array[String]),
+            paths: T.nilable(T.any(String, T::Array[String])),
+            route_options: T.nilable(T::Hash[Symbol, T.untyped]),
+            block: T.nilable(T.proc.bind(Grape::Endpoint).void),
+          ).void
+        end
+        def route(methods, paths = T.unsafe(nil), route_options = T.unsafe(nil), &block); end
 
-    sig do
-      params(
-        methods: T.any(Symbol, String, T::Array[String]),
-        paths: T.nilable(T.any(String, T::Array[String])),
-        route_options: T.nilable(T::Hash[Symbol, T.untyped]),
-        block: T.nilable(T.proc.bind(Grape::Endpoint).void),
-      ).void
+        sig do
+          params(
+            param: Symbol,
+            options: T.nilable(T::Hash[Symbol, T.untyped]),
+            block: T.nilable(T.proc.bind(T.class_of(Grape::API::Instance)).void),
+          ).void
+        end
+        def route_param(param, options = T.unsafe(nil), &block); end
+      end
     end
-    def route(methods, paths = T.unsafe(nil), route_options = T.unsafe(nil), &block); end
 
-    sig do
-      params(
-        param: Symbol,
-        options: T.nilable(T::Hash[Symbol, T.untyped]),
-        block: T.nilable(T.proc.bind(T.class_of(Grape::API::Instance)).void),
-      ).void
+    module Validations
+      module ClassMethods
+        sig { params(block: T.proc.bind(Grape::Validations::ParamsScope).void).void }
+        def params(&block); end
+      end
     end
-    def route_param(param, options = T.unsafe(nil), &block); end
   end
 
-  module DSL::Validations::ClassMethods
-    sig { params(block: T.proc.bind(Grape::Validations::ParamsScope).void).void }
-    def params(&block); end
+  class Endpoint
+    sig { returns(Grape::Request) }
+    def request; end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Thatch Health, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: Sorbet signatures and Tapioca DSL compiler for Grape.