GitRepository.dirty_files() - Code Metrics - Inspection of "Merge pull request #128 from michaeljoseph/pyup-up..." - michaeljoseph/changes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 07ef42...4ababe )

by Michael

created 2017-11-12 20:10 UTC

GitRepository.dirty_files() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	4.125

Importance

Changes

Metric	Value
cc	3
c	0
b	0
f	0
dl	0
loc	6
ccs	1
cts	2
cp	0.5
crap	4.125
rs	9.4285

import re
import shlex

import attr
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import semantic_version
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import uritemplate
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import requests
import giturlparse
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from plumbum.cmd import git
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

MERGED_PULL_REQUEST = re.compile(
    r'^([0-9a-f]{5,40}) Merge pull request #(\w+)'
)

GITHUB_PULL_REQUEST_API = (
    'https://api.github.com/repos{/owner}{/repo}/issues{/number}'
)
GITHUB_LABEL_API = (
    'https://api.github.com/repos{/owner}{/repo}/labels'
)


def changes_to_release_type(repository):
    pull_request_labels = set()
    changes = repository.changes_since_last_version

    for change in changes:
        for label in change.labels:
            pull_request_labels.add(label)

    change_descriptions = [
        '\n'.join([change.title, change.description]) for change in changes
    ]

    current_version = repository.latest_version
    if 'BREAKING CHANGE' in change_descriptions:
        return 'major', Release.BREAKING_CHANGE, current_version.next_major()
    elif 'enhancement' in pull_request_labels:
        return 'minor', Release.FEATURE, current_version.next_minor()
    elif 'bug' in pull_request_labels:
        return 'patch', Release.FIX, current_version.next_patch()
    else:
        return None, Release.NO_CHANGE, current_version


@attr.s
class Release:
    NO_CHANGE = 'nochanges'
    BREAKING_CHANGE = 'breaking'
    FEATURE = 'feature'
    FIX = 'fix'

    release_date = attr.ib()
    version = attr.ib()
    description = attr.ib(default=attr.Factory(str))
    name = attr.ib(default=attr.Factory(str))
    changes = attr.ib(default=attr.Factory(dict))


@attr.s
class PullRequest:
    number = attr.ib()
    title = attr.ib()
    description = attr.ib()
    author = attr.ib()
    labels = attr.ib(default=attr.Factory(list))

    @classmethod
    def from_github(cls, api_response):
        return cls(
            number=api_response['number'],
            title=api_response['title'],
            description=api_response['body'],
            author=api_response['user']['login'],
            labels=[
                label['name']
                for label in api_response['labels']
            ],
        )


@attr.s
class GitRepository:
    VERSION_ZERO = semantic_version.Version('0.0.0')
    # TODO: handle multiple remotes (cookiecutter [non-owner maintainer])
    REMOTE_NAME = 'origin'

    auth_token = attr.ib(default=None)

    @property
    def remote_url(self):
        return git(shlex.split('config --get remote.{}.url'.format(
            self.REMOTE_NAME
        )))

    @property
    def parsed_repo(self):
        return giturlparse.parse(self.remote_url)

    @property
    def repo(self):
        return self.parsed_repo.repo

    @property
    def owner(self):
        return self.parsed_repo.owner

    @property
    def platform(self):
        return self.parsed_repo.platform

    @property
    def is_github(self):
        return self.parsed_repo.github

    @property
    def is_bitbucket(self):
        return self.parsed_repo.bitbucket

    @property
    def commit_history(self):
        return [
            commit_message
            for commit_message in git(shlex.split(
                'log --oneline --no-color'
            )).split('\n')
            if commit_message
        ]

    @property
    def first_commit_sha(self):
        return git(
            'rev-list', '--max-parents=0', 'HEAD'
        )

    @property
    def tags(self):
        return git(shlex.split('tag --list')).split('\n')

    @property
    def versions(self):
        versions = []
        for tag in self.tags:
            try:
                versions.append(semantic_version.Version(tag))
            except ValueError:
                pass
        return versions

    @property
    def latest_version(self) -> semantic_version.Version:
        return max(self.versions) if self.versions else self.VERSION_ZERO

    def merges_since(self, version=None):
        if version == semantic_version.Version('0.0.0'):
            version = self.first_commit_sha

        revision_range = ' {}..HEAD'.format(version) if version else ''

        merge_commits = git(shlex.split(
            'log --oneline --merges --no-color{}'.format(revision_range)
        )).split('\n')
        return merge_commits

    @property
    def files_modified_in_last_commit(self):
        return git(shlex.split('diff --name -only --diff -filter=d'))

    @property
    def dirty_files(self):
        return [
            modified_path
            for modified_path in git(shlex.split('-c color.status=false status --short --branch'))

            if modified_path.startswith(' M')
        ]

    @classmethod
    def add(cls, files_to_add):
        return git(['add'] + files_to_add)

    @classmethod
    def commit(cls, message):
        return git(shlex.split(
            'commit --message="{}" '.format(message)
        ))

    @classmethod
    def tag(cls, version):
        # TODO: signed tags
        return git(
            shlex.split('tag --annotate {version} --message="{version}"'.format(

                version=version
            ))
        )

    @classmethod
    def push(cls, tags=False):
        return git(['push'] + ['--tags'] if tags else [])

    # TODO: pull_requests_since(version=None)
    # TODO: cached_property
    @property
    def changes_since_last_version(self):
        pull_requests = []

        for index, commit_msg in enumerate(self.merges_since(self.latest_version)):

            matches = MERGED_PULL_REQUEST.findall(commit_msg)

            if matches:
                _, pull_request_number = matches[0]

                pull_requests.append(PullRequest.from_github(
                    self.github_pull_request(pull_request_number)
                ))
        return pull_requests

    def github_pull_request(self, pr_num):
        pull_request_api_url = uritemplate.expand(
            GITHUB_PULL_REQUEST_API,
            dict(
                owner=self.owner,
                repo=self.repo,
                number=pr_num
            ),
        )

        return requests.get(
            pull_request_api_url,
            headers={
                'Authorization': 'token {}'.format(self.auth_token)
            },
        ).json()

    # TODO: cached_property
    # TODO: move to test fixture
    def github_labels(self):

        labels_api_url = uritemplate.expand(
            GITHUB_LABEL_API,
            dict(
                owner=self.owner,
                repo=self.repo,
            ),
        )

        return requests.get(
            labels_api_url,
            headers={
                'Authorization': 'token {}'.format(self.auth_token)
            },
        ).json()





