Bug-Fixing Commits Classifiers¶
Base Classifier¶
-
class
repominer.mining.base.FixingCommitClassifier(commit: pydriller.domain.commit.Commit)¶ This class implements rules to detect fixing commits categories related to IaC defects, as defined in http://chrisparnin.me/pdf/GangOfEight.pdf.
-
__init__(commit: pydriller.domain.commit.Commit)¶ The class constructor.
- Parameters
commit (Commit) – The commit to analyze.
- Raises
TypeError – If commit is None
-
comment_changed() → bool¶ Return True if the commit fixes a comment.
- Returns
True if the commit modifies a comment
- Return type
bool
-
fixes_conditional()¶ Return True if the commit fixes a conditional.
- Returns
True if the commit fixes a conditional. False, otherwise.
- Return type
bool
-
fixes_configuration_data()¶ Return True if the commit fixes configuration data.
- Returns
True if the commit fixes configuration data. False, otherwise.
- Return type
bool
-
fixes_dependency()¶ Return True if the commit fixes a dependency. For example, if an import or include is changed.
- Returns
True if the commit fixes a dependency. False, otherwise.
- Return type
bool
-
fixes_documentation()¶ Return True if the commit fixes the documentation.
- Returns
True if the commit fixes the documentation. False, otherwise.
- Return type
bool
-
fixes_idempotency()¶ Return True if the commit fixes an idempotency issue.
- Returns
True if the commit fixes an idempotency. False, otherwise.
- Return type
bool
-
fixes_security()¶ Return True if the commit fixes a security issue.
- Returns
True if the commit fixes security. False, otherwise.
- Return type
bool
-
fixes_service()¶ Return True if the commit fixes a service issue.
- Returns
True if the commit fixes a service. False, otherwise.
- Return type
bool
-
fixes_syntax()¶ Return True if the commit fixes a syntax issue.
- Returns
True if the commit fixes syntnax. False, otherwise.
- Return type
bool
-
Ansible Classifier¶
-
class
repominer.mining.ansible.AnsibleFixingCommitClassifier(commit: pydriller.domain.commit.Commit)¶ Bases:
repominer.mining.base.FixingCommitClassifierThis class extends a FixingCommitClassifier to classify bug-fixing commits of Ansible files.
-
__init__(commit: pydriller.domain.commit.Commit)¶ The class constructor.
- Parameters
commit (Commit) – The commit to analyze.
- Raises
TypeError – If commit is None
-