Class: Tapioca::Dsl::Compilers::ActiveStorage

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

Overview

‘Tapioca::Dsl::Compilers::ActiveStorage` decorates RBI files for subclasses of `ActiveRecord::Base` that declare [one](edgeguides.rubyonrails.org/active_storage_overview.html#has-one-attached) or [many](edgeguides.rubyonrails.org/active_storage_overview.html#has-many-attached) attachments.

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

~~~rb class Post < ApplicationRecord

has_one_attached :photo
has_many_attached :blogs

end ~~~

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

~~~rbi # typed: strong

class Post

sig { returns(ActiveStorage::Attached::Many) }
def blogs; end

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

sig { returns(ActiveStorage::Attached::One) }
def photo; end

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

end ~~~

Constant Summary collapse

ConstantType = 
type_member do
  {
    fixed: T.all(
      Module,
      ::ActiveStorage::Reflection::ActiveRecordExtensions::ClassMethods,
    ),
  }
end

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, #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, #constant_defined?, #constantize, #constants_of, #descendants_of, #file_candidates_for, #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, #signature_of, #singleton_class_of, #superclass_of

Methods included from Runtime::AttachedClassOf

#attached_class_of

Methods included from RBIHelper

#as_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 



83
84
85
86
87
 
# File 'lib/tapioca/dsl/compilers/active_storage.rb', line 83

def gather_constants
  descendants_of(::ActiveRecord::Base)
    .reject(&:abstract_class?)
    .grep(::ActiveStorage::Reflection::ActiveRecordExtensions::ClassMethods)
end

Instance Method Details

#decorate ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/tapioca/dsl/compilers/active_storage.rb', line 59

def decorate
  return if constant.reflect_on_all_attachments.empty?

  root.create_path(constant) do |scope|
    constant.reflect_on_all_attachments.each do |reflection|
      type = type_of(reflection)
      name = reflection.name.to_s
      scope.create_method(
        name,
        return_type: type,
      )
      scope.create_method(
        "#{name}=",
        parameters: [create_param("attachable", type: "T.untyped")],
        return_type: "T.untyped",
      )
    end
  end
end