chore: Code clenaup

Author: SilverRainZ

docs/usage.rst

@@ -86,7 +86,7 @@ Parameters:
 ``paths``
    Equivalent to :rst:dir:`recentupdate:paths`.
 
-``self``
+``self_only``
    Equivalent to :rst:dir:`recentupdate:self`.
 
 ``group_by``

src/sphinxnotes/recentupdate/__init__.py

@@ -43,8 +43,6 @@
 logger = logging.getLogger(__name__)
 
 
-CURRENT_REPO: Repo
-
 @dataclass
 class Revision:
     #: Git commit message, split by lines
@@ -206,11 +204,12 @@ def path2doc(repo: Repo, env: BuildEnvironment, blob_path: str) -> str | None:
 def collect_revisions(
     repo: Repo,
     env: BuildEnvironment,
-    count: int,
+    count: int | None,
     paths: list[str],
-    group_by: str = '',
+    group_by: str | None,
 ) -> list[Revision]:
     """Collect recent revisions from git, optionally grouped by time period."""
+    repo = CURRENT_REPO
     count = count or env.config.recentupdate_count
     group_by = group_by or env.config.recentupdate_group_by
 
@@ -231,44 +230,42 @@ def collect_revisions(
 
     return revs
 
-
 class RecentUpdateDirective(BaseContextDirective):
     """Directive for displaying recent document updates."""
 
+    @staticmethod
+    def _group_by_choice(arg: str):
+        return directives.choice(arg, GROUP_BY_CHOICES)
+
     has_content = True
     required_arguments = 0
     optional_arguments = 1
     option_spec = {
         'self': directives.flag,
         'paths': directives.unchanged,
-        'group-by': directives.unchanged,
+        'group-by': _group_by_choice,
     }
 
     def current_context(self) -> dict:
         repo = CURRENT_REPO
 
-        count = (
-            int(self.arguments[0])
-            if self.arguments
-            else self.env.config.recentupdate_count
-        )
+        count = int(self.arguments[0]) if self.arguments else None
 
-        current_doc = 'self' in self.options
-        if current_doc:
+        if 'self' in self.options:
             docpath = self.env.doc2path(self.env.docname)
             paths = [path.relpath(docpath, repo.working_dir)]
         elif 'paths' in self.options:
             paths = [p.strip() for p in self.options['paths'].splitlines() if p.strip()]
         else:
-            paths = ['.']
+            paths = []
 
-        group_by = self.options.get('group-by', '')
+        group_by = self.options.get('group-by')
 
         revs = collect_revisions(repo, self.env, count, paths, group_by)
         return {'revisions': revs}
 
     def current_template(self) -> Template:
-        text = '\n'.join(self.content) if self.has_content and self.content else ''
+        text = '\n'.join(self.content)
         if not text.strip():
             text = self.env.config.recentupdate_template
         return Template(text, phase=Phase.Parsing)
@@ -282,22 +279,22 @@ class RecentUpdateExtraContext(ExtraContext):
     def generate(
         self,
         req: ExtraContextRequest,
-        count: int = 0,
-        paths: list[str] = [
-            '.',
-        ],
-        self_doc: bool = False,
-        group_by: str = '',
+        count: int | None = None,
+        paths: list[str] = [],
+        group_by: str | None = None,
+        self_only: bool = False,
     ) -> Any:
         repo = CURRENT_REPO
-        if self_doc:
+
+        if self_only:
             docpath = req.env.doc2path(req.env.docname)
-            repo_path = path.relpath(docpath, repo.working_dir)
-            paths = [repo_path]
+            paths = [path.relpath(docpath, repo.working_dir)]
 
         return collect_revisions(repo, req.env, count, paths, group_by)
 
 
+CURRENT_REPO: Repo
+GROUP_BY_CHOICES = ['day', 'month', 'year']
 DEFAULT_TEMPLATE = dedent("""\
     {% for r in revisions %}
     ``👤 {{ r.author }}`` @ ``📅 {{ r.date.strftime('%Y-%m-%d') }}``
@@ -317,7 +314,6 @@ def generate(
     {% endfor %}
     """)
 
-
 def setup(app: Sphinx):
     meta.pre_setup(app)
 
@@ -334,7 +330,7 @@ def setup(app: Sphinx):
     app.add_config_value('recentupdate_count', 5, 'env', types=int)
     app.add_config_value('recentupdate_template', DEFAULT_TEMPLATE, 'env', types=str)
     app.add_config_value(
-        'recentupdate_group_by', None, 'env', types=ENUM(None, 'day', 'month', 'year')
+        'recentupdate_group_by', None, 'env', types=ENUM(None, *GROUP_BY_CHOICES)
     )
 
     return meta.post_setup(app)

tests/roots/test-recentupdate-current-doc/index.rst

@@ -4,7 +4,7 @@ Recentupdate Current Doc Test
 .. data.render::
    :debug:
 
-   {% for r in load_extra('recentupdate', count=10, self_doc=True) %}
+   {% for r in load_extra('recentupdate', count=10, self_only=True) %}
    Commit: {{ r.message[0] }}
    {% endfor %}