update_copyright/project.py

   1 # Copyright (C) 2012 W. Trevor King <wking@tremily.us>
   2 #
   3 # This file is part of update-copyright.
   4 #
   5 # update-copyright is free software: you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by the Free
   7 # Software Foundation, either version 3 of the License, or (at your option) any
   8 # later version.
   9 #
  10 # update-copyright is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13 # more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along with
  16 # update-copyright.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 """Project-specific configuration."""
  19
  20 import ConfigParser as _configparser
  21 import fnmatch as _fnmatch
  22 import os.path as _os_path
  23 import sys
  24 import time as _time
  25
  26 from . import LOG as _LOG
  27 from . import utils as _utils
  28 from .vcs.git import GitBackend as _GitBackend
  29 try:
  30     from .vcs.bazaar import BazaarBackend as _BazaarBackend
  31 except ImportError, _bazaar_import_error:
  32     _BazaarBackend = None
  33 try:
  34     from .vcs.mercurial import MercurialBackend as _MercurialBackend
  35 except ImportError, _mercurial_import_error:
  36     _MercurialBackend = None
  37
  38
  39 class Project (object):
  40     def __init__(self, root='.', name=None, vcs=None, copyright=None,
  41                  short_copyright=None):
  42         self._root = _os_path.normpath(_os_path.abspath(root))
  43         self._name = name
  44         self._vcs = vcs
  45         self._author_hacks = None
  46         self._year_hacks = None
  47         self._aliases = None
  48         self._copyright = None
  49         self._short_copyright = None
  50         self.with_authors = False
  51         self.with_files = False
  52         self._ignored_paths = None
  53         self._pyfile = None
  54         self._encoding = None
  55         self._width = 79
  56
  57         # unlikely to occur in the wild :p
  58         self._copyright_tag = u'-xyz-COPY' + u'-RIGHT-zyx-'
  59
  60     def load_config(self, stream):
  61         parser = _configparser.RawConfigParser()
  62         parser.optionxform = str
  63         parser.readfp(stream)
  64         for section in parser.sections():
  65             clean_section = section.replace('-', '_')
  66             try:
  67                 loader = getattr(self, '_load_{}_conf'.format(clean_section))
  68             except AttributeError, e:
  69                 _LOG.error('invalid {} section'.format(section))
  70                 raise
  71             loader(parser=parser)
  72
  73     def _load_project_conf(self, parser):
  74         try:
  75             self._name = parser.get('project', 'name')
  76         except _configparser.NoOptionError:
  77             pass
  78         try:
  79             vcs = parser.get('project', 'vcs')
  80         except _configparser.NoOptionError:
  81             pass
  82         else:
  83             kwargs = {
  84                 'root': self._root,
  85                 'author_hacks': self._author_hacks,
  86                 'year_hacks': self._year_hacks,
  87                 'aliases': self._aliases,
  88                 }
  89             if vcs == 'Git':
  90                 self._vcs = _GitBackend(**kwargs)
  91             elif vcs == 'Bazaar':
  92                 if _BazaarBackend is None:
  93                     raise _bazaar_import_error
  94                 self._vcs = _BazaarBackend(**kwargs)
  95             elif vcs == 'Mercurial':
  96                 if _MercurialBackend is None:
  97                     raise _mercurial_import_error
  98                 self._vcs = _MercurialBackend(**kwargs)
  99             else:
 100                 raise NotImplementedError('vcs: {}'.format(vcs))
 101
 102     def _load_copyright_conf(self, parser):
 103         try:
 104             self._copyright = parser.get('copyright', 'long').splitlines()
 105         except _configparser.NoOptionError:
 106             pass
 107         try:
 108             self._short_copyright = parser.get(
 109                 'copyright', 'short').splitlines()
 110         except _configparser.NoOptionError:
 111             pass
 112
 113     def _load_files_conf(self, parser):
 114         try:
 115             self.with_authors = parser.get('files', 'authors')
 116         except _configparser.NoOptionError:
 117             pass
 118         try:
 119             self.with_files = parser.get('files', 'files')
 120         except _configparser.NoOptionError:
 121             pass
 122         try:
 123             ignored = parser.get('files', 'ignored')
 124         except _configparser.NoOptionError:
 125             pass
 126         else:
 127             self._ignored_paths = [pth.strip() for pth in ignored.split(',')]
 128         try:
 129             pyfile = parser.get('files', 'pyfile')
 130         except _configparser.NoOptionError:
 131             pass
 132         else:
 133             self._pyfile = _os_path.join(self._root, pyfile)
 134
 135     def _load_author_hacks_conf(self, parser, encoding=None):
 136         if encoding is None:
 137             encoding = self._encoding or _utils.ENCODING
 138         author_hacks = {}
 139         for path in parser.options('author-hacks'):
 140             authors = parser.get('author-hacks', path)
 141             author_hacks[tuple(path.split('/'))] = set(
 142                 unicode(a.strip(), encoding) for a in authors.split('|'))
 143         self._author_hacks = author_hacks
 144         if self._vcs is not None:
 145             self._vcs._author_hacks = self._author_hacks
 146
 147     def _load_year_hacks_conf(self, parser):
 148         year_hacks = {}
 149         for path in parser.options('year-hacks'):
 150             year = parser.get('year-hacks', path)
 151             year_hacks[tuple(path.split('/'))] = int(year)
 152         self._year_hacks = year_hacks
 153         if self._vcs is not None:
 154             self._vcs._year_hacks = self._year_hacks
 155
 156     def _load_aliases_conf(self, parser, encoding=None):
 157         if encoding is None:
 158             encoding = self._encoding or _utils.ENCODING
 159         aliases = {}
 160         for author in parser.options('aliases'):
 161             _aliases = parser.get('aliases', author)
 162             author = unicode(author, encoding)
 163             aliases[author] = set(
 164                 unicode(a.strip(), encoding) for a in _aliases.split('|'))
 165         self._aliases = aliases
 166         if self._vcs is not None:
 167             self._vcs._aliases = self._aliases
 168
 169     def _info(self):
 170         return {
 171             'project': self._name,
 172             'vcs': self._vcs.name,
 173             }
 174
 175     def update_authors(self, dry_run=False):
 176         _LOG.info('update AUTHORS')
 177         authors = self._vcs.authors()
 178         new_contents = u'{} was written by:\n{}\n'.format(
 179             self._name, u'\n'.join(authors))
 180         _utils.set_contents(
 181             _os_path.join(self._root, 'AUTHORS'),
 182             new_contents, unicode=True, encoding=self._encoding,
 183             dry_run=dry_run)
 184
 185     def update_file(self, filename, dry_run=False):
 186         _LOG.info('update {}'.format(filename))
 187         contents = _utils.get_contents(
 188             filename=filename, unicode=True, encoding=self._encoding)
 189         original_year = self._vcs.original_year(filename=filename)
 190         authors = self._vcs.authors(filename=filename)
 191         new_contents = _utils.update_copyright(
 192             contents=contents, original_year=original_year, authors=authors,
 193             text=self._copyright, info=self._info(), prefix=('# ', '# ', None),
 194             width=self._width, tag=self._copyright_tag)
 195         new_contents = _utils.update_copyright(
 196             contents=new_contents, original_year=original_year,
 197             authors=authors, text=self._copyright, info=self._info(),
 198             prefix=('/* ', ' * ', ' */'), width=self._width,
 199             tag=self._copyright_tag)
 200         _utils.set_contents(
 201             filename=filename, contents=new_contents,
 202             original_contents=contents, unicode=True, encoding=self._encoding,
 203             dry_run=dry_run)
 204
 205     def update_files(self, files=None, dry_run=False):
 206         if files is None or len(files) == 0:
 207             files = _utils.list_files(root=self._root)
 208         for filename in files:
 209             if self._ignored_file(filename=filename):
 210                 continue
 211             self.update_file(filename=filename, dry_run=dry_run)
 212
 213     def update_pyfile(self, dry_run=False):
 214         if self._pyfile is None:
 215             _LOG.info('no pyfile location configured, skip `update_pyfile`')
 216             return
 217         _LOG.info('update pyfile at {}'.format(self._pyfile))
 218         current_year = _time.gmtime()[0]
 219         original_year = self._vcs.original_year()
 220         authors = self._vcs.authors()
 221         lines = [
 222             _utils.copyright_string(
 223                 original_year=original_year, final_year=current_year,
 224                 authors=authors, text=self._copyright, info=self._info(),
 225                 prefix=u'# ', width=self._width),
 226             u'', u'import textwrap as _textwrap', u'', u'',
 227             u'LICENSE = """',
 228             _utils.copyright_string(
 229                 original_year=original_year, final_year=current_year,
 230                 authors=authors, text=self._copyright, info=self._info(),
 231                 prefix=u'', width=self._width),
 232             u'""".strip()',
 233             u'',
 234             u'def short_license(info, wrap=True, **kwargs):',
 235             u'    paragraphs = [',
 236             ]
 237         paragraphs = _utils.copyright_string(
 238             original_year=original_year, final_year=current_year,
 239             authors=authors, text=self._short_copyright, info=self._info(),
 240             author_format_fn=_utils.short_author_formatter, wrap=False,
 241             ).split(u'\n\n')
 242         for p in paragraphs:
 243             lines.append(u"        '{}' % info,".format(
 244                     p.replace(u"'", ur"\'")))
 245         lines.extend([
 246                 u'        ]',
 247                 u'    if wrap:',
 248                 u'        for i,p in enumerate(paragraphs):',
 249                 u'            paragraphs[i] = _textwrap.fill(p, **kwargs)',
 250                 ur"    return '\n\n'.join(paragraphs)",
 251                 u'',  # for terminal endline
 252                 ])
 253         new_contents = u'\n'.join(lines)
 254         _utils.set_contents(
 255             filename=self._pyfile, contents=new_contents, unicode=True,
 256             encoding=self._encoding, dry_run=dry_run)
 257
 258     def _ignored_file(self, filename):
 259         """
 260         >>> p = Project()
 261         >>> p._ignored_paths = ['a', './b/']
 262         >>> p._ignored_file('./a/')
 263         True
 264         >>> p._ignored_file('b')
 265         True
 266         >>> p._ignored_file('a/z')
 267         True
 268         >>> p._ignored_file('ab/z')
 269         False
 270         >>> p._ignored_file('./ab/a')
 271         False
 272         >>> p._ignored_file('./z')
 273         False
 274         """
 275         filename = _os_path.relpath(filename, self._root)
 276         if self._ignored_paths is not None:
 277             base = filename
 278             while base not in ['', '.', '..']:
 279                 for path in self._ignored_paths:
 280                     if _fnmatch.fnmatch(base, _os_path.normpath(path)):
 281                         _LOG.debug('ignoring {} (matched {})'.format(
 282                                 filename, path))
 283                         return True
 284                 base = _os_path.split(base)[0]
 285         if self._vcs and not self._vcs.is_versioned(filename):
 286             _LOG.debug('ignoring {} (not versioned))'.format(filename))
 287             return True
 288         return False