feat: Add support to exclude `PFObject` fields in query results with `PFQuery.excludeKeys`

dplewis commented 1 year ago

New Pull Request Checklist

[x] I am not disclosing a vulnerability.
[x] I am creating this PR in reference to an issue.

Issue Description

Added support for parameter excludeKeys in queries (similar to select keys) in order to exclude the desired fields from retrieved objects.

Added in Parse-Server 3.6.0 https://github.com/parse-community/parse-server/pull/5737

Approach

TODOs before merging

[x] Add tests
[x] Add changes to documentation (guides, repository pages, in-code descriptions)

parse-github-assistant[bot] commented 1 year ago

Thanks for opening this pull request!

❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 84.12% and project coverage change: +1.91 :tada:

Comparison is base (19c8a62) 76.26% compared to head (7124416) 78.17%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #1731 +/- ## ========================================== + Coverage 76.26% 78.17% +1.91% ========================================== Files 305 307 +2 Lines 36754 36865 +111 ========================================== + Hits 28029 28818 +789 + Misses 8725 8047 -678 ``` | [Impacted Files](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community) | Coverage Δ | | |---|---|---| | [Parse/Parse/Internal/Commands/PFRESTQueryCommand.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvUGFyc2UvSW50ZXJuYWwvQ29tbWFuZHMvUEZSRVNUUXVlcnlDb21tYW5kLm0=) | `44.81% <20.00%> (-1.23%)` | :arrow_down: | | [...e/Parse/Internal/Query/State/PFMutableQueryState.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvUGFyc2UvSW50ZXJuYWwvUXVlcnkvU3RhdGUvUEZNdXRhYmxlUXVlcnlTdGF0ZS5t) | `96.26% <86.66%> (-1.57%)` | :arrow_down: | | [Parse/Parse/Internal/Query/State/PFQueryState.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvUGFyc2UvSW50ZXJuYWwvUXVlcnkvU3RhdGUvUEZRdWVyeVN0YXRlLm0=) | `100.00% <100.00%> (ø)` | | | [Parse/Parse/Source/PFQuery.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvUGFyc2UvU291cmNlL1BGUXVlcnkubQ==) | `94.82% <100.00%> (+0.06%)` | :arrow_up: | | [...ests/Other/TestCases/UnitTestCase/PFUnitTestCase.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvVGVzdHMvT3RoZXIvVGVzdENhc2VzL1VuaXRUZXN0Q2FzZS9QRlVuaXRUZXN0Q2FzZS5t) | `100.00% <100.00%> (ø)` | | | [Parse/Tests/Unit/QueryStateUnitTests.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvVGVzdHMvVW5pdC9RdWVyeVN0YXRlVW5pdFRlc3RzLm0=) | `100.00% <100.00%> (ø)` | | | [Parse/Tests/Unit/QueryUnitTests.m](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community#diff-UGFyc2UvVGVzdHMvVW5pdC9RdWVyeVVuaXRUZXN0cy5t) | `98.77% <100.00%> (+0.01%)` | :arrow_up: | ... and [29 files with indirect coverage changes](https://app.codecov.io/gh/parse-community/Parse-SDK-iOS-OSX/pull/1731/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=parse-community)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

parseplatformorg commented 1 year ago

🎉 This change has been released in version 2.4.0

parse-community / Parse-SDK-iOS-OSX