feature: countless pagination

[Paul-Bob]

Description

Fixes #1748

Added new DSL to resource:

self.pagination = -> do
  {
    type: :countless, # default -> :normal
    size: []          # default -> [1, 2, 2, 1]
  }
end

class CourseLinkResource < Avo::BaseResource
  ...
  self.pagination = -> do
    {
      type: :countless,
      size: []
    }
  end

  # OR

  self.pagination = {
    type: :countless,
    size: []
  }
  ...
end

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
  • feature: countless pagination docs.avohq.io#126
• I have added tests that prove my fix is effective or that my feature works

Manual review steps

1. Add self.pagination = -> do { type: :countless, size: [] } end to any resource
2. Verify resource's index page

Manual reviewer: please leave a comment with output from the test if that's the case.

[codeclimate]

Code Climate has analyzed commit 606fe9b and detected 0 issues on this pull request.

View more on Code Climate.

[Paul-Bob]

We need translations for:

records_selected_from_all_pages_html: All records selected from all pages
x_records_selected_from_page_html: <span class="font-bold text-gray-700">%{selected}</span> records selected on this page

• avo.ar.yml
• avo.fr.yml
• avo.nb.yml
• avo.nn.yml
• avo.tr.yml

[adrianthedev]

Let's change the API from slef.countles to

self.pagination = {
  type: :normal/:countless/:countless_minimal
}

This will allow us to future-proof the pagination API.

[Paul-Bob]

Let's change the API from slef.countles to

self.pagination = {
  type: :normal/:countless/:countless_minimal
}

This will allow us to future-proof the pagination API.

About the countless_minimal we talked that we want to achieve this:

The result on the image can be obtained by countless and size: [] so I added the size key on the pagination hash, keeping our default value. Each user can customize the size or not... The documentation explains it well.

countless_minimal will actually hide the whole pages navigation. Do we really need to implement it? I think (not sure) we can implement it on a next PR with a custom navigator component where we implement our "Prev" and "Next" buttons without using the pagy helpers. Pagy helpers can´t be used with countless_minimal

[adrianthedev]

Why did we comment these tests?

[Paul-Bob]

My bad, I commeted on dev when working on it and forgot to uncomment 🤦🏼

[adrianthedev]

Let's extract this into it's own apply_pagination method so users can override it more easily.
This can be a great pattern going forward.

[adrianthedev]

Left a few comments. Good job!

[adrianthedev]

Let's use deafult instead of nornmal

[github-actions]

This PR has been merged into main. The functionality will be available in the next release.

Please check the release guide for more information.