A Rust implementation of the Whitespace-separated values, as defined by Stenway. Follow the release notes on https://honestlysam.uk/

0.3.2

Sunday 28th April 2024

Fixed trailing whitespace bug with primitive. Renamed primitive2 to split. Added more tests. Feature gated the nom and pest parsers behind the feature gates "nom" and "pest".

TODO:

1. Serde implementation
2. Shift focus to line parsing, in prep for stream parsing.
3. Shift integration tests to unit or doc tests. Integration tests need to be different now, since serde does not have the halfway point I am currently testing to.
4. Benchmarking: Learn Divan
5. Learn how to handle errors better.
6. Documentation

Friday 26th April 2024

Fixed bugs with primitive2 and pest. Added more tests, and added benchmarks with Criterion. The results demonstrate that primitive and nom are about as fast as each other, with nom a touch faster, primitive2 is over 50% slower than primitive, and pest is anywhere between 80% and 300% slower than primitive.

TODO:

1. Fix error tests on nom and pest. Learn how to handle errors better.
2. feature gates for all parsers.
3. Serde implementation
4. Shift integration tests to unit or doc tests
5. Benchmarking: Learn Divan
6. Documentation

0.3.1

Wednesday 13th March 2024

Added implementation of primitive2 after a lot of pain and heartache. Added dependency to itertools for it. The form is very similar to the primitive implementation but the detail is far worse. I wonder if there is a mathematical equivalence somewhere. Read up on Serde implementations of other data formats and prepped for that stage. Tidied up integration tests.

Produced a somewhat large file to do benchmarking against. Now need to learn one of those frameworks. Divan looks good. I will compress my sample inputs into const strings in one file, so I remove all I/O from the integration tests and benchmarks.

Added minimal CLI support to take integration test files only. Panics otherwise.

TODO:

1. Fix error tests on nom and pest. Learn how to handle errors better.
2. feature gates for all parsers.
3. Serde implementation
4. Benchmarking: Learn Divan or Criterion
5. Documentation
6. Shift integration tests to unit or doc tests

0.3.0

Monday 11th March 2024

Modified the type of all parsers to return a Result<Wsv, WsvError> so that I could implement custom traits on the Wsv newtype. The tabulate functionality is now Display, and there are also Default, IntoIterator, PartialEq and From. This will allow me to intentionally control the functionality of the resulting type.

Shifted around the integration test code so that it didn't use macros and was easier to feature gate (coming soon). Shifted around the source code to practice using modules and privacy settings, and found that lib cannot declare a directory for sub-modules.

Added another primitive implementation of the parser which hinges on splitting the string and dealing with the parts, rather than iterating over every character in order. This is unfinished.

I also played with the tracing crate, which was somewhat useful for debugging but I still haven't baked it into the implementations. Not sure where would be best.

TODO:

1. CLI interface
2. Serde implementation
3. Benchmarking: Produce a huge file for this.
4. Documentation
5. Shift integration tests to unit or doc tests

0.2.0

Tuesday 27th February 2024

Added an implementation of the parser using nom and exposed wsv::parse as a common interface. Unified all the test cases and standardised the API of all three implementations, up to errors. Also unified the data model underlying all three.

I will publish 1.0.0 once I have successfully feature-gated the alternative functions.

TODO:

1. Shift all the code I have for the ReliableTXT implementation somewhere else
2. Process command line arguments to take a file path with clap or clio.

0.1.5

Sunday 25th February 2024

Rewrote the pest grammar from scratch which simplified the code processing the parser output. Made public the tabulate module so the binary can be executed to demonstrate the function and allow for a visual representation in CLI of the parser functioning properly. Useful for debugging. Introduced thiserror for the pest implementation.

TODO:

1. Process command line arguments to take a file path, rather than hardcoding one
2. Switch integration tests to unit tests or doc tests, so I can remove the public access and elect one implementation to import through wsv::parse.
3. Create a new parser using nom
4. Write documentation.

0.1.4

Friday 23rd February 2024

Adds an implementation of the parser using pest. It took all morning to figure out how to handle an error with a Generic Type parameter, but eventually realised you can just use Display on the whole thing and treat it as a string.

All tests pass once again, and also removed tests concerning parsing the file into valid UTF-8. This will be handled in another crate when I implement the ReliableTXT spec.