Merge pull request #3 from mrstebo/feature/number-faker

Feature/number faker

README.md

@@ -13,6 +13,7 @@ Contents
   - [Faker.App](doc/app.md)
   - [Faker.Fake](doc/fake.md)
   - [Faker.Name](doc/name.md)
+  - [Faker.Number](doc/number.md)
   - [Faker.Random](doc/random.md)
 
 ## Installing

appveyor.yml

@@ -37,7 +37,7 @@ after_test:
   - nuget install OpenCover -Version 4.6.519 -OutputDirectory tools
   - nuget install coveralls.net -Version 0.7.0 -OutputDirectory tools
   - ps: >-
-      .\tools\OpenCover.4.6.519\tools\OpenCover.Console.exe -register:user -filter:"+[FakerDotNet*]* -[FakerDotNet.Tests*]*" -target:"C:\Program Files\dotnet\dotnet.exe" -targetargs:"test -f netcoreapp2.0 tests\FakerDotNet.Tests\FakerDotNet.Tests.csproj" -output:opencoverCoverage.xml -mergeoutput -hideskipped:File -oldStyle -searchdirs:tests\FakerDotNet.Tests\bin\$env:CONFIGURATION\netcoreapp2.0
+      .\tools\OpenCover.4.6.519\tools\OpenCover.Console.exe -register:user -filter:"+[FakerDotNet*]* -[FakerDotNet.Tests*]* -[FakerDotNet.Wrappers*]*" -target:"C:\Program Files\dotnet\dotnet.exe" -targetargs:"test -f netcoreapp2.0 tests\FakerDotNet.Tests\FakerDotNet.Tests.csproj" -output:opencoverCoverage.xml -mergeoutput -hideskipped:File -oldStyle -searchdirs:tests\FakerDotNet.Tests\bin\$env:CONFIGURATION\netcoreapp2.0
 
       $coveralls = (Resolve-Path "tools/coveralls.net.*/tools/csmacnz.coveralls.exe").ToString()
 
@@ -55,4 +55,4 @@ deploy:
   - provider: Environment
     name: Public NuGet Feed
     on:
-      appveyor_repo_tag: true
+      appveyor_repo_tag: true

doc/number.md

@@ -0,0 +1,25 @@
+# Faker.Number
+
+```js
+Faker.Number.Number(10) //=> "1968353479"
+
+Faker.Number.LeadingZeroNumber(10) //=> "0669336915"
+
+Faker.Number.Decimal(2) //=> "11.88"
+
+Faker.Number.Decimal(2, 3) //=> "18.843"
+
+Faker.Number.Normal(50, 3.5) //=> 47.14669604069156
+
+Faker.Number.Hexadecimal(3) //=> "e74"
+
+Faker.Number.Between(1, 10) //=> 7
+
+Faker.Number.Positive() //=> 235.59238499107653
+
+Faker.Number.Negative() //=> -4480.042585669558
+
+Faker.Number.NonZeroDigit() //=> "8"
+
+Faker.Number.Digit() //=> "1"
+```

src/FakerDotNet/Data/AppData.cs

@@ -99,4 +99,4 @@ internal class AppData
             "#.#."
         };
     }
-}
+}

src/FakerDotNet/Faker.cs

@@ -9,6 +9,7 @@ public static class Faker
         public static IAppFaker App { get; } = Container.App;
         public static IFakeFaker Fake { get; } = Container.Fake;
         public static INameFaker Name { get; } = Container.Name;
+        public static INumberFaker Number { get; } = Container.Number;
         public static IRandomFaker Random { get; } = Container.Random;
     }
 }

src/FakerDotNet/FakerContainer.cs

@@ -7,22 +7,25 @@ internal interface IFakerContainer
         IAppFaker App { get; }
         IFakeFaker Fake { get; }
         INameFaker Name { get; }
+        INumberFaker Number { get; }
         IRandomFaker Random { get; }
     }
 
     internal class FakerContainer : IFakerContainer
     {
-        public IAppFaker App { get; }
-        public IFakeFaker Fake { get; }
-        public INameFaker Name { get; }
-        public IRandomFaker Random { get; }
-
         public FakerContainer()
         {
             App = new AppFaker(this);
             Fake = new FakeFaker(this);
             Name = new NameFaker(this);
+            Number = new NumberFaker();
             Random = new RandomFaker();
         }
+
+        public IAppFaker App { get; }
+        public IFakeFaker Fake { get; }
+        public INameFaker Name { get; }
+        public INumberFaker Number { get; }
+        public IRandomFaker Random { get; }
     }
 }

src/FakerDotNet/Fakers/AppFaker.cs

@@ -40,4 +40,4 @@ public string Author()
             return $"{_fakerContainer.Name.FirstName()} {_fakerContainer.Name.LastName()}";
         }
     }
-}
+}

src/FakerDotNet/Fakers/FakeFaker.cs

