refactor(git): rename get tag function to distinguish return str and GitTag

Lee-W · Lee-W · commit 9f93074e1763 · 2020-01-21T18:37:20.000+08:00
diff --git a/commitizen/commands/init.py b/commitizen/commands/init.py
@@ -5,7 +5,7 @@
 from commitizen import factory, out
 from commitizen.cz import registry
 from commitizen.config import BaseConfig, TomlConfig, IniConfig
-from commitizen.git import get_latest_tag, get_all_tags
+from commitizen.git import get_latest_tag_name, get_tag_names
 from commitizen.defaults import config_files
 
 
@@ -57,7 +57,7 @@ def _ask_name(self) -> str:
         return name
 
     def _ask_tag(self) -> str:
-        latest_tag = get_latest_tag()
+        latest_tag = get_latest_tag_name()
         if not latest_tag:
             out.error("No Existing Tag. Set tag to v0.0.1")
             return "0.0.1"
@@ -66,14 +66,14 @@ def _ask_tag(self) -> str:
             f"Is {latest_tag} the latest tag?", style=self.cz.style, default=False
         ).ask()
         if not is_correct_tag:
-            tags = get_all_tags()
+            tags = get_tag_names()
             if not tags:
                 out.error("No Existing Tag. Set tag to v0.0.1")
                 return "0.0.1"
 
             latest_tag = questionary.select(
                 "Please choose the latest tag: ",
-                choices=get_all_tags(),
+                choices=get_tag_names(),
                 style=self.cz.style,
             ).ask()
 
diff --git a/commitizen/git.py b/commitizen/git.py
@@ -15,9 +15,9 @@ def __eq__(self, other):
 
 class GitCommit(GitObject):
     def __init__(self, rev, title, body=""):
-        self.rev = rev
-        self.title = title
-        self.body = body
+        self.rev = rev.strip()
+        self.title = title.strip()
+        self.body = body.strip()
 
     @property
     def message(self):
@@ -28,9 +28,10 @@ def __repr__(self):
 
 
 class GitTag(GitObject):
-    def __init__(self, name, rev):
-        self.name = name
-        self.rev = rev
+    def __init__(self, name, rev, date):
+        self.rev = rev.strip()
+        self.name = name.strip()
+        self.date = date.strip()
 
     def __repr__(self):
         return f"{self.name} ({self.rev})"
@@ -85,19 +86,34 @@ def get_commits(
     return git_commits
 
 
+def get_tags(dateformat: str = "%Y-%m-%d") -> List[GitTag]:
+    inner_delimiter = "---inner_delimiter---"
+    formatter = (
+        f"'%(refname:lstrip=2){inner_delimiter}"
+        f"%(objectname){inner_delimiter}"
+        f"%(committerdate:format:{dateformat})'"
+    )
+    c = cmd.run(f"git tag --format={formatter} --sort=-committerdate")
+    if c.err or not c.out:
+        return []
+
+    git_tags = [GitTag(*line.split(inner_delimiter)) for line in c.out.split("\n")[:-1]]
+    return git_tags
+
+
 def tag_exist(tag: str) -> bool:
     c = cmd.run(f"git tag --list {tag}")
     return tag in c.out
 
 
-def get_latest_tag() -> Optional[str]:
+def get_latest_tag_name() -> Optional[str]:
     c = cmd.run("git describe --abbrev=0 --tags")
     if c.err:
         return None
     return c.out.strip()
 
 
-def get_all_tags() -> Optional[List[str]]:
+def get_tag_names() -> Optional[List[str]]:
     c = cmd.run("git tag --list")
     if c.err:
         return []
@@ -111,24 +127,6 @@ def find_git_project_root() -> Optional[Path]:
     return None
 
 
-def get_tags_with_rev() -> List[GitTag]:
-    tag_delimiter = "---tag-delimiter---"
-    c = cmd.run(
-        (
-            f"git tag --format='%(refname:lstrip=2){tag_delimiter}%(objectname)'"
-            " --sort=-committerdate"
-        )
-    )
-    if c.err or not c.out:
-        return []
-
-    git_tags = []
-    for line in c.out.split("\n")[:-1]:
-        name, rev = line.split(tag_delimiter)
-        git_tags.append(GitTag(name.strip(), rev.strip()))
-    return git_tags
-
-
 def is_staging_clean() -> bool:
     """Check if staing is clean"""
     c = cmd.run("git diff --no-ext-diff --name-only")
