Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Kaiaulu Architcture #283

Merged
merged 1 commit into from
Mar 3, 2024
Merged

Conversation

carlosparadis
Copy link
Member

The overall architecture of Kaiaulu has been refactored from "downloaders/parsers/networks" to an architecture that reflect the data source or tool interface, i.e.: source code/git/mail/jira/bugzilla/ etc. The functionality of the downloaders, parsers and network transformations are then now in the respective modules.

This reflects the intuition that a user will seek for, for example, Git functionality, or want to download JIRA issues, instead of broadly look to browse all parsers in Kaiaulu. A benefit of this new architecture is that the parsers, downloaders and network functionality now will no longer grow in size to every new tool or data source added, nor the associated unit test files.

For more details and rationale, see the respective issue for this commit.

The overall architecture of Kaiaulu has been refactored
from "downloaders/parsers/networks" to an architecture
that reflect the data source or tool interface, i.e.:
source code/git/mail/jira/bugzilla/ etc. The functionality
of the downloaders, parsers and network transformations
are then now in the respective modules.

This reflects the intuition that a user will seek for, for example,
Git functionality, or want to download JIRA issues, instead of
broadly look to browse all parsers in Kaiaulu. A benefit
of this new architecture is that the parsers, downloaders
and network functionality now will no longer grow in size
to every new tool or data source added, nor the associated
unit test files.

For more details and rationale, see the respective issue for
this commit.

Signed-off-by: Carlos Paradis <carlosviansi@gmail.com>
@carlosparadis carlosparadis added type:documentation Improvements or additions to documentation type:refactoring Code changes that improve maintenability, performance, etc labels Mar 3, 2024
@carlosparadis carlosparadis self-assigned this Mar 3, 2024
Copy link

codecov bot commented Mar 3, 2024

Codecov Report

Attention: Patch coverage is 27.03331% with 942 lines in your changes are missing coverage. Please review.

Project coverage is 39.79%. Comparing base (7747fb4) to head (44e717f).

Files Patch % Lines
R/bugzilla.R 0.00% 343 Missing ⚠️
R/src.R 9.00% 202 Missing ⚠️
R/git.R 68.25% 120 Missing ⚠️
R/mail.R 18.68% 74 Missing ⚠️
R/github.R 0.00% 68 Missing ⚠️
R/jira.R 55.10% 44 Missing ⚠️
R/vulnerabilities.R 0.00% 44 Missing ⚠️
R/dv8.R 0.00% 42 Missing ⚠️
R/reply.R 0.00% 5 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master     #283   +/-   ##
=======================================
  Coverage   39.79%   39.79%           
=======================================
  Files          21       20    -1     
  Lines        3091     3091           
=======================================
  Hits         1230     1230           
  Misses       1861     1861           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@carlosparadis carlosparadis merged commit 94045d1 into master Mar 3, 2024
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements or additions to documentation type:refactoring Code changes that improve maintenability, performance, etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant