Saftpresse/Plugin.pm

filter: Statementstmt 71.4% 10 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 40.0% 2 / 5 Podpod 100% 2 / 2 totaltotal 66.6% 14 / 21 SCAR 0.2
CC
1
Cov
71%
__ANON__
2.0
process
2.0
init
2.0
CRAP 1.0
« Saftpresse/CountersOutput/JSON.pm ↑ Summary Saftpresse/Input/RELP/RSP.pm »
1 package Log::Saftpresse::Plugin;
2  
3 1 ▶use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4  
5 # ABSTRACT: base class for saftpresse plugins
6 1 our $VERSION = '1.5'; # VERSION
7  
8 1 ▶use Log::Saftpresse::Counters;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10  
11 1 has 'name' => ( is => 'ro', isa => 'Str', required => 1 );
12  
13 has 'counters' => (
14 is => 'ro', isa => 'Log::Saftpresse::Counters', lazy => 1,
15 default => sub {
16 0 ▶ Log::Saftpresse::Counters->new;
Subroutine __ANON__: not called CC=1 SCAR=6.9
17 },
18 1 handles => [ 'incr', 'incr_one', 'incr_max' ],
19 );
20  
21  
22 sub process {
23 0 ▶ my ( $self, $stash, $notes ) = @_;
Subroutine process: not called CC=1 SCAR=6.9
Pod documented
24 0 die('not implemented');
25 }
26  
27 0 ▶sub init { return; }
Subroutine init: not called CC=1 SCAR=6.9
Pod documented
28  
29 1 1;
30  
31 __END__
32  
33 =pod
34  
35 =encoding UTF-8
36  
37 =head1 NAME
38  
39 Log::Saftpresse::Plugin - base class for saftpresse plugins
40  
41 =head1 VERSION
42  
43 version 1.5
44  
45 =head1 Description
46  
47 This is the base class for saftpresse processing plugins.
48  
49 All plugin classes must inherit from this class.
50  
51 =head1 Synopsis
52  
53 package Log::Saftpresse::Plugin::MyPlugin;
54
55 use Moose;
56
57 extends 'Log::Saftpresse::Plugin';
58  
59 sub process {
60 my ( $self, $event ) = @_;
61  
62 $event->{'example_text'} = 'this is an example';
63 $self->incr_one('examples', 'count');
64  
65 return;
66 }
67
68 1;
69  
70 =head1 Attributes
71  
72 =head2 name( $str )
73  
74 The name of plugin instance.
75  
76 =head2 counters( L<Log::Saftpresse::Counters> )
77  
78 Holds the counters of this plugin.
79  
80 =head1 Methods
81  
82 =head2 process( $event, $notes )
83  
84 This method must be implemented by every plugin.
85  
86 Saftpresse will call it for every processed event and
87 pass $event and $notes.
88  
89 =head2 init
90  
91 This method is called after an instance of the plugin has been created.
92  
93 A module could implement it to do initialization tasks.
94  
95 =head2 incr, incr_one, incr_max
96  
97 This methods are delegated to the counter object.
98  
99 =head1 AUTHOR
100  
101 Markus Benning <ich@markusbenning.de>
102  
103 =head1 COPYRIGHT AND LICENSE
104  
105 This software is Copyright (c) 1998 by James S. Seymour, 2015 by Markus Benning.
106  
107 This is free software, licensed under:
108  
109 The GNU General Public License, Version 2, June 1991
110  
111 =cut
« Saftpresse/CountersOutput/JSON.pm ↑ Summary Saftpresse/Input/RELP/RSP.pm »