Class: Tapioca::Dsl::Compilers::ActiveSupportCurrentAttributes

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

Overview

‘Tapioca::Dsl::Compilers::ActiveSupportCurrentAttributes` decorates RBI files for all subclasses of [`ActiveSupport::CurrentAttributes`](api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html).

For example, with the following singleton class

~~~rb class Current < ActiveSupport::CurrentAttributes

extend T::Sig

attribute :account

def helper
  # ...
end

sig { params(user_id: Integer).void }
def authenticate(user_id)
  # ...
end

end ~~~

this compiler will produce an RBI file with the following content: ~~~rbi # typed: true

class Current

include GeneratedAttributeMethods

class << self
  sig { returns(T.untyped) }
  def ; end

  sig { params(account: T.untyped).returns(T.untyped) }
  def account=(); end

  sig { params(user_id: Integer).void }
  def authenticate(user_id); end

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

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

  sig { params(account: T.untyped).returns(T.untyped) }
  def account=(); end
end

end ~~~

Constant Summary collapse

ConstantType = 
type_member { { fixed: T.class_of(::ActiveSupport::CurrentAttributes) } }

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 



100
101
102
 
# File 'lib/tapioca/dsl/compilers/active_support_current_attributes.rb', line 100

def gather_constants
  descendants_of(::ActiveSupport::CurrentAttributes)
end

Instance Method Details

#decorate ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/tapioca/dsl/compilers/active_support_current_attributes.rb', line 68

def decorate
  dynamic_methods = dynamic_methods_of_constant
  instance_methods = instance_methods_of_constant - dynamic_methods
  return if dynamic_methods.empty? && instance_methods.empty?

  root.create_path(constant) do |current_attributes|
    current_attributes_methods_name = "GeneratedAttributeMethods"
    current_attributes.create_module(current_attributes_methods_name) do |generated_attribute_methods|
      dynamic_methods.each do |method|
        method = method.to_s
        # We want to generate each method both on the class
        generate_method(current_attributes, method, class_method: true)
        # and on the instance
        generate_method(generated_attribute_methods, method, class_method: false)
      end

      instance_methods.each do |method|
        # instance methods are only elevated to class methods
        # no need to add separate instance methods for them
        method = constant.instance_method(method)
        create_method_from_def(current_attributes, method, class_method: true)
      end
    end

    current_attributes.create_include(current_attributes_methods_name)
  end
end