Class: Tapioca::Dsl::Compilers::ActiveRecordFixtures

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

Overview

Tapioca::Dsl::Compilers::ActiveRecordFixtures decorates RBIs for test fixture methods that are created dynamically by Rails.

For example, given an application with a posts table, we can have a fixture file

first_post:
  author: John
  title: My post

Rails will allow us to invoke posts(:first_post) in tests to get the fixture record. The generated RBI by this compiler will produce the following

# test_case.rbi
# typed: true
class ActiveSupport::TestCase
  include ActiveRecord::TestFixtures

  sig { returns(T::Array[Post]) }                                                          #   No names: returns an Array of all fixtures
  sig { params(fixture_name: T.any(String, Symbol)).returns(Post) }                        #   One name: returns the requested fixture
  sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)) # Many names: returns an Array of the requested fixtures
  .returns(T::Array[Post]) }
  def posts(fixture_name = nil, *other_fixtures); end
end

The include is generated because Rails mixes ActiveRecord::TestFixtures into ActiveSupport::TestCase through the :active_support_test_case load hook in rails/test_help.rb. Since RBI generation does not load an app's test helper, this runtime include is not captured. Without it, Sorbet does not see the class methods the module contributes via mixes_in_class_methods, such as fixtures. : [ConstantType = singleton(ActiveSupport::TestCase)]

Constant Summary collapse

MISSING = 
Object.new

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 RBIHelper

RBIHelper::TYPE_PARAMETER_MATCHER

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

#anonymous_parameter_name?, #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, #extract_type_parameters, #sanitize_signature_types, serialize_type_variable, #valid_method_name?, #valid_parameter_name?

Methods included from SorbetHelper

#sorbet, #sorbet_path, #sorbet_supports?, #sorbet_syntax_check!

Constructor Details

This class inherits a constructor from Tapioca::Dsl::Compiler

Class Method Details

.gather_constants ⇒ Object

: -> Enumerable[Module[top]]



71
72
73
74
75
 
# File 'lib/tapioca/dsl/compilers/active_record_fixtures.rb', line 71

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

  [ActiveSupport::TestCase]
end

Instance Method Details

#decorate ⇒ Object

: -> void



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/tapioca/dsl/compilers/active_record_fixtures.rb', line 50

def decorate
  method_names = if fixture_loader.respond_to?(:fixture_sets)
    method_names_from_lazy_fixture_loader
  else
    method_names_from_eager_fixture_loader
  end

  method_names.select! { |name| fixture_class_mapping_from_fixture_files[name] != MISSING }

  root.create_path(constant) do |mod|
    mod.create_include("ActiveRecord::TestFixtures")

    method_names.each do |name|
      create_fixture_method(mod, name.to_s)
    end
  end
end