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

Renaming UserDefault property wrapper #10

Closed
wants to merge 2 commits into from

Conversation

Sam-Spencer
Copy link

@Sam-Spencer Sam-Spencer commented Aug 19, 2020

What is the purpose of this pull request? (put an "X" next to item)

  • Documentation update.
  • Bug fix.
  • New feature.
  • Other, please explain:

What changes did you make? (Give an overview)
Renamed @UserDefault (and related) property wrappers to @SecureUserDefault because the type name as well as the target name conflicts with other Swift Packages (i.e. Guillermo Muntaner's Burritos) that also provide UserDefault-related property wrappers (although with different functionality).

Which issue (if any) does this pull request address?
This does not address a specific existing issue, however it does resolve SPM import conflicts on Xcode 11+.

Is there anything you'd like reviewers to focus on?
I realize that this PR may be invalid, or moving in an undesirable direction for the project. However, I thought it was worthwhile to share not only as a fix for the aforementioned issue, but because a more verbose name makes it clearer what the function of this property wrapper is. In fact, I believe that the readability of code using this library would be greatly improved if all of the included property wrappers were prepended with Secure. Of course, that might just be a picky programmer preference I have -- to each their own!

Regardless, I love the package and am very thankful for your hard work and contribution to the community. I'll be using it in more than a few App Store projects :) 🥂


This change is Reviewable

The `UserDefault` naming scheme conflicts with other popular Swift Packagaes such as Guillermo Muntaner's "Burritos" package (which also happens to define a UserDefault property wrapper). By prepending "Secure" the behavior is more explicit.
@welcome
Copy link

welcome bot commented Aug 19, 2020

🙌 Thanks for your contribution! 🎉🥳 You're awesome.

@codeclimate
Copy link

codeclimate bot commented Aug 19, 2020

Code Climate has analyzed commit 9eedeff and detected 0 issues on this pull request.

View more on Code Climate.

@stale
Copy link

stale bot commented Dec 5, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Dec 5, 2020
@stale stale bot closed this Dec 12, 2020
@Sam-Spencer
Copy link
Author

:(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant