employer
/
tame
1
0
Fork 0
Code Packages Releases Activity
tame/tamer
History
Mike Gerwitz 0acc21f16f Makefile.am (check): Check whether formatting is required 
Given that developers should be doing TDD and therefore running this target
frequently, this has the effect of providing immediate feedback when
formatting is needed and outputting a diff.  Developers will then quickly
understand what changes need to be made to avoid future issues (and can run
`cargo fmt` to fix it), at which point they'll rarely ever encounter
formatting errors.

The original purpose was to ensure pipelines fail when the formatter has not
been run.
 		2020-02-24 14:56:28 -05:00
..
build-aux TAMER: Initial commit 2019-11-18 14:05:47 -05:00
src Graph-based POC 2019-12-02 10:05:48 -05:00
.gitignore TAMER: Initial commit 2019-11-18 14:05:47 -05:00
Cargo.lock Graph-based POC 2019-12-02 10:05:48 -05:00
Cargo.toml Cargo.toml (profile.release)[lto]: Enable 2020-01-02 10:40:52 -05:00
Makefile.am Makefile.am (check): Check whether formatting is required 2020-02-24 14:56:28 -05:00
README.md Makefile.am (check): Check whether formatting is required 2020-02-24 14:56:28 -05:00
autogen.sh TAMER: Initial commit 2019-11-18 14:05:47 -05:00
bootstrap TAMER: Initial commit 2019-11-18 14:05:47 -05:00
configure.ac Makefile.am (check): Check whether formatting is required 2020-02-24 14:56:28 -05: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