Class: Tapioca::Dsl::Compilers::ActionText

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

Overview

‘Tapioca::Dsl::Compilers::ActionText` decorates RBI files for subclasses of `ActiveRecord::Base` that declare [has_rich_text](edgeguides.rubyonrails.org/action_text_overview.html#creating-rich-text-content)

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

~~~rb class Post < ApplicationRecord

has_rich_text :body
has_rich_text :title, encrypted: true

end ~~~

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

~~~rbi # typed: strong

class Post

sig { returns(ActionText::RichText) }
def body; end

sig { params(value: T.nilable(T.any(ActionText::RichText, String))).returns(T.untyped) }
def body=(value); end

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

sig { returns(ActionText::EncryptedRichText) }
def title; end

sig { params(value: T.nilable(T.any(ActionText::EncryptedRichText, String))).returns(T.untyped) }
def title=(value); end

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

end ~~~

Constant Summary collapse

ConstantType = 
type_member { { fixed: T.class_of(::ActiveRecord::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=, reset_state

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

.action_text_associations(constant) ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/tapioca/dsl/compilers/action_text.rb', line 79

def action_text_associations(constant)
  # Implementation copied from https://github.com/rails/rails/blob/31052d0e518b9da103eea2f79d250242ed1e3705/actiontext/lib/action_text/attribute.rb#L66
  constant.reflect_on_all_associations(:has_one)
    .map(&:name).map(&:to_s)
    .select { |n| n.start_with?("rich_text_") }
end

.gather_constants ⇒ Object 



87
88
89
90
91
 
# File 'lib/tapioca/dsl/compilers/action_text.rb', line 87

def gather_constants
  descendants_of(::ActiveRecord::Base)
    .reject(&:abstract_class?)
    .select { |c| action_text_associations(c).any? }
end

Instance Method Details

#decorate ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/tapioca/dsl/compilers/action_text.rb', line 52

def decorate
  root.create_path(constant) do |scope|
    self.class.action_text_associations(constant).each do |name|
      reflection = constant.reflections.fetch(name)
      type = reflection.options.fetch(:class_name)
      name = reflection.name.to_s.sub("rich_text_", "")
      scope.create_method(
        name,
        return_type: type,
      )
      scope.create_method(
        "#{name}?",
        return_type: "T::Boolean",
      )
      scope.create_method(
        "#{name}=",
        parameters: [create_param("value", type: "T.nilable(T.any(#{type}, String))")],
        return_type: "T.untyped",
      )
    end
  end
end