@@ -21,7 +21,7 @@ public FakeFaker(IFakerContainer fakerContainer)
         public string F(string format)
         {
             if (string.IsNullOrEmpty(format)) throw new FormatException("A string must be specified");
-            
+
             var result = format;
             Match match;
             while ((match = Regex.Match(result, @"\{(\w+).(\w+)\}")).Success)
@@ -60,4 +60,4 @@ private static (string faker, string method) ExtractMatchDataFrom(Match match)
             return (className, methodName);
         }
     }
-}
+}

src/FakerDotNet/Fakers/NameFaker.cs

@@ -16,14 +16,14 @@ public interface INameFaker
     internal class NameFaker : INameFaker
     {
         private static readonly NameData Data = new NameData();
-        
+
         private readonly IFakerContainer _fakerContainer;
 
         public NameFaker(IFakerContainer fakerContainer)
         {
             _fakerContainer = fakerContainer;
         }
-        
+
         public string Name()
         {
             return $"{FirstName()} {LastName()}";
@@ -62,4 +62,4 @@ public string Title()
                 _fakerContainer.Random.Element(Data.TitleJobs));
         }
     }
-}
+}

src/FakerDotNet/Fakers/NumberFaker.cs

@@ -0,0 +1,107 @@
+using System;
+using System.Linq;
+using System.Text;
+using FakerDotNet.Wrappers;
+
+namespace FakerDotNet.Fakers
+{
+    public interface INumberFaker
+    {
+        string Number(int digits = 10);
+        string LeadingZeroNumber(int digits = 10);
+        string Decimal(int leftDigits = 5, int rightDigits = 2);
+        double Normal(int mean = 1, int standardDeviation = 1);
+        string Hexadecimal(int digits = 6);
+        double Between(double min, double max);
+        double Within(Range<double> range);
+        double Positive(double from = 1.00D, double to = 5000.00D);
+        double Negative(double from = -5000.00D, double to = -1.00D);
+        string NonZeroDigit();
+        string Digit();
+    }
+
+    internal class NumberFaker : INumberFaker
+    {
+        private readonly IRandomWrapper _randomWrapper;
+
+        public NumberFaker()
+            : this(new RandomWrapper())
+        {
+        }
+
+        internal NumberFaker(IRandomWrapper randomWrapper)
+        {
+            _randomWrapper = randomWrapper;
+        }
+
+        public string Number(int digits = 10)
+        {
+            var sb = new StringBuilder();
+
+            if (digits > 1)
+            {
+                sb.Append(NonZeroDigit());
+                digits--;
+            }
+            sb.Append(LeadingZeroNumber(digits));
+
+            return sb.ToString();
+        }
+
+        public string LeadingZeroNumber(int digits = 10)
+        {
+            return string.Join("", Enumerable.Range(0, digits).Select(_ => _randomWrapper.Next(0, 9)));
+        }
+
+        public string Decimal(int leftDigits = 5, int rightDigits = 2)
+        {
+            return $"{Number(leftDigits)}.{Number(rightDigits)}";
+        }
+
+        public double Normal(int mean = 1, int standardDeviation = 1)
+        {
+            var theta = 2 * Math.PI * _randomWrapper.NextDouble();
+            var rho = Math.Sqrt(-2 * Math.Log(1 - +_randomWrapper.NextDouble()));
+            var scale = standardDeviation * rho;
+            return mean + scale * Math.Cos(theta);
+        }
+
+        public string Hexadecimal(int digits = 6)
+        {
+            return string.Join("", Enumerable.Range(0, digits).Select(_ => int.Parse(Digit()).ToString("X")));
+        }
+
+        public double Between(double min, double max)
+        {
+            var realMin = Math.Min(min, max);
+            var realMax = Math.Max(min, max);
+
+            return _randomWrapper.NextDouble() * (realMax - realMin) + realMin;
+        }
+
+        public double Within(Range<double> range)
+        {
+            return Between(range.Minimum, range.Maximum);
+        }
+
+        public double Positive(double from = 1.00D, double to = 5000.00D)
+        {
+            return Between(from, to);
+        }
+
+        public double Negative(double from = -5000.00D, double to = -1.00D)
+        {
+            return Between(from, to);
+        }
+
+        public string NonZeroDigit()
+        {
+            return Convert.ToString(_randomWrapper.Next(1, 9));
+        }
+
+        public string Digit()
+        {
+            return Convert.ToString(_randomWrapper.Next(0, 9));
+        }
+    }
+}

src/FakerDotNet/Fakers/RandomFaker.cs

@@ -12,7 +12,7 @@ public interface IRandomFaker
     internal class RandomFaker : IRandomFaker
     {
         private static readonly Random RNG = new Random();
-        
+
         public T Element<T>(IEnumerable<T> collection)
         {
             // ReSharper disable PossibleMultipleEnumeration
@@ -22,4 +22,4 @@ public T Element<T>(IEnumerable<T> collection)
             // ReSharper restore PossibleMultipleEnumeration
         }
     }
