commit 542652f305f35e2ddca11aa01b9cb5aa5aa5ac9e Author: Nettika Date: Mon Jul 4 02:26:48 2022 -0700 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..ce58249 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,7 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "vet" +version = "0.1.0" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..1c6d4ab --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,9 @@ +[package] +name = "vet" +version = "0.1.0" +authors = ["Benjamin Herman "] +edition = "2021" +description = "Validation of arbitrary types" +repository = "https://github.com/metanomial/vet" +license = "MIT OR Apache-2.0" +keywords = ["validation"] diff --git a/license-apache.txt b/license-apache.txt new file mode 100644 index 0000000..94c7068 --- /dev/null +++ b/license-apache.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Benjamin Herman + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/license-mit.txt b/license-mit.txt new file mode 100644 index 0000000..6b572de --- /dev/null +++ b/license-mit.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Benjamin Herman + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..8f0adb5 --- /dev/null +++ b/readme.md @@ -0,0 +1,74 @@ +# Vet + +A library for validation of arbitrary types. + +## Usage + +Add a dependency entry in `Cargo.toml`. + +```toml +[dependencies] +vet = "0.1" +``` + +```rust +use vet::{Vet, Vetted}; + +#[derive(Debug)] +struct Username(String); + +#[derive(Debug, PartialEq)] +enum UsernameVetError { + TooShort, + TooLong, + InvalidChar, +} + +impl Vet for Username { + type VetError = UsernameVetError; + fn is_valid(&self) -> Result<(), Self::VetError> { + if self.0.len() < 3 { + return Err(Self::VetError::TooShort); + } + if self.0.len() > 32 { + return Err(Self::VetError::TooLong); + } + if self.0.chars().any(|c| !c.is_alphanumeric()) { + return Err(Self::VetError::InvalidChar); + } + Ok(()) + } +} + +fn main() { + let username = Username(String::from("hi")); + assert_eq!(username.is_valid(), Err(UsernameVetError::TooShort)); + + let username = Username(String::from("benjamin")); + match username.vet() { + Ok(username) => create_account(username), + Err(error) => println!("Could not create account: {:?}", error), + } +} + +fn create_account(username: Vetted) { + println!("Account {:?} created", username); +} +``` + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([license-apache.txt](license-apache.txt) or + http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([license-mit.txt](license-mit.txt) or + http://opensource.org/licenses/MIT) + +at your option. + +## Contribution + +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. diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000..0755672 --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1,2 @@ +edition = "2021" +format_code_in_doc_comments = true \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..bd3bb36 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,116 @@ +//! Provides an interface for validation of arbitrary types. +//! +//! The `Vet` trait requires an implementation of a `VetError` type alias and +//! an `is_valid` method, which executes arbitrary validation logic and returns +//! a result indicating whether the instance is valid. +//! +//! The `Vet` trait also provides a default implementation of a `vet` method +//! which, dependant on the result of `is_valid`, either wraps the instance with +//! a `Vetted` struct or propagates the validation error. +//! +//! The `Vetted` wrapper guarantees that the inner value was successfully +//! validated and remains immutable as long as it is wrapped. +//! +//! Implementations for the common standard library types `Vec` and +//! `Option` are provided. +//! +//! # Examples +//! +//! ``` +//! use vet::{Vet, Vetted}; +//! +//! #[derive(Debug)] +//! struct Username(String); +//! +//! #[derive(Debug, PartialEq)] +//! enum UsernameVetError { +//! TooShort, +//! TooLong, +//! InvalidChar, +//! } +//! +//! impl Vet for Username { +//! type VetError = UsernameVetError; +//! +//! fn is_valid(&self) -> Result<(), Self::VetError> { +//! if self.0.len() < 3 { +//! return Err(Self::VetError::TooShort); +//! } +//! if self.0.len() > 32 { +//! return Err(Self::VetError::TooLong); +//! } +//! if self.0.chars().any(|c| !c.is_alphanumeric()) { +//! return Err(Self::VetError::InvalidChar); +//! } +//! Ok(()) +//! } +//! } +//! +//! fn main() { +//! let username = Username(String::from("hi")); +//! assert_eq!(username.is_valid(), Err(UsernameVetError::TooShort)); +//! +//! let username = Username(String::from("benjamin")); +//! match username.vet() { +//! Ok(username) => create_account(username), +//! Err(error) => println!("Could not create account: {:?}", error), +//! } +//! } +//! +//! fn create_account(username: Vetted) { +//! println!("Account {:?} created", username); +//! } +//! ``` + +use core::ops::Deref; + +/// A wrapper around a validated instance +#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] +pub struct Vetted(T); + +impl Deref for Vetted { + type Target = T; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +/// An interface for arbitrary type validation +pub trait Vet { + /// The error returned by failed validation + type VetError; + + /// Executes arbitrary validation logic on this instance. + fn is_valid(&self) -> Result<(), Self::VetError>; + + /// Validates this instance and results in a wrapped instance if successful. + fn vet(self) -> Result, Self::VetError> + where + Self: Sized, + { + match self.is_valid() { + Ok(()) => Ok(Vetted(self)), + Err(e) => Err(e), + } + } +} + +impl Vet for Option { + type VetError = T::VetError; + + fn is_valid(&self) -> Result<(), Self::VetError> { + match self { + Some(t) => t.is_valid(), + None => Ok(()), + } + } +} + +impl Vet for Vec { + type VetError = T::VetError; + + fn is_valid(&self) -> Result<(), Self::VetError> { + self.iter().try_for_each(|t| t.is_valid()) + } +}