grape_sorbet 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f1483462bce00425216e9bd1be3137206600302347695f41aed3b8dcc1b19a7
-  data.tar.gz: e1f75b93fac21bf377184bcdc9224acc28da3dd8e885498fcc8359b22f0dbca7
+  metadata.gz: d4014b15113664de2c3ef60d30403fbe67f7d348d1f6c80fe7ac38d12b071646
+  data.tar.gz: 58c89b271a8ddec8a5d97a28044f8f46ad9259d2749371a96ca4c2a3362b235e
 SHA512:
-  metadata.gz: b42428f7c407aa7651a7db09e37e7c85219f3998ca0d53335d4751d8b42a13e736f5c3df681f808f01830d02f34c94574dd9ab6607613f2bbbac775dd61508bf
-  data.tar.gz: 59ae1b6e5bd26bd0fe5add3810b789df8f2b714484d1795d32f18b4484f6b33972cb2d2c1b180bfa6e3b7df6d5bbfd6c0571c575172502424199e22b338598ab
+  metadata.gz: f306c2fd09fe53fe081259dfb9df0cbd47d0923040d8593f6ea15a5bf4fbb6d837b0ec46a08188a673b1b1b03fead58dbab121f565659f1f6a8336f252ae6a79
+  data.tar.gz: 6f57c28ba24c5d771d38203a29e856cb7e54726685ff3a027cc7da42450a210019f85596eceaa1e5d62a9bc7bd7a328d11076c45ecfeb8119db70be068265a9d

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.0.9 (2024-07-15)
+
+- Entity name setter method
+
+## 0.0.8 (2024-07-12)
+
+- Improve types for `rescue_from`
+
 ## 0.0.7 (2024-07-03)
 
 - Add signatures for `error!` and a few other methods

data/Gemfile

@@ -32,4 +32,6 @@ group :test do
   gem "minitest-reporters", "~> 1.4"
 
   gem "simplecov", require: false
+
+  gem "grape-entity", require: false
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape_sorbet (0.0.7)
+    grape_sorbet (0.0.9)
       activesupport
       grape (~> 2.0)
       sorbet-runtime (~> 0.5.10741)
@@ -53,10 +53,13 @@ GEM
       mustermann-grape (~> 1.1.0)
       rack (>= 2)
       zeitwerk
+    grape-entity (1.0.1)
+      activesupport (>= 3.0.0)
+      multi_json (>= 1.3.2)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.13.2)
+    irb (1.14.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
@@ -67,6 +70,7 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.1.0)
@@ -74,14 +78,14 @@ GEM
     mutex_m (0.2.0)
     netrc (0.11.0)
     parallel (1.25.1)
-    parser (3.3.3.0)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     prism (0.30.0)
     psych (5.1.2)
       stringio
     racc (1.8.0)
-    rack (3.1.6)
+    rack (3.1.7)
     rainbow (3.1.1)
     rake (13.2.1)
     rbi (0.1.13)
@@ -94,20 +98,20 @@ GEM
       io-console (~> 0.5)
     rexml (3.3.1)
       strscan