-}
+}

src/FakerDotNet/Properties/AssemblyInfo.cs

@@ -14,4 +14,4 @@
 [assembly: AssemblyFileVersion("1.0.0.0")]
 
 [assembly: InternalsVisibleTo("FakerDotNet.Tests")]
-[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2")]
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2")]

src/FakerDotNet/Range.cs

@@ -0,0 +1,14 @@
+namespace FakerDotNet
+{
+    public sealed class Range<T> where T : struct
+    {
+        public T Minimum { get; }
+        public T Maximum { get; }
+
+        public Range(T minimum, T maximum)
+        {
+            Minimum = minimum;
+            Maximum = maximum;
+        }
+    }
+}

src/FakerDotNet/Wrappers/RandomWrapper.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+
+namespace FakerDotNet.Wrappers
+{
+    internal interface IRandomWrapper
+    {
+        int Next(int min, int max);
+        double NextDouble();
+    }
+
+    [ExcludeFromCodeCoverage]
+    internal class RandomWrapper : IRandomWrapper
+    {
+        private static readonly Random RandomInstance = new Random();
+
+        public int Next(int min, int max) => RandomInstance.Next(min, max);
+
+        public double NextDouble() => RandomInstance.NextDouble();
+    }
+}

tests/FakerDotNet.Tests/FakerContainerTests.cs

@@ -33,6 +33,12 @@ public void Name_returns_INameFaker()
             Assert.IsInstanceOf<INameFaker>(_fakerContainer.Name);
         }
 
+        [Test]
+        public void Number_returns_INumberFaker()
+        {
+            Assert.IsInstanceOf<INumberFaker>(_fakerContainer.Number);
+        }
+
         [Test]
         public void Random_returns_IRandomFaker()
         {

tests/FakerDotNet.Tests/FakerTests.cs

@@ -25,6 +25,12 @@ public void Name_returns_INameFaker()
             Assert.IsInstanceOf<INameFaker>(Faker.Name);
         }
 
+        [Test]
+        public void Number_returns_INumberFaker()
+        {
+            Assert.IsInstanceOf<INumberFaker>(Faker.Number);
+        }
+
         [Test]
         public void Random_returns_IRandomFaker()
         {

tests/FakerDotNet.Tests/Fakers/AppFakerTests.cs

@@ -11,22 +11,32 @@ namespace FakerDotNet.Tests.Fakers
     [Parallelizable]
     public class AppFakerTests
     {
-        private static readonly AppData Data = new AppData();
-
         [SetUp]
         public void SetUp()
         {
             _fakerContainer = A.Fake<IFakerContainer>();
             _appFaker = new AppFaker(_fakerContainer);
         }
 
+        private static readonly AppData Data = new AppData();
+
         private IFakerContainer _fakerContainer;
         private IAppFaker _appFaker;
 
+        [Test]
+        public void Author_returns_a_full_name()
+        {
+            A.CallTo(() => _fakerContainer.Name.FirstName()).Returns("John");
+            A.CallTo(() => _fakerContainer.Name.LastName()).Returns("Smith");
+
+            Assert.AreEqual("John Smith", _appFaker.Author());
+        }
+
         [Test]
         public void Name_returns_a_name()
         {
-            A.CallTo(() => _fakerContainer.Random.Element(A<IEnumerable<string>>.That.IsSameSequenceAs(Data.Names)))
+            A.CallTo(() => _fakerContainer.Random.Element(
+                    A<IEnumerable<string>>.That.IsSameSequenceAs(Data.Names)))
                 .Returns("My App");
 
             Assert.AreEqual("My App", _appFaker.Name());
@@ -37,21 +47,14 @@ public void Version_returns_a_formatted_version()
         {
             var numbers = Enumerable.Range(0, 9);
 
-            A.CallTo(() => _fakerContainer.Random.Element(A<IEnumerable<string>>.That.IsSameSequenceAs(Data.Versions)))
+            A.CallTo(() => _fakerContainer.Random.Element(
+                    A<IEnumerable<string>>.That.IsSameSequenceAs(Data.Versions)))
                 .Returns("0.#.#");
-            A.CallTo(() => _fakerContainer.Random.Element(A<IEnumerable<int>>.That.IsSameSequenceAs(numbers)))
+            A.CallTo(() => _fakerContainer.Random.Element(
+                    A<IEnumerable<int>>.That.IsSameSequenceAs(numbers)))
                 .ReturnsNextFromSequence(1, 2);
 
             Assert.AreEqual("0.1.2", _appFaker.Version());
         }
-
-        [Test]
-        public void Author_returns_a_full_name()
-        {
-            A.CallTo(() => _fakerContainer.Name.FirstName()).Returns("John");
-            A.CallTo(() => _fakerContainer.Name.LastName()).Returns("Smith");
-
-            Assert.AreEqual("John Smith", _appFaker.Author());
-        }
     }
 }