Skip to content

Commit 11aa1e4

Browse files
DarthBDarthB
committed
doc: add readme and overwork docs and cargo.tomls
1 parent c15be47 commit 11aa1e4

File tree

8 files changed

+311
-12
lines changed

8 files changed

+311
-12
lines changed

‎LICENSE-APACHE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎LICENSE-MIT‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
MIT License
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎README.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Readme - EngCon
2+
[![ci](https://github.com/DarthB/engcon/actions/workflows/ci.yml/badge.svg)](https://github.com/DarthB/engcon/actions/workflows/ci.yml)
3+
4+
EngCon (Engineering Contracts) is a set of macros and traits defining contracts often found in
5+
engineering problems and uses the new-type pattern to add a `Validated<T>` datatype ensures that
6+
the specified contracts are hold.
7+
8+
## Motivation
9+
10+
Let's imagine an use-case where an engineer needs to both:
11+
12+
1. Input data that defines the specifications of a distillation column.
13+
2. Simulate and optimize such a distillation column.
14+
15+
In the first case a relaxed type that allows malformed input (at least temporary) is needed.
16+
Thus type should provide methods that
17+
18+
In the second case we would like to use Rust type system to ensure that only valid input
19+
for a distillation column.
20+
21+
## Including EngCon in your Project
22+
23+
Import `engcon` and `engcon_macros` into your project by adding the following lines to your Cargo.toml.
24+
engcon_macros contains the macros needed to derive the traits in EngCon.
25+
26+
```toml
27+
[dependencies]
28+
engcon = "0.1"
29+
engcon_macros = "0.1"
30+
31+
# You can also access engcon_macros exports directly through strum using the "derive" feature
32+
engcon = { version = "0.1", features = ["derive"] }
33+
```
34+
35+
This pattern is also used by by the well known [strum crate](https://docs.rs/strum/latest/strum/) that has helpful procedural macros
36+
for enumerations.
37+
38+
## Example Usage
39+
40+
```rust
41+
#[derive(Debug, Clone, Default, Copy, PartialEq, Validatable)]
42+
pub struct DistillationColumn {
43+
#[validate_value(x >= 3)]
44+
pub trays: i32,
45+
46+
#[validate_value(x < trays, x >= 1)]
47+
pub feed_place: i32,
48+
49+
#[validate_value(x > 0.0)]
50+
pub reflux_ratio: f32,
51+
52+
#[validate_value(x > 0.0, x < 1.0)]
53+
pub distiliate_to_feed_ratio: f32,
54+
}
55+
```
56+
57+
You can run an example based on the distillation column after cloning by typing `cargo run`.
58+
59+
### Is that a reinvented wheel?
60+
61+
Well, actually I started this project to learn about procedural macros. I learnt that the use-case I had in mind
62+
is often not supported. At least not as a first-class citizen. What I mean is the coupling between variables, as the `feed_place < trays`
63+
contract in the example. I also perfer the attributes to be formal mathmatical, i.e. with comparsions and boolean logic.
64+
As I believe that is benefical from an engineers perspective.
65+
66+
All that said, I found the following crates that may serve your use-case better:
67+
68+
- [Contract](https://docs.rs/contracts/latest/contracts/) - Allows the definition of preconditions, invariants and post-conditions supporting desing by contract.
69+
- [Validator](https://github.com/Keats/validator) - A strong input validator useful for web input, supports e-mail and credit card validators.
70+
- [prae](https://docs.rs/prae/latest/prae/index.html) - A declarative macro that defines types that require validation. It uses closures for validation and small adjustments.
71+
72+
## Roadmap
73+
74+
I have some ideas how to continue, but I also want to get inital feedback.
75+
76+
- Use a composite error type to collect all invalid contracts
77+
- Enhance the automatically generated code
78+
- Overthink the grammar, use `&&` and `||` instead of `,` to put multiple rules in a contract.
79+
80+
## Contributors
81+
82+
The following contributors have either helped to start this project, have contributed code, are actively maintaining it (including documentation), or in other ways being awesome contributors to this project. We'd like to take a moment to recognize them.
83+
84+
[<img src="https://github.com/DarthB.png?size=72" alt="DarthB" width="72">](https://github.com/DarthB)
85+
86+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
87+
88+
## License
89+
90+
EngCon is free, open source and permissively licensed!
91+
Except where noted (below and/or in individual files), all code in this repository is dual-licensed under either:
92+
93+
* MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
94+
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
95+
96+
at your option.
97+
This means you can select the license you prefer!
98+
This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.

‎engcon/Cargo.toml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ edition = "2021"
55
authors = ["Tim Janus <tim@janus.rs>"]
66
license = "MIT OR Apache-2.0"
77

8-
description = "Helpful macros to define contracts for constraints at rust struct level."
9-
#keywords = ["engineering", "contracts"]
10-
#categories = []
8+
description = "Helpful macros to define (eng)ineering (con)tracts on data-structure level"
9+
keywords = ["engineering", "contracts", "validation", "rules"]
10+
categories = ["data-structures", "science"]
1111

12-
#documentation = "https://docs.rs/strum"
12+
documentation = "https://docs.rs/engcon"
1313
homepage = "https://github.com/DarthB/engcon"
1414
repository = "https://github.com/DarthB/engcon"
15-
readme = "README.md"
15+
readme = "../README.md"
1616

1717
[features]
1818
derive = ["engcon_macros"]

‎engcon/src/lib.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! # EngCon
22
//!
3-
//! EngCon is a set of macros and traits defining contracts often found in
3+
//! EngCon (Engineering Contracts) is a set of macros and traits defining contracts often found in
44
//! engineering problems, e.g. the design of a distilation column.
55
//!
66
//! # Including EngCon in your Project

‎engcon_macros/Cargo.toml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ edition = "2021"
55
authors = ["Tim Janus <tim@janus.rs>"]
66
license = "MIT OR Apache-2.0"
77

8-
description = "Helpful macros to define contracts for constraints at rust struct level."
9-
#keywords = ["engineering", "contracts"]
10-
#categories = []
8+
description = "Helpful macros to define contracts on data-structure level"
9+
keywords = ["engineering", "contracts", "validation", "rules"]
10+
categories = ["data-structures", "science"]
1111

12-
#documentation = "https://docs.rs/strum"
12+
documentation = "https://docs.rs/engcon"
1313
homepage = "https://github.com/DarthB/engcon"
1414
repository = "https://github.com/DarthB/engcon"
15-
readme = "README.md"
15+
readme = "../README.md"
1616

1717
[lib]
1818
path = "src/lib.rs"

‎engcon_macros/src/lib.rs‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! # EngCon
22
//!
3-
//! EngCon is a set of macros and traits defining contracts often found in
3+
//! EngCon (Engineering Contracts) is a set of macros and traits defining contracts often found in
44
//! engineering problems, e.g. the design of a distilation column.
55
//!
66
//! This crate only contains derive macros for use with the
@@ -37,6 +37,10 @@ mod validator;
3737
/// pub distiliate_to_feed_ratio: f32,
3838
/// }
3939
/// ```
40+
///
41+
/// # Generated Code
42+
///
43+
///
4044
#[proc_macro_derive(Validatable, attributes(validate_value))]
4145
pub fn validate(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
4246
// Parse the input tokens into a syntax tree

‎examples/distillation/Cargo.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
name = "engcon_distillation"
33
version = "0.1.0"
44
edition = "2021"
5+
authors = ["Tim Janus <tim@janus.rs>"]
6+
license = "MIT OR Apache-2.0"
57

68
[dependencies]
79
engcon = { path = "../../engcon", features = ["derive"] }

0 commit comments

Comments
 (0)