Class: Tapioca::Dsl::Compilers::ActiveModelSecurePassword

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

Overview

‘Tapioca::Dsl::Compilers::ActiveModelSecurePassword` decorates RBI files for all classes that use [`ActiveModel::SecurePassword`](api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html).

For example, with the following class:

~~~rb class User

include ActiveModel::SecurePassword

has_secure_password
has_secure_password :token

end ~~~

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

class User

sig { params(unencrypted_password: T.untyped).returns(T.untyped) }
def authenticate(unencrypted_password); end

sig { params(unencrypted_password: T.untyped).returns(T.untyped) }
def authenticate_password(unencrypted_password); end

sig { params(unencrypted_password: T.untyped).returns(T.untyped) }
def authenticate_token(unencrypted_password); end

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

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

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

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

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

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

end ~~~

Constant Summary collapse

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

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 



98
99
100
101
102
103
104
 
# File 'lib/tapioca/dsl/compilers/active_model_secure_password.rb', line 98

def gather_constants
  # This selects all classes that are `ActiveModel::SecurePassword::ClassMethods === klass`.
  # In other words, we select all classes that have `ActiveModel::SecurePassword::ClassMethods`
  # as an ancestor of its singleton class, i.e. all classes that have extended the
  # `ActiveModel::SecurePassword::ClassMethods` module.
  all_classes.grep(::ActiveModel::SecurePassword::ClassMethods)
end

Instance Method Details

#decorate ⇒ Object 



64
65
66
67
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
 
# File 'lib/tapioca/dsl/compilers/active_model_secure_password.rb', line 64

def decorate
  instance_methods_modules = if constant < ActiveModel::SecurePassword::InstanceMethodsOnActivation
    # pre Rails 6.0, this used to be a single static module
    [ActiveModel::SecurePassword::InstanceMethodsOnActivation]
  else
    # post Rails 6.0, this is now using a dynamic module builder pattern
    # and we can have multiple different ones included into the model
    constant.ancestors.grep(ActiveModel::SecurePassword::InstanceMethodsOnActivation)
  end

  return if instance_methods_modules.empty?

  methods = instance_methods_modules.flat_map { |mod| mod.instance_methods(false) }
  return if methods.empty?

  root.create_path(constant) do |klass|
    methods.each do |method|
      if method == :authenticate || method.start_with?("authenticate_")
        klass.create_method(
          method.to_s,
          parameters: [create_param("unencrypted_password", type: "T.untyped")],
          return_type: "T.any(#{constant}, FalseClass)",
        )
      else
        create_method_from_def(klass, constant.instance_method(method))
      end
    end
  end
end