employer

tame

History

Mike Gerwitz 233fa7de6a tamer: diagnose::panic: New module This change introduces diagnostic messages for panics. The intent is to be able to use panics in situations where it is either not possible to or not worth the time to recover from errors and ensure a consistent/sensible system state. In those situations, we still ought to be able to provide the user with useful information to attempt to get unstuck, since the error is surely in response to some particular input, and maybe that input can be tweaked to work around the problem. Ideally, invalid states are avoided using the type system and statically verified at compile-time. But this is not always possible, or in some cases may be way more effort or cause way more code complexity than is worth, given the unliklihood of the error occurring. With that said, it's been interesting, over the past >10y that TAME has existed, seeing how unlikely errors do sometimes pop up many years after they were written. It's also interesting to have my intuition of what is "unlikely" challenged, but hopefully it holds generally. DEV-7145		2022-08-09 15:20:37 -04:00
..
benches	tamer: Xirf::Text refinement	2022-08-01 15:01:37 -04:00
build-aux	Copyright year update 2022	2022-05-03 14:14:29 -04:00
src	tamer: diagnose::panic: New module	2022-08-09 15:20:37 -04:00
.gitignore	TAMER: Initial commit	2019-11-18 14:05:47 -05:00
Cargo.lock	tamer: Cargo.toml: Remove lazy_static	2022-06-24 14:18:04 -04:00
Cargo.toml	tamer: New parser-trace-stderr feature flag	2022-07-21 22:10:08 -04:00
Makefile.am	Copyright year update 2022	2022-05-03 14:14:29 -04:00
README.md	Copyright year update 2022	2022-05-03 14:14:29 -04:00
autogen.sh	Copyright year update 2022	2022-05-03 14:14:29 -04:00
bootstrap	Copyright year update 2022	2022-05-03 14:14:29 -04:00
configure.ac	Copyright year update 2022	2022-05-03 14:14:29 -04:00
rustfmt.toml	tamer/rustfmt (max_width): Set to 80	2019-11-27 09:15:15 -05:00

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.