Class: Tapioca::Dsl::Compilers::JsonApiClientResource

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

Overview

‘Tapioca::Dsl::Compilers::JsonApiClientResource` generates RBI files for classes that inherit [`JsonApiClient::Resource`](github.com/JsonApiClient/json_api_client).

For example, with the following classes that inherits ‘JsonApiClient::Resource`:

~~~rb # user.rb class User < JsonApiClient::Resource

has_many :posts

property :name, type: :string
property :is_admin, type: :boolean, default: false

end

# post.rb class Post < JsonApiClient::Resource

belongs_to :user

property :title, type: :string

end ~~~

this compiler will produce RBI files with the following content:

~~~rbi # user.rbi # typed: strong

class User

include JsonApiClientResourceGeneratedMethods

module JsonApiClientResourceGeneratedMethods
  sig { returns(T::Boolean) }
  def is_admin; end

  sig { params(is_admin: T::Boolean).returns(T::Boolean) }
  def is_admin=(is_admin); end

  sig { returns(T.nilable(::String)) }
  def name; end

  sig { params(name: T.nilable(::String)).returns(T.nilable(::String)) }
  def name=(name); end

  sig { returns(T.nilable(T::Array[Post])) }
  def posts; end

  sig { params(posts: T.nilable(T::Array[Post])).returns(T.nilable(T::Array[Post])) }
  def posts=(posts); end
end

end

# post.rbi # typed: strong

class Post

include JsonApiClientResourceGeneratedMethods

module JsonApiClientResourceGeneratedMethods
  sig { returns(T.nilable(::String)) }
  def title; end

  sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
  def title=(title); end

  sig { returns(T.nilable(::String)) }
  def user_id; end

  sig { params(user_id: T.nilable(::String)).returns(T.nilable(::String)) }
  def user_id=(user_id); end
end

end ~~~

Constant Summary collapse

ConstantType = 
type_member { { fixed: T.class_of(::JsonApiClient::Resource) } }

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, #options, #root

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tapioca::Dsl::Compiler

#add_error, #compiler_enabled?, handles?, #initialize, processable_constants, requested_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, #signature_of!, #singleton_class_of, #superclass_of

Methods included from Runtime::AttachedClassOf

#attached_class_of

Methods included from RBIHelper

#as_nilable_type, #as_non_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 



112
113
114
115
116
 
# File 'lib/tapioca/dsl/compilers/json_api_client_resource.rb', line 112

def gather_constants
  all_modules.select do |c|
    name_of(c) && ::JsonApiClient::Resource > c
  end
end

Instance Method Details

#decorate ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/tapioca/dsl/compilers/json_api_client_resource.rb', line 88

def decorate
  schema = resource_schema
  return if schema.nil? && constant.associations.empty?

  root.create_path(constant) do |k|
    module_name = "JsonApiClientResourceGeneratedMethods"
    k.create_module(module_name) do |mod|
      schema&.each_property do |property|
        generate_methods_for_property(mod, property)
      end

      constant.associations.each do |association|
        generate_methods_for_association(mod, association)
      end
    end

    k.create_include(module_name)
  end
end