Class: Tapioca::Dsl::Compilers::ActiveRecordTypedStore

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

Overview

‘Tapioca::Dsl::Compilers::ActiveRecordTypedStore` generates RBI files for Active Record models that use [`ActiveRecord::TypedStore`](github.com/byroot/activerecord-typedstore) features.

For example, with the following ActiveRecord class:

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

typed_store :metadata do |s|
  s.string(:reviewer, blank: false, accessor: false)
  s.date(:review_date)
  s.boolean(:reviewed, null: false, default: false)
end

end ~~~

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

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

include StoreAccessors

module StoreAccessors
  sig { params(review_date: T.nilable(Date)).returns(T.nilable(Date)) }
  def review_date=(review_date); end

  sig { returns(T.nilable(Date)) }
  def review_date; end

  sig { returns(T.nilable(Date)) }
  def review_date_was; end

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

  sig { returns(T.nilable(Date)) }
  def review_date_before_last_save; end

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

  sig { returns(T.nilable([T.nilable(Date), T.nilable(Date)])) }
  def review_date_change; end

  sig { returns(T.nilable([T.nilable(Date), T.nilable(Date)])) }
  def saved_change_to_review_date; end

  sig { params(reviewd: T::Boolean).returns(T::Boolean) }
  def reviewed=(reviewed); end

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

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

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

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

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

  sig { returns(T.nilable([T::Boolean, T::Boolean])) }
  def reviewed_change; end

  sig { returns(T.nilable([T::Boolean, T::Boolean])) }
  def saved_change_to_reviewed; end
end

end ~~~

Constant Summary collapse

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

.gather_constants ⇒ Object 



121
122
123
124
125
 
# File 'lib/tapioca/dsl/compilers/active_record_typed_store.rb', line 121

def gather_constants
  descendants_of(::ActiveRecord::Base).select do |klass|
    klass.include?(ActiveRecord::TypedStore::Behavior)
  end
end

Instance Method Details

#decorate ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/tapioca/dsl/compilers/active_record_typed_store.rb', line 96

def decorate
  stores = constant.typed_stores
  return if stores.values.all? { |store| store.accessors.empty? }

  root.create_path(constant) do |model|
    store_accessors_module = model.create_module("StoreAccessors")
    model.create_include("StoreAccessors")

    stores.values.each do |store_data|
      store_data.accessors.each do |accessor, name|
        field = store_data.fields.fetch(accessor)
        type = type_for(field.type_sym)
        type = as_nilable_type(type) if field.null
        name ||= field.name # support < 1.5.0

        generate_methods(store_accessors_module, name.to_s, type)
      end
    end
  end
end