Merging upstream version 0.14.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 46 insertions, 6 deletions

diff --git a/qa/samples/user_rules/extra/extra_rules.py b/qa/samples/user_rules/extra/extra_rules.py
index 8109299..6fb985f 100644
--- a/qa/samples/user_rules/extra/extra_rules.py
+++ b/qa/samples/user_rules/extra/extra_rules.py
@@ -1,16 +1,19 @@
-from gitlint.rules import CommitRule, RuleViolation
+# -*- coding: utf-8 -*-
+
+from gitlint.rules import CommitRule, RuleViolation, ConfigurationRule
+from gitlint.options import IntOption, StrOption, ListOption
 from gitlint.utils import sstr
 
 
 class GitContextRule(CommitRule):
     """ Rule that tests whether we can correctly access certain gitcontext properties """
-    name = "gitcontext"
+    name = u"gïtcontext"
     id = "UC1"
 
     def validate(self, commit):
         violations = [
-            RuleViolation(self.id, "GitContext.current_branch: {0}".format(commit.context.current_branch), line_nr=1),
-            RuleViolation(self.id, "GitContext.commentchar: {0}".format(commit.context.commentchar), line_nr=1)
+            RuleViolation(self.id, u"GitContext.current_branch: {0}".format(commit.context.current_branch), line_nr=1),
+            RuleViolation(self.id, u"GitContext.commentchar: {0}".format(commit.context.commentchar), line_nr=1)
         ]
 
         return violations
@@ -18,12 +21,49 @@ class GitContextRule(CommitRule):
 
 class GitCommitRule(CommitRule):
     """ Rule that tests whether we can correctly access certain commit properties """
-    name = "gitcommit"
+    name = u"gïtcommit"
     id = "UC2"
 
     def validate(self, commit):
         violations = [
-            RuleViolation(self.id, "GitCommit.branches: {0}".format(sstr(commit.branches)), line_nr=1),
+            RuleViolation(self.id, u"GitCommit.branches: {0}".format(sstr(commit.branches)), line_nr=1),
+            RuleViolation(self.id, u"GitCommit.custom_prop: {0}".format(commit.custom_prop), line_nr=1),
+        ]
+
+        return violations
+
+
+class GitlintConfigurationRule(ConfigurationRule):
+    """ Rule that tests whether we can correctly access the config as well as modify the commit message """
+    name = u"cönfigrule"
+    id = "UC3"
+
+    def apply(self, config, commit):
+        # We add a line to the commit message body that pulls a value from config, this proves we can modify the body
+        # and read the config contents
+        commit.message.body.append("{0} ".format(config.target))  # trailing whitespace deliberate to trigger violation
+
+        # We set a custom property that we access in CommitRule, to prove we can add extra properties to the commit
+        commit.custom_prop = u"foöbar"
+
+        # We also ignore some extra rules, proving that we can modify the config
+        config.ignore.append("B4")
+
+
+class ConfigurableCommitRule(CommitRule):
+    """ Rule that tests that we can add configuration to user-defined rules """
+    name = u"configürable"
+    id = "UC4"
+
+    options_spec = [IntOption(u"int-öption", 2, u"int-öption description"),
+                    StrOption(u"str-öption", u"föo", u"int-öption description"),
+                    ListOption(u"list-öption", [u"foo", u"bar"], u"list-öption description")]
+
+    def validate(self, _):
+        violations = [
+            RuleViolation(self.id, u"int-öption: {0}".format(self.options[u'int-öption'].value), line_nr=1),
+            RuleViolation(self.id, u"str-öption: {0}".format(self.options[u'str-öption'].value), line_nr=1),
+            RuleViolation(self.id, u"list-öption: {0}".format(sstr(self.options[u'list-öption'].value)), line_nr=1),
         ]
 
         return violations