Fix Variable and Secret url bugs

[AndrewJDawes]

Fixes: #2815, #2834

Tests added to tests/Repository.py:

• testRepoSecrets
• testRepoVariables

Note:

• This fix for Variable and Secret urls is a dependency for new functionality to fetch Environment variables and secrets
  • i.e., https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#list-environment-variables
• Adding the optional attributeTransformer callable argument will also make it possible to support this Variable and Secret functionality on the Environment model.
• I am currently working on a pull request to add support for get_secrets and get_variables on the Environment model (tests are not added yet)!

If you have any questions or if there is anything I can help with, would you please let me know?

We utilize this library at my work place to for automations against repos in our GitHub Enterprise organizations, so we are eager to get some of these bugs fixed and new functionality added to fully support Environment variables and secrets.

[codecov-commenter]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (26eedbb) 96.74% compared to head (17afa49) 96.81%.

Files	Patch %	Lines
github/PaginatedList.py	95.23%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2835      +/-   ##
==========================================
+ Coverage   96.74%   96.81%   +0.07%     
==========================================
  Files         142      142              
  Lines       14364    14399      +35     
==========================================
+ Hits        13896    13940      +44     
+ Misses        468      459       -9     

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

[AndrewJDawes]

Also fixes #2785

[EnricoMi]

Thanks for the contribution.

I'd prefer to move the logic that builds the Variable url from the Repository (that uses an attributes transformer), into the Variable class.

For this:

• add attribute variables_url to Variable
• in Variable.url, construct url from variables_url and name, if self._url. is not set
• in Repository, inject variables_url into paginated elements via attributes_transformer_override_from_dictionary

[EnricoMi]

Btw, in 6abd3e5 I have restored compatibility of PaginatedList with Pickle, which is good to have.

[AndrewJDawes]

Hey, @EnricoMi !

Pushed up a new commit to implement your suggestions!

[EnricoMi]

Pushed up a new commit to implement your suggestions!

Looks exactly like what I meant! Now lets iterate over the PR some more...

[AndrewJDawes]

Hey, @EnricoMi !

Those suggestions make sense to me! I think it reads cleaner.

I submitted another commit that implements your suggestions. Would you take a look when you get a chance?

Context on why the attributes transformers were initially accepting a Callable:

• I am still hoping to submit a follow-up PR after this one to provide the same functionality for Repository Environments and their Variables and Secrets.
• To that end, I wanted to make sure these enhancements wouldn't prevent us from adding that functionality.
• Specifically, I wasn't sure about moving control over the attributes transformations into PaginatedList and removing the possibility of a decorator pattern to wrap transformers (that was why we defaulted to lambda functions and each transformer accepted a Callable).
• However, after looking things over, I think moving control to PaginatedList and removing the decorator pattern should be fine and we should still be able to add support for Repository Environments and their Variables/Secrets.
• So, I implemented your suggestions!

[AndrewJDawes]

Hey, @EnricoMi - just noting that I removed the extra unwanted transformer. Thought I had done that already - my mistake!

Would you please let me know if there is anything else I can help with?

[EnricoMi]

This looks really good, thanks for the contribution!