Class: Tapioca::Dsl::Compilers::IdentityCache

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

Overview

‘Tapioca::Dsl::Compilers::IdentityCache` generates RBI files for Active Record models

that use `include IdentityCache`.

[‘IdentityCache`](github.com/Shopify/identity_cache) is a blob level caching solution to plug into Active Record.

For example, with the following Active Record class:

~~~rb # post.rb class Post < ApplicationRecord

include IdentityCache

cache_index :blog_id
cache_index :title, unique: true
cache_index :title, :review_date, unique: true

end ~~~

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

~~~rbi # post.rbi # typed: true class Post

sig { params(blog_id: T.untyped, includes: T.untyped).returns(T::Array[::Post])
def fetch_by_blog_id(blog_id, includes: nil); end

sig { params(blog_ids: T.untyped, includes: T.untyped).returns(T::Array[::Post])
def fetch_multi_by_blog_id(index_values, includes: nil); end

sig { params(title: T.untyped, includes: T.untyped).returns(::Post) }
def fetch_by_title!(title, includes: nil); end

sig { params(title: T.untyped, includes: T.untyped).returns(T.nilable(::Post)) }
def fetch_by_title(title, includes: nil); end

sig { params(index_values: T.untyped, includes: T.untyped).returns(T::Array[::Post]) }
def fetch_multi_by_title(index_values, includes: nil); end

sig { params(title: T.untyped, review_date: T.untyped, includes: T.untyped).returns(T::Array[::Post]) }
def fetch_by_title_and_review_date!(title, review_date, includes: nil); end

sig { params(title: T.untyped, review_date: T.untyped, includes: T.untyped).returns(T::Array[::Post]) }
def fetch_by_title_and_review_date(title, review_date, includes: nil); end

end ~~~

Constant Summary collapse

COLLECTION_TYPE = 
T.let(
  ->(type) { "T::Array[::#{type}]" },
  T.proc.params(type: T.any(Module, String)).returns(String),
)
ConstantType = 
type_member { { fixed: T.class_of(::ActiveRecord::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=

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 



101
102
103
104
105
 
# File 'lib/tapioca/dsl/compilers/identity_cache.rb', line 101

def gather_constants
  descendants_of(::ActiveRecord::Base).select do |klass|
    ::IdentityCache::WithoutPrimaryIndex > klass
  end
end

Instance Method Details

#decorate ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tapioca/dsl/compilers/identity_cache.rb', line 69

def decorate
  caches = constant.send(:all_cached_associations)
  cache_indexes = constant.send(:cache_indexes)
  return if caches.empty? && cache_indexes.empty?

  root.create_path(constant) do |model|
    cache_manys = constant.send(:cached_has_manys)
    cache_ones = constant.send(:cached_has_ones)
    cache_belongs = constant.send(:cached_belongs_tos)

    cache_indexes.each do |field|
      create_fetch_by_methods(field, model)
    end

    cache_manys.values.each do |field|
      create_fetch_field_methods(field, model, returns_collection: true)
    end

    cache_ones.values.each do |field|
      create_fetch_field_methods(field, model, returns_collection: false)
    end

    cache_belongs.values.each do |field|
      create_fetch_field_methods(field, model, returns_collection: false)
    end
  end
end