Add multiple sort field support in sort_link #438
Conversation
This patch allows users to sort on multiple fields with the sort_link
helper.
To specify sorting on multiple fields:
sort_link(:kind, [:kind, 'name asc'])
This will create a sort link that sorts first by kind, and then by
name. The first `:kind` parameter ensures that the link generated
shows the sort status of the `kind` field.
When you specify a sort direction in the sort fields array, the
direction is locked to that direction. In the above example, clicking
the resulting link would toggle sorting of the kind field, but the name
field would always sort ascending.
Also added was the ability to specify multiple default_order fields
with a hash:
sort_link(:kind, [:kind, :name],
:default_order => { :name => 'asc', :kind => 'desc' })
Clicking the resulting link will toggle the sort directions of both
`name` and `kind`, sorting the `name` field by default ascending, and
the `kind` field descending.
This spec ensures that the user can provide a label when specifying multiple sort fields
|
@caleb This is a great addition. I've been working around this limitation in my applications for so long I hadn't considered adding this. We just need to get the tests green for Rails 3.1 and 3.2, which ought to be quick. Let's merge this in so people can start trying it out and fix the Rails 3.1/3.2 compatibility ASAP. |
Add multiple sort field support in sort_link [skip ci]
|
Thanks 💛 |
|
Thanks for fixing rails 3! I was going to work on that tonight. |
|
Would you like to add a PR to update the (Don't forget to use |
|
I will do that tonight. On Oct 2, 2014, at 11:48 AM, Jon Atack notifications@github.com wrote:
|
|
I've found what seems to be a bug introduced by this PR. If neither a default_order nor a custom label is specified, |
|
Okay. I can look into this today or tomorrow. |
|
Great, thank you. |
|
Could you give me some example code showing the failing case? I will make a test case out of it. |
|
The following displays 'Website' in the label (and works fine): <%= sort_link(@q, :website, 'Website') %>
<%= sort_link(@q, :website, [:posts_count, :name], 'Website') %>
<%= sort_link(@q, :website, [:posts_count, :name], default_order: :desc) %>But the following shows nothing: <%= sort_link(@q, :website) %>
<%= sort_link(@q, :website, [:posts_count, :name]) %> |
|
Using Rails master and Ruby 2.1.3 p242. But all worked fine before the PR, so I don't think the Rails version is changing anything here. |
|
Thank you. I thought there was a test that covered the broken case, but apparently not. I will dive into it tonight. |
|
That would be great. We could definitely use better test coverage. |
Not passing an options hash into sort_link caused it to fail to look up the link title. This is because `!args.first.try(:is_a?, Hash)` would return true if the length of args was 0. I've simplified the logic to just test if the next parameter in args is a String (rather than test if it's not a Hash).
|
@caleb Awesome feature! I have one request for you, although really for the maintainers (@jonatack). After reading the documentation in the README and trying to get this to work for an hour, it was only then that I found this github issue and realized this might not be a released feature. I think it would be awesome for apparently-no-so-veteran people like me to put a note in the README that says something like the following, which I've copied from jquery-cookie:
|
|
@tylercollier thanks for the feedback. If you look at the CHANGELOG, this feature was merged into a general release (Ransack 1.5.0) on October 26, 2014: 2 releases ago, and soon to be 3. What version of Ransack is not working for you? |
|
My fault! I was using version 1.4.1. Apparently it was included from active admin, which I added to my project on 2014-09-30, a week after 1.4.1 was released. So in this case, my suggestion wouldn't have helped me, since I was the one who was on an old version. Still, I think it's a good idea that many READMEs are including for git(hub) repos these days. Regardless, thanks for the fast response, and keep up the good work! |
|
Sure, glad you got it sorted. |
|
@tylercollier I added your suggestion to the README. Thanks for the idea! |
|
Thank you! I'm sure it'll help folks. |
Let me know what you think of this patch. I would love to see this included in ransack, since this is a problem I run into frequently.
This patch allows users to sort on multiple fields with the sort_link
helper.
To specify sorting on multiple fields:
sort_link(:kind, [:kind, 'name asc'])This will create a sort link that sorts first by kind, and then by
name. The first
:kindparameter ensures that the link generatedshows the sort status of the
kindfield.When you specify a sort direction in the sort fields array, the
direction is locked to that direction. In the above example, clicking
the resulting link would toggle sorting of the kind field, but the name
field would always sort ascending.
Also added was the ability to specify multiple default_order fields
with a hash:
sort_link(:kind, [:kind, :name], :default_order => { :name => 'asc', :kind => 'desc' })Clicking the resulting link will toggle the sort directions of both
nameandkind, sorting thenamefield by default ascending, andthe
kindfield descending.If you wanted to specify a label, you would add it after the array or sort fields:
sort_link(:kind, [:kind, :name], "Property Kind", :default_order => 'asc')