Class: Tapioca::Dsl::Compilers::ActiveSupportEnvironmentInquirer

Inherits:
Tapioca::Dsl::Compiler show all
Defined in:
lib/tapioca/dsl/compilers/active_support_environment_inquirer.rb

Overview

Tapioca::Dsl::Compilers::ActiveSupportEnvironmentInquirer decorates an RBI file for non-default environment files in the config/environments directory.

For example, in a Rails application with the following files:

  • config/environments/development.rb

  • config/environments/demo.rb

  • config/environments/production.rb

  • config/environments/staging.rb

  • config/environments/test.rb

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

class ActiveSupport::EnvironmentInquirer

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

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

end ~~~ : [ConstantType = singleton(::ActiveSupport::EnvironmentInquirer)]

Constant Summary

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::SignatureBlockError, 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 Runtime::Reflection

#abstract_type_of, #ancestors_of, #are_equal?, #attached_class_of, #class_of, #const_source_location, #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 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

: -> T::Enumerable[T::Module]



51
52
53
54
55
 
# File 'lib/tapioca/dsl/compilers/active_support_environment_inquirer.rb', line 51

def gather_constants
  return [] unless defined?(Rails.application) && Rails.application

  [::ActiveSupport::EnvironmentInquirer]
end

Instance Method Details

#decorate ⇒ Object

: -> void



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tapioca/dsl/compilers/active_support_environment_inquirer.rb', line 36

def decorate
  envs = Rails.root.glob("config/environments/*.rb").map { |f| f.basename(".rb").to_s }.sort
  envs -= ::ActiveSupport::EnvironmentInquirer::DEFAULT_ENVIRONMENTS
  return if envs.none?

  root.create_path(::ActiveSupport::EnvironmentInquirer) do |mod|
    envs.each do |env|
      mod.create_method("#{env}?", return_type: "T::Boolean")
    end
  end
end