-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1417 from nextcloud/refactor/sort_box
refactor: cleanup sort_box public api
- Loading branch information
Showing
11 changed files
with
126 additions
and
119 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1 @@ | ||
| /// Signature of a function returning a [Comparable]. | ||
| typedef ComparableGetter<T> = Comparable<Object> Function(T); | ||
|
|
||
| /// The box to sort by. | ||
| /// | ||
| /// A box contains a property and a corresponding order. | ||
| typedef Box<T> = ({T property, SortBoxOrder order}); | ||
|
|
||
| /// Sorting Box to sort [List]s on multiple properties. | ||
| class SortBox<T extends Enum, R> { | ||
| /// Constructs a new SortBox. | ||
| /// | ||
| /// A *Box* is a record of a property and how to order it. | ||
| SortBox( | ||
| this._properties, | ||
| this._boxes, | ||
| ); | ||
|
|
||
| /// A mapping of all values [T] to their [ComparableGetter]. | ||
| final Map<T, ComparableGetter<R>> _properties; | ||
|
|
||
| /// A mapping of values [T] to their *Boxes*. | ||
| /// | ||
| /// The Boxes are applied if two elements are considered equal regarding their property [T]. | ||
| final Map<T, Set<Box<T>>> _boxes; | ||
|
|
||
| /// Sorts the [input] list according to their [box]. | ||
| /// | ||
| /// A box contains the property and [SortBoxOrder] how the list should be sorted. | ||
| /// In case the property of two elements is considered equal all following boxes specified at `_boxes[property]` are applied. | ||
| /// If specified [presort] will be applied before [box] and [_boxes]. | ||
| /// | ||
| /// This function sorts the input in place and a reference to it mutating the provided list. | ||
| List<R> sort( | ||
| List<R> input, | ||
| Box<T> box, [ | ||
| Set<Box<T>>? presort, | ||
| ]) { | ||
| if (input.length <= 1) { | ||
| return input; | ||
| } | ||
|
|
||
| final boxes = { | ||
| ...?presort, | ||
| box, | ||
| ...?_boxes[box.property], | ||
| }; | ||
|
|
||
| final sorted = input..sort((item1, item2) => _compare(item1, item2, boxes.iterator..moveNext())); | ||
|
|
||
| return sorted; | ||
| } | ||
|
|
||
| int _compare( | ||
| R item1, | ||
| R item2, | ||
| Iterator<Box<T>> iterator, | ||
| ) { | ||
| final box = iterator.current; | ||
| final comparableGetter = _properties[box.property]!; | ||
|
|
||
| final comparable1 = comparableGetter(item1); | ||
| final comparable2 = comparableGetter(item2); | ||
|
|
||
| final order = switch (box.order) { | ||
| SortBoxOrder.ascending => comparable1.compareTo(comparable2), | ||
| SortBoxOrder.descending => comparable2.compareTo(comparable1), | ||
| }; | ||
|
|
||
| if (order == 0 && iterator.moveNext()) { | ||
| return _compare(item1, item2, iterator); | ||
| } | ||
|
|
||
| return order; | ||
| } | ||
| } | ||
|
|
||
| /// Sorting order used by [SortBox]. | ||
| enum SortBoxOrder { | ||
| /// Ascending sorting order. | ||
| ascending, | ||
|
|
||
| /// Descending sorting order. | ||
| descending, | ||
| } | ||
| export 'src/sort_box.dart'; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| import 'package:meta/meta.dart'; | ||
|
|
||
| /// Signature of a function returning a [Comparable]. | ||
| typedef ComparableGetter<T> = Comparable<Object> Function(T); | ||
|
|
||
| /// The box to sort by. | ||
| /// | ||
| /// A box contains a property and a corresponding order. | ||
| typedef Box<T> = ({T property, SortBoxOrder order}); | ||
|
|
||
| /// Sorting Box to sort [List]s on multiple properties. | ||
| @immutable | ||
| class SortBox<T extends Enum, R> { | ||
| /// Constructs a new SortBox. | ||
| /// | ||
| /// A *Box* is a record of a property and how to order it. | ||
| const SortBox({ | ||
| required this.properties, | ||
| required this.boxes, | ||
| }); | ||
|
|
||
| /// A mapping of all values [T] to their [ComparableGetter]. | ||
| final Map<T, ComparableGetter<R>> properties; | ||
|
|
||
| /// A mapping of values [T] to their *Boxes*. | ||
| /// | ||
| /// The Boxes are applied if two elements are considered equal regarding their property [T]. | ||
| final Map<T, Set<Box<T>>> boxes; | ||
|
|
||
| /// Sorts the [input] list according to their [box]. | ||
| /// | ||
| /// A box contains the property and [SortBoxOrder] how the list should be sorted. | ||
| /// In case the property of two elements is considered equal all following boxes specified at `boxes[property]` are applied. | ||
| /// If specified [presort] will be applied before [box] and [boxes]. | ||
| void sort( | ||
| List<R> input, | ||
| Box<T> box, [ | ||
| Set<Box<T>>? presort, | ||
| ]) { | ||
| if (input.length <= 1) { | ||
| return; | ||
| } | ||
|
|
||
| final boxes = { | ||
| ...?presort, | ||
| box, | ||
| ...?this.boxes[box.property], | ||
| }; | ||
|
|
||
| input.sort((item1, item2) => _compare(item1, item2, boxes.iterator..moveNext())); | ||
| } | ||
|
|
||
| /// Iteratively compares two elements [item1] and [item2] according to the current box in [iterator]. | ||
| int _compare( | ||
| R item1, | ||
| R item2, | ||
| Iterator<Box<T>> iterator, | ||
| ) { | ||
| final box = iterator.current; | ||
| final comparableGetter = properties[box.property]!; | ||
|
|
||
| final comparable1 = comparableGetter(item1); | ||
| final comparable2 = comparableGetter(item2); | ||
|
|
||
| final order = switch (box.order) { | ||
| SortBoxOrder.ascending => comparable1.compareTo(comparable2), | ||
| SortBoxOrder.descending => comparable2.compareTo(comparable1), | ||
| }; | ||
|
|
||
| // If equal try the next property in the box | ||
| if (order == 0 && iterator.moveNext()) { | ||
| return _compare(item1, item2, iterator); | ||
| } | ||
|
|
||
| return order; | ||
| } | ||
| } | ||
|
|
||
| /// Sorting order used by [SortBox]. | ||
| enum SortBoxOrder { | ||
| /// Ascending sorting order. | ||
| ascending, | ||
|
|
||
| /// Descending sorting order. | ||
| descending, | ||
| } |
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
Oops, something went wrong.