File Coverage

blib/lib/Articulate/Role/Sortation/AllYouNeedIsCmp.pm

Criterion	Covered	Total	%
statement	27	29	93.1
branch	6	8	75.0
condition	1	2	50.0
subroutine	7	7	100.0
pod	3	3	100.0
total	44	49	89.8

package Articulate::Role::Sortation::AllYouNeedIsCmp;
use strict;
use warnings;
use Moo::Role;

=head1 NAME

Articulate::Role::Sortation::AllYouNeedIsCmp - provides sortation methods derived from you cmp method

=head1 SYNOPSIS

  package My::Sortation::Class;
  use Moo;
  with 'Articulate::Role::Sortation::AllYouNeedIsCmp';
  sub cmp { ... }
  sub decorate { ... } # optional
  1;

Provides the C and C funtions. These call on the C method (which you are exected to write) and, optionally, the C method (if it exists).

=cut

=head1 METHODS

=head3 order

Convenience method which inspects the C value of the C hash and returns it (or returns C) if undefined).

=cut

sub order {
  my $self = shift;
  return ( $self->options->{order} // 'asc' ) if $self->can('options');
  return 'asc';
}

=head3 sort

  $sorter->sort( [items] )

Performs a simple sort, using C and C.

=cut

sub sort {
  my $self  = shift;
  my $items = shift;
  my $dec   = sub {
    my $orig = shift;
    $self->can('decorate')
      ? $self->decorate($orig)
      : $orig;
  };
  return [ sort { $self->cmp( $dec->($b), $dec->($a) ) } @$items ]
    if 'desc' eq $self->order;
  return [ sort { $self->cmp( $dec->($a), $dec->($b) ) } @$items ];
}

=head3 schwartz

  $sorter->schwartz( [items] );

Performs a schwartxian transform using C, and sorts the decorated items using C, then returns the originals in the sorted order.

=cut

sub schwartz {
  my $self  = shift;
  my $items = shift;
  if ( $self->can('decorate') ) {
    return [
      map { $_->[0] }
      sort { $self->cmp( $a->[1], $b->[1] ) }
      map { [ $_, $self->decorate($_) ] } @$items
    ];
  }
  else {
    return $self->sort($items);
  }
}

1;