File Coverage

blib/lib/Template/Provider/CustomDBIC.pm

Criterion	Covered	Total	%
statement	15	75	20.0
branch	0	34	0.0
condition	0	38	0.0
subroutine	5	9	55.5
pod	1	1	100.0
total	21	157	13.3

line	stmt	bran	cond	sub	time	code
1						package Template::Provider::CustomDBIC;
2
3	2			2	11012	use strict;
	2				4
	2				59
4	2			2	12	use warnings;
	2				4
	2				64
5
6	2			2	10	use base qw/ Template::Provider /;
	2				4
	2				1336
7
8	2			2	29859	use Carp qw( croak );
	2				5
	2				106
9	2			2	998	use Date::Parse ();
	2				15590
	2				2004
10
11						our $VERSION = '0.05';
12
13						=head1 NAME
14
15						Template::Provider::CustomDBIC - Load templates using DBIx::Class
16
17
18						=head1 SYNOPSIS
19
20						use My::CustomDBIC::Schema;
21						use Template;
22						use Template::Provider::CustomDBIC;
23
24						my $schema = My::CustomDBIC::Schema->connect(
25						$dsn, $user, $password, \%options
26						);
27						my $resultset = $schema->resultset('Template');
28
29						If all of your templates are stored in a single table the most convenient
30						method is to pass the provider a L.
31
32						my $template = Template->new({
33						LOAD_TEMPLATES => [
34						Template::Provider::CustomDBIC->new({
35						RESULTSET => $resultset,
36						# Other template options like COMPILE_EXT...
37						}),
38						],
39						});
40
41						# Process the template in 'column' referred by reference from resultset 'Template'.
42						$template->process('table/reference/column');
43
44
45						=head1 DESCRIPTION
46
47						Template::Provider::CustomDBIC allows a L
48						L instead of, or in addition to, the default filesystem-based
49						L.
50
51
52						=head2 SCHEMA
53
54						This provider requires a schema containing at least the following:
55
56						=over
57
58						=item
59
60						A column containing the template name. When C<$template-Eprovider($name)>
61						is called the provider will search this column for the corresponding C<$name>.
62						For this reason the column must be a unique key, else an exception will be
63						raised.
64
65						=item
66
67						A column containing the actual template content itself. This is what will be
68						compiled and returned when the template is processed.
69
70						=item
71
72						A column containing the time the template was last modified. This must return
73						- or be inflated to - a date string recognisable by L.
74
75						=back
76
77
78						=head2 OPTIONS
79
80						In addition to supplying a RESULTSET or SCHEMA and the standard
81						L options, you may set the following preferences:
82
83						=over 4
84
85						=item COLUMN_NAME
86
87						The table column that contains the template name. This will default to 'name'.
88
89						=item COLUMN_CONTENT
90
91						The table column that contains the template data itself. This will default to
92						'content'.
93
94						=item COLUMN_MODIFIED
95
96						The table column that contains the date that the template was last modified.
97						This will default to 'modified'.
98
99						=back
100
101
102						=head1 METHODS
103
104						=begin comment
105
106						->_init( \%options )
107
108						Check that valid Template::Provider::CustomDBIC-specific arguments have been
109						supplied and store the appropriate values. See above for the available
110						options.
111
112						=end comment
113
114						=cut
115
116						sub _init {
117	0			0		my ( $self, $options ) = @_;
118
119						# Provide defaults as necessary.
120	0		0			$self->{COLUMN_NAME} = $options->{COLUMN_NAME} \|\| 'name';
121	0		0			$self->{COLUMN_MODIFIED} = $options->{COLUMN_MODIFIED} \|\| 'modified';
122	0		0			$self->{COLUMN_CONTENT} = $options->{COLUMN_CONTENT} \|\| 'content';
123
124						# Ensure that a RESULTSET or SCHEMA has been specified. In the case of
125						# both RESULTSET takes precedence.
126	0					my $storage;
127
128	0	0				if ( defined $options->{RESULTSET} ) {
129
130	0					$self->{RESULTSET} = $options->{RESULTSET};
131	0					$storage = $self->{RESULTSET}->result_source->schema->storage;
132
133						} else { # neither specified
134
135	0					return $self->error('A valid DBIx::Class::ResultSet is required');
136						}
137
138						# The connection DSN will be used when caching templates.
139	0					$self->{DSN} = $storage->connect_info->[0];
140
141						# Use Template::Provider's ->_init() to create the COMPILE_DIR...
142	0					$self->SUPER::_init($options);
143
144						# ...and add a directory for templates cached by this provider.
145	0	0				if ( $self->{COMPILE_DIR} ) {
146
147						# Adapted from Template::Provider 2.91
148	0					require File::Spec;
149	0					require File::Path;
150
151	0					my $wdir = $self->{DSN};
152	0	0				$wdir =~ s/://g if $^O eq 'MSWin32';
153	0					$wdir =~ /(.*)/; # untaint
154	0					$wdir = File::Spec->catfile( $self->{COMPILE_DIR}, $1 );
155	0	0				File::Path::mkpath($wdir) unless -d $wdir;
156						}
157
158	0					return $self;
159						}
160
161						=head2 ->fetch( $name )
162
163						This method is called automatically during L