Class: Tapioca::Dsl::Compilers::FrozenRecord

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

Overview

‘Tapioca::Dsl::Compilers::FrozenRecord` generates RBI files for subclasses of [`FrozenRecord::Base`](github.com/byroot/frozen_record).

For example, with the following FrozenRecord class:

~~~rb # student.rb class Student < FrozenRecord::Base end ~~~

and the following YAML file:

~~~ yaml # students.yml

  • id: 1 first_name: John last_name: Smith

  • id: 2 first_name: Dan last_name: Lord

~~~

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

~~~rbi # Student.rbi # typed: strong class Student

include FrozenRecordAttributeMethods

module FrozenRecordAttributeMethods
  sig { returns(T.untyped) }
  def first_name; end

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

  sig { returns(T.untyped) }
  def id; end

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

  sig { returns(T.untyped) }
  def last_name; end

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

end ~~~

Constant Summary collapse

ConstantType = 
type_member { { fixed: T.all(T.class_of(::FrozenRecord::Base), Extensions::FrozenRecord) } }

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 



91
92
93
 
# File 'lib/tapioca/dsl/compilers/frozen_record.rb', line 91

def gather_constants
  descendants_of(::FrozenRecord::Base).reject(&:abstract_class?)
end

Instance Method Details

#decorate ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/tapioca/dsl/compilers/frozen_record.rb', line 67

def decorate
  attributes = constant.attributes
  return if attributes.empty?

  root.create_path(constant) do |record|
    module_name = "FrozenRecordAttributeMethods"

    record.create_module(module_name) do |mod|
      attributes.each do |attribute|
        mod.create_method("#{attribute}?", return_type: "T::Boolean")
        mod.create_method(attribute.to_s, return_type: "T.untyped")
      end
    end

    record.create_include(module_name)

    decorate_scopes(record)
  end
end