summaryrefslogtreecommitdiff
path: root/license-summary
blob: 07ca9b8fec143e73677300d3151db05be8546eac (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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
#!/usr/bin/python
#
# Copyright 2013  Lars Wirzenius
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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, see <http://www.gnu.org/licenses/>.
#
# =*= License: GPL-3+ =*=


# sed -n ' "$@"


import cliapp
import re
import sys

import licsummary


class LicenseSummary(cliapp.Application):

    def add_settings(self):
        self.settings.string_list(
            ['common-exclude'],
            'add REGEXP to patterns for files that are commonly excluded',
            metavar='REGEXP',
            default=['NEWS', 'COPYING', 'LICENSE', 'LICENCE'])

        self.settings.string_list(
            ['exclude', 'e'],
            'exclude files matching REGEXP '
                'from report of files without a license summary',
            metavar='REGEXP')

        self.settings.boolean(
            ['check'],
            'fail if any files are missing a license summary, '
                'or there are more than one summaries in use')

    def setup(self):
        self.pat = re.compile(r'=\*= [Ll]icen[cs]es?:\s*(?P<summary>\S.*\S)\s*=\*=')
        self.summaries = {}
        self.filenames = set()

    def cleanup(self):
        for summary in sorted(self.summaries.keys()):
            self.report_group(summary, self.summaries[summary])

        without_summary = self.filenames_without_summary()
        if without_summary:
            self.report_group('no summary', without_summary)

        if self.settings['check']:
            error = 0

            if without_summary:
                sys.stderr.write(
                    'ERROR: The following files have no license summary:\n')
                for filename in sorted(without_summary):
                    sys.stderr.write('  %s\n' % filename)
                error = 1

            if len(self.summaries) > 1:
                sys.stderr.write('ERROR: More than one summary in use\n')

            sys.exit(error)

    def report_group(self, summary, filenames):
        self.output.write('%s (%d):\n' % (summary, len(filenames)))
        for filename in sorted(filenames):
            self.output.write('\t%s\n' % filename)

    def filenames_without_summary(self):
        with_summary = self.filenames_with_summaries()
        without_summary = set(self.filenames).difference(with_summary)
        result = set()
        patterns = self.settings['common-exclude'] + self.settings['exclude']
        for filename in without_summary:
            for pattern in patterns:
                if re.search(pattern, filename):
                    break
            else:
                result.add(filename)
        return result

    def filenames_with_summaries(self):
        result = set()
        for filenames in self.summaries.values():
            result = result.union(set(filenames))
        return result

    def process_input(self, name):
        self.filenames.add(name)
        return cliapp.Application.process_input(self, name)

    def process_input_line(self, filename, line):
        m = self.pat.search(line)
        if m:
            s = m.group('summary')
            self.summaries[s] = self.summaries.get(s, []) + [filename]


LicenseSummary(version=licsummary.__version__).run()