/usr/lib/perl5/Template/Plugin/Assert.pm is in libtemplate-perl 2.24-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | #============================================================= -*-Perl-*-
#
# Template::Plugin::Assert
#
# DESCRIPTION
# Template Toolkit plugin module which allows you to assert that
# items fetchs from the stash are defined.
#
# AUTHOR
# Andy Wardley <abw@wardley.org>
#
# COPYRIGHT
# Copyright (C) 2008 Andy Wardley. All Rights Reserved.
#
# This module is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
#
#============================================================================
package Template::Plugin::Assert;
use base 'Template::Plugin';
use strict;
use warnings;
use Template::Exception;
our $VERSION = 1.00;
our $MONAD = 'Template::Monad::Assert';
our $EXCEPTION = 'Template::Exception';
our $AUTOLOAD;
sub load {
my $class = shift;
my $context = shift;
my $stash = $context->stash;
my $vmethod = sub {
$MONAD->new($stash, shift);
};
# define .assert vmethods for hash and list objects
$context->define_vmethod( hash => assert => $vmethod );
$context->define_vmethod( list => assert => $vmethod );
return $class;
}
sub new {
my ($class, $context, @args) = @_;
# create an assert plugin object which will handle simple variable
# lookups.
return bless { _CONTEXT => $context }, $class;
}
sub AUTOLOAD {
my ($self, @args) = @_;
my $item = $AUTOLOAD;
$item =~ s/.*:://;
return if $item eq 'DESTROY';
# lookup the named values
my $stash = $self->{ _CONTEXT }->stash;
my $value = $stash->dotop($stash, $item, \@args);
if (! defined $value) {
die $EXCEPTION->new( assert => "undefined value for $item" );
}
return $value;
}
package Template::Monad::Assert;
our $EXCEPTION = 'Template::Exception';
our $AUTOLOAD;
sub new {
my ($class, $stash, $this) = @_;
bless [$stash, $this], $class;
}
sub AUTOLOAD {
my ($self, @args) = @_;
my ($stash, $this) = @$self;
my $item = $AUTOLOAD;
$item =~ s/.*:://;
return if $item eq 'DESTROY';
my $value = $stash->dotop($stash, $item, \@args);
if (! defined $value) {
die $EXCEPTION->new( assert => "undefined value for $item" );
}
return $value;
}
1;
__END__
=head1 NAME
Template::Plugin::Assert - trap undefined values
=head1 SYNOPSIS
[% USE assert %]
# throws error if any undefined values are returned
[% object.assert.method %]
[% hash.assert.key %]
[% list.assert.item %]
=head1 DESCRIPTION
This plugin defines the C<assert> virtual method that can be used
to automatically throw errors when undefined values are used.
For example, consider this dotop:
[% user.name %]
If C<user.name> is an undefined value then TT will silently ignore the
fact and print nothing. If you C<USE> the C<assert> plugin then you
can add the C<assert> vmethod between the C<user> and C<name> elements,
like so:
[% user.assert.name %]
Now, if C<user.name> is an undefined value, an exception will be thrown:
assert error - undefined value for name
=head1 AUTHOR
Andy Wardley E<lt>abw@wardley.orgE<gt> L<http://wardley.org/>
=head1 COPYRIGHT
Copyright (C) 2008 Andy Wardley. All Rights Reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=head1 SEE ALSO
L<Template::Plugin>
=cut
# Local Variables:
# mode: perl
# perl-indent-level: 4
# indent-tabs-mode: nil
# End:
#
# vim: expandtab shiftwidth=4:
|