File Coverage

blib/lib/Template/Plugin/Bootstrap/Pagination.pm

Criterion	Covered	Total	%
statement	101	103	98.0
branch	46	48	95.8
condition	23	30	76.6
subroutine	17	17	100.0
pod	3	3	100.0
total	190	201	94.5

package Template::Plugin::Bootstrap::Pagination;
{
  $Template::Plugin::Bootstrap::Pagination::VERSION = '0.002000';
}
use parent qw(Template::Plugin);

# ABSTRACT: Produce HTML suitable for the Bootstrap pagination component

use strict;
use warnings;

use Carp;
use MRO::Compat;
use HTML::Entities;
use Scalar::Util qw(blessed);
use Template::Exception;


sub new {
	my ($class, $context, $arg_ref) = @_;

	my $self = $class->next::method($context, $arg_ref);

	if (defined $arg_ref && ref $arg_ref ne 'HASH') {
		$self->_throw('Hash reference required');
	}
	$arg_ref ||= {};
	$self->{default} = {
		prev_text => '«',
		next_text => '»',
		centered  => 0,
		right     => 0,
		siblings  => 3,
		offset    => 0,
		factor    => 1,
		version   => 2,
		%{$arg_ref},
	};

	return $self;
}



sub pagination {
	my ($self, $arg_ref) = @_;

	$arg_ref = {
		%{$self->{default}},
		%{$arg_ref || {}},
	};

	my $pager = $arg_ref->{pager};
	unless (blessed $pager && $pager->isa('Data::Page')) {
		$self->_throw("Required 'pager' parameter not passed or not a 'Data::Page' instance");
	}

	my $pagination = '';
	if ($pager->total_entries() > $pager->entries_per_page()) {
		my $current_page = $pager->current_page();
		my $first_page   = $pager->first_page();
		my $last_page    = $pager->last_page();
		my $page = $first_page;
		PAGE: while ($page <= $last_page) {
			if ($current_page == $page) {
				$pagination .= ''
					. ''.$page.''
				. '';
			}
			else {
				if ($page == $first_page || $page == $last_page
						|| abs($page - $current_page) <= ($arg_ref->{siblings})
							|| $last_page <= (2 * $arg_ref->{siblings} + 1)) {
					$pagination .= ''
						. ''.$page.''
					. '';
				}
				elsif ($first_page + 1 == $page || $last_page - 1 == $page) {
					$pagination .= ''
						. '…'
					. '';
				}
				else {
					$page = ($page < $current_page)
						? $current_page - $arg_ref->{siblings}
						: $last_page - 1;
					next PAGE;
				}
			}
			$page++;
		}
	}

	my $version = $arg_ref->{version} || 2;
	if ($version eq '2') {
		return $self->_pagination_2($pagination, $arg_ref);
	} elsif ($version eq '3') {
		return $self->_pagination_3($pagination, $arg_ref);
	} else {
		croak('Bootstrap version ' . $version . ' not (yet) supported');
	}
}

sub _pagination_2 {
	my ($self, $pagination, $arg_ref) = @_;

	my $alignment = $arg_ref->{centered}
		? ' pagination-centered'
		: ($arg_ref->{right} ? ' pagination-right' : '');
	my $size = defined $arg_ref->{size} ? ' pagination-'.$arg_ref->{size} : '';
	my ($prev_uri, $next_uri) = $self->_prev_next_uri($arg_ref);
	return ''
		. ''
			. $self->_pager_item($prev_uri, $arg_ref->{prev_text})
			. $pagination
			. $self->_pager_item($next_uri, $arg_ref->{next_text})
		. ''
	. '';
}

sub _pagination_3 {
	my ($self, $pagination, $arg_ref) = @_;

	my $alignment = $arg_ref->{centered}
		? 'text-center'
		: ($arg_ref->{right} ? 'text-right' : 'text-left');
	my $size = defined $arg_ref->{size} ? ({
		'mini'  => ' pagination-sm',
		'small' => ' pagination-sm',
		'large' => ' pagination-lg',
	}->{$arg_ref->{size}} || '') : '';
	my ($prev_uri, $next_uri) = $self->_prev_next_uri($arg_ref);
	return ''
		. ''
			. $self->_pager_item($prev_uri, $arg_ref->{prev_text})
			. $pagination
			. $self->_pager_item($next_uri, $arg_ref->{next_text})
		. ''
	. '';
}



sub pager {
	my ($self, $arg_ref) = @_;

	$arg_ref = {
		%{$self->{default}},
		%{$arg_ref || {}},
	};

	my $pager = $arg_ref->{pager};
	unless (blessed $pager && $pager->isa('Data::Page')) {
		$self->_throw("Required 'pager' parameter not passed or not a 'Data::Page' instance");
	}

	my ($prev_uri, $next_uri) = $self->_prev_next_uri($arg_ref);
	my $prev_page = $self->_pager_item(
		$prev_uri, $arg_ref->{prev_text}, $arg_ref->{align} ? 'previous' : ()
	);
	my $next_page = $self->_pager_item(
		$next_uri, $arg_ref->{next_text}, $arg_ref->{align} ? 'next' : ()
	);

	return ''
		. $prev_page
		. $next_page
	. '';
}


sub _pager_item {
	my ($self, $uri, $text, @item_classes) = @_;

	my $content;
	if (defined $uri) {
		$content = ''.$text.'';
	}
	else {
		push @item_classes, 'disabled';
		$content = ''.$text.'';
	}

	my $item = '
	if (scalar @item_classes) {
		$item .= ' class="'.join(' ', @item_classes).'"';
	}

	return $item.'>'.$content.'';
}


sub _prev_next_uri {
	my ($self, $arg_ref) = @_;

	my $pager = $arg_ref->{pager};
	return map {
		$_ ? $self->_uri_for_page($_, $arg_ref) : undef;
	} ($pager->previous_page(), $pager->next_page());
}


sub _uri_for_page {
	my ($self, $page, $arg_ref) = @_;

	my $uri = $arg_ref->{uri};
	if (! defined $uri || $uri eq '') {
		$self->_throw("Required 'uri' parameter not passed");
	}
	$uri =~ s/__PAGE__/( $page + $arg_ref->{offset} ) * $arg_ref->{factor}/eg;
	return encode_entities($uri);
}


sub _throw {
	my ($self, $error) = @_;
	croak(Template::Exception->new('Bootstrap.Pagination', $error));
}


1;


__END__