Add LoC(lines of code) tracker #62

willdavidson05 · 2024-06-24T17:08:15Z

Description

This PR create a LoC_tracker.py module that retrieves file statistics from a specified source and target commit. From these statistics, we find the total number of insertions and deletions, sum them together, and then return the total.

A test was made test_LoC.py, that checks that the module works correctly.

I appreciate any comments or feedback!

Closes #54

What is the nature of your change?

Content additions or updates (adds or updates content)
Bug fix (fixes an issue).
Enhancement (adds functionality).
Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

I have read the CONTRIBUTING.md guidelines.
My code follows the style guidelines of this project.
I have performed a self-review of my own contributions.
I have commented my content, particularly in hard-to-understand areas.
I have made corresponding changes to related documentation (outside of book content).
My changes generate no new warnings.
New and existing tests pass locally with my changes.
I have added tests that prove my additions are effective or that my feature works.
I have deleted all non-relevant text in this pull request template.

gwaybio

A couple comments. I'm general, great to see such comprehensive docs on the PR description and that it was a bite-sized change. Keep it up!

gwaybio · 2024-06-24T18:22:59Z

src/almanack/LoC_tracker.py

+    for commit in repo.iter_commits():
+        # Retrieve commit statistics
+        diff_stat = commit.stats.total
+        lines_added = diff_stat["insertions"]


Are you envisioning that you'll do something differently with insertions and deletions in the future? If not, then why not simply append commit.stats.total?

This is a good point! I did this initially for print statement testing, however I see how this is unnecessary . This helped me find the "lines" attribute of stats which works even better. Thank you for this!

src/almanack/LoC_tracker.py

gwaybio · 2024-06-24T18:24:41Z

tests/test_Loc.py

+def test_calculate_loc_changes(repository_paths: dict[str, pathlib.Path]):
+    high_entropy_path = repository_paths["high_entropy"]
+    low_entropy_path = repository_paths["low_entropy"]
+


I'm not totally confident, but don't these require assertions to make a valid test?

Whoops, you're totally right! I have corrected this mistake and created a robust test case.

willdavidson05 · 2024-06-24T20:50:33Z

Thank you for the review @gwaybio !! Your comments really helped me simplify/optimize my code and test cases. I have requested another review but no rush to get to it.

d33bs

Nice job! I left a few comments and suggestions. Please don't hesitate to reach out with any questions.

d33bs · 2024-06-25T14:08:23Z

src/almanack/LoC_tracker.py

Consider generalizing the name for this module to help invite further work where / when needed.

Will do! I have been thinking about a new name, and the best I have is code_tracker.py. Let me know what you think of this! I'm not sure how I feel about it yet.

d33bs · 2024-06-25T14:14:33Z

src/almanack/LoC_tracker.py

+
+    total_lines_changed = 0
+
+    for commit in repo.iter_commits():


Would it be possible to tie in almanack.git_parser.get_commit_logs here somehow to help introduce flexibility when it comes to certain commit segments or time periods (instead of only in full summary)? Perhaps it could come in the form of an expansion of the data structure found within that function (another dictionary key-value pair, for example). For example, we might expect that earlier in a project's lifespan the amount of change will be higher than later on. These counts from the earlier time periods might inadvertently effect calculations for later time periods under certain circumstances.

Thanks for the idea Dave! I was able to implement get_commit_logs by adding in attributes to my function, but wanted to see what you think?

tests/data/almanack/entropy/add_data.py

tests/data/almanack/entropy/add_entropy.py

src/almanack/LoC_tracker.py

willdavidson05 · 2024-06-25T17:44:25Z

Thank you @d33bs for the review! I have made some minor changes based off of your comments. I added attributes to my git_commit_logs function so I am able to reference my git_parser.py module through code_tracker.py. I also added hint return types for every function I have done so far. I left a couple questions on your comments as well!

willdavidson05 · 2024-06-27T17:11:26Z

@d33bs Wanted to give a couple notes about what I have changed.
1.) I deleted the get_all_commit_logs function inside of git_parser.py. I no longer see the need for it at this time
2.) I changed the calculate_loc_changes function to accept two new arguments source and target. This allows a file-based approach to our calculation.
3.) I created a function that grabs the two most recent commits(source,target) for the test datasets. I'm not sure if this is the best way to go about it, but would love to hear what you think! I also have it in test_code_tracker.py because I didn't see the utility of having it anywhere else.

d33bs

Great work! I left a few comments for your consideration - interested in what you think about these. Please don't hesitate to let me know if you have any questions.

src/almanack/code_tracker.py

d33bs · 2024-06-28T14:06:07Z

src/almanack/code_tracker.py

