Class: KaminariPlugin

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

Overview

typed: strict

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


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
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/sorbet-rails/gem_plugins/kaminari_plugin.rb', line 5

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

  # Get the configured Kaminari page method name, or fall back to 'page' if necessary.
  page_method = T.unsafe(::Kaminari).config.page_method_name || 'page'

  # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-activerecord/lib/kaminari/activerecord/active_record_model_extension.rb#L15
  add_relation_query_method(
    root,
    page_method.to_s,
    parameters: [
      Parameter.new('num', type: 'T.nilable(Integer)', default: 'nil')
    ],
  )

  # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-core/lib/kaminari/models/page_scope_methods.rb#L7
  add_relation_query_method(
    root,
    "per",
    parameters: [
      Parameter.new('num', type: 'Integer'),
      Parameter.new('max_per_page', type: 'T.nilable(Integer)', default: 'nil')
    ],
  )

  # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-core/lib/kaminari/models/page_scope_methods.rb#L27
  add_relation_query_method(
    root,
    "padding",
    parameters: [
      Parameter.new('num', type: 'Integer')
    ],
  )

  # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-core/lib/kaminari/models/configuration_methods.rb#L19
  model_class_rbi = root.create_class(model_class_name)
  model_class_rbi.create_method(
    "default_per_page",
    return_type: "Integer",
    class_method: true,
  )

  # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-core/lib/kaminari/models/page_scope_methods.rb#L82
  model_relation_rbi = root.create_class(self.model_relation_class_name)
  model_relation_rbi.create_method(
    'last_page?',
    parameters: nil,
    return_type: 'T::Boolean',
  )
  model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
  model_assoc_relation_rbi.create_method(
    'last_page?',
    parameters: nil,
    return_type: 'T::Boolean',
  )
  collection_proxy_rbi = root.create_class(self.model_assoc_proxy_class_name)
  collection_proxy_rbi.create_method(
    'last_page?',
    parameters: nil,
    return_type: 'T::Boolean',
  )
end