feature: add default_sort_column configuration option

[icaroryan]

Description

This PR adds the ability to customize the default sorting attribute. The sorting column for the index view is created_at by default, but now the user can customize that by setting the default_sort_column option in the resource file to the desired default sorting column.

We still use created_at as the default sorting column if:

• default_sort_column is not set
• default_sort_column is set, but the model doesn't have that column

This also allow for backwards compatibility.

Fixes #2982

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
• I have added tests that prove my fix is effective or that my feature works

Screenshots & recording (UPDATED)

Screen.Recording.2024-07-19.at.11.49.19.AM.mov

Manual review steps

Tip: You can use the console log to see what column is being used for sorting when fetching the records (or just look at the UI)

1. Open any model's index page
2. Verify that it's sorting by created_at
3. Set the default_sort_column to another column
4. Ensure the query reflects the changes approximately

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

[codeclimate]

Code Climate has analyzed commit 25c15c4 and detected 0 issues on this pull request.

View more on Code Climate.

[icaroryan]

Hey guys, feel free to nitpick. Any feedback is welcome! 😄

[adrianthedev]

I somehow thought that this would be a configuration on the resource, not app-wide.
Interesting.
Let's think about pros and cons.

If we do it like this, then we won't be able to control it resource-wide.
If we do it as a resource configuration, you can override it in BaseResource (pending #2998 to be merged) for all resources and still maintain the ability to change it for just a few resources.

What do you think?

[icaroryan]

@adrianthedev I totally agree with you! I think I misunderstood the issue ticket because I actually wrote a draft message asking if having it on the resource would be better, but for some reason, I decided not to send it. I should’ve clarified it before getting started, but fortunately, the ticket is small enough that I can just change it to the resource.
Thank you for the feedback!

[icaroryan]

@adrianthedev I just updated the PR to move the option to the resource level instead! Thanks once again

[Paul-Bob]

@adrianthedev I totally agree with you! I think I misunderstood the issue ticket

No @icaroryan, you understood it right, I wrote it with the global configuration in mind, but I also agree with @adrianthedev's comment, is much more flexible to be configurable at the resource level.

If we do it as a resource configuration, you can override it in BaseResource (pending #2998 to be merged) for all resources and still maintain the ability to change it for just a few resources.

This is a great example of how to use the BaseResource, let's ensure that we document this.

[Paul-Bob]

Looking great @icaroryan thanks for the contribution!

Are you up to make the documentation for this PR?

[adrianthedev]

Thank you for your contribution @icaroryan 💪

[icaroryan]

@Paul-Bob, I can take care of the documentation for this one, too. Thanks for creating an issue for it