Class: AasmPlugin

Inherits:
SorbetRails::ModelPlugins::Base show all
Defined in:
lib/sorbet-rails/gem_plugins/aasm_plugin.rb

Overview

typed: false

Constant Summary

Constants inherited from SorbetRails::ModelPlugins::Base

SorbetRails::ModelPlugins::Base::Parameter

Instance Attribute Summary

Attributes inherited from SorbetRails::ModelPlugins::Base

#available_classes, #model_class

Instance Method Summary collapse

Methods inherited from SorbetRails::ModelPlugins::Base

#initialize, #serialization_coder_for_column

Methods included from SorbetRails::ModelUtils

#add_relation_query_method, #exists_class_method?, #exists_instance_method?, #habtm_class?, #model_assoc_proxy_class_name, #model_assoc_relation_class_name, #model_class_name, #model_module_name, #model_query_methods_returning_assoc_relation_module_name, #model_query_methods_returning_relation_module_name, #model_relation_class_name, #model_relation_type_alias, #model_relation_type_class_name

Methods included from SorbetRails::ModelColumnUtils

#active_record_type_to_sorbet_type, #attribute_has_unconditional_presence_validation?, #model_class, #nilable_column?, #time_zone_aware_column?, #type_for_column_def

Constructor Details

This class inherits a constructor from SorbetRails::ModelPlugins::Base

Instance Method Details

#generate(root) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/sorbet-rails/gem_plugins/aasm_plugin.rb', line 4

def generate(root)
  return unless @model_class.include?(::AASM)

  model_rbi = root.create_class(
    model_class_name
  )

  aasm_events = @model_class.aasm.events.map(&:name)
  aasm_states = @model_class.aasm.states.map(&:name)

  # If you have an event like :bazify, you get these methods:
  # - `may_bazify?`
  # - `bazify`
  # - `bazify!`
  # - `bazify_without_validation!`
  aasm_events.each do |event|
    model_rbi.create_method(
      "may_#{event}?",
      return_type: 'T::Boolean'
    )

    model_rbi.create_method(
      event.to_s,
      return_type: 'T::Boolean'
    )

    model_rbi.create_method(
      "#{event}!",
      return_type: 'T::Boolean'
    )

    model_rbi.create_method(
      "#{event}_without_validation!",
      return_type: 'T::Boolean'
    )
  end

  # - If you have a state like :baz, you get:
  # - a method `baz?`
  # - a constant `STATE_BAZ`
  aasm_states.each do |state|
    model_rbi.create_method(
      "#{state}?",
      return_type: 'T::Boolean'
    )

    root.create_module(
      "#{model_class_name}::STATE_#{state.to_s.upcase}"
    )
  end
end