grape_sorbet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68395f140413d15f9db05463e554cdf86ec2e60915226877fd738cf1b7d17183
+  data.tar.gz: 8c4a99e44696bd706c216c1629c18c48a359902710100542061f65fd01fae256
+SHA512:
+  metadata.gz: db6b2f00da52ea9382f4cc6fc05c38b569614e95f7f81061d684d884716ea761a2b8d23a090606dccab3c5e54faa715fcc5e4b59d598b7e66b279ec2cfae0dce
+  data.tar.gz: ef8ffe995841f9cb5ca094e36ea7ef82d0ccc05626a3a68e8a252469ff1197460cfa5556e58d93c361964f2a4617a846b3e873d3d228a58da276fbdf0eae3fc9

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.rubocop.yml

@@ -0,0 +1,23 @@
+# Opinionated cops - see https://ruby-style-guide.shopify.dev/ for explanations
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-sorbet
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+Naming/ConstantName:
+  Enabled: false
+
+Sorbet/StrictSigil:
+  Enabled: true
+
+Style/MutableConstant:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+3.3.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 14116796+olivierbellone@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in grape_sorbet.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development, :test do
+  gem "irb"
+end
+
+group :development do
+  gem "sorbet", "~> 0.5.10736"
+  gem "tapioca", require: false
+
+  gem "rubocop", require: false
+  gem "rubocop-minitest", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-shopify", require: false
+  gem "rubocop-sorbet", require: false
+
+  gem "bundler-audit", require: false
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "minitest-reporters", "~> 1.4"
+
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,191 @@
+PATH
+  remote: .
+  specs:
+    grape_sorbet (0.0.1)
+      activesupport
+      grape (~> 2.0)
+      sorbet-runtime (~> 0.5.10741)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ansi (1.5.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.2.4)
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    concurrent-ruby (1.3.1)
+    connection_pool (2.4.1)
+    docile (1.4.0)
+    drb (2.2.1)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    erubi (1.12.0)
+    grape (2.0.0)
+      activesupport (>= 5)
+      builder
+      dry-types (>= 1.1)
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    minitest (5.23.1)
+    minitest-reporters (1.6.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.2)
+      mustermann (>= 1.0.0)
+    mutex_m (0.2.0)
+    netrc (0.11.0)
+    parallel (1.24.0)
+    parser (3.3.2.0)
+      ast (~> 2.4.1)
+      racc
+    prism (0.29.0)
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
+    rack (3.0.11)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbi (0.1.13)
+      prism (>= 0.18.0, < 1.0.0)
+      sorbet-runtime (>= 0.5.9204)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.8)
+      io-console (~> 0.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rubocop (1.64.1)
+      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)
+      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 (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-shopify (2.15.1)
+      rubocop (~> 1.51)
+    rubocop-sorbet (0.8.3)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sorbet (0.5.11406)
+      sorbet-static (= 0.5.11406)
+    sorbet-runtime (0.5.11406)
+    sorbet-static (0.5.11406-aarch64-linux)
+    sorbet-static (0.5.11406-universal-darwin)
+    sorbet-static (0.5.11406-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11406)
+      sorbet (= 0.5.11406)
+      sorbet-runtime (= 0.5.11406)
+    spoom (1.3.2)
+      erubi (>= 1.10.0)
+      prism (>= 0.19.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    stringio (3.1.0)
+    strscan (3.1.0)
+    tapioca (0.14.3)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (>= 0.1.4, < 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.36)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.6.15)
+
+PLATFORMS
+  aarch64-linux
+  universal-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  bundler-audit
+  grape_sorbet!
+  irb
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.4)
+  rake (~> 13.0)
+  rubocop
+  rubocop-minitest
+  rubocop-performance
+  rubocop-rake
+  rubocop-shopify
+  rubocop-sorbet
+  simplecov
+  sorbet (~> 0.5.10736)
+  tapioca
+
+BUNDLED WITH
+   2.5.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Thatch Health, Inc.
+
+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.

data/README.md

