summaryrefslogtreecommitdiffstats
path: root/lib/Spreadsheet/Template/Processor.pm
blob: 8532feaa7327f034faf6d51252a89de467e9265e (plain) (blame)
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
package Spreadsheet::Template::Processor;
use Moose::Role;
# ABSTRACT: role for classes which preprocess a template file before rendering

requires 'process';

=head1 SYNOPSIS

  package MyProcessor;
  use Moose;

  with 'Spreadsheet::Template::Processor';

  sub process {
      # ...
  }

=head1 DESCRIPTION

This role should be consumed by any class which will be used as the
C<processor_class> in a L<Spreadsheet::Template> instance.

=cut

=method process($contents, $vars)

This method is required to be implemented by any classes which consume this
role. It should take the contents of the template and return a JSON file as
described in L<Spreadsheet::Template>. This typically just means running it
through a template engine of some kind.

=cut

no Moose::Role;

1;