tame/tamer
Mike Gerwitz 1f2315436c tamer: tamec: Extract xmli lowering into pipeline module
This is the same idea as the previous two commits: get all the lowering
pipelines into the same place so that we can observe commonalities and
attempt to derive an appropriate abstraction.

`lower_xmli` could have invoked `tree_reconstruction` itself, since it has
all the information that it needs to do so, but the idea is that these will
accept sources from the caller.  This also demonstrates that sinks need to
be flexible.  In an ideal abstraction, perhaps this would be able to produce
an iterator that accepts the first token type and yields the last, which can
then be directed to a sink, but that's not compatible with how the lowering
operations currently work, which requires a single value to be
returned.  But if it did work that way, then they'd be able to compose just
as any other parser.

Maybe for the future.

DEV-13162
2023-06-05 13:44:48 -04:00
..
benches tamer: benches: Remove asg and asg_lower_xmle microbenchmarks 2023-05-17 11:14:00 -04:00
build-aux tamer: src::asg::graph::object::pkg::name: New module 2023-05-05 10:26:56 -04:00
src tamer: tamec: Extract xmli lowering into pipeline module 2023-06-05 13:44:48 -04:00
tests tamer: asg: Integrate package CanonicalName 2023-05-05 10:26:58 -04:00
.gitignore tamer: configure.ac: conf.sh: New configuration file 2023-03-10 14:27:57 -05:00
Cargo.lock tamer: asg::graph::visit::topo: Introduce topological sort 2023-04-26 09:51:45 -04:00
Cargo.toml tamer: asg::graph::visit::topo: Introduce topological sort 2023-04-26 09:51:45 -04:00
Makefile.am tamer: Makefile.am: cargo clippy: Use active feature flags 2023-03-17 10:20:56 -04:00
README.md Copyright year and name update 2023-01-20 23:37:30 -05:00
autogen.sh Copyright year and name update 2023-01-20 23:37:30 -05:00
bootstrap Copyright year and name update 2023-01-20 23:37:30 -05:00
conf.sh.in tamer: asg::graph::object::xir: Initial rate element reconstruction 2023-03-10 14:27:58 -05:00
configure.ac tamer: Rust v1.{68=>70}: Stabalized nonzero_min_max and is_some_and 2023-04-12 12:04:13 -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.