blib/lib/Module/Extract/DeclaredVersion.pm

filter: Statementstmt 96.3% 53 / 55 Branchbran 83.3% 10 / 12 Conditioncond 77.7% 7 / 9 MC/DCmcdc 40.0% 2 / 5 Subroutinesub 100% 13 / 13 Podpod 100% 4 / 4 totaltotal 90.8% 89 / 98 CC 9 SCAR 10.5
CC
9
Cov
92%
_get_ppi_for_file
6.1
__ANON__
3.0
get_declared_version
2.0
CRAP 2.8
↑ Summary
1 3 ▶use utf8;
Subroutine BEGIN: called CC=1 SCAR=0.0
2 3 ▶use v5.10;
Subroutine BEGIN: called CC=1 SCAR=0.0
3  
4 package Module::Extract::DeclaredVersion;
5 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
6  
7 3 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 3 ▶no warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 3 our $VERSION = '1.026';
11  
12 =encoding utf8
13  
14 =head1 NAME
15  
16 Module::Extract::DeclaredVersion - Extract the version of Perl a module declares
17  
18 =head1 SYNOPSIS
19  
20 use Module::Extract::DeclaredVersion;
21  
22 my $extor = Module::Extract::DeclaredVersion->new;
23  
24 my $version = $extor->get_declared_version( $file );
25 if( $extor->error ) { ... }
26  
27 =head1 DESCRIPTION
28  
29 Extract the largest declared Perl version and returns it as a
30 version object. For instance, in a script you might have:
31  
32 use v5.16;
33  
34 This module will extract that C<v5.16> and return it.
35  
36 This module tries to handle any format that PPI will recognize, passing
37 them through version.pm to normalize them.
38  
39 =cut
40  
41 =over 4
42  
43 =item new
44  
45 Makes an object. The object doesn't do anything just yet, but you need
46 it to call the methods.
47  
48 =cut
49  
50 1 ▶sub new {
Subroutine new: called CC=1 SCAR=0.0
Pod documented
51 1 my $class = shift;
52  
53 1 my $self = bless {}, $class;
54  
55 1 $self->init;
56  
57 1 $self;
58 }
59  
60 =item init
61  
62 Set up the object. You shouldn't need to call this yourself. You can
63 override it though!
64  
65 =cut
66  
67 1 ▶sub init {
Subroutine init: called CC=1 SCAR=0.0
Pod documented
68 1 $_[0]->_clear_error;
69 }
70  
71 =item get_declared_version( FILE )
72  
73 Extracts all of the declared minimum versions for Perl, sorts them,
74 and returns the largest a version object.
75  
76 =cut
77  
78 3 ▶sub get_declared_version {
Subroutine get_declared_version: called CC=2 SCAR=6.9
Pod documented
79 3 my( $self, $file ) = @_;
80  
81 3 $self->_clear_error;
82  
83 3 my $versions = $self->_get_ppi_for_file( $file );
84 3 ▶ return unless defined $versions;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $versions 1 2 3
85  
86 my @sorted = sort {
87 2 eval { version->parse( $b->{version} ) }
88 <=>
89 1 eval { version->parse( $a->{version} ) }
90 } @$versions;
91  
92 2 eval { version->parse( $sorted[0]->{version} ) };
93 }
94  
95 3 ▶sub _get_ppi_for_file {
Subroutine _get_ppi_for_file: called CC=6 SCAR=18.1
96 3 my( $self, $file ) = @_;
97  
98 3 ▶ unless( -e $file ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (-e $file) 1 2 3
99 1 $self->_set_error( ref( $self ) . ": File [$file] does not exist!" );
100 1 return;
101 }
102  
103 2 require PPI;
104  
105 2 my $Document = eval { PPI::Document->new( $file ) };
106 2 ▶ unless( $Document ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($Document) 0 2 2
107 0 $self->_set_error( ref( $self ) . ": Could not parse file [$file]" );
108 0 return;
109 }
110  
111 my $modules = $Document->find(
112 666 ▶ sub {
Subroutine __ANON__: called CC=3 SCAR=11.0
113 666 ▶ $_[1]->isa( 'PPI::Statement::Include' ) &&
Branch: 1 branch
BranchTrueFalseTotal
$_[1]->isa("PPI::Statement::Include") and $_[1]->type eq "use" || $_[1]->type eq "require" 17 649 666
Condition83%5/6
$_[1]->isa('PPI::Statement::Include') && ($_[1]->type eq 'use' || $_[1]->type eq 'require')
!ll&&!rl&&r
649215
$_[1]->type eq "use" or $_[1]->type eq "require"
l!l&&r!l&&!r
1502
MC/DC66%2/3
$_[1]->isa('PPI::Statement::Include') && ($_[1]->type eq 'use' || $_[1]->type eq 'require')
$_[1]->isa('PPI::Statement::Include') $_[1]->type eq "use" $_[1]->type eq "require"
Truth table75%3/4
A && B or C
A= $_[1]->isa('PPI::Statement::Include')B= $_[1]->type eq "use"C= $_[1]->type eq "require"
ABCresult
0XX0
1000
11X1
1011
114 ( $_[1]->type eq 'use' || $_[1]->type eq 'require' )
115 }
116 2 );
117  
118 2 ▶ return unless $modules;
Branch: 1 branch
BranchTrueFalseTotal
unless $modules 0 2 2
119  
120 2 my %Seen;
121 my @versions =
122 15 grep { $_->{version_literal} }
123 map {
124 2 my $literal = $_->version_literal;
125 15 $literal =~ s/\s//g;
126 15 ▶ $literal = undef unless length $literal;
Branch: 1 branch
BranchTrueFalseTotal
unless length $literal 12 3 15
127 15 ▶ my $hash = {
Condition66%2/3
$literal // $_->version
l!l&&r!l&&!r
3120
MC/DC0%0/2
$literal // $_->version
$literal $_->version
Truth table66%2/3
A // B
A= $literalB= $_->version
ABresult
1X1
011
000
128 version => $_->version,
129 version_literal => ( $literal // $_->version ), #/
130 };
131 } @$modules;
132  
133 2 return \@versions;
134 }
135  
136 =item error
137  
138 Return the error from the last call to C<get_modules>.
139  
140 =cut
141  
142 1 ▶sub _set_error { $_[0]->{error} = $_[1]; }
Subroutine _set_error: called CC=1 SCAR=0.0
143  
144 4 ▶sub _clear_error { $_[0]->{error} = '' }
Subroutine _clear_error: called CC=1 SCAR=0.0
145  
146 3 ▶sub error { $_[0]->{error} }
Subroutine error: called CC=1 SCAR=0.0
Pod documented
147  
148 =back
149  
150 =head1 TO DO
151  
152 =over 4
153  
154 =item * Make it recursive, so it scans the source for any module that it finds.
155  
156 =back
157  
158 =head1 SEE ALSO
159  
160 L<Module::Extract::Use>
161  
162 =head1 SOURCE AVAILABILITY
163  
164 The source code is in Github
165  
166 https://github.com/briandfoy/module-extract-declaredversion
167  
168 =head1 AUTHOR
169  
170 brian d foy, C<< <briandfoy@pobox.com> >>
171  
172 =head1 COPYRIGHT AND LICENSE
173  
174 Copyright © 2011-2025, brian d foy <briandfoy@pobox.com>. All rights reserved.
175  
176 You may redistribute this under the terms of the Artistic License 2.0.
177  
178 =cut
179  
180 3 1;
↑ Summary