Class: Tapioca::Dsl::Compilers::RailsGenerators

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

Overview

‘Tapioca::Dsl::Compilers::RailsGenerators` generates RBI files for Rails generators

For example, with the following generator:

~~~rb # lib/generators/sample_generator.rb class ServiceGenerator < Rails::Generators::NamedBase

argument :result_type, type: :string

class_option :skip_comments, type: :boolean, default: false

end ~~~

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

~~~rbi # service_generator.rbi # typed: strong

class ServiceGenerator

sig { returns(::String)}
def result_type; end

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

end ~~~

Constant Summary collapse

BUILT_IN_MATCHER = 
T.let(
  /::(ActionMailbox|ActionText|ActiveRecord|Rails)::Generators/,
  Regexp,
)
ConstantType = 
type_member { { fixed: T.class_of(::Rails::Generators::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

.gather_constants ⇒ Object 



66
67
68
69
70
71
72
73
74
 
# File 'lib/tapioca/dsl/compilers/rails_generators.rb', line 66

def gather_constants
  all_classes.select do |const|
    name = qualified_name_of(const)

    name &&
      !name.match?(BUILT_IN_MATCHER) &&
      ::Rails::Generators::Base > const
  end
end

Instance Method Details

#decorate ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/tapioca/dsl/compilers/rails_generators.rb', line 47

def decorate
  base_class = base_class_of_constant
  arguments = constant.arguments - base_class.arguments
  class_options = constant.class_options.reject do |name, option|
    base_class.class_options[name] == option
  end

  return if arguments.empty? && class_options.empty?

  root.create_path(constant) do |klass|
    arguments.each { |argument| generate_methods_for_argument(klass, argument) }
    class_options.each { |_name, option| generate_methods_for_argument(klass, option) }
  end
end