Add sort_by and direction option for HasMany field
#810
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
houndci-bot
reviewed
Apr 3, 2017
spec/lib/fields/has_many_spec.rb
Outdated
| field = association.new(:orders, customer.orders, :show) | ||
|
|
||
| reversed_order = customer.orders.sort_by(&:address_line_two).map(&:id) | ||
| correct_order = customer.orders.sort { |a, b| b.address_line_two <=> a.address_line_two } |
spec/lib/fields/has_many_spec.rb
Outdated
| context "with `direction` option" do | ||
| it "returns the resources in correct order" do | ||
| customer = FactoryGirl.create(:customer, :with_orders) | ||
| association = Administrate::Field::HasMany.with_options(sort_by: :address_line_two, direction: :desc) |
spec/lib/fields/has_many_spec.rb
Outdated
| field = association.new(:orders, customer.orders, :show) | ||
|
|
||
| correct_order = customer.orders.sort_by(&:address_line_two).map(&:id) | ||
| reversed_order = customer.orders.sort { |a, b| b.address_line_two <=> a.address_line_two } |
spec/lib/fields/has_many_spec.rb
Outdated
| context "with `sort_by` option" do | ||
| it "returns the resources in correct order" do | ||
| customer = FactoryGirl.create(:customer, :with_orders) | ||
| association = Administrate::Field::HasMany.with_options(sort_by: :address_line_two) |
BenMorganIO
reviewed
Apr 4, 2017
spec/lib/fields/has_many_spec.rb
Outdated
| @@ -1,6 +1,7 @@ | |||
| require "administrate/field/has_many" | |||
| require "support/constant_helpers" | |||
| require "support/mock_relation" | |||
| require "rails_helper" | |||
There was a problem hiding this comment.
huh, was this required?
There was a problem hiding this comment.
Apparently for some reason when running only one file of the spec. Will remove 👍
There was a problem hiding this comment.
@BenMorganIO There you go. Good catch, thank you!
BenMorganIO
reviewed
Apr 4, 2017
| @@ -74,6 +74,10 @@ which are specified through the `.with_options` class method: | |||
| `:limit` - Set the number of resources to display in the show view. Default is | |||
| `5`. | |||
|
|
|||
| `:sort_by` - What to sort the association by in the show view. | |||
|
|
|||
| `:direction` - What direction the sort should be in, `:asc` (default) or `:desc`. | |||
There was a problem hiding this comment.
Why not call it :order?
There was a problem hiding this comment.
Do you mean direction -> order? I chose direction in order to keep things consistent with the naming in Administrate::Order.
BenMorganIO
reviewed
Apr 11, 2017
spec/lib/fields/has_many_spec.rb
Outdated
|
|
||
| expect(field.resources).to eq([:a] * limit) | ||
| expect(field.resources.length).to eq(limit) |
There was a problem hiding this comment.
.size would probably be better here.
spec/lib/fields/has_many_spec.rb
Outdated
| field = association.new(:customers, resources, :show) | ||
| field = association.new(:orders, resources, :show) | ||
|
|
||
| expect(field.resources.length).to eq(1) |
There was a problem hiding this comment.
expect(field.resources).to be_one
|
@BenMorganIO Thanks for your feedback. Updated the spec commit and rebased on top of |
|
Not really sure what's up with CircleCI there, and I can't trigger a rebuild. |
BenMorganIO
approved these changes
Apr 12, 2017
|
|
||
| expect(field.resources).to eq([:a] * limit) | ||
| expect(field.resources.size).to eq(limit) |
There was a problem hiding this comment.
These few lines read much nicer!
|
Great, thank you! I'm going to merge. |
iarie
pushed a commit
to iarie/administrate
that referenced
this pull request
Jun 17, 2017
* Add `sort_by` and `direction` options to HasMany field * Add spec for `sort_by` and `direction` in HasMany field * [Docs] Add instructions for HasMany sort_by and direction options
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey,
As always, thanks for a great gem.
This PR adds a
sort_byoption to theHasManyfield, allowing the developer to control in what order the data is displayed. It usesAdministrate::Orderin order to support future features (such as allowing the user to select what param to sort by).Hit me with your feedback! 👍
(Note: This tackles the same problem as in #750, but with a different approach. Not sure which is preferable here.)