Class: Tapioca::Dsl::Compilers::ActiveSupportTimeExt

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

Overview

‘Tapioca::Dsl::Compilers::ActiveSupportTimeExt` generates an RBI file for the `Time#current` method defined by [Active Support’s Time extensions](api.rubyonrails.org/classes/Time.html).

If ‘Time.zone` or `config.time_zone` are set, then the `Time.current` method will be defined as returning an instance of `ActiveSupport::TimeWithZone`, otherwise it will return an instance of `Time`.

For an application that is configured with: “‘ruby config.time_zone = “UTC” “` this compiler will produce the following RBI file: “`rbi class Time

class << self
  sig { returns(::ActiveSupport::TimeWithZone) }
  def current; end
end

end “‘ whereas if `Time.zone` and `config.time_zone` are not set, it will produce: “`rbi class Time

class << self
  sig { returns(::Time) }
  def current; end
end

end “‘

Constant Summary collapse

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

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 



61
62
63
 
# File 'lib/tapioca/dsl/compilers/active_support_time_ext.rb', line 61

def gather_constants
  [::Time]
end

Instance Method Details

#decorate ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/tapioca/dsl/compilers/active_support_time_ext.rb', line 43

def decorate
  return unless constant.respond_to?(:zone)

  root.create_path(constant) do |mod|
    return_type = if ::Time.zone
      "::ActiveSupport::TimeWithZone"
    else
      "::Time"
    end

    mod.create_method("current", return_type: return_type, class_method: true)
  end
end