-    rubocop (1.64.1)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-minitest (0.35.0)
+    rubocop-minitest (0.35.1)
       rubocop (>= 1.61, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-performance (1.21.1)
@@ -127,23 +131,23 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    sorbet (0.5.11466)
-      sorbet-static (= 0.5.11466)
-    sorbet-runtime (0.5.11466)
-    sorbet-static (0.5.11466-aarch64-linux)
-    sorbet-static (0.5.11466-universal-darwin)
-    sorbet-static (0.5.11466-x86_64-linux)
-    sorbet-static-and-runtime (0.5.11466)
-      sorbet (= 0.5.11466)
-      sorbet-runtime (= 0.5.11466)
-    spoom (1.3.2)
+    sorbet (0.5.11481)
+      sorbet-static (= 0.5.11481)
+    sorbet-runtime (0.5.11481)
+    sorbet-static (0.5.11481-aarch64-linux)
+    sorbet-static (0.5.11481-universal-darwin)
+    sorbet-static (0.5.11481-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11481)
+      sorbet (= 0.5.11481)
+      sorbet-runtime (= 0.5.11481)
+    spoom (1.3.3)
       erubi (>= 1.10.0)
-      prism (>= 0.19.0)
+      prism (>= 0.28.0)
       sorbet-static-and-runtime (>= 0.5.10187)
       thor (>= 0.19.2)
     stringio (3.1.1)
     strscan (3.1.0)
-    tapioca (0.15.0)
+    tapioca (0.15.1)
       bundler (>= 2.2.25)
       netrc (>= 0.11.0)
       parallel (>= 1.21.0)
@@ -169,6 +173,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler-audit
+  grape-entity
   grape_sorbet!
   irb
   minitest (~> 5.0)
@@ -185,4 +190,4 @@ DEPENDENCIES
   tapioca
 
 BUNDLED WITH
-   2.5.9
+   2.5.15

data/grape_sorbet.gemspec

@@ -31,9 +31,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_runtime_dependency("activesupport")
-  spec.add_runtime_dependency("grape", "~> 2.0")
-  spec.add_runtime_dependency("sorbet-runtime", "~> 0.5.10741")
+  spec.add_dependency("activesupport")
+  spec.add_dependency("grape", "~> 2.0")
+  spec.add_dependency("sorbet-runtime", "~> 0.5.10741")
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/grape_sorbet/grape_entity_name.rb

@@ -0,0 +1,89 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module GrapeSorbet
+  # This is a patch for Grape::Entity to make it easier to define custom entity names when using Sorbet.
+  #
+  # This patch defines a class setter `entity_name=` that can be used to define a custom entity name in a single line,
+  # while still working as expected with grape-swagger:
+  # ```
+  # class Link < Grape::Entity
+  #   self.entity_name = "LinkedStatus"
+  # end
+  # ```
+  #
+  # Without this patch, you would have to define a custom entity name like this:
+  # ```
+  # class Link < Grape::Entity
+  #   extend T::Sig
+  #
+  #   sig { returns(String) }
+  #   def self.entity_name
+  #     "LinkedStatus"
+  #   end
+  # end
+  # ```
+  #
+  # or even more verbose, if you're using the `Style/ClassMethodsDefinitions` Rubocop rule with
+  # `EnforcedStyle: self_class`:
+  # ```
+  # class Link < Grape::Entity
+  #   class << self
+  #     extend T::Sig
+  #
+  #     sig { returns(String) }
+  #     def entity_name
+  #       "LinkedStatus"
+  #     end
+  #   end
+  # end
+  # ```
+  module GrapeEntityName
+    extend T::Sig
+
+    include Kernel
+
+    # Sets the entity name.
+    #
+    # Used by grape-swagger to define a custom name to use in the OpenAPI schema instead of generating it from the
+    # fully qualified class name.
+    #
+    # @param entity_name [String] The custom entity name.
+    sig { params(entity_name: String).returns(String) }
+    attr_writer :entity_name
+
+    # Returns the custom entity name if one has been set (using `entity_name=`), otherwise raises an error.
+    #
+    # @return [String] The custom entity name.
+    # @raise [StandardError] If no custom entity name has been set.
+    sig { returns(String) }
+    def entity_name
+      @entity_name = T.let(@entity_name, T.nilable(String))
+
+      return @entity_name unless @entity_name.nil?
+
+      raise "entity_name has not been set for #{self}, call `#{self}.entity_name = \"...\"` to set it"
+    end
+
+    sig { params(method_name: T.any(String, Symbol), include_all: T.untyped).returns(T::Boolean) }
+    def respond_to?(method_name, include_all = false)
+      # grape-swagger checks if the model class responds to `:entity_name`, so we need to return false if
+      # `@entity_name` is nil (meaning `entity_name=` was never called).
+      if method_name.to_sym == :entity_name
+        return !!(defined?(@entity_name) && !@entity_name.nil?)
+      end
+
+      super
+    end
+  end
+end
+
+begin
+  require "grape-entity"
+rescue LoadError
+  return
+else
+  Grape::Entity.extend(GrapeSorbet::GrapeEntityName)
+end

data/lib/grape_sorbet/version.rb

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

data/lib/grape_sorbet.rb

@@ -5,3 +5,4 @@ module GrapeSorbet
 end
 
 require_relative "grape_sorbet/version"
+require_relative "grape_sorbet/grape_entity_name"

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

@@ -172,16 +172,30 @@ module Tapioca
 
         sig { void }
         def create_request_response_methods
-          request_response_methods_module.create_method(
+          sigs = [
+            request_response_methods_module.create_sig(
+              parameters: {
+                args: "Symbol",
+                block: "T.nilable(T.proc.bind(#{EndpointClassName}).params(e: Exception).void)",
+              },
+              return_type: "void",
+            ),
+            request_response_methods_module.create_sig(
+              type_parameters: ["E"],
+              parameters: {
+                args: "T::Class[T.all(::Exception, T.type_parameter(:E))]",
+                block: "T.nilable(T.proc.bind(#{EndpointClassName}).params(e: T.type_parameter(:E)).void)",
+              },
+              return_type: "void",
+            ),
+          ]
+          request_response_methods_module.create_method_with_sigs(
             "rescue_from",
+            sigs: sigs,
             parameters: [
-              create_rest_param("args", type: "T.untyped"),
-              create_block_param(
-                "block",
-                type: "T.nilable(T.proc.bind(#{EndpointClassName}).params(e: Exception).void)",
-              ),
+              RBI::RestParam.new("args"),
+              RBI::BlockParam.new("block"),
             ],
-            return_type: "void",
           )
         end
 

data/rbi/grape.rbi

@@ -51,7 +51,15 @@ module Grape
 
     module RequestResponse
       module ClassMethods
-        sig { params(args: T.untyped, block: T.proc.bind(Grape::Endpoint).params(e: Exception).void).void }
+        sig { params(args: Symbol, block: T.nilable(T.proc.bind(Grape::Endpoint).params(e: Exception).void)).void }
+        sig do
+          type_parameters(:E)
+            .params(
+              args: T::Class[T.all(Exception, T.type_parameter(:E))],
+              block: T.proc.bind(Grape::Endpoint).params(e: T.type_parameter(:E)).void,
+            )
+            .void
+        end
         def rescue_from(*args, &block); end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Thatch Health, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,6 +72,7 @@ files:
 - Rakefile
 - grape_sorbet.gemspec
 - lib/grape_sorbet.rb
+- lib/grape_sorbet/grape_entity_name.rb
 - lib/grape_sorbet/version.rb
 - lib/tapioca/dsl/compilers/grape_endpoints.rb
 - lib/tapioca/dsl/helpers/grape_constants_helper.rb