Merge pull request #32 from daemon3000/random-seed

Seed support for random generator
drager · Jan 10, 2021 · 91b1f0e · 91b1f0e
2 parents 63ed4c3 + ae09db9
commit 91b1f0e
Show file tree

Hide file tree

Showing 18 changed files with 143 additions and 58 deletions.
diff --git a/example/faker.dart b/example/faker.dart
@@ -3,6 +3,9 @@ library faker.example;
 import 'package:faker/faker.dart';
 
 void main() {
+  // final random = RandomGenerator(seed: 63833423);
+  // final faker = Faker.withGenerator(random);
+
   // Generate some different types of data.
   print(faker.address.country());
   print(faker.company.name());
@@ -28,7 +31,7 @@ void main() {
   print(faker.internet.userAgent(osName: 'iOS'));
 
   // Generate localized Farsi lorem text
-  var fakerFa = Faker(FakerDataProviderFa());
+  final fakerFa = Faker(provider: FakerDataProviderFa());
   print(fakerFa.lorem.word());
   print(fakerFa.lorem.sentence());
   print(fakerFa.lorem.words(10).join(' '));

diff --git a/lib/src/address.dart b/lib/src/address.dart
@@ -4,14 +4,18 @@ import 'data/address/countries.dart';
 import 'data/address/country_codes.dart';
 import 'data/address/neighborhoods.dart';
 import 'data/address/street_suffixes.dart';
-import 'faker.dart';
+import 'person.dart';
 import 'random_generator.dart';
 
 class Address {
   static const compassDirections = ['North', 'East', 'West', 'South'];
   static const cityPrefixes = ['New', 'Lake', 'Port'];
 
-  const Address();
+  const Address(this.person);
+
+  final Person person;
+
+  RandomGenerator get random => person.random;
 
   /// Generates a zip code.
   ///
@@ -30,15 +34,15 @@ class Address {
   String city() {
     switch (random.integer(4)) {
       case 0:
-        return '${cityPrefix()} ${faker.person.firstName()}${citySuffix()}';
+        return '${cityPrefix()} ${person.firstName()}${citySuffix()}';
       case 1:
-        return '${cityPrefix()} ${faker.person.firstName()}';
+        return '${cityPrefix()} ${person.firstName()}';
       case 2:
-        return '${faker.person.firstName()}${citySuffix()}';
+        return '${person.firstName()}${citySuffix()}';
       case 3:
-        return '${faker.person.lastName()}${citySuffix()}';
+        return '${person.lastName()}${citySuffix()}';
       default:
-        return '${faker.person.lastName()}${citySuffix()}';
+        return '${person.lastName()}${citySuffix()}';
     }
   }
 
@@ -68,8 +72,8 @@ class Address {
   ///   faker.address.streetName();
   /// ```
   String streetName() => random.integer(2) == 0
-      ? '${Faker().person.lastName()} ${streetSuffix()}'
-      : '${Faker().person.firstName()} ${streetSuffix()}';
+      ? '${person.lastName()} ${streetSuffix()}'
+      : '${person.firstName()} ${streetSuffix()}';
 
   /// Generates a street address.
   ///

diff --git a/lib/src/company.dart b/lib/src/company.dart
@@ -1,4 +1,4 @@
-import 'faker.dart';
+import 'person.dart';
 import 'random_generator.dart';
 
 class Company {
@@ -30,7 +30,11 @@ class Company {
     'Division'
   ];
 
-  const Company();
+  const Company(this.person);
+
+  final Person person;
+
+  RandomGenerator get random => person.random;
 
   /// Generates a company name.
   ///
@@ -41,14 +45,14 @@ class Company {
   String name() {
     switch (random.integer(3)) {
       case 0:
-        return '${faker.person.lastName()} ${suffix()}';
+        return '${person.lastName()} ${suffix()}';
       case 1:
-        return '${faker.person.lastName()}-${faker.person.lastName()}';
+        return '${person.lastName()}-${person.lastName()}';
       case 2:
-        return '${faker.person.lastName()}, ${faker.person.lastName()} '
-            'and ${faker.person.lastName()}';
+        return '${person.lastName()}, ${person.lastName()} '
+            'and ${person.lastName()}';
       default:
-        return '${faker.person.lastName()} ${suffix()}';
+        return '${person.lastName()} ${suffix()}';
     }
   }
 

diff --git a/lib/src/conference.dart b/lib/src/conference.dart
@@ -2,7 +2,9 @@ import 'data/conference/conference_names.dart';
 import 'random_generator.dart';
 
 class Conference {
-  const Conference();
+  const Conference(this.random);
+
+  final RandomGenerator random;
 
   /// Generates a conference name.
   ///

diff --git a/lib/src/currency.dart b/lib/src/currency.dart
@@ -3,7 +3,9 @@ import 'data/currency/currency_names.dart';
 import 'random_generator.dart';
 
 class Currency {
-  const Currency();
+  const Currency(this.random);
+
+  final RandomGenerator random;
 
   /// Generates a currency code.
   ///

diff --git a/lib/src/date.dart b/lib/src/date.dart
@@ -2,7 +2,9 @@ import 'data/date_time/time_zones.dart';
 import 'random_generator.dart';
 
 class Date {
-  const Date();
+  const Date(this.random);
+
+  final RandomGenerator random;
 
   static final _yearSuffixes = [
     'BC',

diff --git a/lib/src/faker.dart b/lib/src/faker.dart
@@ -18,7 +18,7 @@ import 'providers/base_providers.dart';
 import 'random_generator.dart';
 import 'sport.dart';
 
-final Faker faker = Faker();
+final Faker faker = Faker.withGenerator(random);
 
 class Faker {
   final Address address;
@@ -37,23 +37,24 @@ class Faker {
   final Date date;
   final RandomGenerator randomGenerator;
 
-  Faker([FakerDataProvider provider])
-      : address = const Address(),
-        conference = const Conference(),
-        company = const Company(),
-        currency = const Currency(),
-        food = const Food(),
-        guid = const Guid(),
-        image = const Image(),
-        internet = const Internet(),
-        job = const Job(),
-        lorem =
-            Lorem(provider?.loremDataProvider ?? DefaultLoremDataProvider()),
-        person = const Person(),
-        phoneNumber = const PhoneNumber(),
-        sport = const Sport(),
-        date = const Date(),
-        randomGenerator = const RandomGenerator();
+  Faker.withGenerator(RandomGenerator random, {FakerDataProvider provider})
+      : address = Address(Person(random)),
+        conference = Conference(random),
+        company = Company(Person(random)),
+        currency = Currency(random),
+        food = Food(random),
+        guid = Guid(random),
+        image = Image(),
+        internet = Internet(random),
+        job = Job(random),
+        lorem = Lorem(random, provider?.loremDataProvider ?? DefaultLoremDataProvider()),
+        person = Person(random),
+        sport = Sport(random),
+        date = Date(random),
+        phoneNumber = PhoneNumber(random),
+        randomGenerator = random;
+
+  factory Faker({int seed, FakerDataProvider provider}) => Faker.withGenerator(RandomGenerator(seed: seed), provider: provider);
 }
 
 class FakerDataProvider {

diff --git a/lib/src/food.dart b/lib/src/food.dart
@@ -4,7 +4,9 @@ import 'data/food/restaurants.dart';
 import 'random_generator.dart';
 
 class Food {
-  const Food();
+  const Food(this.random);
+
+  final RandomGenerator random;
 
   /// Generates a restaurant.
   ///

diff --git a/lib/src/guid.dart b/lib/src/guid.dart
@@ -1,7 +1,9 @@
 import 'random_generator.dart';
 
 class Guid {
-  const Guid();
+  const Guid(this.random);
+
+  final RandomGenerator random;
 
   String guid() =>
       random.fromPatternToHex(['########-####-####-####-############']);

diff --git a/lib/src/internet.dart b/lib/src/internet.dart
@@ -1,4 +1,3 @@
-import '../faker.dart';
 import 'data/person/firstnames.dart';
 import 'data/user_agent/user_agent.dart';
 import 'data/user_agent/user_agent_data.dart';
@@ -24,7 +23,9 @@ class Internet {
     'safetymail.info'
   ];
 
-  const Internet();
+  const Internet(this.random);
+
+  final RandomGenerator random;
 
   /// Generates an email from the [userName] and [domainName] methods.
   ///

diff --git a/lib/src/job.dart b/lib/src/job.dart
@@ -4,7 +4,9 @@ import 'data/job/job_prefix.dart';
 import 'random_generator.dart';
 
 class Job {
-  const Job();
+  const Job(this.random);
+
+  final RandomGenerator random;
 
   /// Generates a job title.
   ///

diff --git a/lib/src/lorem.dart b/lib/src/lorem.dart
@@ -2,9 +2,10 @@ import 'package:faker/src/providers/base_providers.dart';
 import 'random_generator.dart';
 
 class Lorem {
-  final LoremDataProvider _provider;
+  const Lorem(this.random, this._provider);
 
-  const Lorem(this._provider);
+  final RandomGenerator random;
+  final LoremDataProvider _provider;
 
   /// Generates a word.
   ///

diff --git a/lib/src/person.dart b/lib/src/person.dart
@@ -19,7 +19,9 @@ class Person {
     'DVM'
   ];
 
-  const Person();
+  const Person(this.random);
+
+  final RandomGenerator random;
 
   /// Generates a name.
   ///

diff --git a/lib/src/phone_number.dart b/lib/src/phone_number.dart
@@ -1,4 +1,4 @@
-import 'package:faker/faker.dart';
+import 'random_generator.dart';
 
 class PhoneNumber {
   static const usPhoneNumberPatterns = [
@@ -37,7 +37,9 @@ class PhoneNumber {
     '001-###-###-####x#####',
   ];
 
-  const PhoneNumber();
+  const PhoneNumber(this.random);
+
+  final RandomGenerator random;
 
   String us() => random.fromPattern(usPhoneNumberPatterns);
 }
diff --git a/lib/src/random_generator.dart b/lib/src/random_generator.dart
@@ -1,15 +1,16 @@
 import 'dart:math';
 
-var _rng = Random();
-
-const random = RandomGenerator();
+final random = RandomGenerator();
 
 class RandomGenerator {
-  const RandomGenerator();
+  RandomGenerator({int seed}):
+    _random = Random(seed);
+
+  final Random _random;
 
   /// Plucks a random element from the given [list].
   T element<T>(List<T> list) {
-    return list[_rng.nextInt(list.length)];
+    return list[_random.nextInt(list.length)];
   }
 
   /// Generates a random number from the [max] value
@@ -20,7 +21,7 @@ class RandomGenerator {
     var number = <int>[];
 
     for (var i = 0; i < times; i++) {
-      number.add(_rng.nextInt(max));
+      number.add(_random.nextInt(max));
     }
     return number;
   }
@@ -35,15 +36,15 @@ class RandomGenerator {
   ///   random.integer(10, min: 5);
   ///   ```
   int integer(int max, {int min = 0}) =>
-      max == min ? max : _rng.nextInt(max - min) + min;
+      max == min ? max : _random.nextInt(max - min) + min;
 
   /// Generates a random boolean.
-  bool boolean() => _rng.nextBool();
+  bool boolean() => _random.nextBool();
 
   /// Generates a random decimal.
   /// Accepts a [scale] and a [min] value.
   double decimal({num scale = 1, num min = 0}) =>
-      _rng.nextDouble() * scale + min;
+      _random.nextDouble() * scale + min;
 
   /// Generates a random string with the given [max] value
   /// and to the lowest [min] value if provided.

diff --git a/lib/src/sport.dart b/lib/src/sport.dart
@@ -2,7 +2,9 @@ import 'data/sport/sport_names.dart';
 import 'random_generator.dart';
 
 class Sport {
-  const Sport();
+  const Sport(this.random);
+
+  final RandomGenerator random;
 
   /// Generates a sport name.
   ///

diff --git a/test/runner.dart b/test/runner.dart
@@ -12,6 +12,7 @@ import 'specs/lorem.dart' as lorem;
 import 'specs/person.dart' as person;
 import 'specs/phone_number.dart' as phoneNumber;
 import 'specs/random_generator.dart' as random;
+import 'specs/seed.dart' as seed;
 import 'specs/sport.dart' as sport;
 
 void main() {
@@ -30,4 +31,5 @@ void main() {
   sport.main();
   date.main();
   random.main();
+  seed.main();
 }