Push — master ( 07ef42...4ababe )

GitRepository.dirty_files() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1	3	import re
2	3	import shlex
3
4	3	import attr
		0 ignored issues – show Configuration introduced 2017-10-18 06:53 UTC by Report Bug Copy Issue Report The import `attr` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
5	3	import semantic_version
		0 ignored issues – show Configuration introduced 2017-10-15 11:30 UTC by Report Bug Copy Issue Report The import `semantic_version` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
6	3	import uritemplate
		0 ignored issues – show Configuration introduced 2017-10-15 09:45 UTC by Report Bug Copy Issue Report The import `uritemplate` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
7	3	import requests
8	3	import giturlparse
		0 ignored issues – show Configuration introduced 2017-10-14 17:35 UTC by Report Bug Copy Issue Report The import `giturlparse` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
9	3	from plumbum.cmd import git
		0 ignored issues – show Configuration introduced 2017-10-15 09:45 UTC by Report Bug Copy Issue Report The import `plumbum.cmd` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
10
11	3	MERGED_PULL_REQUEST = re.compile(
12		r'^([0-9a-f]{5,40}) Merge pull request #(\w+)'
13		)
14
15	3	GITHUB_PULL_REQUEST_API = (
16		'https://api.github.com/repos{/owner}{/repo}/issues{/number}'
17		)
18	3	GITHUB_LABEL_API = (
19		'https://api.github.com/repos{/owner}{/repo}/labels'
20		)
21
22
23	3	def changes_to_release_type(repository):
24	3	pull_request_labels = set()
25	3	changes = repository.changes_since_last_version
26
27	3	for change in changes:
28	3	for label in change.labels:
29	3	pull_request_labels.add(label)
30
31	3	change_descriptions = [
32		'\n'.join([change.title, change.description]) for change in changes
33		]
34
35	3	current_version = repository.latest_version
36	3	if 'BREAKING CHANGE' in change_descriptions:
37		return 'major', Release.BREAKING_CHANGE, current_version.next_major()
38	3	elif 'enhancement' in pull_request_labels:
39		return 'minor', Release.FEATURE, current_version.next_minor()
40	3	elif 'bug' in pull_request_labels:
41	3	return 'patch', Release.FIX, current_version.next_patch()
42		else:
43	3	return None, Release.NO_CHANGE, current_version
44
45
46	3	@attr.s
47		class Release:
48	3	NO_CHANGE = 'nochanges'
49	3	BREAKING_CHANGE = 'breaking'
50	3	FEATURE = 'feature'
51	3	FIX = 'fix'
52
53	3	release_date = attr.ib()
54	3	version = attr.ib()
55	3	description = attr.ib(default=attr.Factory(str))
56	3	name = attr.ib(default=attr.Factory(str))
57	3	changes = attr.ib(default=attr.Factory(dict))
58
59
60	3	@attr.s
61		class PullRequest:
62	3	number = attr.ib()
63	3	title = attr.ib()
64	3	description = attr.ib()
65	3	author = attr.ib()
66	3	labels = attr.ib(default=attr.Factory(list))
67
68	3	@classmethod
69		def from_github(cls, api_response):
70	3	return cls(
71		number=api_response['number'],
72		title=api_response['title'],
73		description=api_response['body'],
74		author=api_response['user']['login'],
75		labels=[
76		label['name']
77		for label in api_response['labels']
78		],
79		)
80
81
82	3	@attr.s
83		class GitRepository:
84	3	VERSION_ZERO = semantic_version.Version('0.0.0')
85		# TODO: handle multiple remotes (cookiecutter [non-owner maintainer])
86	3	REMOTE_NAME = 'origin'
87
88	3	auth_token = attr.ib(default=None)
89
90	3	@property
91		def remote_url(self):
92	3	return git(shlex.split('config --get remote.{}.url'.format(
93		self.REMOTE_NAME
94		)))
95
96	3	@property
97		def parsed_repo(self):
98	3	return giturlparse.parse(self.remote_url)
99
100	3	@property
101		def repo(self):
102	3	return self.parsed_repo.repo
103
104	3	@property
105		def owner(self):
106	3	return self.parsed_repo.owner
107
108	3	@property
109		def platform(self):
110	3	return self.parsed_repo.platform
111
112	3	@property
113		def is_github(self):
114	3	return self.parsed_repo.github
115
116	3	@property
117		def is_bitbucket(self):
118		return self.parsed_repo.bitbucket
119
120	3	@property
121		def commit_history(self):
122		return [
123		commit_message
124		for commit_message in git(shlex.split(
125		'log --oneline --no-color'
126		)).split('\n')
127		if commit_message
128		]
129
130	3	@property
131		def first_commit_sha(self):
132		return git(
133		'rev-list', '--max-parents=0', 'HEAD'
134		)
135
136	3	@property
137		def tags(self):
138	3	return git(shlex.split('tag --list')).split('\n')
139
140	3	@property
141		def versions(self):
142	3	versions = []
143	3	for tag in self.tags:
144	3	try:
145	3	versions.append(semantic_version.Version(tag))
146	3	except ValueError:
147	3	pass
148	3	return versions
149
150	3	@property
151	3	def latest_version(self) -> semantic_version.Version:
152	3	return max(self.versions) if self.versions else self.VERSION_ZERO
153
154	3	def merges_since(self, version=None):
155	3	if version == semantic_version.Version('0.0.0'):
156		version = self.first_commit_sha
157
158	3	revision_range = ' {}..HEAD'.format(version) if version else ''
159
160	3	merge_commits = git(shlex.split(
161		'log --oneline --merges --no-color{}'.format(revision_range)
162		)).split('\n')
163	3	return merge_commits
164
165	3	@property
166		def files_modified_in_last_commit(self):
167		return git(shlex.split('diff --name -only --diff -filter=d'))
168
169	3	@property
170		def dirty_files(self):
171		return [
172		modified_path
173		for modified_path in git(shlex.split('-c color.status=false status --short --branch'))
		0 ignored issues – show Coding Style introduced 2017-10-30 10:28 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (98/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
174		if modified_path.startswith(' M')
175		]
176
177	3	@classmethod
178		def add(cls, files_to_add):
179	3	return git(['add'] + files_to_add)
180
181	3	@classmethod
182		def commit(cls, message):
183	3	return git(shlex.split(
184		'commit --message="{}" '.format(message)
185		))
186
187	3	@classmethod
188		def tag(cls, version):
189		# TODO: signed tags
190	3	return git(
191		shlex.split('tag --annotate {version} --message="{version}"'.format(
		0 ignored issues – show Coding Style introduced 2017-10-30 10:28 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (80/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
192		version=version
193		))
194		)
195
196	3	@classmethod
197	3	def push(cls, tags=False):
198	3	return git(['push'] + ['--tags'] if tags else [])
199
200		# TODO: pull_requests_since(version=None)
201		# TODO: cached_property
202	3	@property
203		def changes_since_last_version(self):
204	3	pull_requests = []
205
206	3	for index, commit_msg in enumerate(self.merges_since(self.latest_version)):
		0 ignored issues – show Coding Style introduced 2017-10-16 08:16 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (83/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
207	3	matches = MERGED_PULL_REQUEST.findall(commit_msg)
208
209	3	if matches:
210	3	_, pull_request_number = matches[0]
211
212	3	pull_requests.append(PullRequest.from_github(
213		self.github_pull_request(pull_request_number)
214		))
215	3	return pull_requests
216
217	3	def github_pull_request(self, pr_num):
218	3	pull_request_api_url = uritemplate.expand(
219		GITHUB_PULL_REQUEST_API,
220		dict(
221		owner=self.owner,
222		repo=self.repo,
223		number=pr_num
224		),
225		)
226
227	3	return requests.get(
228		pull_request_api_url,
229		headers={
230		'Authorization': 'token {}'.format(self.auth_token)
231		},
232		).json()
233
234		# TODO: cached_property
235		# TODO: move to test fixture
236	3	def github_labels(self):
237
238	3	labels_api_url = uritemplate.expand(
239		GITHUB_LABEL_API,
240		dict(
241		owner=self.owner,
242		repo=self.repo,
243		),
244		)
245
246	3	return requests.get(
247		labels_api_url,
248		headers={
249		'Authorization': 'token {}'.format(self.auth_token)
250		},
251		).json()
252
253
254
255

michaeljoseph / changes

Push — master ( 07ef42...4ababe )

GitRepository.dirty_files() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files