aboutsummaryrefslogtreecommitdiffstats
path: root/lib/Youri/Check/Maintainer/Resolver.pm
blob: 0a87624d870b596e997b8ad737cf2e5064e6f602 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# $Id$
package Youri::Check::Maintainer::Resolver;

=head1 NAME

Youri::Check::Maintainer::Resolver - Abstract maintainer resolver

=head1 DESCRIPTION

This abstract class defines Youri::Check::Maintainer::Resolver interface.

=head1 SYNOPSIS

    use Youri::Check::Maintainer::Resolver::Foo;

    my $resolver = Youri::Check::Maintainer::Resolver::Foo->new();

    print $resolver->get_maintainer('foo');

=cut

use warnings;
use strict;
use Carp;
use Youri::Utils;

=head1 CLASS METHODS

=head2 new(%args)

Creates and returns a new Youri::Check::Maintainer::Resolver object.

No generic parameters (subclasses may define additional ones).

Warning: do not call directly, call subclass constructor instead.

=cut

sub new {
    my $class = shift;
    croak "Abstract class" if $class eq __PACKAGE__;

    my %options = (
        test    => 0,  # test mode
        verbose => 0,  # verbose mode
        @_
    );

    my $self = bless {
        _test    => $options{test},
        _verbose => $options{verbose}
    }, $class;

    $self->_init(%options);

    return $self;
}

sub _init {
    # do nothing
}

=head2 get_maintainer($package)

Returns maintainer for given package, which can be either a full
L<Youri::Package> object or just a package name.

=head1 SUBCLASSING

The following methods have to be implemented:

=over

=item get_maintainer

=back

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2002-2006, YOURI project

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

=cut

1;