Class: Tapioca::Dsl::Compilers::ActiveResource

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

Overview

‘Tapioca::Dsl::Compilers::ActiveResource` decorates RBI files for subclasses of [`ActiveResource::Base`](github.com/rails/activeresource) which declare `schema` fields.

For example, with the following ‘ActiveResource::Base` subclass:

~~~rb class Post < ActiveResource::Base

schema do
  integer 'id', 'month', 'year'
end

end ~~~

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

~~~rbi # post.rbi # typed: true class Post

sig { returns(Integer) }
def id; end

sig { params(id: Integer).returns(Integer) }
def id=(id); end

sig { returns(T::Boolean) }
def id?; end

sig { returns(Integer) }
def month; end

sig { params(month: Integer).returns(Integer) }
def month=(month); end

sig { returns(T::Boolean) }
def month?; end

sig { returns(Integer) }
def year; end

sig { params(year: Integer).returns(Integer) }
def year=(year); end

sig { returns(T::Boolean) }
def year?; end

end ~~~

Constant Summary collapse

ConstantType = 
type_member { { fixed: T.class_of(::ActiveResource::Base) } }

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 



77
78
79
 
# File 'lib/tapioca/dsl/compilers/active_resource.rb', line 77

def gather_constants
  descendants_of(::ActiveResource::Base)
end

Instance Method Details

#decorate ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'lib/tapioca/dsl/compilers/active_resource.rb', line 63

def decorate
  return if constant.schema.blank?

  root.create_path(constant) do |resource|
    constant.schema.each do |attribute, type|
      create_schema_methods(resource, attribute, type)
    end
  end
end