Mike Gerwitz
1aca0945df
My initial plan with expansion was to wrap a `PasteState` in another that unwraps `Expansion` and converts into a `Dead` state, so that existing `TransitionResult` stitching methods (`delegate`, specifically) could be used. But the desire to use that existing method was primarily because stitching was a complex operation that was abstracted away _as part of the `delegate` method_, which made writing new ones verbose and difficult. Thus began the previous commits to begin to move that responsibility elsewhere so that it could be more composable. This continues with that, introducing a new trait that will culminate in the removal of a wrapping `ParseState` in favor of a stitching method. The old `StitchableExpansionState` is still used for tests, which demonstrates that the boilerplate problem still exists despite improvements made here These will become more generalized in the future as I have time (and the functional aspects of the code more formalized too, now that they're taking shape). The benefit of this is that we avoid having to warp our abstractions in ways that don't make sense (use of a dead state transition) just to satisfy existing APIs. It also means that we do not need the boilerplate of a `ParseState` any time we want to introduce this type of stitching/delegation. It also means that those methods can eventually be extracted into more general traits in the future as well. Ultimately, though, the two would have accomplished the same thing. But the difference is most emphasized in the _parent_---the actual stitching still has to take place for desugaring in the attribute parser, and I'd like for that abstraction to still be in terms of expansion. But if I utilized `StitchableExpansionState`, which converted into a dead state, I'd have to either forego the expansion abstraction---which would make the parser even more confusing---or I'd have to create _another_ abstraction around the dead state, which would mean that I stripped one abstraction just to introduce another one that's essentially the same thing. It didn't feel right, but it would have worked. The use of `PhantomData` in `StitchableExpansionState` was also a sign that something wasn't quite right, in terms of how the abstractions were integrating with one-another. And so here we are, as I struggle to wade my way through all of the yak shavings and make any meaningful progress on this project, while others continue to suffer due to slow build times. I'm sorry. Even if the system is improving. DEV-13156 |
||
|---|---|---|
| .. | ||
| benches | ||
| build-aux | ||
| src | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Makefile.am | ||
| README.md | ||
| autogen.sh | ||
| bootstrap | ||
| configure.ac | ||
| rustfmt.toml | ||
README.md
TAME in Rust (TAMER)
TAME was written to help tame the complexity of developing comparative insurance rating systems. This project aims to tame the complexity and performance issues of TAME itself. TAMER is therefore more tame than TAME.
TAME was originally written in XSLT. For more information about the
project, see the parent README.md.
Building
To bootstrap from the source repository, run ./bootstrap.
To configure the build for your system, run ./configure. To build, run
make. To run tests, run make check.
You may also invoke cargo directly, which make will do for you using
options provided to configure.
Note that the default development build results in terrible runtime performance! See [#Build Flags][] below for instructions on how to generate a release binary.
Build Flags
The environment variable CARGO_BUILD_FLAGS can be used to provide
additional arguments to cargo build when invoked via make. This can be
provided optionally during configure and can be overridden when invoking
make. For example:
# release build
$ ./configure && make CARGO_BUILD_FLAGS=--release
$ ./configure CARGO_BUILD_FLAGS=--release && make
# dev build
$ ./configure && make
$ ./configure CARGO_BUILD_FLAGS=--release && make CARGO_BUILD_FLAGS=
Hacking
This section contains advice for those developing TAMER.
Running Tests
Developers should be using test-driven development (TDD). make check will
run all necessary tests.
Code Format
Rust provides rustfmt that can automatically format code for you. This
project mandates its use and therefore eliminates personal preference in
code style (for better or worse).
Formatting checks are run during make check and, on failure, will output
the diff that would be applied if you ran make fmt (or make fix); this
will run cargo fmt for you (and will use the binaries configured via
configure).
Since developers should be doing test-driven development (TDD) and therefore
should be running make check frequently, the hope is that frequent
feedback on formatting issues will allow developers to quickly adjust their
habits to avoid triggering formatting errors at all.
If you want to automatically fix formatting errors and then run tests:
$ make fmt check
Benchmarking
Benchmarks serve two purposes: external integration tests (which are subject
to module visibility constraints) and actual benchmarking. To run
benchmarks, invoke make bench.
Note that link-time optimizations (LTO) are performed on the binary for benchmarking so that its performance reflects release builds that will be used in production.
The configure script will automatically detect whether the test feature
is unstable (as it was as of the time of writing) and, if so, will
automatically fall back to invoking nightly (by running cargo +nightly bench).
If you do not have nightly, run you install it via rustup install nightly.