aboutsummaryrefslogtreecommitdiff
path: root/paludis/qa/description_check.cc
blob: 50c4c4da46fb6ab6836267ca6b0e5acee476be7a (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006 Ciaran McCreesh <ciaranm@gentoo.org>
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include "description_check.hh"
#include <strings.h>

using namespace paludis;
using namespace paludis::qa;

DescriptionCheck::DescriptionCheck()
{
}

CheckResult
DescriptionCheck::operator() (const EbuildCheckData & e) const
{
    CheckResult result(stringify(e.get<ecd_name>()) + "-" + stringify(e.get<ecd_version>()),
            identifier());

    try
    {
        PackageDatabaseEntry ee(e.get<ecd_name>(), e.get<ecd_version>(),
                e.get<ecd_environment>()->package_database()->favourite_repository());
        VersionMetadata::ConstPointer metadata(
                e.get<ecd_environment>()->package_database()->fetch_metadata(ee));

        const std::string::size_type length(metadata->get(vmk_description).length());
        if (0 == length)
            result << Message(qal_major, "DESCRIPTION unset or empty");
        else if (0 == strcasecmp(e.get<ecd_name>().get<qpn_package>().data().c_str(),
                    metadata->get(vmk_description).c_str()))
            result << Message(qal_major, "DESCRIPTION equal to $PN? You can do better than that.");
        else if (std::string::npos != metadata->get(vmk_description).find("Based on the") &&
                std::string::npos != metadata->get(vmk_description).find("eclass"))
            result << Message(qal_major, "DESCRIPTION is about as useful as a chocolate teapot");
        else if (length < 10)
            result << Message(qal_minor, "DESCRIPTION suspiciously short (" + stringify(length) + ")");
        else if (length > 300)
            result << Message(qal_minor, "DESCRIPTION written by Duncan? (" + stringify(length) + ")");
        else if (length > 120)
            result << Message(qal_minor, "DESCRIPTION too long (" + stringify(length) + ")");

    }
    catch (const InternalError &)
    {
        throw;
    }
    catch (const Exception & e)
    {
        result << Message(qal_fatal, "Caught Exception '" + e.message() + "' ("
                + e.what() + ")");
    }

    return result;
}

const std::string &
DescriptionCheck::identifier()
{
    static const std::string id("description");
    return id;
}