grape_sorbet 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aadd0dde4fcc5037da59fbc26226c5d54d94686cc4024875e9cf9e21e547df8
-  data.tar.gz: 9ca6394902e1aea0a6facfcb584c3bac8c03ff580f5a3c8501962fcb737d7154
+  metadata.gz: afca4010268efe01d37b64b7cfd4bbd7f6266779a3a135ab04fe14869ab71daf
+  data.tar.gz: ee494b0147c0b9d32ae90a5a1fba81218687b26396131a56ff9a1bb16306d693
 SHA512:
-  metadata.gz: 212aad3e25427f5d9329061e20d308d54daea04584c65d6cd0c5f8d542b7396287cb43a76f93999fea67c24883610e6f9d56e399bf59f7a65737ad51b21b4b41
-  data.tar.gz: 56f4c190b13f6763ad0e2a4b051346011eb976c3664de34e5b915f886a2c2970054b8e1946b5738fa2f439c1ecb88fc1f094d80e63145529a0e9b861fb0faa69
+  metadata.gz: 122aa7dab2572d6df1cfc79a3ec7a80b652f5ad7d5d51d87b0e9077385e3fb8041fd75b190f76ce4c58b4f1aea575dd1194d505b21c5d9ff32d80b9fca1aa33a
+  data.tar.gz: 4eb298722d0e14cb745a20917899825463fd50d6b87b0e1d9541566c9bc5961effec782c7ec767cacc9bcf37536596e0f885c3ae9eb5bdf60717f32d1833c341

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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.3)
       activesupport
       grape (~> 2.0)
       sorbet-runtime (~> 0.5.10741)

data/README.md

@@ -90,7 +90,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.3"
 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,11 +2,6 @@
 # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Thatch Health, Inc.