.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CPAN::Audit::Filter 3pm"
.TH CPAN::Audit::Filter 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
CPAN::Audit::Filter \- manage the reports / CVEs to ignore
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&        use CPAN::Audit::Filter;
\&
\&        my $filter = CPAN::Audit::Filter\->new( exclude => $array_ref );
\&
\&        my $query = CPAN::Audit::Query\->new(...);
\&        my $advisories = $query\->advisories_for( $distname, $version_range );
\&
\&        foreach my $advisory ( $advisories\->@* ) {
\&                next if $filter\->excludes($advisory);
\&                ...
\&        }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.SS "Class methods"
.IX Subsection "Class methods"
.IP \(bu 4
new( exclude => ARRAYREF )
.Sp
The values in the array ref for \f(CW\*(C`exclude\*(C'\fR are uppercased before
they are stored.
.SS "Instance methods"
.IX Subsection "Instance methods"
.IP \(bu 4
excludes( \f(CW$advisory\fR )
.Sp
Returns true if this instance excludes either the ID or any of the
CVEs for ADVISORY, a hash as returned by CPAN::Audit::Query. This
hash has these keys:
.Sp
.Vb 2
\&        id       \- a string, such as Some\-Module\-001
\&        cves \- an array reference of CVE strings, such as CVE\-2022\-001
.Ve
.Sp
The values extracted from the hash are uppercased before use.
.IP \(bu 4
ignored_count
.Sp
Return the count of the advisories that were ignored. Each ID or CVE
value only counts once.
.SH LICENSE
.IX Header "LICENSE"
Copyright (C) 2022 Graham TerMarsch
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.