Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DanCouper/natural_sort
Elixir natural sort implementation for lists of strings.
https://github.com/DanCouper/natural_sort
Last synced: about 1 month ago
JSON representation
Elixir natural sort implementation for lists of strings.
- Host: GitHub
- URL: https://github.com/DanCouper/natural_sort
- Owner: DanCouper
- License: mit
- Created: 2015-05-15T10:12:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-14T07:00:55.000Z (over 3 years ago)
- Last Synced: 2024-10-08T19:52:24.579Z (2 months ago)
- Language: Elixir
- Size: 227 KB
- Stars: 14
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Elixir natural sort implementation for lists of strings. (Algorithms and Data structures)
- fucking-awesome-elixir - natural_sort - Elixir natural sort implementation for lists of strings. (Algorithms and Data structures)
- awesome-elixir - natural_sort - Elixir natural sort implementation for lists of strings. (Algorithms and Data structures)
README
NaturalSort
===========
**NOTE v0.2 used an explicit second argument (`case_sensitive`).
This has been removed and replaced with an options keyword list,
this is a breaking change.**
Sort a list of strings containing numbers in a natural manner.
Sort functions will not [generally] sort strings containing
numbers the same way a human would.
Given a list:
```
["a10", "a05c", "a1", "a", "a2", "a1a", "a0", "a1b", "a20"]
```
Applying standard sort will produce:
```
["a", "a0", "a05c", "a1", "a10", "a1a", "a1b", "a2", "a20"]
```
But applying a natural sort will give:
```
["a", "a0", "a1", "a1a", "a1b", "a2", "a05c", "a10", "a20"]
```
## Functions
Just the one:
### `NaturalSort.sort(list, options \\ [])`
Sorts a list of strings (ascending).
This works by leveraging Elixir's
`Enum.sort_by/3` function (which takes as the second argument
a mapping function). The mapping operation converts each string
into a list of strings and integers. Once in this form, applying
the sort function results in a correctly sorted list.
#### Options
There are currently two available options (passed as a
keyword list), `:direction` and `case_sensitive`.
* `:direction` may have a value of `:asc` or `:desc`, and
defaults to `:asc`.
* `:case_sensitive` may be `true` or `false`, and defaults
to `false`.
#### Examples
iex> NaturalSort.sort(["x2-y7", "x8-y8", "x2-y08", "x2-g8" ])
["x2-g8", "x2-y7", "x2-y08", "x8-y8" ]
iex> NaturalSort.sort(["a5", "a400", "a1"], direction: :desc)
["a400", "a5", "a1"]
iex> NaturalSort.sort(["foo03.z", "foo45.D", "foo06.a", "foo06.A", "foo"], case_sensitive: :true)
["foo", "foo03.z", "foo06.A", "foo06.a", "foo45.D"]
iex> NaturalSort.sort(["foo03.z", "foo45.D", "foo06.a", "foo06.A", "foo"], [case_sensitive: :true, direction: :desc])
["foo45.D", "foo06.a", "foo06.A", "foo03.z", "foo"]
## Prior art:
[VersionEye's naturalsorter gem](https://github.com/versioneye/naturalsorter)
was the inspiration, with that being based on
[Martin Pool's natural sorting algorithm](http://sourcefrog.net/projects/natsort/), and making direct use of the Ruby implementation of the original
C version.
Elixir's [Version](https://github.com/elixir-lang/elixir/blob/v1.0.4/lib/elixir/lib/version.ex#L1) module does a similar thing.
## Todo/Review
- REVIEW: Benchmark further.
- ENHANCEMENT: Add options: choice to use unicode, choice to strip whitespace from result.
- ENHANCEMENT: Stream rather than map - this was designed to aid me in organising vast amounts of files by name; mapping over large lists seems inefficient.