BIMI/Record/Location.pm

filter: Statementstmt 94.5% 35 / 37 Branchbran 75.0% 15 / 20 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 88.8% 8 / 9 Podpod 100% 1 / 1 totaltotal 88.0% 59 / 67 CC 11 SCAR 11.8
CC
11
Cov
88%
_build_is_location_valid
5.0
_build_is_valid
4.2
_build_indicator
3.2
CRAP 3.3
« BIMI/Record/Authority.pm ↑ Summary BIMI/Options.pm »
1 package Mail::BIMI::Record::Location;
2 # ABSTRACT: Class to model a BIMI location
3 29 our $VERSION = '3.20260302'; # VERSION
4 29 ▶use 5.20.0;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 29 ▶use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 29 ▶use Mail::BIMI::Prelude;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 29 ▶use Mail::BIMI::Indicator;
Subroutine BEGIN: called CC=1 SCAR=0.0
8  
9 29 extends 'Mail::BIMI::Base';
10 29 with 'Mail::BIMI::Role::HasError';
11 29 has is_location_valid => ( is => 'rw', lazy => 1, builder => '_build_is_location_valid' );
12 29 has uri => ( is => 'rw', isa => 'Maybe[Str]', required => 1,
13 documentation => 'inputs: URI of Indicator', );
14 29 has is_valid => ( is => 'rw', lazy => 1, builder => '_build_is_valid',
15 documentation => 'Is this Location record valid' );
16 29 has indicator => ( is => 'rw', lazy => 1, builder => '_build_indicator',
17 documentation => 'Mail::BIMI::Indicator object for this location' );
18 0 ▶has is_relevant => ( is => 'rw', lazy => 1, default => sub{return 1},
Subroutine __ANON__: not called CC=1 SCAR=6.9
19 29 documentation => 'Is the location relevant' );
20  
21  
22 ▶sub _build_is_location_valid($self) {
Subroutine _build_is_location_valid: called CC=5 SCAR=16.1
23 # Check is_valid without checking indicator, because recursion!
24 26 ▶ if ( !defined $self->uri ) {
Branch: 3 branches
BranchTrueFalseTotal
if (not defined $self->uri) { } 1 25 26
elsif ($self->uri eq '') { } 1 24 25
elsif (not $self->uri =~ m[^https://]u) { } 1 23 24
25 1 $self->add_error('MISSING_L_TAG');
26 }
27 elsif ( $self->uri eq '' ) {
28 1 $self->add_error('EMPTY_L_TAG');
29 }
30 elsif ( ! ( $self->uri =~ /^https:\/\// ) ) {
31 1 $self->add_error('INVALID_TRANSPORT_L');
32 }
33 else {
34 }
35  
36 26 ▶ return 0 if $self->errors->@*;
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->errors} 3 23 26
37 23 return 1;
38 }
39  
40 ▶sub _build_is_valid($self) {
Subroutine _build_is_valid: called CC=4 SCAR=14.5
41 26 ▶ return 0 if !$self->is_location_valid;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->is_location_valid 3 23 26
42 23 ▶ if ( !$self->indicator->is_valid ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->indicator->is_valid) 0 23 23
43 0 $self->add_error_object( $self->indicator->errors );
44 }
45  
46 23 ▶ return 0 if $self->errors->@*;
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->errors} 0 23 23
47 23 $self->log_verbose('Location is valid');
48 23 return 1;
49 }
50  
51 ▶sub _build_indicator($self) {
Subroutine _build_indicator: called CC=3 SCAR=11.7
52 23 ▶ return if !$self->is_location_valid;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->is_location_valid 0 23 23
53 23 ▶ return if !$self->is_relevant;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->is_relevant 0 23 23
54 23 return Mail::BIMI::Indicator->new( uri => $self->uri, bimi_object => $self->bimi_object, source => 'Location' );
55 }
56  
57  
58 ▶sub finish($self) {
Subroutine finish: called CC=2 SCAR=7.6
Pod documented
59 5 ▶ $self->indicator->finish if $self->indicator;
Branch: 1 branch
BranchTrueFalseTotal
if $self->indicator 5 0 5
60 }
61  
62 29 1;
63  
64 __END__
65  
66 =pod
67  
68 =encoding UTF-8
69  
70 =head1 NAME
71  
72 Mail::BIMI::Record::Location - Class to model a BIMI location
73  
74 =head1 VERSION
75  
76 version 3.20260302
77  
78 =head1 DESCRIPTION
79  
80 Class for representing, validating, and processing a BIMI location attribute
81  
82 =head1 INPUTS
83  
84 These values are used as inputs for lookups and verifications, they are typically set by the caller based on values found in the message being processed
85  
86 =head2 uri
87  
88 is=rw required
89  
90 URI of Indicator
91  
92 =head1 ATTRIBUTES
93  
94 These values are derived from lookups and verifications made based upon the input values, it is however possible to override these with other values should you wish to, for example, validate a record before it is published in DNS, or validate an Indicator which is only available locally
95  
96 =head2 errors
97  
98 is=rw
99  
100 =head2 indicator
101  
102 is=rw
103  
104 Mail::BIMI::Indicator object for this location
105  
106 =head2 is_location_valid
107  
108 is=rw
109  
110 =head2 is_relevant
111  
112 is=rw
113  
114 Is the location relevant
115  
116 =head2 is_valid
117  
118 is=rw
119  
120 Is this Location record valid
121  
122 =head2 warnings
123  
124 is=rw
125  
126 =head1 CONSUMES
127  
128 =over 4
129  
130 =item * L<Mail::BIMI::Role::HasError>
131  
132 =back
133  
134 =head1 EXTENDS
135  
136 =over 4
137  
138 =item * L<Mail::BIMI::Base>
139  
140 =back
141  
142 =head1 METHODS
143  
144 =head2 I<finish()>
145  
146 Finish and clean up, write cache if enabled.
147  
148 =head1 REQUIRES
149  
150 =over 4
151  
152 =item * L<Mail::BIMI::Indicator|Mail::BIMI::Indicator>
153  
154 =item * L<Mail::BIMI::Prelude|Mail::BIMI::Prelude>
155  
156 =item * L<Moose|Moose>
157  
158 =back
159  
160 =head1 AUTHOR
161  
162 Marc Bradshaw <marc@marcbradshaw.net>
163  
164 =head1 COPYRIGHT AND LICENSE
165  
166 This software is copyright (c) 2020 by Marc Bradshaw.
167  
168 This is free software; you can redistribute it and/or modify it under
169 the same terms as the Perl 5 programming language system itself.
170  
171 =cut
« BIMI/Record/Authority.pm ↑ Summary BIMI/Options.pm »