Class: Tapioca::Dsl::Compilers::ActiveModelValidationsConfirmation

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

Overview

‘Tapioca::Dsl::Compilers::ActiveModelValidationsConfirmation` decorates RBI files for all classes that use [`ActiveModel::Validates::Confirmation`](api.rubyonrails.org/classes/ActiveModel/Validations/HelperMethods.html#method-i-validates_confirmation_of).

For example, with the following class:

~~~rb class User

include ActiveModel::Validations

validates_confirmation_of :password

validates :email, confirmation: true

end ~~~

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

class User

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

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

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

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

end ~~~

Constant Summary collapse

ConstantType = 
type_member do
  {
    fixed: T.all(
      T::Class[ActiveModel::Validations],
      ActiveModel::Validations::HelperMethods,
      ActiveModel::Validations::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, #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

.gather_constants ⇒ Object 



58
59
60
61
 
# File 'lib/tapioca/dsl/compilers/active_model_validations_confirmation.rb', line 58

def gather_constants
  # Collect all the classes that include ActiveModel::Validations
  all_classes.select { |c| ActiveModel::Validations > c }
end

Instance Method Details

#decorate ⇒ Object 



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

def decorate
  confirmation_validators = constant.validators.grep(ActiveModel::Validations::ConfirmationValidator)

  return if confirmation_validators.empty?

  # Create a RBI definition for each class that includes Active::Model::Validations
  root.create_path(constant) do |klass|
    # Create RBI definitions for all the attributes that use confirmation validation
    confirmation_validators.each do |validator|
      validator.attributes.each do |attr_name|
        klass.create_method("#{attr_name}_confirmation", return_type: "T.untyped")
        klass.create_method(
          "#{attr_name}_confirmation=",
          parameters: [create_param("#{attr_name}_confirmation", type: "T.untyped")],
          return_type: "T.untyped",
        )
      end
    end
  end
end