DocumentationInspector

Complexity

Total Complexity

8

Size/Duplication

Total Lines	28
Duplicated Lines	100 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	is_readme()	2	2	1
A	has_doc()	10	10	4
A	__init__()	3	3	1
A	update()	5	5	3

import logging

from ..yaml import yaml_load

logger = logging.getLogger('binstar.auth')


class ProjectFilesInspector(object):
    def __init__(self, pfiles):
        self.pfiles = pfiles

    def update(self, metadata):
        metadata['files'] = [pfile.to_dict() for pfile in self.pfiles]
        return metadata


class DocumentationInspector(object):

This code seems to be duplicated in your project.

    valid_names = [
        'README.md',
        'README.rst',
        'README.txt',
        'README'
    ]

    def __init__(self, pfiles):
        self.pfiles = pfiles
        self.doc_pfile = None

    def update(self, metadata):
        if self.has_doc():
            with open(self.doc_pfile.fullpath) as docfile:
                metadata['readme'] = docfile.read()
        return metadata

    def has_doc(self):
        def is_readme(basename, relativepath, fullpath):
            return basename == relativepath and basename in self.valid_names

        for pfile in self.pfiles:
            if pfile.validate(is_readme):
                self.doc_pfile = pfile
                break

        return self.doc_pfile is not None


class ConfigurationInspector(object):

This code seems to be duplicated in your project.

    valid_names = [
        'project.yml',
        'project.yaml'
    ]

    def __init__(self, pfiles):
        self.pfiles = pfiles
        self.config_pfile = None

    def update(self, metadata):
        try:
            if self.has_config():
                with open(self.config_pfile.fullpath) as configfile:
                    metadata['configuration'] = yaml_load(configfile)
        except:
            logger.warning("Could not parse configuration file.")
        return metadata

    def has_config(self):
        def is_config(basename, relativepath, fullpath):
            return basename == relativepath and basename in self.valid_names

        for pfile in self.pfiles:
            if pfile.validate(is_config):
                self.config_pfile = pfile
                break

        return self.config_pfile is not None


inspectors = [
    DocumentationInspector,
    ProjectFilesInspector,
    ConfigurationInspector
]