Structured data (like json, ndjson, toml, yaml) asserts in snapbox

[epage]

Like the value from special handling of text vs binary, asserting with knowledge of structured data would help gloss over irrelevant details and allow smarter wildcards

• json (json support for snapbox #106)
• jsonlines (feat(snap): Jsonlines support  #277)
• toml

[epage]

A basic way of doing this is

• Have feature flags per file format
• Have path asserts check for file type and deserialize the file according to any enabled formats
• For matches, instead of equality, create structured wildcards (wildcards that match entire subsets of the data). See cargo-test-support for ideas

[epage]

Besides a {..}, should we have {VAR}s that we deserialize and substitute?

[Muscraft]

After some discussion with @epage, we found the following blockers:

• A DataFormat enum should be created to hold all supported data formats (add DataFormat enum #109)

• as_bytes should be renamed to to_bytes and it should output Vec<u8> (refactor(snapbox)!: Change as_bytes to to_bytes #110)

• A function should be created, that outputs the current DataFormat of the Data it is called on (format(&self) -> DataFormat). Usage: expected.format() (refactor(snapbox)!: Change try_text to try_coerce #111)

• A try_coerce function should be created that takes in a DataFormat that the Data will try to be turned into (try_coerce(self, format: DataFormat) -> Self). If it fails to coerce into the expected data format the old one should be returned. Usage: actual.try_coerce(expected.format()) (refactor(snapbox)!: Change try_text to try_coerce #111)

• calls to try_text in assert.rs and path.rs should be updated to use try_coerce (refactor(snapbox)!: Change try_text to try_coerce #111)

• schema.rs should change calls to Data to std::fs::read_string + normalize the newlines (refactor(snapbox): Changes to normalization #122)

• rename map_text to normalize. It should then take in a normalization operation / algorithm (NormalizeNewlines, NormalizeMatches, etc) (refactor(snapbox): Changes to normalization #122)

• calls to map_text in assert.rs and path.rs should instead call normalize (refactor(snapbox): Changes to normalization #122)

• as_str should be renamed to render and it should output Option<String>. The original intent of as_str was for outputting Diffs. This should be changed to String since there are some formats that have borrowing issues with &str. (refactor(snapbox): Changes to normalization #122)

• A function to detect the format of the given Data should be created (detect(&self, supported_formats: Vec<DataFormat>) -> DataFormat), where supported_formats is runtime coerced formats, controlled by user). Usage: expected.detect(supported_formats)