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

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 ~~~

Instance Attribute Summary

Attributes inherited from Base

#processable_constants

Instance Method Summary collapse

Methods inherited from Base

#handles?, #initialize

Constructor Details

This class inherits a constructor from Tapioca::Compilers::Dsl::Base

Instance Method Details

#decorate(root, constant) ⇒ Object 



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

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

  root.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"

        generate_methods(model, field.name.to_s, type)
      end
    end
  end
end

#gather_constants ⇒ Object 



118
119
120
121
122
 
# File 'lib/tapioca/compilers/dsl/active_record_typed_store.rb', line 118

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