Class: Tapioca::Dsl::Compilers::GraphqlMutation

Inherits:
Tapioca::Dsl::Compiler show all
Extended by:
T::Sig
Defined in:
lib/tapioca/dsl/compilers/graphql_mutation.rb

Overview

‘Tapioca::Dsl::Compilers::GraphqlMutation` generates RBI files for subclasses of [`GraphQL::Schema::Mutation`](graphql-ruby.org/api-doc/2.0.11/GraphQL/Schema/Mutation).

For example, with the following ‘GraphQL::Schema::Mutation` subclass:

~~~rb class CreateComment < GraphQL::Schema::Mutation

argument :body, String, required: true
argument :post_id, ID, required: true

def resolve(body:, post_id:)
  # ...
end

end ~~~

this compiler will produce the RBI file ‘notify_user_job.rbi` with the following content:

~~~rbi # create_comment.rbi # typed: true class CreateComment

sig { params(body: String, post_id: String).returns(T.untyped) }
def resolve(body:, post_id:); end

end ~~~

Constant Summary collapse

ConstantType = 
type_member { { fixed: T.class_of(GraphQL::Schema::Mutation) } }

Constants included from Runtime::Reflection

Runtime::Reflection::ANCESTORS_METHOD, Runtime::Reflection::CLASS_METHOD, Runtime::Reflection::CONSTANTS_METHOD, Runtime::Reflection::EQUAL_METHOD, Runtime::Reflection::METHOD_METHOD, Runtime::Reflection::NAME_METHOD, Runtime::Reflection::OBJECT_ID_METHOD, Runtime::Reflection::PRIVATE_INSTANCE_METHODS_METHOD, Runtime::Reflection::PROTECTED_INSTANCE_METHODS_METHOD, Runtime::Reflection::PUBLIC_INSTANCE_METHODS_METHOD, Runtime::Reflection::REQUIRED_FROM_LABELS, Runtime::Reflection::SINGLETON_CLASS_METHOD, Runtime::Reflection::SUPERCLASS_METHOD, Runtime::Reflection::UNDEFINED_CONSTANT

Constants included from SorbetHelper

SorbetHelper::FEATURE_REQUIREMENTS, SorbetHelper::SORBET_BIN, SorbetHelper::SORBET_EXE_PATH_ENV_VAR, SorbetHelper::SORBET_GEM_SPEC, SorbetHelper::SORBET_PAYLOAD_URL, SorbetHelper::SPOOM_CONTEXT

Instance Attribute Summary

Attributes inherited from Tapioca::Dsl::Compiler

#constant, #root

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tapioca::Dsl::Compiler

#add_error, #compiler_enabled?, handles?, #initialize, processable_constants

Methods included from T::Generic::TypeStoragePatch

#[], #has_attached_class!, #type_member, #type_template

Methods included from Runtime::Reflection

#abstract_type_of, #ancestors_of, #are_equal?, #class_of, #constant_defined?, #constantize, #constants_of, #descendants_of, #file_candidates_for, #final_module?, #inherited_ancestors_of, #method_of, #name_of, #name_of_type, #object_id_of, #private_instance_methods_of, #protected_instance_methods_of, #public_instance_methods_of, #qualified_name_of, #resolve_loc, #sealed_module?, #signature_of, #singleton_class_of, #superclass_of

Methods included from Runtime::AttachedClassOf

#attached_class_of

Methods included from RBIHelper

#as_nilable_type, #create_block_param, #create_kw_opt_param, #create_kw_param, #create_kw_rest_param, #create_opt_param, #create_param, #create_rest_param, #create_typed_param, #sanitize_signature_types, serialize_type_variable, #valid_method_name?, #valid_parameter_name?

Methods included from SorbetHelper

#sorbet, #sorbet_path, #sorbet_supports?

Constructor Details

This class inherits a constructor from Tapioca::Dsl::Compiler

Class Method Details

.gather_constants ⇒ Object 



82
83
84
 
# File 'lib/tapioca/dsl/compilers/graphql_mutation.rb', line 82

def gather_constants
  all_classes.select { |c| c < GraphQL::Schema::Mutation && c != GraphQL::Schema::RelayClassicMutation }
end

Instance Method Details

#argument_type(argument, constant) ⇒ Object 



72
73
74
75
76
 
# File 'lib/tapioca/dsl/compilers/graphql_mutation.rb', line 72

def argument_type(argument, constant)
  return "T.untyped" unless argument

  Helpers::GraphqlTypeHelper.type_for_argument(argument, constant)
end

#decorate ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/tapioca/dsl/compilers/graphql_mutation.rb', line 44

def decorate
  return unless constant.method_defined?(:resolve)

  method_def = constant.instance_method(:resolve)
  return if signature_of(method_def) # Skip if the mutation already has an inline sig

  arguments = constant.all_argument_definitions
  return if arguments.empty?

  arguments_by_name = arguments.to_h { |a| [a.keyword.to_s, a] }

  params = compile_method_parameters_to_rbi(method_def).map do |param|
    name = param.param.name
    argument = arguments_by_name.fetch(name, nil)
    create_typed_param(param.param, argument_type(argument, constant))
  end

  root.create_path(constant) do |mutation|
    mutation.create_method("resolve", parameters: params, return_type: "T.untyped")
  end
end