Class: Tapioca::Dsl::Compilers::ActiveSupportConcern

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

Overview

‘Tapioca::Dsl::Compilers::ActiveSupportConcern` generates RBI files for classes that both `extend` `ActiveSupport::Concern` and `include` another class that extends `ActiveSupport::Concern`

For example for the following hierarchy:

~~~rb # concern.rb module Foo

extend ActiveSupport::Concern
module ClassMethods; end

end

module Bar

extend ActiveSupport::Concern
module ClassMethods; end
include Foo

end

class Baz

include Bar

end ~~~

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

~~~rbi # typed: true module Bar

mixes_in_class_methods(::Foo::ClassMethods)

end ~~~

Constant Summary collapse

ConstantType =
type_member { { fixed: Module } }

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, #root

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tapioca::Dsl::Compiler

#add_error, #compiler_enabled?, handles?, #initialize, processable_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, #singleton_class_of, #superclass_of

Methods included from Runtime::AttachedClassOf

#attached_class_of

Methods included from RBIHelper

#as_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

.dependencies_of(concern) ⇒ Object



83
84
85
# File 'lib/tapioca/dsl/compilers/active_support_concern.rb', line 83

def dependencies_of(concern)
  concern.instance_variable_get(:@_dependencies) || []
end

.gather_constantsObject



68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/tapioca/dsl/compilers/active_support_concern.rb', line 68

def gather_constants
  # Find all Modules that are:
  all_modules.select do |mod|
    # named (i.e. not anonymous)
    name_of(mod) &&
      # not singleton classes
      !mod.singleton_class? &&
      # extend ActiveSupport::Concern, and
      mod.singleton_class < ActiveSupport::Concern &&
      # have dependencies (i.e. include another concern)
      !dependencies_of(mod).empty?
  end
end

Instance Method Details

#decorateObject



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

def decorate
  dependencies = linearized_dependencies

  mixed_in_class_methods = dependencies
    .uniq # Deduplicate
    .filter_map do |concern| # Map to class methods module name, if exists
      "#{qualified_name_of(concern)}::ClassMethods" if concern.const_defined?(:ClassMethods)
    end

  return if mixed_in_class_methods.empty?

  root.create_path(constant) do |mod|
    mixed_in_class_methods.each do |mix|
      mod.create_mixes_in_class_methods(mix)
    end
  end
end