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::SINGLETON_CLASS_METHOD, Runtime::Reflection::SUPERCLASS_METHOD

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

#[], #type_member, #type_template

Methods included from Runtime::Reflection

#ancestors_of, #are_equal?, #class_of, #constantize, #constants_of, #descendants_of, #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, #signature_of, #singleton_class_of, #superclass_of

Methods included from Helpers::ParamHelper

#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

Constructor Details

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

Class Method Details

.gather_constants ⇒ Object 



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

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

Instance Method Details

#decorate ⇒ Object 



67
68
69
70
71
72
73
74
75
 
# File 'lib/tapioca/dsl/compilers/active_resource.rb', line 67

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