Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore anonymous helpers #4

Merged
merged 1 commit into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions lib/tapioca/dsl/compilers/grape_endpoints.rb
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,10 @@ def create_api_class
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
named_helper_mods = constant.namespace_stackable(:helpers).reject { |mod| mod.name.nil? }

api.create_class(EndpointClassName, superclass_name: superclass) do |klass|
helper_mods.each do |mod|
named_helper_mods.each do |mod|
klass.create_include(mod.name)
end
end
Expand Down
5 changes: 5 additions & 0 deletions rbi/grape.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ module Grape
sig { params(name: Symbol, block: T.proc.bind(Grape::Validations::ParamsScope).void).void }
def params(name, &block); end
end

module ClassMethods
sig { params(new_modules: T.untyped, block: T.nilable(T.proc.bind(Grape::DSL::Helpers::BaseHelper).void)).void }
def helpers(*new_modules, &block); end
end
end

module RequestResponse
Expand Down
73 changes: 63 additions & 10 deletions spec/tapioca/dsl/compilers/grape_endpoints_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -122,20 +122,17 @@ class PrivateEndpoint < ::Grape::Endpoint
assert_equal(expected, rbi_for(:TwitterAPI))
end

it "does not process anonymous helpers" do
it "ignores anonymous helpers" do
add_ruby_file("twitter_api.rb", <<~RUBY)
class TwitterAPI < Grape::API::Instance
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
params :pagination do
optional :page, type: Integer
optional :per_page, type: Integer
end
end

Expand All @@ -148,9 +145,65 @@ def authenticate!
end
RUBY

assert_raises(RuntimeError, /Cannot compile Grape API with anonymous helpers/) do
rbi_for(:TwitterAPI)
end
expected = template(<<~RUBY)
# typed: strong

class TwitterAPI
extend GeneratedCallbacksMethods
extend GeneratedRoutingMethods

module GeneratedCallbacksMethods
sig { params(block: T.proc.bind(PrivateEndpoint).void).void }
def after(&block); end

sig { params(block: T.proc.bind(PrivateEndpoint).void).void }
def after_validation(&block); end

sig { params(block: T.proc.bind(PrivateEndpoint).void).void }
def before(&block); end

sig { params(block: T.proc.bind(PrivateEndpoint).void).void }
def before_validation(&block); end

sig { params(block: T.proc.bind(PrivateEndpoint).void).void }
def finally(&block); end
end

module GeneratedRoutingMethods
sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def delete(*args, &block); end

sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def get(*args, &block); end

sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def head(*args, &block); end

sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def options(*args, &block); end

sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def patch(*args, &block); end

sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def post(*args, &block); end

sig { params(args: T.untyped, block: T.nilable(T.proc.bind(PrivateEndpoint).void)).void }
def put(*args, &block); end

sig { params(param: Symbol, options: T::Hash[Symbol, T.untyped], block: T.nilable(T.proc.bind(T.class_of(PrivateAPIInstance)).void)).void }
def route_param(param, options = {}, &block); end
end

class PrivateAPIInstance < ::Grape::API::Instance
extend GeneratedRoutingMethods
end

class PrivateEndpoint < ::Grape::Endpoint; end
end
RUBY

assert_equal(expected, rbi_for(:TwitterAPI))
end
end
end
Expand Down