# gears-core-rust

_Cross platform, embeddable library for structured document transformation_

[![Build Status](https://travis-ci.org/gears-project/gears-core-rust.svg?branch=master)](https://travis-ci.org/gears-project/gears-core-rust)
[![codecov](https://codecov.io/gh/gears-project/gears-core-rust/branch/master/graph/badge.svg)](https://codecov.io/gh/gears-project/gears-core-rust)
[![Crates.io Status](http://meritbadge.herokuapp.com/gears)](https://crates.io/crates/gears)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gears-project/gears-core-rust/master/LICENSE)
[![Documentation](https://docs.rs/gears/badge.svg)](https://docs.rs/gears)


## Specifications

The requirements and specifications are documented using [artifact-app](https://github.com/vitiral/artifact) . 

The generated artifact documents are automatically published from `master` at 
[https://gears-project.github.io/gears-core-rust/](https://gears-project.github.io/gears-core-rust/)

To generate the documents locally run,

```
 cargo install artifact-app
 art check
 art ls -p
 art export -o target/spec html
```

## Build

```
cargo build --release
cargo build --features embedded
```

## DSL

```
with domain {
    add entity post;
    with entity post {
        add attribute name:string;
        with attribute name {
            set default 'none';
        };
    };
};

with xflows {
    add main_flow;
    with main_flow {
        add node branch_2;
    };
};
```

## Testing

    cargo test -- --nocapture

    RUST_BACKTRACE=1 cargo test -- --nocapture

    RUST_BACKTRACE=1 cargo watch -x "test -- --nocapture"

    RUST_BACKTRACE=1 RUST_LOG=gearsg=debug cargo watch -x "test -- --nocapture"

    RUST_BACKTRACE=1 RUST_LOG=gearsg=debug cargo watch -x "test --features peg/trace -- --nocapture"

See https://doc.rust-lang.org/log/env_logger/ for more logging options