Feature/150 refactor generation of rn (#151)

Create raw version of Record and split of logic to support:
- all PR with issue
- all PR without issue
- all issues without PR
- all standalone commits

Author: OlivieFranklova

.gitignore

@@ -157,3 +157,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
+
+default_output.txt
+run_locally.sh

.pylintrc

@@ -322,7 +322,7 @@ max-returns=6
 max-statements=50
 
 # Minimum number of public methods for a class (see R0903).
-min-public-methods=2
+min-public-methods=1
 
 
 [EXCEPTIONS]

DEVELOPER.md

@@ -146,7 +146,7 @@ open htmlcov/index.html
 ```
 
 ## Run Action Locally
-Create *.sh file and place it in the project root.
+Create run_locally.sh file and place it in the project root.
 
 ```bash
 #!/bin/bash

main.py

@@ -21,14 +21,19 @@
 """
 
 import logging
+import warnings
 
 from github import Github, Auth
+from urllib3.exceptions import InsecureRequestWarning
 
 from release_notes_generator.generator import ReleaseNotesGenerator
 from release_notes_generator.model.custom_chapters import CustomChapters
 from release_notes_generator.action_inputs import ActionInputs
 from release_notes_generator.utils.gh_action import set_action_output
 from release_notes_generator.utils.logging_config import setup_logging
+from release_notes_generator.filter import FilterByRelease
+
+warnings.filterwarnings("ignore", category=InsecureRequestWarning)
 
 
 def run() -> None:
@@ -42,7 +47,7 @@ def run() -> None:
     logger.info("Starting 'Release Notes Generator' GitHub Action")
 
     # Authenticate with GitHub
-    py_github = Github(auth=Auth.Token(token=ActionInputs.get_github_token()), per_page=100)
+    py_github = Github(auth=Auth.Token(token=ActionInputs.get_github_token()), per_page=100, verify=False, timeout=60)
 
     ActionInputs.validate_inputs()
     # Load custom chapters configuration
@@ -51,7 +56,8 @@ def run() -> None:
     )
 
     generator = ReleaseNotesGenerator(py_github, custom_chapters)
-    rls_notes = generator.generate()
+    filterer = FilterByRelease()
+    rls_notes = generator.generate(filterer)
     logger.debug("Generated release notes: \n%s", rls_notes)
 
     # Set the output for the GitHub Action

release_notes_generator/action_inputs.py

@@ -65,6 +65,40 @@ class ActionInputs:
     _row_format_issue = None
     _row_format_pr = None
     _row_format_link_pr = None
+    _owner = ""
+    _repo_name = ""
+
+    @staticmethod
+    def get_github_owner() -> str:
+        """
+        Get the GitHub owner from the action inputs.
+        """
+        if ActionInputs._owner:
+            return ActionInputs._owner
+
+        repository_id = get_action_input(GITHUB_REPOSITORY) or ""
+        if "/" in repository_id:
+            ActionInputs._owner, _ = repository_id.split("/", 1)
+        else:
+            ActionInputs._owner = repository_id
+
+        return ActionInputs._owner
+
+    @staticmethod
+    def get_github_repo_name() -> str:
+        """
+        Get the GitHub repository name from the action inputs.
+        """
+        if ActionInputs._repo_name:
+            return ActionInputs._repo_name
+
+        repository_id = get_action_input(GITHUB_REPOSITORY) or ""
+        if "/" in repository_id:
+            _, ActionInputs._repo_name = repository_id.split("/", 1)
+        else:
+            ActionInputs._repo_name = repository_id
+
+        return ActionInputs._repo_name
 
     @staticmethod
     def get_github_repository() -> str:
@@ -194,7 +228,9 @@ def get_coderabbit_release_notes_title() -> str:
         """
         Get the CodeRabbit release notes title from the action inputs.
         """
-        return get_action_input(CODERABBIT_RELEASE_NOTES_TITLE, CODERABBIT_RELEASE_NOTE_TITLE_DEFAULT)  # type: ignore[return-value]
+        return get_action_input(
+            CODERABBIT_RELEASE_NOTES_TITLE, CODERABBIT_RELEASE_NOTE_TITLE_DEFAULT
+        )  # type: ignore[return-value]
 
     @staticmethod
     def get_coderabbit_summary_ignore_groups() -> list[str]:
@@ -298,11 +334,16 @@ def validate_inputs() -> None:
             errors.append("Repository ID must be a non-empty string.")
 
         if "/" in repository_id:
-            owner, repo_name = ActionInputs.get_github_repository().split("/")
+            ActionInputs._owner, ActionInputs._repo_name = ActionInputs.get_github_repository().split("/")
         else:
-            owner = repo_name = ""
-
-        if not isinstance(owner, str) or not owner.strip() or not isinstance(repo_name, str) or not repo_name.strip():
+            ActionInputs._owner = ActionInputs._repo_name = ""
+
+        if (
+            not isinstance(ActionInputs._owner, str)
+            or not ActionInputs._owner.strip()
+            or not isinstance(ActionInputs._repo_name, str)
+            or not ActionInputs._repo_name.strip()
+        ):
             errors.append("Owner and Repo must be a non-empty string.")
 
         tag_name = ActionInputs.get_tag_name()
@@ -373,7 +414,7 @@ def validate_inputs() -> None:
                 logger.error(error)
             sys.exit(1)
 
-        logger.debug("Repository: %s/%s", owner, repo_name)
+        logger.debug("Repository: %s/%s", ActionInputs._owner, ActionInputs._repo_name)
         logger.debug("Tag name: %s", tag_name)
         logger.debug("Chapters: %s", chapters)
         logger.debug("Published at: %s", published_at)

release_notes_generator/builder.py

@@ -29,7 +29,6 @@
 logger = logging.getLogger(__name__)
 
 
-# pylint: disable=too-few-public-methods
 class ReleaseNotesBuilder:
     """
     A class representing the Release Notes Builder.
@@ -39,7 +38,7 @@ class ReleaseNotesBuilder:
 
     def __init__(
         self,
-        records: dict[int, Record],
+        records: dict[int | str, Record],
         changelog_url: str,
         custom_chapters: CustomChapters,
     ):

release_notes_generator/filter.py

@@ -0,0 +1,106 @@
+#
+# Copyright 2023 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""This module contains the Filter classes which are responsible for filtering records based on various criteria."""
+
+import logging
+from copy import deepcopy
+from typing import Optional
+from release_notes_generator.model.mined_data import MinedData
+
+logger = logging.getLogger(__name__)
+
+
+class Filter:
+    """
+    Base class for filtering records.
+    """
+
+    def filter(self, data: MinedData) -> MinedData:
+        """
+        Filter the mined data based on specific criteria.
+
+        @param data: The mined data to filter.
+        @return: The filtered mined data.
+        """
+        raise NotImplementedError("Subclasses should implement this method.")
+
+
+class FilterByRelease(Filter):
+    """
+    Filter records based on the release version.
+    """
+
+    def __init__(self, release_version: Optional[str] = None):
+        self.release_version = release_version
+
+    def filter(self, data: MinedData) -> MinedData:
+        """
+        Filters issues, pull requests, and commits based on the latest release date.
+        If the release is not None, it filters out closed issues, merged pull requests, and commits
+        that occurred before the release date.
+
+        @Parameters:
+        - data (MinedData): The mined data containing issues, pull requests, commits, and release information.
+
+        @Returns:
+        - MinedData: The filtered mined data with issues, pull requests, and commits reduced based on the release date.
+        """
+        md = MinedData()
+        md.repository = data.repository
+        md.release = data.release
+        md.since = data.since
+
+        if data.release is not None:
+            logger.info("Starting issue, prs and commit reduction by the latest release since time.")
+
+            # filter out closed Issues before the date
+            issues_list = list(
+                filter(lambda issue: issue.closed_at is not None and issue.closed_at >= data.since, data.issues)
+            )
+            logger.debug("Count of issues reduced from %d to %d", len(data.issues), len(issues_list))
+
+            # filter out merged PRs and commits before the date
+            pulls_list = list(
+                filter(lambda pull: pull.merged_at is not None and pull.merged_at >= data.since, data.pull_requests)
+            )
+            logger.debug("Count of pulls reduced from %d to %d", len(data.pull_requests), len(pulls_list))
+
+            commits_list = list(filter(lambda commit: commit.commit.author.date > data.since, data.commits))
+            logger.debug("Count of commits reduced from %d to %d", len(data.commits), len(commits_list))
+
+            md.issues = issues_list
+            md.pull_requests = pulls_list
+            md.commits = commits_list
+
+            logger.debug(
+                "Input data. Issues: %d, Pull Requests: %d, Commits: %d",
+                len(data.issues),
+                len(data.pull_requests),
+                len(data.commits),
+            )
+            logger.debug(
+                "Filtered data. Issues: %d, Pull Requests: %d, Commits: %d",
+                len(md.issues),
+                len(md.pull_requests),
+                len(md.commits),
+            )
+        else:
+            md.issues = deepcopy(data.issues)
+            md.pull_requests = deepcopy(data.pull_requests)
+            md.commits = deepcopy(data.commits)
+
+        return md

release_notes_generator/generator.py

@@ -25,7 +25,7 @@
 
 from github import Github
 
-from release_notes_generator.model.MinedData import MinedData
+from release_notes_generator.filter import Filter
 from release_notes_generator.miner import DataMiner
 from release_notes_generator.action_inputs import ActionInputs
 from release_notes_generator.builder import ReleaseNotesBuilder
@@ -65,60 +65,30 @@ def rate_limiter(self) -> GithubRateLimiter:
         """Getter for the GithubRateLimiter instance."""
         return self._rate_limiter
 
-    def _filter_by_release(self, data: MinedData) -> None:
-        """
-        Filters issues, pull requests, and commits based on the latest release date.
-        If the release is not None, it filters out closed issues, merged pull requests, and commits
-        that occurred before the release date.
-        @param data: The mined data containing issues, pull requests, commits, and release information.
-        """
-        issues_list = data.issues
-        pulls_list = data.pull_requests
-        commits_list = data.commits
-
-        if data.release is not None:
-            logger.info("Starting issue, prs and commit reduction by the latest release since time.")
-
-            # filter out closed Issues before the date
-            data.issues = list(
-                filter(lambda issue: issue.closed_at is not None and issue.closed_at >= data.since, issues_list)
-            )
-            logger.debug("Count of issues reduced from %d to %d", len(issues_list), len(data.issues))
-
-            # filter out merged PRs and commits before the date
-            data.pull_requests = list(
-                filter(lambda pull: pull.merged_at is not None and pull.merged_at >= data.since, pulls_list)
-            )
-            logger.debug("Count of pulls reduced from %d to %d", len(pulls_list), len(data.pull_requests))
-
-            data.commits = list(filter(lambda commit: commit.commit.author.date > data.since, commits_list))
-            logger.debug("Count of commits reduced from %d to %d", len(commits_list), len(data.commits))
-
-    def generate(self) -> Optional[str]:
+    def generate(self, filterer: Filter) -> Optional[str]:
         """
         Generates the Release Notes for a given repository.
 
+        @Parameters:
+        - filterer: An instance of Filter that will be used to filter the mined data.
+
         @return: The generated release notes as a string, or None if the repository could not be found.
         """
         miner = DataMiner(self._github_instance, self._rate_limiter)
         data = miner.mine_data()
         if data.is_empty():
             return None
 
-        self._filter_by_release(data)
+        filtered_data = filterer.filter(data=data)
 
         changelog_url: str = get_change_url(
-            tag_name=ActionInputs.get_tag_name(), repository=data.repository, git_release=data.release
+            tag_name=ActionInputs.get_tag_name(), repository=filtered_data.repository, git_release=filtered_data.release
         )
 
-        assert data.repository is not None, "Repository must not be None"
+        assert filtered_data.repository is not None, "Repository must not be None"
 
-        rls_notes_records: dict[int, Record] = RecordFactory.generate(
-            github=self._github_instance,
-            repo=data.repository,
-            issues=data.issues,
-            pulls=data.pull_requests,
-            commits=data.commits,
+        rls_notes_records: dict[int | str, Record] = RecordFactory.generate(
+            github=self._github_instance, data=filtered_data
         )
 
         release_notes_builder = ReleaseNotesBuilder(

release_notes_generator/miner.py

@@ -29,7 +29,7 @@
 from github.Repository import Repository
 
 from release_notes_generator.action_inputs import ActionInputs
-from release_notes_generator.model.MinedData import MinedData
+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.utils.decorators import safe_call_decorator
 from release_notes_generator.utils.github_rate_limiter import GithubRateLimiter
@@ -47,6 +47,9 @@ def __init__(self, github_instance: Github, rate_limiter: GithubRateLimiter):
         self._safe_call = safe_call_decorator(rate_limiter)
 
     def mine_data(self) -> MinedData:
+        """
+        Mines data from GitHub, including repository information, issues, pull requests, commits, and releases.
+        """
         logger.info("Starting data mining from GitHub...")
         data = MinedData()
 

release_notes_generator/model/base_chapters.py

@@ -32,10 +32,10 @@ def __init__(self, sort_ascending: bool = True, print_empty_chapters: bool = Tru
         self.sort_ascending = sort_ascending
         self.print_empty_chapters = print_empty_chapters
         self.chapters: dict[str, Chapter] = {}
-        self.populated_record_numbers: list[int] = []
+        self.populated_record_numbers: list[int | str] = []
 
     @property
-    def populated_record_numbers_list(self) -> list[int]:
+    def populated_record_numbers_list(self) -> list[int | str]:
         """
         Gets the list of populated record numbers.
 
@@ -82,7 +82,7 @@ def titles(self) -> list[str]:
         return [chapter.title for chapter in self.chapters.values()]
 
     @abstractmethod
-    def populate(self, records: dict[int, Record]) -> None:
+    def populate(self, records: dict[int | str, Record]) -> None:
         """
         Populates the chapters with records.