Deterministic for loops for dictionaries
#242
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilyapuchka
reviewed
Sep 20, 2018
CHANGELOG.md
Outdated
| @@ -7,6 +7,9 @@ | |||
| - Now accessing undefined keys in NSObject does not cause runtime crash and instead renders empty string. | |||
| [Ilya Puchka](https://github.com/ilyapuchka) | |||
| [#234](https://github.com/stencilproject/Stencil/pull/234) | |||
| - `for` tag: When iterating over a dictionary the keys will now always be sorted to ensure consistent output generation. | |||
There was a problem hiding this comment.
[nit] should mention sorting order probably
There was a problem hiding this comment.
"... sorted (in an ascending order) ..."?
|
So, small discussion point from #240 is that the current Stencil behaviour was, until now, undefined. So let's define it then. An important note should be that the behaviour should be consistent, no matter the swift version you compile Stencil with (4 vs 4.2).
|
a3da20c to
064b2f7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: I was a bit too quick and merged #240 into the wrong branch, and github won't allow me to fix things without a new PR 🤷♂️
With Swift 4.2, hashing isn't consistent between runs anymore. A consequence of this is, if we iterate over a dictionary, the output won't always be the same, which will be unexpected for a user.
With this PR we iterate over the sorted keys of a dictionary, ensuring consistent output across runs.