Class: SorbetRails::ModelRbiFormatter
- Inherits:
-
Object
- Object
- SorbetRails::ModelRbiFormatter
- Extended by:
- ModelPlugins, T::Sig
- Includes:
- ModelUtils
- Defined in:
- lib/sorbet-rails/model_rbi_formatter.rb
Instance Attribute Summary collapse
-
#available_classes ⇒ Object
readonly
Returns the value of attribute available_classes.
-
#model_class ⇒ Object
readonly
Returns the value of attribute model_class.
Instance Method Summary collapse
- #generate_base_rbi(root) ⇒ Object
- #generate_rbi ⇒ Object
-
#initialize(model_class, available_classes) ⇒ ModelRbiFormatter
constructor
A new instance of ModelRbiFormatter.
- #run_plugins(plugins, generator, allow_failure: true) ⇒ Object
Methods included from ModelPlugins
get_plugin_by_name, get_plugins, register_plugin, register_plugin_by_name, set_plugins
Methods included from 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
Constructor Details
#initialize(model_class, available_classes) ⇒ ModelRbiFormatter
Returns a new instance of ModelRbiFormatter.
24 25 26 27 28 29 30 31 32 33 |
# File 'lib/sorbet-rails/model_rbi_formatter.rb', line 24 def initialize(model_class, available_classes) @model_class = T.let(model_class, T.class_of(ActiveRecord::Base)) @available_classes = T.let(available_classes, T::Set[String]) begin # Load all dynamic instance methods of this model by instantiating a fake model @model_class.new unless @model_class.abstract_class? rescue StandardError => err puts "#{err.class}: Note: Unable to create new instance of #{model_class_name}" end end |
Instance Attribute Details
#available_classes ⇒ Object (readonly)
Returns the value of attribute available_classes.
15 16 17 |
# File 'lib/sorbet-rails/model_rbi_formatter.rb', line 15 def available_classes @available_classes end |
#model_class ⇒ Object (readonly)
Returns the value of attribute model_class.
12 13 14 |
# File 'lib/sorbet-rails/model_rbi_formatter.rb', line 12 def model_class @model_class end |
Instance Method Details
#generate_base_rbi(root) ⇒ Object
70 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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/sorbet-rails/model_rbi_formatter.rb', line 70 def generate_base_rbi(root) # This is the backbone of the model_rbi_formatter. # It could live in a base plugin but I consider it not replacable and better to leave here model_relation_rbi = root.create_class( self.model_relation_class_name, superclass: "ActiveRecord::Relation", ) model_relation_rbi.create_include(self.model_query_methods_returning_relation_module_name) model_relation_rbi.create_constant( "Elem", value: "type_member(fixed: #{model_class_name})", ) model_assoc_relation_rbi = root.create_class( self.model_assoc_relation_class_name, superclass: "ActiveRecord::AssociationRelation", ) model_assoc_relation_rbi.create_include(self.model_query_methods_returning_assoc_relation_module_name) model_assoc_relation_rbi.create_constant( "Elem", value: "type_member(fixed: #{model_class_name})", ) collection_proxy_rbi = root.create_class( self.model_assoc_proxy_class_name, superclass: "ActiveRecord::Associations::CollectionProxy", ) collection_proxy_rbi.create_include(self.model_query_methods_returning_assoc_relation_module_name) collection_proxy_rbi.create_constant( "Elem", value: "type_member(fixed: #{self.model_class_name})", ) model_rbi = root.create_class( self.model_class_name, superclass: T.must(@model_class.superclass).name, ) model_rbi.create_extend(self.model_query_methods_returning_relation_module_name) model_rbi.create_type_alias( self.model_relation_type_class_name, type: self.model_relation_type_alias ) end |
#generate_rbi ⇒ Object
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/sorbet-rails/model_rbi_formatter.rb', line 36 def generate_rbi puts "-- Generate sigs for #{model_class_name} --" # Collect the instances of each plugin into an array plugin_instances = self.class.get_plugins.map do |plugin_klass| plugin_klass.new(model_class, available_classes) end generator = Parlour::RbiGenerator.new(break_params: 3) run_plugins(plugin_instances, generator, allow_failure: true) # Generate the base after the plugins because when ConflictResolver merge the modules, # it'll put the modules at the last position merged. Putting the base stuff # last will keep the order consistent and minimize changes when new plugins are added. generate_base_rbi(generator.root) Parlour::ConflictResolver.new.resolve_conflicts(generator.root) do |msg, candidates| puts "Conflict: #{msg}. Skip following methods" candidates.each do |c| puts "- Method `#{c.name}` generated by #{c.generated_by.class.name}" end nil end rbi = <<~MESSAGE # This is an autogenerated file for dynamic methods in #{self.model_class_name} # Please rerun bundle exec rake rails_rbi:models[#{self.model_class_name}] to regenerate. MESSAGE rbi += generator.rbi return rbi end |
#run_plugins(plugins, generator, allow_failure: true) ⇒ Object
122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/sorbet-rails/model_rbi_formatter.rb', line 122 def run_plugins(plugins, generator, allow_failure: true) plugins.each do |plugin| begin generator.current_plugin = plugin plugin.generate(generator.root) rescue Exception => e raise e unless allow_failure puts "!!! Plugin #{plugin.class.name} threw an exception: #{e}" end end end |