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

Rename mixin methods which are incorrectly labeled protected #1020

Closed
mikkonie opened this issue Aug 30, 2022 · 2 comments
Closed

Rename mixin methods which are incorrectly labeled protected #1020

mikkonie opened this issue Aug 30, 2022 · 2 comments
Assignees
Labels
breaking Breaking change, to be implemented and documented with care internal Changes invisible to the user or APIs (e.g. refactoring and optimization)
Milestone

Comments

@mikkonie
Copy link
Collaborator

Not sure why I have originally done this, but a lot of mixins have public methods prefixed with _protected_syntax(). This is incorrect and creates issues e.g. when we in fact want to have some protected or private methods which the actual mixin API methods need to call.

This also affects several testing classes so sadly it is a breaking change.

It's bothered me for a while and it seems a good time to get this over with in milestone v0.12.0, which will break a lot of things in any case.

@mikkonie mikkonie added breaking Breaking change, to be implemented and documented with care internal Changes invisible to the user or APIs (e.g. refactoring and optimization) labels Aug 30, 2022
@mikkonie mikkonie added this to the SODAR Core v0.12.0 milestone Aug 30, 2022
@mikkonie mikkonie self-assigned this Aug 30, 2022
@mikkonie
Copy link
Collaborator Author

mikkonie commented Oct 21, 2022

List of renamed methods with current naming:

adminalerts.tests.test_models.AdminAlertMixin.make_alert()
appalerts.tests.test_models.AppAlertMixin.make_app_alert()
filesfolders.tests.test_models.FileMixin.make_file()
filesfolders.tests.test_models.FolderMixin.make_folder()
filesfolders.tests.test_models.HyperLinkMixin.make_hyperlink()
filesfolders.views.FilesfoldersTimelineMixin.add_item_modify_event()
projectroles.tests.test_commands.BatchUpdateRolesMixin.write_file()
projectroles.tests.test_models.ProjectMixin.make_project()
projectroles.tests.test_models.ProjectInviteMixin.make_invite()
projectroles.tests.test_models.AppSettingMixin.make_setting()
projectroles.tests.test_models.ProjectUserTagMixin.make_tag()
projectroles.tests.test_models.RemoteSiteMixin.make_site()
projectroles.tests.test_models.RemoteProjectMixin.make_remote_project()
projectroles.tests.test_models.RemoteTargetMixin.set_up_as_target()
projectroles.tests.test_models.RemoteTargetMixin.set_up_as_target()
projectroles.tests.test_models.SODARUserMixin
projectroles.tests.test_models.SODARUserMixin.make_sodar_user()
projectroles.tests.test_models.RoleAssignmentMixin.make_assignment()
projectroles.tests.test_ui.LiveUserMixin.make_user()
projectroles.tests.test_views_api.SODARAPIViewTestMixin.get_basic_auth_header()
projectroles.views_api.ProjectInviteAPIMixin.validate()
sodarcache.tests.test_models.JsonCacheItemMixin.make_item()
timeline.tests.test_models.ProjectEventMixin.make_event()
timeline.tests.test_models.ProjectEventObjectRefMixin.make_object_ref()
timeline.tests.test_models.ProjectEventStatusMixin.make_event_status()

@mikkonie
Copy link
Collaborator Author

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking change, to be implemented and documented with care internal Changes invisible to the user or APIs (e.g. refactoring and optimization)
Projects
None yet
Development

No branches or pull requests

1 participant