Merge branch 'master' into ulid

Author: cksac

README.md

@@ -328,3 +328,327 @@ This project is licensed under either of
   http://opensource.org/licenses/MIT)
 
 at your option.
+=======
+# Fake
+
+![Rust](https://github.com/cksac/fake-rs/workflows/Rust/badge.svg)
+[![Docs Status](https://docs.rs/fake/badge.svg)](https://docs.rs/fake)
+[![Latest Version](https://img.shields.io/crates/v/fake.svg)](https://crates.io/crates/fake)
+
+A Rust library for generating fake data.
+
+## Installation
+
+Default:
+
+```toml
+[dependencies]
+fake = { version = "2.9.2", features = ["derive"] }
+```
+
+Available features:
+
+- `derive`: if you want to use `#[derive(Dummy)]`
+- supported crates feature flags:
+  - `chrono`
+  - `chrono-tz`
+  - `http`
+  - `uuid`
+  - `bigdecimal` (via `bigdecimal-rs`)
+  - `rust_decimal`
+  - `random_color`
+  - `geo`
+  - `semver`
+  - `serde_json`
+  - `time`
+  - `zerocopy`
+  - `glam`
+- `always-true-rng`: expose AlwaysTrueRng
+- `maybe-non-empty-collections`: allow to use AlwaysTrueRng to generate non-empty collections
+
+## Usage
+
+```rust
+use fake::{Dummy, Fake, Faker};
+use rand::rngs::StdRng;
+use rand::SeedableRng;
+
+#[derive(Debug, Dummy)]
+pub struct Foo {
+    #[dummy(faker = "1000..2000")]
+    order_id: usize,
+    customer: String,
+    paid: bool,
+}
+
+#[derive(Debug, Dummy)]
+struct Bar<T> {
+    field: Vec<T>,
+}
+
+fn main() {
+    // type derived Dummy
+    let f: Foo = Faker.fake();
+    println!("{:?}", f);
+
+    let b: Bar<Foo> = Faker.fake();
+    println!("{:?}", b);
+
+    // using `Faker` to generate default fake value of given type
+    let tuple = Faker.fake::<(u8, u32, f32)>();
+    println!("tuple {:?}", tuple);
+    println!("String {:?}", Faker.fake::<String>());
+
+    // types U can used to generate fake value T, if `T: Dummy<U>`
+    println!("String {:?}", (8..20).fake::<String>());
+    println!("u32 {:?}", (8..20).fake::<u32>());
+
+    // using `faker` module with locales
+    use fake::faker::name::raw::*;
+    use fake::locales::*;
+
+    let name: String = Name(EN).fake();
+    println!("name {:?}", name);
+
+    let name: String = Name(ZH_TW).fake();
+    println!("name {:?}", name);
+
+    // using convenient function without providing locale
+    use fake::faker::lorem::en::*;
+    let words: Vec<String> = Words(3..5).fake();
+    println!("words {:?}", words);
+
+    // using macro to generate nested collection
+    let name_vec = fake::vec![String as Name(EN); 4, 3..5, 2];
+    println!("random nested vec {:?}", name_vec);
+
+    // fixed seed rng
+    let seed = [
+        1, 0, 0, 0, 23, 0, 0, 0, 200, 1, 0, 0, 210, 30, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+        0, 0, 0, 0,
+    ];
+    let ref mut r = StdRng::from_seed(seed);
+    for _ in 0..5 {
+        let v: usize = Faker.fake_with_rng(r);
+        println!("value from fixed seed {}", v);
+    }
+}
+```
+
+# Fakers with locale
+
+## Lorem
+
+```rust
+Word();
+Words(count: Range<usize>);
+Sentence(count: Range<usize>);
+Sentences(count: Range<usize>);
+Paragraph(count: Range<usize>);
+Paragraphs(count: Range<usize>);
+```
+
+## Name
+
+```rust
+FirstName();
+LastName();
+Title();
+Suffix();
+Name();
+NameWithTitle();
+```
+
+## Number
+
+```rust
+Digit();
+NumberWithFormat<'a>(fmt: &'a str);
+```
+
+## Boolean
+
+```rust
+Boolean(ratio: u8);
+```
+
+## Internet
+
+```rust
+FreeEmailProvider();
+DomainSuffix();
+FreeEmail();
+SafeEmail();
+Username();
+Password(len_range: Range<usize>);
+IPv4();
+IPv6();
+IP();
+MACAddress();
+UserAgent();
+```
+
+## HTTP
+
+```rust
+RfcStatusCode();
+ValidStatusCode();
+```
+
+## Color
+
+```rust
+HexColor();
+RgbColor();
+RgbaColor();
+HslColor();
+HslaColor();
+Color();
+```
+
+## Company
+
+```rust
+CompanySuffix();
+CompanyName();
+Buzzword();
+BuzzwordMiddle();
+BuzzwordTail();
+CatchPhase();
+BsVerb();
+BsAdj();
+BsNoun();
+Bs();
+Profession();
+Industry();
+```
+
+## Currency
+
+```rust
+CurrencyCode();
+CurrencyName();
+CurrencySymbol();
+```
+
+## Creditcard
+
+```rust
+CreditCardNumber();
+```
+
+## Address
+
+```rust
+CityPrefix();
+CitySuffix();
+CityName();
+CountryName();
+CountryCode();
+StreetSuffix();
+StreetName();
+TimeZone();
+StateName();
+StateAbbr();
+SecondaryAddressType();
+SecondaryAddress();
+ZipCode();
+PostCode();
+BuildingNumber();
+Latitude();
+Longitude();
+Geohash(precision: u8);
+```
+
+## Administrative
+
+```rust
+HealthInsuranceCode();
+```
+
+## Automotive
+
+```rust
+LicencePlate();
+```
+
+## Barcode
+
+```rust
+Isbn();
+Isbn13();
+Isbn10();
+```
+
+## Phone Number
+
+```rust
+PhoneNumber();
+CellNumber();
+```
+
+## Date/Time
+
+```rust
+Time();
+Date();
+DateTime();
+Duration();
+DateTimeBefore(dt: DateTime<Utc>);
+DateTimeAfter(dt: DateTime<Utc>);
+DateTimeBetween(start: DateTime<Utc>, end: DateTime<Utc>);
+```
+
+## Filesystem
+
+```rust
+FilePath();
+FileName();
+FileExtension();
+DirPath();
+```
+
+### Finance
+
+```rust
+Bic();
+Isin();
+```
+
+### UUID
+
+```rust
+UUIDv1();
+UUIDv3();
+UUIDv4();
+UUIDv5();
+```
+
+### Decimal
+
+```rust
+Decimal();
+PositiveDecimal();
+NegativeDecimal();
+NoDecimalPoints();
+```
+
+### Bigdecimal
+
+```rust
+BigDecimal();
+PositiveBigDecimal();
+NegativeBigDecimal();
+NoBigDecimalPoints();
+```
+
+# LICENSE
+
+This project is licensed under either of
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+  http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or
+  http://opensource.org/licenses/MIT)
+
+at your option.

fake/src/impls/chrono/mod.rs

@@ -33,11 +33,11 @@ impl Dummy<Faker> for Utc {
 impl Dummy<Faker> for FixedOffset {
     fn dummy_with_rng<R: Rng + ?Sized>(_: &Faker, rng: &mut R) -> Self {
         if rng.gen_bool(0.5) {
-            let halfs: i32 = (0..=28).fake_with_rng(rng);
-            FixedOffset::east_opt(halfs * 30 * 60).expect("failed to create FixedOffset")
+            let halves: i32 = (0..=28).fake_with_rng(rng);
+            FixedOffset::east_opt(halves * 30 * 60).expect("failed to create FixedOffset")
         } else {
-            let halfs: i32 = (0..=24).fake_with_rng(rng);
-            FixedOffset::west_opt(halfs * 30 * 60).expect("failed to create FixedOffset")
+            let halves: i32 = (0..=24).fake_with_rng(rng);
+            FixedOffset::west_opt(halves * 30 * 60).expect("failed to create FixedOffset")
         }
     }
 }

fake/src/utils.rs

@@ -1,5 +1,5 @@
 #[cfg(feature = "always-true-rng")]
-mod alway_true_rng {
+mod always_true_rng {
     use rand::{rngs::mock::StepRng, Error, RngCore};
     use rand_core::impls;
 
@@ -58,4 +58,4 @@ mod alway_true_rng {
 }
 
 #[cfg(feature = "always-true-rng")]
-pub use alway_true_rng::AlwaysTrueRng;
+pub use always_true_rng::AlwaysTrueRng;