Class: Tapioca::Compilers::Dsl::IdentityCache
- Extended by:
- T::Sig
- Defined in:
- lib/tapioca/compilers/dsl/identity_cache.rb
Overview
‘Tapioca::Compilers::DSL::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 generator 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) )
Constants included from Reflection
Reflection::ANCESTORS_METHOD, Reflection::CLASS_METHOD, Reflection::CONSTANTS_METHOD, Reflection::EQUAL_METHOD, Reflection::METHOD_METHOD, Reflection::NAME_METHOD, Reflection::OBJECT_ID_METHOD, Reflection::PRIVATE_INSTANCE_METHODS_METHOD, Reflection::PROTECTED_INSTANCE_METHODS_METHOD, Reflection::PUBLIC_INSTANCE_METHODS_METHOD, Reflection::SINGLETON_CLASS_METHOD, Reflection::SUPERCLASS_METHOD
Instance Attribute Summary
Attributes inherited from Base
#errors, #processable_constants
Instance Method Summary collapse
Methods inherited from Base
#add_error, #generator_enabled?, #handles?, #initialize, resolve
Methods included from ParamHelper
#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
Methods included from Reflection
#ancestors_of, #are_equal?, #class_of, #constantize, #constants_of, #descendants_of, #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, #signature_of, #singleton_class_of, #superclass_of
Constructor Details
This class inherits a constructor from Tapioca::Compilers::Dsl::Base
Instance Method Details
#decorate(root, constant) ⇒ Object
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 96 97 |
# File 'lib/tapioca/compilers/dsl/identity_cache.rb', line 71 def decorate(root, constant) 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, constant) 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 |
#gather_constants ⇒ Object
100 101 102 103 104 |
# File 'lib/tapioca/compilers/dsl/identity_cache.rb', line 100 def gather_constants descendants_of(::ActiveRecord::Base).select do |klass| klass < ::IdentityCache::WithoutPrimaryIndex end end |