## no critic: TestingAndDebugging::RequireUseStrict
package Sorter;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-01-22'; # DATE
our $DIST = 'Sorter'; # DIST
our $VERSION = '0.1.1'; # VERSION

1;
# ABSTRACT: Reusable sorter subroutines

__END__

=pod

=encoding UTF-8

=head1 NAME

Sorter - Reusable sorter subroutines

=head1 SPECIFICATION VERSION

0.1

=head1 VERSION

This document describes version 0.1.1 of Sorter (from Perl distribution Sorter), released on 2024-01-22.

=head1 SYNOPSIS

Basic:

 use Sorter::naturally;
 my $sorter = Sorter::naturally->new;

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

Specifying arguments:

 use Sorter::naturally;
 my $sorter = Sorter::naturally->new(reverse => 1);
 my @sorted = $sorter->(...);

Specifying sorter on the command-line (for other CLI's):

 % customsort -s naturally ...
 % customsort -s naturally=reverse,1 ...

=head1 DESCRIPTION

B<EXPERIMENTAL. SPEC MIGHT STILL CHANGE.>

=head1 Glossary

A B<sorter> is a subroutine that accepts a list of items to sort.

A B<sorter module> is a module under the C<Sorter::*> namespace that you can use
to generate a sorter.

=head2 Writing a Sorter module

 package Sorter::naturally;

 # required. must return a hash (DefHash)
 sub meta {
     return +{
         v => 1,
         args => {
             reverse => {
                 schema => 'bool*', # Sah schema
             },
         },
     };
 }

 sub gen_sorter {
     my %args = @_;
     ...
 }

 1;

=head2 Namespace organization

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/Sorter>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-Sorter>.

=head1 SEE ALSO

Base specifications: L<DefHash>, L<Sah>.

Related: L<Comparer>

Previous incarnation: L<Sort::Sub>. C<Sorter> and C<Comparer> are meant to
eventually supersede Sort::Sub. The main improvement upon Sort::Sub is the split
into three kinds of subroutines: 1) a sorter (a subroutine that accepts a list
of items to sort), where C<Sorter::*> modules are meant to generate; 2) a
keymaker (a subroutine that converts an item to a string/numeric key suitable
for simple comparison using C<eq> or C<==> during sorting); you can use
C<Data::Sah::Value::perl::KeyMaker> namespace for this; and 3) comparer (a
subroutine that compares two items that can be used in C<sort()>), where
C<Comparer::*> modules are meant to generate. Perl's C<sort()> allows us to
specify a comparer, but oftentimes it's more efficient to sort by key using a
keymaker, and sometimes due to preprocessing and/or postprocessing it's more
suitable to use the more generic C<sorter> interface.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 CONTRIBUTING


To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.

Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2024 by perlancar <perlancar@cpan.org>.

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

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Sorter>

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.

=cut
