File Coverage

blib/lib/Data/Object/Plugin.pm
Criterion Covered Total %
statement 17 17 100.0
branch n/a
condition n/a
subroutine 6 6 100.0
pod 1 1 100.0
total 24 24 100.0


line stmt bran cond sub pod time code
1             package Data::Object::Plugin;
2              
3 1     1   33556 use 5.014;
  1         4  
4              
5 1     1   8 use strict;
  1         2  
  1         22  
6 1     1   5 use warnings;
  1         2  
  1         24  
7 1     1   5 use routines;
  1         2  
  1         7  
8              
9 1     1   2723 use Data::Object::Class;
  1         1065  
  1         11  
10              
11             our $VERSION = '0.01'; # VERSION
12              
13             # METHODS
14              
15 1     1 1 32052 method execute() {
  1         3  
16              
17 1         9 return $self;
18             }
19              
20             1;
21              
22             =encoding utf8
23              
24             =head1 NAME
25              
26             Data::Object::Plugin
27              
28             =cut
29              
30             =head1 ABSTRACT
31              
32             Plugin Class for Perl 5
33              
34             =cut
35              
36             =head1 SYNOPSIS
37              
38             package Plugin;
39              
40             use Data::Object::Class;
41              
42             extends 'Data::Object::Plugin';
43              
44             package main;
45              
46             my $plugin = Plugin->new;
47              
48             =cut
49              
50             =head1 DESCRIPTION
51              
52             This package provides an abstract base class for defining plugin classes.
53              
54             =cut
55              
56             =head1 METHODS
57              
58             This package implements the following methods:
59              
60             =cut
61              
62             =head2 execute
63              
64             execute() : Any
65              
66             The execute method is the main method and entrypoint for plugin classes.
67              
68             =over 4
69              
70             =item execute example #1
71              
72             # given: synopsis
73              
74             $plugin->execute
75              
76             =back
77              
78             =cut
79              
80             =head1 AUTHOR
81              
82             Al Newkirk, C<awncorp@cpan.org>
83              
84             =head1 LICENSE
85              
86             Copyright (C) 2011-2019, Al Newkirk, et al.
87              
88             This is free software; you can redistribute it and/or modify it under the terms
89             of the The Apache License, Version 2.0, as elucidated in the L<"license
90             file"|https://github.com/iamalnewkirk/data-object-plugin/blob/master/LICENSE>.
91              
92             =head1 PROJECT
93              
94             L<Wiki|https://github.com/iamalnewkirk/data-object-plugin/wiki>
95              
96             L<Project|https://github.com/iamalnewkirk/data-object-plugin>
97              
98             L<Initiatives|https://github.com/iamalnewkirk/data-object-plugin/projects>
99              
100             L<Milestones|https://github.com/iamalnewkirk/data-object-plugin/milestones>
101              
102             L<Contributing|https://github.com/iamalnewkirk/data-object-plugin/blob/master/CONTRIBUTE.md>
103              
104             L<Issues|https://github.com/iamalnewkirk/data-object-plugin/issues>
105              
106             =cut