NAME

VERSION

SYNOPSIS

 use Sort::Sub qw($naturally);

 my @sorted = sort $naturally ('track1.mp3', 'track10.mp3', 'track2.mp3', 'track1b.mp3', 'track1a.mp3');
 # => ('track1.mp3', 'track1a.mp3', 'track1b.mp3', 'track2.mp3', 'track10.mp3')

Request as subroutine:

 use Sort::Sub qw(naturally);

 my @sorted = sort {naturally} (...);

Request a reverse sort:

 use Sort::Sub qw($naturally<r>);

 my @sorted = sort $naturally (...);
 # => ('track10.mp3', 'track2.mp3', 'track1b.mp3', 'track1a.mp3', 'track1.mp3')

Request a case-insensitive sort:

 use Sort::Sub qw($naturally<i>);

 my @sorted = sort $naturally (...);

Request a case-insensitive, reverse sort:

 use Sort::Sub qw($naturally<ir>);

 my @sorted = sort $naturally ('track2.mp3', 'Track1.mp3', 'Track10.mp3');
 => ('Track10.mp3', 'track2.mp3', 'Track1.mp3')

Pass arguments to sort generator routine:

 use Sort::Sub '$by_num_of_colons', {pattern=>':'};

 my @sorted = sort $by_num_of_colons ('a::','b:','c::::','d:::');
 => ('b:','a::','d:::','c::::')

Request a coderef directly, without using the import interface:

 use Sort::Sub;

 my $naturally = Sort::Sub::get_sorter('naturally');
 my $naturally = Sort::Sub::get_sorter('$naturally');
 my $rev_naturally = Sort::Sub::get_sorter('naturally<r>');

DESCRIPTION

To use Sort::Sub, you import a list of:

 ["$"]NAME [ "<" [i][r] ">" ]

Where NAME is actually searched under "Sort::Sub::*" namespace. For example:

 naturally

will attempt to load "Sort::Sub::naturally" module and call its "gen_sorter" subroutine.

You can either request a subroutine name like the above or a variable name (e.g. $naturally).

After the name, you can add some options, enclosed with angle brackets "<>". There are some known options, e.g. "i" (for case-insensitive sort) or "r" (for reverse sort). Some examples:

 naturally<i>
 naturally<r>
 naturally<ri>

GUIDELINES FOR WRITING A SORT::SUB::* MODULE

The module must contain a "gen_sorter" subroutine. It will be called with:

 ($is_reverse, $is_ci, $args)

Where $is_reserve will be set to true if user requests a reverse sort, $is_ci will be set to true if user requests a case-insensitive sort. $args is hashref to pass additional arguments to the "gen_sorter()" routine. The subroutine should return a code reference.

The module should also contain a "meta" subroutine which returns a metadata DefHash. Known properties (keys) include: "v" (currently at 1), "summary", "compares_record" (bool, if set to true then sorter will be fed records "[$data, $order]" instead of just $data; $order is a number that can be line number of array index; this allows sorter to sort by additional information instead of just the data items). Other metadata properties will be added in the future.

FUNCTIONS

 my $coderef = Sort::Sub::get_sorter('SPEC' [ , \%args [ , $with_meta ] ]);

 my $rev_naturally = Sort::Sub::get_sorter('naturally<r>');

 ($sorter, $meta)

HOMEPAGE

SOURCE

BUGS

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

Supporting CLI's: sortsub (from App::sortsub), sorted (from App::sorted), CLI's from App::SortSubUtils.

AUTHOR

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.