title-min-length: Update tests, add docs

* Update tests related to the `title-min-length` (mostly cosmetic
  changes)

* Add one more test for empty title.

* Add the new `title-min-length` rule to various documentation files.

Signed-off-by: mr.Shu <mr@shu.io>

Author: mrshu

docs/configuration.md

@@ -68,6 +68,11 @@ extra-path=examples/
 [title-max-length]
 line-length=80
 
+# Conversely, you can also enforce minimal length of a title with the
+# "title-min-length" rule:
+# [title-min-length]
+# min-length=5
+
 [title-must-not-contain-word]
 # Comma-separated list of words that should not occur in the title. Matching is case
 # insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"
@@ -429,4 +434,4 @@ gitlint -c general.staged=true # different way of doing the same
 #.gitlint
 [general]
 staged=true
-```
+```

docs/rules.md

@@ -14,6 +14,7 @@ T4    | title-hard-tab              | >= 0.1.0          | Title cannot contain h
 T5    | title-must-not-contain-word | >= 0.1.0          | Title cannot contain certain words (default: "WIP")
 T6    | title-leading-whitespace    | >= 0.4.0          | Title cannot have leading whitespace (space or tab)
 T7    | title-match-regex           | >= 0.5.0          | Title must match a given regex (default: .*)
+T8    | title-max-length            | >=                | Title length must be > 5 chars.
 B1    | body-max-line-length        | >= 0.1.0          | Lines in the body must be < 80 chars
 B2    | body-trailing-whitespace    | >= 0.1.0          | Body cannot have trailing whitespace (space or tab)
 B3    | body-hard-tab               | >= 0.1.0          | Body cannot contain hard tab characters (\t)
@@ -82,6 +83,12 @@ ID    | Name                        | gitlint version | Description
 ------|-----------------------------|-----------------|-------------------------------------------
 T7    | title-match-regex           | >= 0.5          | Title must match a given regex (default: .*)
 
+## T8: title-min-length ##
+
+ID    | Name                        | gitlint version | Description
+------|-----------------------------|-----------------|-------------------------------------------
+T1    | title-min-length            | >=              | Title length must be > 5 chars.
+
 
 ### Options ###
 
@@ -240,4 +247,4 @@ ignore=all
 [ignore-by-body]
 regex=(.*)release(.*)
 ignore=T1,body-min-length,B6
-```
+```

gitlint/config.py

@@ -51,6 +51,7 @@ class LintConfig(object):
                             rules.TitleHardTab,
                             rules.TitleMustNotContainWord,
                             rules.TitleRegexMatches,
+                            rules.TitleMinLength,
                             rules.BodyMaxLineLength,
                             rules.BodyMinLength,
                             rules.BodyMissing,

gitlint/files/gitlint

@@ -43,6 +43,11 @@
 # [title-max-length]
 # line-length=50
 
+# Conversely, you can also enforce minimal length of a title with the
+# "title-min-length" rule:
+# [title-min-length]
+# min-length=5
+
 # [title-must-not-contain-word]
 # Comma-separated list of words that should not occur in the title. Matching is case
 # insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"
@@ -103,4 +108,4 @@
 # under [general] section above.
 # [contrib-title-conventional-commits]
 # Specify allowed commit types. For details see: https://www.conventionalcommits.org/
-# types = bugfix,user-story,epic
+# types = bugfix,user-story,epic

gitlint/rules.py

@@ -245,7 +245,7 @@ class TitleMinLength(LineRule):
     def validate(self, title, _commit):
         min_length = self.options['min-length'].value
         actual_length = len(title)
-        if 0 < actual_length < min_length:
+        if actual_length < min_length:
             violation_message = "Title is too short ({0}<{1})".format(actual_length, min_length)
             return [RuleViolation(self.id, violation_message, title, 1)]
 

gitlint/tests/rules/test_title_rules.py

@@ -160,7 +160,7 @@ def test_min_line_length(self):
         violation = rule.validate(u"å" * 72, None)
         self.assertIsNone(violation)
 
-        # assert error on line length > 72
+        # assert error on line length < 5
         expected_violation = RuleViolation("T8", "Title is too short (4<5)", u"å" * 4, 1)
         violations = rule.validate(u"å" * 4, None)
         self.assertListEqual(violations, [expected_violation])
@@ -174,3 +174,8 @@ def test_min_line_length(self):
         expected_violation = RuleViolation("T8", "Title is too short (2<3)", u"å" * 2, 1)
         violations = rule.validate(u"å" * 2, None)
         self.assertListEqual(violations, [expected_violation])
+
+        # assert raise on empty title
+        expected_violation = RuleViolation("T8", "Title is too short (0<3)", "", 1)
+        violations = rule.validate("", None)
+        self.assertListEqual(violations, [expected_violation])