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

Inherits:
Base
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/tapioca/compilers/dsl/active_record_typed_store.rb

Overview

‘Tapioca::Compilers::DSL::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 generator 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

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, #handles?, #initialize

Methods included from Reflection

#ancestors_of, #are_equal?, #class_of, #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 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/tapioca/compilers/dsl/active_record_typed_store.rb', line 101

def decorate(root, constant)
  stores = constant.typed_stores
  return if stores.values.flat_map(&:accessors).empty?

  root.create_path(constant) do |model|
    stores.values.each do |store_data|
      store_data.accessors.each do |accessor|
        field = store_data.fields[accessor]
        type = type_for(field.type_sym)
        type = "T.nilable(#{type})" if field.null && type != "T.untyped"

        model.create_module("StoreAccessors") do |store_accessors_module|
          generate_methods(store_accessors_module, field.name.to_s, type)
        end

        model.create_include("StoreAccessors")
      end
    end
  end
end

#gather_constants ⇒ Object 



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

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