@@ -0,0 +1,111 @@
+# 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)
+
+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.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add r --github=https://github.com/thatch-health/grape_sorbet
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install specific_install
+    $ gem specific_install https://github.com/thatch-health/grape_sorbet.git
+
+After installing the gem, make sure to run `bundle exec tapioca gem grape_sorbet` in your project to import the hand written signatures.
+
+## Usage
+
+Starting with the following example from grape's documentation:
+
+```ruby
+module Twitter
+  class API < Grape::API
+    version 'v1', using: :header, vendor: 'twitter'
+    format :json
+    prefix :api
+
+    helpers do
+      def current_user
+        @current_user ||= User.authorize!(env)
+      end
+
+      def authenticate!
+        error!('401 Unauthorized', 401) unless current_user
+      end
+    end
+
+    resource :statuses do
+      desc 'Return a personal timeline.'
+      get :home_timeline do
+        authenticate!
+        current_user.statuses.limit(20)
+      end
+    end
+  end
+end
+```
+
+First, you'll need to make the following changes:
+
+* derive from `Grape::API::Instance` rather than `Grape::API`
+* change the `helpers` call to replace the block parameter with a named module
+
+You'll also need to use `T.bind(self, T.all(Grape::Endpoint, <HelpersModuleName>))` in helper methods that use methods provided by Grape (e.g. `env` in `current_user` or `error!` in `authenticate!`) or other methods from the same helper module (e.g. `current_user` in `authenticate!`).
+
+With the changes:
+
+```ruby
+module Twitter
+  class API < Grape::API::Instance
+    version 'v1', using: :header, vendor: 'twitter'
+    format :json
+    prefix :api
+
+    module Helpers
+      def current_user
+        T.bind(self, T.all(Grape::Endpoint, Helpers))
+        @current_user ||= User.authorize!(env)
+      end
+
+      def authenticate!
+        T.bind(self, T.all(Grape::Endpoint, Helpers))
+        error!('401 Unauthorized', 401) unless current_user
+      end
+    end
+    helpers Helpers
+
+    resource :statuses do
+      desc 'Return a personal timeline.'
+      get :home_timeline do
+        authenticate!
+        current_user.statuses.limit(20)
+      end
+    end
+  end
+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,
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thatch-health/grape_sorbet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thatch-health/grape_sorbet/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TestGem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thatch-health/grape_sorbet/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+task default: :test
+
+RuboCop::RakeTask.new do |t|
+  t.options = ["--parallel"]
+end

data/grape_sorbet.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/grape_sorbet/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "grape_sorbet"
+  spec.version = GrapeSorbet::VERSION
+  spec.authors = ["Thatch Health, Inc."]
+  spec.email = ["grape-sorbet@thatch.ai"]
+
+  spec.summary = "Sorbet signatures and Tapioca DSL compiler for Grape."
+  spec.description = "This gem provides Sorbet signatures and a Tapioca DSL compiler that enable using " \
+    "the Grape API framework in a Sorbet-typed Ruby project."
+  spec.homepage = "https://github.com/thatch-health/grape_sorbet"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/thatch-health/grape_sorbet/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|sorbet)/|\.(?:git|circleci|vscode)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  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")
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/grape_sorbet/version.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module GrapeSorbet
+  VERSION = "0.0.1"
+end

data/lib/grape_sorbet.rb

@@ -0,0 +1,7 @@
+# typed: strict
+# frozen_string_literal: true
+
+module GrapeSorbet
+end
+
+require_relative "grape_sorbet/version"

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

@@ -0,0 +1,164 @@
+# typed: strict
+# frozen_string_literal: true
+
+begin
+  require "grape"
+rescue LoadError
+  return
+end
+
+require "active_support/core_ext/class/subclasses"
+
+require "tapioca/dsl/helpers/grape_constants_helper"
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # `Tapioca::Compilers::GrapeEndpoints` decorates RBI files for subclasses of `Grape::API::Instance`.
+      #
+      # For example, with the following `Grape::API::Instance` subclass:
+      #
+      # ~~~rb
+      # class API < Grape::API::Instance
+      #   helpers Helpers
+      # end
+      # ~~~
+      #
+      # this compiler will produce the RBI file `api.rbi` with the following content:
+      # ~~~rbi
+      # # api.rbi
+      # # typed: true
+      #
+      # class API
+      #   extend GeneratedRoutingMethods
+      #
+      #   module GeneratedRoutingMethods
+      #     sig { params(args: T.untyped, blk: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
+      #     def get(*args, &blk); end
+      #
+      #     # ...
+      #
+      #     sig do
+      #       params(
+      #         param: Symbol,
+      #         options: T.nilable(T::Hash[Symbol, T.untyped]),
+      #         blk: T.nilable(T.proc.bind(T.class_of(PrivateAPIInstance)).void)
+      #       ).void
+      #     end
+      #     def route_param(param, options = nil, &blk); end
+      #   end
+      #
+      #   class PrivateAPIInstance < ::Grape::API::Instance
+      #     extend GeneratedRoutingMethods
+      #   end
+      #
+      #   class PrivateEndpoint < ::Grape::Endpoint
+      #     include Helpers
+      #   end
+      # end
+      # ~~~
+      #
+      class GrapeEndpoints < Tapioca::Dsl::Compiler
+        extend T::Sig
+        include Helpers::GrapeConstantsHelper
+
+        ConstantType = type_member { { fixed: T.class_of(::Grape::API::Instance) } }
+
+        sig { override.void }
+        def decorate
+          create_classes_and_includes
+          create_routing_methods
+        end
+
+        class << self
+          extend T::Sig
+
+          sig { override.returns(T::Enumerable[Module]) }
+          def gather_constants
+            ::Grape::API::Instance.descendants
+          end
+        end
+
+        HTTP_VERB_METHODS = T.let(
+          [:get, :post, :put, :patch, :delete, :head, :options].freeze,
+          T::Array[Symbol],
+        )
+
+        private
+
+        sig { returns(RBI::Scope) }
+        def api
+          @api ||= T.let(
+            root.create_path(constant),
+            T.nilable(RBI::Scope),
+          )
+        end
+
+        sig { returns(RBI::Scope) }
+        def routing_methods_module
+          @routing_methods_module ||= T.let(
+            api.create_module(RoutingMethodsModuleName),
+            T.nilable(RBI::Scope),
+          )
+        end
+
+        sig { void }
+        def create_classes_and_includes
+          api.create_extend(RoutingMethodsModuleName)
+          create_api_class
+          create_endpoint_class
+        end
+
+        sig { void }
+        def create_api_class
+          superclass = "::Grape::API::Instance"
+
+          api.create_class(APIInstanceClassName, superclass_name: superclass) do |klass|
+            klass.create_extend(RoutingMethodsModuleName)
+          end
+        end
+
+        sig { void }
+        def create_endpoint_class
+          superclass = "::Grape::Endpoint"
+
+          helper_mods = constant.namespace_stackable(:helpers)
+
+          if helper_mods.any? { |mod| mod.name.nil? }
+            raise "Cannot compile Grape API with anonymous helpers"
+          end
+
+          api.create_class(EndpointClassName, superclass_name: superclass) do |klass|
+            helper_mods.each do |mod|
+              klass.create_include(mod.name)
+            end
+          end
+        end
+
+        sig { void }
+        def create_routing_methods
+          HTTP_VERB_METHODS.each do |verb|
+            routing_methods_module.create_method(
+              verb.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
+
+          routing_methods_module.create_method(
+            "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)"),
+            ],
+            return_type: "void",
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Tapioca
+  module Dsl
+    module Helpers
+      module GrapeConstantsHelper
+        extend T::Sig
+
+        RoutingMethodsModuleName = "GeneratedRoutingMethods"
+
+        APIInstanceClassName = "PrivateAPIInstance"
+        EndpointClassName = "PrivateEndpoint"
+      end
+    end
+  end
+end

data/rbi/grape.rbi

@@ -0,0 +1,108 @@
+# typed: strict
+# 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
+    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
+    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 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
+
+    # @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(
+        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
+
+  module DSL::Validations::ClassMethods
+    sig { params(block: T.proc.bind(Grape::Validations::ParamsScope).void).void }
+    def params(&block); end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: grape_sorbet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thatch Health, Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.10741
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.10741
+description: This gem provides Sorbet signatures and a Tapioca DSL compiler that enable
+  using the Grape API framework in a Sorbet-typed Ruby project.
+email:
+- grape-sorbet@thatch.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape_sorbet.gemspec
+- lib/grape_sorbet.rb
+- lib/grape_sorbet/version.rb
+- lib/tapioca/dsl/compilers/grape_endpoints.rb
+- lib/tapioca/dsl/helpers/grape_constants_helper.rb
+- rbi/grape.rbi
+homepage: https://github.com/thatch-health/grape_sorbet
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thatch-health/grape_sorbet
+  source_code_uri: https://github.com/thatch-health/grape_sorbet
+  changelog_uri: https://github.com/thatch-health/grape_sorbet/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Sorbet signatures and Tapioca DSL compiler for Grape.
+test_files: []