diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | Cargo.toml | 6 | ||||
| -rw-r--r-- | LICENSE-APACHE | 201 | ||||
| -rw-r--r-- | LICENSE-MIT | 19 | ||||
| -rw-r--r-- | README.md | 29 | ||||
| -rw-r--r-- | derive-macro/Cargo.toml | 21 | ||||
| -rw-r--r-- | derive-macro/src/handle_enum.rs | 55 | ||||
| -rw-r--r-- | derive-macro/src/handle_struct.rs | 15 | ||||
| -rw-r--r-- | derive-macro/src/lib.rs | 46 | ||||
| -rw-r--r-- | lib/Cargo.toml | 19 | ||||
| -rw-r--r-- | lib/src/lib.rs | 130 | ||||
| -rw-r--r-- | tests/Cargo.toml | 11 | ||||
| -rw-r--r-- | tests/src/lib.rs | 130 |
13 files changed, 684 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..96ef6c0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..28a26f5 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,6 @@ +[workspace] +members = [ + "lib", + "derive-macro", + "tests", +] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -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 [yyyy] [name of copyright owner] + +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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..83e9656 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) 2016 Alexander van Ratingen + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2458ae --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Generate-Random + +Generate random data. + +## Example + +```rust +use generate_random::GenerateRandom; + +#[derive(GenerateRandom)] +enum MyEnum { + A, + C(bool), + B { + x: u8, + }, + // Providing a weight allows changing the probabilities. + // This variant is now twice as likely to be generated as the others. + #[weight(2)] + D, +} + +let mut rng = rand::thread_rng(); +let my_value = MyEnum::generate_random(&mut rng); +``` + +## Documentation + +[Documentation](https://lib.rs/crates/generate-random) diff --git a/derive-macro/Cargo.toml b/derive-macro/Cargo.toml new file mode 100644 index 0000000..24bfa19 --- /dev/null +++ b/derive-macro/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "generate-random-macro" +version = "0.1.0" +edition = "2021" +license = "MIT OR Apache-2.0" +authors = ["Alexander van Ratingen"] +homepage = "https://github.com/alvra/generate-random" +repository = "https://github.com/alvra/generate-random" +documentation = "https://docs.rs/generate-random" +description = "Generate random data" +readme = "README.md" +keywords = ["random"] + +[lib] +proc-macro = true + +[dependencies] +proc-macro2 = "1.0" +syn = { version = "1.0", features = ["full", "extra-traits"] } +quote = "1.0" +proc_macro2_helper = "0.2" diff --git a/derive-macro/src/handle_enum.rs b/derive-macro/src/handle_enum.rs new file mode 100644 index 0000000..b2b14c0 --- /dev/null +++ b/derive-macro/src/handle_enum.rs @@ -0,0 +1,55 @@ +use proc_macro2::{Ident, Literal, TokenStream}; +use quote::quote; +use syn::{DataEnum, Variant}; +use super::generate_fields; + +fn variant_weight(variant: &Variant) -> Literal { + for attr in variant.attrs.iter() { + if attr.path.is_ident("weight") { + return attr.parse_args::<Literal>().expect("expected literal for `#[weight(...)]`") + } + } + Literal::u64_suffixed(1) +} + +pub fn generate(name: &Ident, ty: DataEnum) -> TokenStream { + let mut variant_weights = ty.variants.into_iter() + .map(|variant| (variant_weight(&variant), variant)); + + let mut arms = TokenStream::new(); + let mut total_weight = quote! { 0 }; + if let Some((weight, variant)) = variant_weights.next() { + let variant_name = variant.ident; + let fields = generate_fields(variant.fields); + arms.extend(quote! { + let end = #weight; + if 0 <= value && value < end { + return Self::#variant_name #fields + } + }); + total_weight = quote! { #weight }; + for (weight, variant) in variant_weights { + let variant_name = variant.ident; + let fields = generate_fields(variant.fields); + arms.extend(quote! { + let start = end; + let end = start + #weight; + if start <= value && value < end { + return Self::#variant_name #fields + } + }); + total_weight = quote! { #total_weight + #weight }; + } + } + + quote! { + impl generate_random::GenerateRandom for #name { + fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self { + let total_weight = #total_weight; + let value = rng.gen_range(0..total_weight); + #arms + unreachable!() + } + } + } +} diff --git a/derive-macro/src/handle_struct.rs b/derive-macro/src/handle_struct.rs new file mode 100644 index 0000000..988bd06 --- /dev/null +++ b/derive-macro/src/handle_struct.rs @@ -0,0 +1,15 @@ +use proc_macro2::{Ident, TokenStream}; +use quote::quote; +use syn::DataStruct; +use super::generate_fields; + +pub fn generate(name: &Ident, ty: DataStruct) -> TokenStream { + let fields = generate_fields(ty.fields); + quote! { + impl generate_random::GenerateRandom for #name { + fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self { + Self #fields + } + } + } +} diff --git a/derive-macro/src/lib.rs b/derive-macro/src/lib.rs new file mode 100644 index 0000000..9aa93f5 --- /dev/null +++ b/derive-macro/src/lib.rs @@ -0,0 +1,46 @@ +//! This crate provide the [`GenerateRandom`] derive macro +//! that implements the trait of the same name from the `generate-random` crate. +//! Refer to the documentation of that crate for more information. + +use syn::{DeriveInput, Data, Fields}; + +mod handle_struct; +mod handle_enum; + +#[proc_macro_derive(GenerateRandom, attributes(weight))] +pub fn derive_generate_random(input: proc_macro::TokenStream) -> proc_macro::TokenStream { + let input: DeriveInput = syn::parse(input).unwrap(); + match input.data { + Data::Struct(ty) => handle_struct::generate(&input.ident, ty), + Data::Enum(ty) => handle_enum::generate(&input.ident, ty), + Data::Union(_) => panic!("Unions are not supported"), + }.into() +} + +fn generate_fields(fields: Fields) -> proc_macro2::TokenStream { + use quote::quote; + match fields { + Fields::Named(fields) => { + let fields = fields.named.into_iter() + .map(|field| { + let field = field.ident.unwrap(); + quote! { + #field: generate_random::GenerateRandom::generate_random(rng), + } + }) + .collect::<proc_macro2::TokenStream>(); + quote! { { #fields } } + } + Fields::Unnamed(fields) => { + let fields = fields.unnamed.into_iter() + .map(|_field| { + quote! { + generate_random::GenerateRandom::generate_random(rng), + } + }) + .collect::<proc_macro2::TokenStream>(); + quote! { ( #fields ) } + } + Fields::Unit => quote! {}, + } +} diff --git a/lib/Cargo.toml b/lib/Cargo.toml new file mode 100644 index 0000000..8050d42 --- /dev/null +++ b/lib/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "generate-random" +version = "0.1.0" +edition = "2021" +license = "MIT OR Apache-2.0" +authors = ["Alexander van Ratingen"] +homepage = "https://github.com/alvra/generate-random" +repository = "https://github.com/alvra/generate-random" +documentation = "https://docs.rs/generate-random" +description = "Generate random data" +readme = "README.md" +keywords = ["random"] + +[dependencies] +rand = "0.8.5" +generate-random-macro = { path = "../derive-macro" } + +[dev-dependencies] +rand_chacha = "0.3.1" diff --git a/lib/src/lib.rs b/lib/src/lib.rs new file mode 100644 index 0000000..40f02e9 --- /dev/null +++ b/lib/src/lib.rs @@ -0,0 +1,130 @@ +//! Generate random data. +//! +//! # Examples +//! +//! ``` +//! use generate_random::GenerateRandom; +//! +//! #[derive(GenerateRandom)] +//! enum MyEnum { +//! A, +//! C(bool), +//! B { +//! x: u8, +//! }, +//! // Providing a weight allows changing the probabilities. +//! // This variant is now twice as likely to be generated as the others. +//! #[weight(2)] +//! D, +//! } +//! +//! let mut rng = rand::thread_rng(); +//! let my_value = MyEnum::generate_random(&mut rng); +//! ``` + +/// This derive macro provides an implementation +/// of the [`trait@GenerateRandom`] trait. +/// +/// Enum variants can be given a `weight` attribute +/// to change how often it is generated. +/// By default, the weight is `1`. +/// The probability of a variants is its weight +/// divided by the sum over all variants. +pub use generate_random_macro::GenerateRandom; + +/// Enable randomly generating values of a type. +/// +/// This trait can be implemented using the derive +/// macro of the same name: [`macro@GenerateRandom`]. +pub trait GenerateRandom { + /// Create a new random value of this type. + fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self; +} + +macro_rules! impl_generate_random { + ( $( $t:ty, )+ ) => { + $( + impl GenerateRandom for $t { + fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self { + rng.gen() + } + } + )+ + } +} + +impl_generate_random! { + bool, + char, + u8, + i8, + u16, + i16, + u32, + i32, + u64, + i64, + u128, + i128, + usize, + isize, + f32, + f64, +} + +impl<T: GenerateRandom> GenerateRandom for Option<T> { + fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self { + if bool::generate_random(rng) { + Some(T::generate_random(rng)) + } else { + None + } + } +} + +macro_rules! impl_generate_random_tuple { + ( $t0:ident $( $t:ident )* ) => { + impl< $t0, $( $t, )* > GenerateRandom for ( $t0, $( $t, )* ) + where + $t0: GenerateRandom, + $( + $t: GenerateRandom, + )* + { + fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self { + ( + $t0::generate_random(rng), + $( + $t::generate_random(rng), + )* + ) + } + } + impl_generate_random_tuple!( $( $t )* ); + }; + () => { + impl GenerateRandom for () { + fn generate_random<R: rand::Rng + ?Sized>(_rng: &mut R) -> Self { + () + } + } + } +} + +impl_generate_random_tuple!(A B C D E F G H I J K L); + +#[cfg(test)] +mod tests { + use super::*; + + fn rng() -> impl rand::Rng { + use rand::SeedableRng; + rand_chacha::ChaCha8Rng::from(rand_chacha::ChaCha8Core::from_seed([37; 32])) + } + + #[test] + fn test_u8() { + let mut rng = rng(); + assert_eq!(u8::generate_random(&mut rng), 55); + } +} diff --git a/tests/Cargo.toml b/tests/Cargo.toml new file mode 100644 index 0000000..efdbef6 --- /dev/null +++ b/tests/Cargo.toml @@ -0,0 +1,11 @@ +[package] +name = "generate-random-tests" +version = "0.0.0" +edition = "2021" +publish = false + +[dependencies] +generate-random = { path = "../lib" } +generate-random-macro = { path = "../derive-macro" } +rand = "0.8.5" +rand_chacha = "0.3.1" diff --git a/tests/src/lib.rs b/tests/src/lib.rs new file mode 100644 index 0000000..c60fbc5 --- /dev/null +++ b/tests/src/lib.rs @@ -0,0 +1,130 @@ +#[cfg(test)] +mod tests { + use generate_random::GenerateRandom; + + fn rng() -> impl rand::Rng { + use rand::SeedableRng; + rand_chacha::ChaCha8Rng::from(rand_chacha::ChaCha8Core::from_seed([37; 32])) + } + + fn repeat<T>(count: usize, f: impl FnMut() -> T) -> Vec<T> { + std::iter::repeat_with(f).take(count).collect() + } + + #[derive(GenerateRandom, PartialEq, Eq, Debug)] + enum TestEnumUnit { + Left, + #[weight(2)] + Right, + } + + #[derive(GenerateRandom, PartialEq, Eq, Debug)] + enum TestEnumUnnamed { + Left(u8), + #[weight(2)] + Right(bool), + } + + #[derive(GenerateRandom, PartialEq, Eq, Debug)] + enum TestEnumNamed { + Left { x: u8 }, + #[weight(2)] + Right { y: bool }, + } + + #[derive(GenerateRandom, PartialEq, Eq, Debug)] + struct TestStructUnit; + + #[derive(GenerateRandom, PartialEq, Eq, Debug)] + struct TestStructUnnamed(u8, i32); + + #[derive(GenerateRandom, PartialEq, Eq, Debug)] + struct TestStructNamed { + x: u8, + y: i32, + } + + #[test] + fn test_enum_unit() { + let mut rng = rng(); + assert_eq!( + repeat( + 6, + || TestEnumUnit::generate_random(&mut rng), + ), + vec![ + TestEnumUnit::Right, + TestEnumUnit::Right, + TestEnumUnit::Left, + TestEnumUnit::Right, + TestEnumUnit::Right, + TestEnumUnit::Right, + ]); + } + + #[test] + fn test_enum_unnamed() { + let mut rng = rng(); + assert_eq!( + repeat( + 6, + || TestEnumUnnamed::generate_random(&mut rng), + ), + vec![ + TestEnumUnnamed::Right(false), + TestEnumUnnamed::Left(142), + TestEnumUnnamed::Right(false), + TestEnumUnnamed::Right(true), + TestEnumUnnamed::Right(false), + TestEnumUnnamed::Left(19), + ]); + } + + #[test] + fn test_enum_named() { + let mut rng = rng(); + assert_eq!( + repeat( + 6, + || TestEnumNamed::generate_random(&mut rng), + ), + vec![ + TestEnumNamed::Right { y: false }, + TestEnumNamed::Left { x: 142 }, + TestEnumNamed::Right { y: false }, + TestEnumNamed::Right { y: true }, + TestEnumNamed::Right { y: false }, + TestEnumNamed::Left { x: 19 }, + ]); + } + + #[test] + fn test_struct_unit() { + let mut rng = rng(); + assert_eq!( + TestStructUnit::generate_random(&mut rng), + TestStructUnit + ); + } + + #[test] + fn test_struct_unnamed() { + let mut rng = rng(); + assert_eq!( + TestStructUnnamed::generate_random(&mut rng), + TestStructUnnamed(55, -896102575) + ); + } + + #[test] + fn test_struct_named() { + let mut rng = rng(); + assert_eq!( + TestStructNamed::generate_random(&mut rng), + TestStructNamed { + x: 55, + y: -896102575, + } + ); + } +} |