Release v0.7.1 by torkleyy · Pull Request #382 · ron-rs/ron

torkleyy · 2022-06-06T13:11:24Z

Closes #365

TODO

Figure out what to do with struct_names
Changelog

@kvark @MomoLangenstein Only four months and four days later and I found some time to do the long awaited 0.7.1 release 😅

I've included all merged PRs since the v0.7.0 release, except:

Changelog

Add struct_names option to PrettyConfig (#329)
Fix newtype variant unwrapping around enum, seq and map (#331)
Implement unwrap_newtypes extension during serialization (#333)
Implement unwrap_variant_newtypes extension during serialization (#336)
Fix issue #338 value map roundtrip (#341)
Fix issue #289 enumerate_arrays comments (#344)
Report struct name in expected struct error (#342)
Add Options builder to configure the RON serde roundtrip (#343)
Fix issue #359 with DeserializeSeed support (#360)
Fix issue #370 with FromStr-equivalent float EBNF and Error::FloatUnderscore (#371)
Fix issue #374 extraneous .0 for small floats (#372)

`struct_names` issue

Pull Request #329 moved the struct_names from the Serializer to the PrettyConfig. This included a breaking change to Serializer::new, removing the third parameter. I see a couple ways to handle this:

a) for 0.7.x, include the field in both `Serializer` and `PrettyConfig` and generate struct names if either are `true`

Advantages:

easy to implement

Disadvantages:

possibly surprising if PrettyConfig and the Serializer::new argument are controlled by different people and one sets it to false

b) use the third parameter to override the field in `PrettyConfig`

Advantages:

easy to implement
won't change the behavior of any existing applications

Disadvantages:

might be surprising for end-users only controlling the PrettyConfig if the struct_names property gets overwritten -> could besolved by doing pretty_config.struct_names = pretty_config.struct_names || struct_names (but that means struct_names = false will be ignored)
non-pretty serialization included this option until now, but this makes struct_names no longer an option with compact serialization
or, alternatively, we could try constructing a dummy PrettyConfig which ends up emulating non-pretty serialization

--> Were we aware that moving the field will no longer allow struct names with non-pretty serialization when merging this change?

c) consider reverting the change

There are a couple things I don't like about this change:

struct names can no longer be emitted with compact serialization
pretty options can break functionality in unexpected ways if the RON is parsed by a different party using enums instead of structs for their serde structures or a different RON parser (seems fairly unlikely)

But I don't feel very strong about it. Having the field in PrettyConfig provides more comfort in most situations IMO, but the edge cases above could be a problem sometimes.

* Fix some clippy warnings * Fix some more clippy warnings Co-authored-by: Rémi Lauzier <remilauzier@protonmail.com>

Fix newtype variant unwrapping inside enum, seq and map

Enable `unwrap_newtypes` extension during serialization

Fix ron-rs#338 value map roundtrip

Added improved `ExpectedStruct` error message

Fix ron-rs#289 enumerate_arrays comments

…enum Fix ron-rs#207 with unit test

Add compact arrays (ron-rs#299) and pretty inline separators

Fixes #ron-rs#238

Add struct name mismatch error + better error messages

* Move struct_names from Serializer to PrettyConfig * Update changelog

* Add code coverage CI step * Added codecov badge to README * Exclude examples from codecov collection

Expose `Extensions` during ser+de through `ron::Options`

…-rs#372) Co-authored-by: KirbyER <7432155-KirbyER@users.noreply.gitlab.com>

* Increased coverage for unit tests * Removed unused enum from empty set test

torkleyy · 2022-06-06T13:13:08Z

+        note = "Serializer::new is deprecated because struct_names was moved to PrettyConfig"
+    )]
+    pub fn new(writer: W, config: Option<PrettyConfig>, struct_names: bool) -> Result<Self> {
+        todo!("figure out how to handle struct_names");


This needs to be resolved before merging.

juntyr · 2022-06-06T15:02:28Z

Why were the other three PRs excluded (struct_names names sense) - are they breaking changes for v0.8?

torkleyy · 2022-06-06T18:35:49Z

Yes exactly, they are breaking changes.

juntyr · 2022-06-06T18:48:17Z

For v0.8 I think the struct_names would be a better fit for the Options since it might have an impact on parsing. This would likely be done by passing it into the constructor like it was before the PR, or by adding a separate post-construction modification method. So perhaps we could add it to Options already, add the post-construction method, and add a depreciation notice to the Serializer constructor that in the next version one should use Options or the post-construction modifier?

torkleyy · 2022-06-06T19:18:53Z

since it might have an impact on parsing

Hmm, it wouldn't right now, would it? I don't think there's a way to get the name of a struct when using deserialize_any, but this is just off the top of my head.
Despite that, I'm thinking it might still be the most consistent option.

kvark

Anything to resolve until CI passes and this is published?

torkleyy · 2022-06-13T11:29:50Z

@kvark ~~CI is failing intentionally~~ (nevermind, fixed now), we only need to resolve how to handle struct_names as described in the PR description. Any thoughts on it?

This is temporary change that should be reverted once the next minor version gets released. It enables semver compatibility with the last release, and is necessary for the 0.7.1 release

torkleyy · 2022-06-13T18:54:22Z

Okay, I fixed CI and implemented option a.

codecov-commenter · 2022-06-13T18:58:55Z

Codecov Report

❗ No coverage uploaded for pull request base (v0.7@7aba9c2). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             v0.7     #382   +/-   ##
=======================================
  Coverage        ?   88.87%           
=======================================
  Files           ?       47           
  Lines           ?     4982           
  Branches        ?        0           
=======================================
  Hits            ?     4428           
  Misses          ?      554           
  Partials        ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7aba9c2...b3bef7f. Read the comment docs.

juntyr · 2022-06-13T21:09:25Z

@torkleyy Ok, that looks good to me 👍 Perhaps we should document the planned depreciation in the release notes?

juntyr · 2022-06-15T08:51:25Z

LGTM

torkleyy · 2022-06-15T08:56:16Z

Thanks for reviewing @MomoLangenstein

torkleyy and others added 27 commits June 6, 2022 10:02

Remove rust-toolchain file

e53b5dd

Fix some clippy warnings (ron-rs#330)

96a038c

* Fix some clippy warnings * Fix some more clippy warnings Co-authored-by: Rémi Lauzier <remilauzier@protonmail.com>

Merge pull request ron-rs#331 from MomoLangenstein/master

11cdae6

Fix newtype variant unwrapping inside enum, seq and map

Merge pull request ron-rs#333 from MomoLangenstein/unwrap-newtypes-ser

a0ad7f6

Enable `unwrap_newtypes` extension during serialization

Merge pull request ron-rs#341 from MomoLangenstein/338-map-roundtrip

649c066

Fix ron-rs#338 value map roundtrip

Merge pull request ron-rs#342 from MomoLangenstein/struct-name-error

3411524

Added improved `ExpectedStruct` error message

Merge pull request ron-rs#344 from MomoLangenstein/enumerate-arrays-fix

7a7bc30

Fix ron-rs#289 enumerate_arrays comments

Fix \0 in string on nightly + enable weekly CI (ron-rs#373)

15a9231

Merge pull request ron-rs#346 from MomoLangenstein/adjacently-tagged-…

d44242b

…enum Fix ron-rs#207 with unit test

Merge pull request ron-rs#349 from MomoLangenstein/compact-arrays

edddc94

Add compact arrays (ron-rs#299) and pretty inline separators

docs(readme): cleanup & update

2f50ff9

Fixes #ron-rs#238

Fix ron-rs#265 with better missing comma detection (ron-rs#353)

7961268

Added Changelog entry

bc626a2

Merge pull request ron-rs#354 from MomoLangenstein/better-errors

184fe04

Add struct name mismatch error + better error messages

Move option to emit struct names to PrettyConfig (ron-rs#329)

50da8b6

* Move struct_names from Serializer to PrettyConfig * Update changelog

Fix ron-rs#358 ron/grammar.md typo/error (ron-rs#362)

439bac9

Enable decimal_floats by default for Value::Number(Float) roundtrip

cd3393e

Fix four clippy::needless_borrow warnings (ron-rs#364)

f801615

Add code coverage CI step (ron-rs#366)

b62b0c0

* Add code coverage CI step * Added codecov badge to README * Exclude examples from codecov collection

Fixed ron-rs#367 with eager implicit some

14e73b3

Merge pull request ron-rs#343 from MomoLangenstein/ron-options

3c21904

Expose `Extensions` during ser+de through `ron::Options`

Implement support for DeserializeSeed through Options (ron-rs#360)

8fe116d

Fix ron-rs#370 with better float EBNF and +inf -NaN +NaN parsing

586eadd

Fixed serialization for floating point values less than EPSILON. (ron…

607b6b4

…-rs#372) Co-authored-by: KirbyER <7432155-KirbyER@users.noreply.gitlab.com>

Increased coverage for unit tests (ron-rs#369)

aaabd8c

* Increased coverage for unit tests * Removed unused enum from empty set test

TODO: figure out what to do with struct_names

8935d27

Formatting

0633f10

torkleyy commented Jun 6, 2022

View reviewed changes

torkleyy requested a review from kvark June 7, 2022 14:37

kvark reviewed Jun 12, 2022

View reviewed changes

torkleyy added 2 commits June 13, 2022 20:29

Reintroduce struct_names field for Serializer

1ba646f

This is temporary change that should be reverted once the next minor version gets released. It enables semver compatibility with the last release, and is necessary for the 0.7.1 release

Fix float parsing test for old Rust version

e3f9847

Update changelog for 0.7.1

5f48fe7

torkleyy requested a review from juntyr June 13, 2022 18:57

juntyr approved these changes Jun 14, 2022

View reviewed changes

torkleyy added 2 commits June 15, 2022 10:44

Document deprecation in change log

e035468

Bump version

b3bef7f

torkleyy merged commit 1ae8b8c into ron-rs:v0.7 Jun 15, 2022

torkleyy deleted the v0.7 branch June 15, 2022 08:56

torkleyy mentioned this pull request Jun 15, 2022

Release 0.7.1 patch #365

Closed

juntyr mentioned this pull request Jul 24, 2022

Enhancement: better error messages for missing struct fields? #393

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release v0.7.1#382

Release v0.7.1#382
torkleyy merged 32 commits into
ron-rs:v0.7from
torkleyy:v0.7

torkleyy commented Jun 6, 2022 •

edited

Loading

Uh oh!

torkleyy Jun 6, 2022

Uh oh!

juntyr commented Jun 6, 2022

Uh oh!

torkleyy commented Jun 6, 2022 •

edited

Loading

Uh oh!

juntyr commented Jun 6, 2022

Uh oh!

torkleyy commented Jun 6, 2022

Uh oh!

kvark left a comment

Uh oh!

torkleyy commented Jun 13, 2022 •

edited

Loading

Uh oh!

torkleyy commented Jun 13, 2022

Uh oh!

codecov-commenter commented Jun 13, 2022 •

edited

Loading

Uh oh!

juntyr commented Jun 13, 2022 •

edited

Loading

Uh oh!

juntyr commented Jun 15, 2022

Uh oh!

torkleyy commented Jun 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

torkleyy commented Jun 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Changelog

struct_names issue

a) for 0.7.x, include the field in both Serializer and PrettyConfig and generate struct names if either are true

b) use the third parameter to override the field in PrettyConfig

c) consider reverting the change

Uh oh!

torkleyy Jun 6, 2022

Choose a reason for hiding this comment

Uh oh!

juntyr commented Jun 6, 2022

Uh oh!

torkleyy commented Jun 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juntyr commented Jun 6, 2022

Uh oh!

torkleyy commented Jun 6, 2022

Uh oh!

kvark left a comment

Choose a reason for hiding this comment

Uh oh!

torkleyy commented Jun 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

torkleyy commented Jun 13, 2022

Uh oh!

codecov-commenter commented Jun 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

juntyr commented Jun 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juntyr commented Jun 15, 2022

Uh oh!

torkleyy commented Jun 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

torkleyy commented Jun 6, 2022 •

edited

Loading

`struct_names` issue

a) for 0.7.x, include the field in both `Serializer` and `PrettyConfig` and generate struct names if either are `true`

b) use the third parameter to override the field in `PrettyConfig`

torkleyy commented Jun 6, 2022 •

edited

Loading

torkleyy commented Jun 13, 2022 •

edited

Loading

codecov-commenter commented Jun 13, 2022 •

edited

Loading

juntyr commented Jun 13, 2022 •

edited

Loading