+
+def calculate_loc_changes(repo_path: pathlib.Path, source: str, target: str) -> int:
+    """
+    Finds the total number of code lines changed between the source and target commits.


Would this be able to parse individual file-level lines of code differences between the source and target commits? If not, consider expanding the function to include this capability (perhaps with an additional parameter which identifies a file within a tree) to address this.

src/almanack/code_tracker.py

tests/test_code_tracker.py

willdavidson05 · 2024-06-28T17:07:47Z

@d33bs, thanks for the review! I have implemented most of your feedback. Just a comment about a question from our meeting earlier, I found that the filename is the filepath relative to the repository root. Thank you!

d33bs

Nice job, this is looking pretty good to me! I left a couple comments about minor considerations; feel free to merge when you feel good about things.

src/almanack/git_parser.py

d33bs · 2024-06-28T18:03:57Z

src/almanack/git_parser.py

+    diff = repo.git.diff(source, target, "--numstat")
+    return {
+        filename: abs(int(removed) + int(added))  # Calculate change
+        for added, removed, filename in (line.split() for line in diff.splitlines())


Given how you gather data from this (data within a string) would it make sense to expand the test data to ensure nothing unusual happens when you have more than one file in a repository? Mostly I wonder, what would happen if there were two files (perhaps with one in a subdir and the other not)?

Will Davidson and others added 5 commits June 18, 2024 09:56

Removing .zip files

f551f61

Merge branch 'software-gardening:main' into main

6638e1d

Changing add_entropy function name

8acb0ed

Removing print statments after cofnirming functionality

5ea57fc

Adding comments

6f011e0

willdavidson05 added this to the Test driven, language agnostic information entropy linting tool milestone Jun 24, 2024

willdavidson05 requested review from falquaddoomi, d33bs and gwaybio June 24, 2024 17:08

Allowing pre-commit to pass

747c6a8

gwaybio reviewed Jun 24, 2024

View reviewed changes

Will Davidson added 5 commits June 24, 2024 14:19

Ensuring proper test, and adding docstring

3943413

pre-commit

d832b11

pre-commit

3988069

Creating proper test cases

33fae5b

Simplifying total_lines_changed

d09425c

willdavidson05 requested a review from gwaybio June 24, 2024 20:50

d33bs reviewed Jun 25, 2024

View reviewed changes

Will Davidson added 4 commits June 25, 2024 11:10

Adding return types and changing LoC tracker function

42ea9cb

Changing file names

6ec8025

Changing file names

c680e6a

Changing file names

c958ff6

willdavidson05 requested a review from d33bs June 25, 2024 17:44

Will Davidson added 5 commits June 25, 2024 13:25

Changing file name

1fed3ba

Changing file name

34b19de

Adding

130db5e

Making LoC file based rather than commit file base

2994813

Pre-commit checks

f963d9f

Will Davidson added 4 commits June 27, 2024 10:55

Deleting comments

61c66bc

pre-commit

f693c18

Remvoing get_all_commit_logs

588a344

adding docustring

4588621

Will Davidson added 5 commits June 27, 2024 11:12

pre-commit changes

51cc282

Changing + to -

8297b08

Stylistic changes

23bbdbf

Grammatical errors

f68874f

pre-commit

7777117

d33bs reviewed Jun 28, 2024

View reviewed changes

Will Davidson added 5 commits June 28, 2024 09:28

Commiting changes

98534ef

Documentation changes, utilizing list comprehension

a076bdf

editing test case for dict return value

7446ba1

Doc changes

708e445

Doc changes

8aae488

willdavidson05 requested a review from d33bs June 28, 2024 17:07

Will Davidson added 2 commits June 28, 2024 11:30

Typo in doc

7ef9110

Typo in doc

ca15bc9

d33bs approved these changes Jun 28, 2024

View reviewed changes

willdavidson05 mentioned this pull request Jun 28, 2024

Expanding test datasets with the addition of directories with multiple files #64

Closed

Edit doc string

baf94d9

willdavidson05 merged commit 03d77e1 into software-gardening:main Jun 28, 2024
10 checks passed

willdavidson05 deleted the LoC-tacker branch June 28, 2024 19:30

willdavidson05 mentioned this pull request Jul 2, 2024

Creating Shannon Entropy calculation function and editing test datasets #65

Merged

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add LoC(lines of code) tracker #62

Add LoC(lines of code) tracker #62

willdavidson05 commented Jun 24, 2024 •

edited

Loading

gwaybio left a comment

gwaybio Jun 24, 2024

willdavidson05 Jun 24, 2024

gwaybio Jun 24, 2024

willdavidson05 Jun 24, 2024

willdavidson05 commented Jun 24, 2024

d33bs left a comment

d33bs Jun 25, 2024

willdavidson05 Jun 25, 2024

d33bs Jun 25, 2024

willdavidson05 Jun 25, 2024 •

edited

Loading

willdavidson05 commented Jun 25, 2024

willdavidson05 commented Jun 27, 2024

d33bs left a comment

d33bs Jun 28, 2024

willdavidson05 commented Jun 28, 2024

d33bs left a comment

d33bs Jun 28, 2024

Add LoC(lines of code) tracker #62

Add LoC(lines of code) tracker #62

Conversation

willdavidson05 commented Jun 24, 2024 • edited Loading

Description

What is the nature of your change?

Checklist

gwaybio left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willdavidson05 commented Jun 24, 2024

d33bs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willdavidson05 Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

willdavidson05 commented Jun 25, 2024

willdavidson05 commented Jun 27, 2024

d33bs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willdavidson05 commented Jun 28, 2024

d33bs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willdavidson05 commented Jun 24, 2024 •

edited

Loading

willdavidson05 Jun 25, 2024 •

edited

Loading