DI-1 - Githubissues

koppor / jabref

Collection of simple for JabRef issues. Please submit PRs to https://github.com/jabRef/jabref/.

https://github.com/jabRef/jabref/

MIT License

8 stars 14 forks source link

DI-1 #687

Closed calixtus closed 1 month ago

calixtus commented 1 month ago

Mandatory checks

[ ] Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
[ ] Tests created for changes (if applicable)
[ ] Manually tested changed features in running JabRef (always required)
[ ] Screenshots added in PR description (for UI changes)
[ ] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
[ ] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

koppor commented 1 month ago

This is an alternative to use Google's Dagger , which was tried out 2.5 years ago at https://github.com/koppor/jabref/pull/518

koppor commented 1 month ago

We can use this PR to do a proper renaming:

Please fix the name "PreferenceService".

Reason:

A Service is a singleton providing things (see https://javaee.github.io/hk2/apidocs/org/jvnet/hk2/annotations/Service.html) (Currently our JabRefPreferences)
A Contract is a thing what a service is providing (see https://javaee.github.io/hk2/apidocs/org/jvnet/hk2/annotations/Contract.html) (currently our `PreferencesService)
In our case the (current) PreferencesService is the contract fulfilled by JabRefPreferences. -- It should be Preferences only

koppor commented 1 month ago

I think, this is the right place to provide the link to some naming hints and usages https://github.com/JabRef/jabref/pull/6103#issuecomment-1742103784

calixtus commented 1 month ago

We can use this PR to do a proper renaming:

Please swap the names "PreferenceService" and "Preferences".

Can we postpone this to a follow up PR? I believe this one is on the edge of what can be understood in one PR. Thats why I called the PR DI-1 😄 I just wanted to finally get rid of Globals and prepare the next steps by unifying the access and the injection method.

koppor commented 1 month ago

Follow-up at https://github.com/JabRef/jabref/pull/11342

koppor commented 1 month ago

We can use this PR to do a proper renaming: Please swap the names "PreferenceService" and "Preferences".

Can we postpone this to a follow up PR?

Please directly after merge as DI-2.