David Golden > CPAN-Reporter > CPAN::Reporter::History

Download:
CPAN-Reporter-1.1708.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  13
Stalled  1
View Bugs
Report a bug
Module Version: 1.1708   Source  

NAME ^

CPAN::Reporter::History - Read or write a CPAN::Reporter history log

VERSION ^

This documentation refers to version 1.1708

SYNOPSIS ^

     use CPAN::Reporter::History 'have_tested';
 
     @results = have_tested( dist => 'Dist-Name-1.23' );

DESCRIPTION ^

Interface for interacting with the CPAN::Reporter history file. Most methods are private for use only within CPAN::Reporter itself. However, a public function is provided to query the history file for results.

USAGE ^

The following function is available. It is not exported by default.

have_tested()

     # all reports for Foo-Bar-1.23
     @results = have_tested( dist => 'Foo-Bar-1.23' );
 
     # all NA reports
     @results = have_tested( grade => 'NA' );
 
     # all reports on the current Perl/platform
     @results = have_tested();

Searches the CPAN::Reporter history file for records exactly matching search criteria, given as pairs of field-names and desired values.

Ordinary search criteria include:

Without additional criteria, a search will be limited to the current version of Perl and the current architecture and OS version. Additional criteria may be specified explicitly or, by specifying the empty string, q{}, will match that field for any record.

     # all reports for Foo-Bar-1.23 on any version of perl 
     # on the current architecture and OS version
     @results = have_tested( dist => 'Foo-Bar-1.23', perl => q{} );

These additional criteria include:

The function returns an array of hashes representing each test result, with all of the fields listed above.

SEE ALSO ^

AUTHOR ^

David A. Golden (DAGOLDEN)

COPYRIGHT AND LICENSE ^

Copyright (c) 2006, 2007, 2008 by David A. Golden

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.