Contents

# typed: strict
class KaminariPlugin < SorbetRails::ModelPlugins::Base
  # Kaminari generates a dynamic `page` method on ActiveRecord relations.
  sig { override.params(root: Parlour::RbiGenerator::Namespace).void }
  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,
    )
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
sorbet-rails-0.7.3	lib/sorbet-rails/gem_plugins/kaminari_plugin.rb
sorbet-rails-0.7.2	lib/sorbet-rails/gem_plugins/kaminari_plugin.rb
sorbet-rails-0.7.1	lib/sorbet-rails/gem_plugins/kaminari_plugin.rb