#152 - Refactor Record call (#154)

* #152 - Refactor Record call
- Review and update of unit tests related to Record and its child subclasses.

Author: miroslavpojer

release_notes_generator/miner.py

@@ -29,8 +29,9 @@
 from github.Repository import Repository
 
 from release_notes_generator.action_inputs import ActionInputs
+from release_notes_generator.model.issue_record import IssueRecord
 from release_notes_generator.model.mined_data import MinedData
-from release_notes_generator.utils.constants import ISSUE_STATE_ALL, PR_STATE_CLOSED
+from release_notes_generator.model.pull_request_record import PullRequestRecord
 from release_notes_generator.utils.decorators import safe_call_decorator
 from release_notes_generator.utils.github_rate_limiter import GithubRateLimiter
 
@@ -63,7 +64,7 @@ def mine_data(self) -> MinedData:
         self._get_issues(data)
 
         # pulls and commits, and then reduce them by the latest release since time
-        data.pull_requests = list(self._safe_call(data.repository.get_pulls)(state=PR_STATE_CLOSED))
+        data.pull_requests = list(self._safe_call(data.repository.get_pulls)(state=PullRequestRecord.PR_STATE_CLOSED))
         data.commits = list(self._safe_call(data.repository.get_commits)())
 
         logger.info("Data mining from GitHub completed.")
@@ -117,14 +118,16 @@ def _get_issues(self, data: MinedData):
         logger.info("Fetching issues from repository...")
         # get all issues
         if data.release is None:
-            data.issues = list(self._safe_call(data.repository.get_issues)(state=ISSUE_STATE_ALL))
+            data.issues = list(self._safe_call(data.repository.get_issues)(state=IssueRecord.ISSUE_STATE_ALL))
         else:
             # default is repository creation date if no releases OR created_at of latest release
             data.since = data.release.created_at if data.release else data.repository.created_at
             if data.release and ActionInputs.get_published_at():
                 data.since = data.release.published_at
 
-            data.issues = list(self._safe_call(data.repository.get_issues)(state=ISSUE_STATE_ALL, since=data.since))
+            data.issues = list(
+                self._safe_call(data.repository.get_issues)(state=IssueRecord.ISSUE_STATE_ALL, since=data.since)
+            )
 
         logger.info("Fetched %d issues", len(data.issues))
 

release_notes_generator/model/commit_record.py

@@ -0,0 +1,75 @@
+"""
+A module that defines the CommitRecord class, which represents a direct commit record in the release notes.
+"""
+
+from typing import Optional
+
+from github.Commit import Commit
+
+from release_notes_generator.action_inputs import ActionInputs
+from release_notes_generator.model.record import Record
+
+
+class CommitRecord(Record):
+    """
+    A class used to represent a direct commit record in the release notes.
+    Inherits from Record and provides additional functionality specific to direct commits.
+    """
+
+    def __init__(self, commit: Commit, skip: bool = False):
+        super().__init__(skip=skip)
+
+        self._commit: Commit = commit
+
+    # properties - override Record properties
+
+    @property
+    def record_id(self) -> int | str:
+        return self._commit.sha
+
+    @property
+    def is_closed(self) -> bool:
+        return True
+
+    @property
+    def is_open(self) -> bool:
+        return False
+
+    @property
+    def labels(self):
+        return []
+
+    @property
+    def authors(self) -> list[str]:
+        return [self._commit.author.login] if self._commit.author else []
+
+    # properties - specific to CommitRecord
+
+    @property
+    def commit(self) -> Commit:
+        """
+        Gets the commits associated with the record.
+        Returns: The commits associated with the record.
+        """
+        return self._commit
+
+    # methods - override Record methods
+
+    def to_chapter_row(self) -> str:
+        self.added_into_chapters()
+        row_prefix = f"{ActionInputs.get_duplicity_icon()} " if self.present_in_chapters() > 1 else ""
+
+        # collecting values for formatting
+        commit_message = self._commit.commit.message.replace("\n", " ")
+        row = f"{row_prefix}Commit: {self._commit.sha[:7]} - {commit_message}"
+
+        if self.contains_release_notes():
+            row = f"{row}\n{self.get_rls_notes()}"
+
+        return row
+
+    def get_rls_notes(self, line_marks: Optional[list[str]] = None) -> str:
+        # TODO - in this version - direct commits does not support release notes
+        return ""
+
+    # methods - specific to CommitRecord

release_notes_generator/model/custom_chapters.py

@@ -18,11 +18,14 @@
 This module contains the CustomChapters class which is responsible for representing the custom chapters in the release
 notes.
 """
+from typing import cast
 
 from release_notes_generator.action_inputs import ActionInputs
 from release_notes_generator.model.base_chapters import BaseChapters
 from release_notes_generator.model.chapter import Chapter
-from release_notes_generator.model.record import Record, CommitRecord
+from release_notes_generator.model.commit_record import CommitRecord
+from release_notes_generator.model.issue_record import IssueRecord
+from release_notes_generator.model.record import Record
 from release_notes_generator.utils.enums import DuplicityScopeEnum
 
 
@@ -55,7 +58,11 @@ def populate(self, records: dict[int | str, Record]) -> None:
                     continue
 
                 for record_label in records[record_id].labels:  # iterate all labels of the record (issue, or 1st PR)
-                    if record_label in ch.labels and records[record_id].pulls_count > 0:
+                    pulls_count = 1
+                    if isinstance(records[record_id], IssueRecord):
+                        pulls_count = cast(IssueRecord, records[record_id]).pull_requests_count()
+
+                    if record_label in ch.labels and pulls_count > 0:
                         if not records[record_id].is_present_in_chapters:
                             ch.add_row(record_id, records[record_id].to_chapter_row())
                             self.populated_record_numbers_list.append(record_id)