blib/lib/Method/Signatures/WithDocumentation.pm

filter: Statementstmt 96.8% 91 / 94 Branchbran 87.5% 21 / 24 Conditioncond 33.3% 1 / 3 MC/DCmcdc 0.0% 0 / 2 Subroutinesub 96.4% 27 / 28 Podpod 0.0% 0 / 10 totaltotal 86.9% 140 / 161 CC 15 SCAR 16.0
CC
15
Cov
93%
__ANON__
13.1
_add_attr_doc
3.3
Name
2.0
CRAP 4.9
↑ Summary
1 2 ▶use strictures 2;
Subroutine BEGIN: called CC=1 SCAR=0.0
2  
3 package Method::Signatures::WithDocumentation;
4  
5 # ABSTRACT: use Method::Signatures with Sub::Documentation together
6  
7 2 ▶use Attribute::Handlers;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 2 ▶use Sub::Documentation 'add_documentation';
Subroutine BEGIN: called CC=1 SCAR=0.0
9 2 ▶use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
10 2 ▶use Data::Alias;
Subroutine BEGIN: called CC=1 SCAR=0.0
11 2 extends 'Method::Signatures';
12  
13 2 our $VERSION = '1.000'; # VERSION
14  
15 5 ▶around parse_proto => sub {
Subroutine __ANON__: called CC=13 SCAR=25.7
16 5 my ($orig, $self, @args) = @_;
17 5 my $code = $self->$orig(@args);
18 5 ▶ return $code unless $self->{function_name};
Branch: 1 branch
BranchTrueFalseTotal
unless $$self{"function_name"} 0 5 5
19 5 my $signature = $self->{signature};
20 5 my @parameters = @{ $signature->parameters };
21 5 my @short_sig;
22 5 foreach my $parameter (@parameters) {
23 16 ▶ if ($parameter->is_yadayada) {
Branch: 1 branch
BranchTrueFalseTotal
if ($parameter->is_yadayada) 0 16 16
24 0 push @short_sig => '...';
25 0 next;
26 }
27 16 my @doc = ($parameter->type, $parameter->variable);
28 16 ▶ push @doc => 'named' if $parameter->is_named;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->is_named 8 8 16
29 16 ▶ push @doc => 'aliased' if $parameter->is_ref_alias;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->is_ref_alias 4 12 16
30 16 ▶ push @doc => 'required' if $parameter->is_required;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->is_required 6 10 16
31 16 ▶ push @doc => 'optional' if not $parameter->is_required;
Branch: 1 branch
BranchTrueFalseTotal
unless $parameter->is_required 10 6 16
32 16 ▶ push @doc => 'defaults to C<<< '.$parameter->default.' >>>' if $parameter->default;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->default 4 12 16
33 16 ▶ push @doc => 'but only when C<<< '.$parameter->default_when.' >>>' if $parameter->default_when;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->default_when 2 14 16
34  
35 16 my $short_sig = $parameter->type . ' ';
36 16 ▶ $short_sig .= "\\" if $parameter->is_ref_alias;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->is_ref_alias 4 12 16
37 16 ▶ $short_sig = $parameter->variable_name.' => '.$short_sig if $parameter->is_named;
Branch: 1 branch
BranchTrueFalseTotal
if $parameter->is_named 8 8 16
38 16 $short_sig .= $parameter->variable;
39 16 ▶ $short_sig = "[ $short_sig ]" unless $parameter->is_required;
Branch: 1 branch
BranchTrueFalseTotal
unless $parameter->is_required 10 6 16
40  
41 add_documentation(
42 package => $self->{into},
43 glob_type => 'CODE',
44 name => $self->{function_name},
45 16 type => 'param_signature',
46 documentation => \@doc,
47 );
48 16 push @short_sig => $short_sig;
49 }
50 add_documentation(
51 package => $self->{into},
52 glob_type => 'CODE',
53 name => $self->{function_name},
54 type => 'type',
55 documentation => $self->{name},
56 5 );
57 add_documentation(
58 package => $self->{into},
59 glob_type => 'CODE',
60 name => $self->{function_name},
61 5 type => 'signature',
62 documentation => join(', ', @short_sig),
63 );
64 5 return $code;
65 2 };
66  
67 57 ▶sub _add_attr_doc {
Subroutine _add_attr_doc: called CC=3 SCAR=12.0
68 57 my ($type, $package, $symbol, $referent, $data) = @_[0..3,5];
69 57 ▶ $data = $data->[0] if ref($data) eq 'ARRAY' && @$data == 1;
Branch: 1 branch
BranchTrueFalseTotal
if ref $data eq "ARRAY" and @$data == 1 0 57 57
Condition33%1/3
ref $data eq "ARRAY" and @$data == 1
!ll&&!rl&&r
5700
MC/DC0%0/2
ref $data eq "ARRAY" and @$data == 1
ref $data eq "ARRAY" @$data == 1
Truth table33%1/3
A and B
A= ref $data eq "ARRAY"B= @$data == 1
ABresult
0X0
100
111
70 add_documentation(
71 package => $package,
72 glob_type => ref($referent),
73 57 name => *{$symbol}{NAME},
74 57 type => $type,
75 documentation => $data,
76 );
77 }
78  
79  
80 2 ▶no warnings 'redefine'; ## no critic
Subroutine BEGIN: called CC=1 SCAR=0.0
81  
82  
83 0 ▶sub UNIVERSAL::Name : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Name: not called CC=1 SCAR=6.9
Pod undocumented
84 0 _add_attr_doc(name => @_);
85 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
86  
87  
88 5 ▶sub UNIVERSAL::Purpose : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Purpose: called CC=1 SCAR=0.0
Pod undocumented
89 5 _add_attr_doc(purpose => @_);
90 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
91  
92  
93 8 ▶sub UNIVERSAL::Pod : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Pod: called CC=1 SCAR=0.0
Pod undocumented
94 8 _add_attr_doc(pod => @_);
95 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
96  
97  
98 12 ▶sub UNIVERSAL::Param : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Param: called CC=1 SCAR=0.0
Pod undocumented
99 12 _add_attr_doc(param => @_);
100 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
101  
102  
103 8 ▶sub UNIVERSAL::Author : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Author: called CC=1 SCAR=0.0
Pod undocumented
104 8 _add_attr_doc(author => @_);
105 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
106  
107  
108 4 ▶sub UNIVERSAL::Returns : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Returns: called CC=1 SCAR=0.0
Pod undocumented
109 4 _add_attr_doc(returns => @_);
110 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
111  
112  
113 8 ▶sub UNIVERSAL::Throws : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Throws: called CC=1 SCAR=0.0
Pod undocumented
114 8 _add_attr_doc(throws => @_);
115 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
116  
117  
118 4 ▶sub UNIVERSAL::Example : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Example: called CC=1 SCAR=0.0
Pod undocumented
119 4 _add_attr_doc(example => @_);
120 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
121  
122  
123 4 ▶sub UNIVERSAL::Since : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Since: called CC=1 SCAR=0.0
Pod undocumented
124 4 _add_attr_doc(since => @_);
125 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
126  
127  
128 4 ▶sub UNIVERSAL::Deprecated : ATTR(CODE,BEGIN,RAWDATA) {
Subroutine Deprecated: called CC=1 SCAR=0.0
Pod undocumented
129 4 _add_attr_doc(deprecated => @_);
130 2 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
131  
132 2 1;
133  
134 __END__
↑ Summary