Merge pull request #20 from bolorundurowb/feature/#6/fix-random-usages

feature/fix random usages

README.md

@@ -4,20 +4,35 @@
 
 ## About ShortId
 
-A CSharp library to generate completely random short id's. They can be used as primary keys or unique identifiers. This library is different in that you can specify the length of the id's generated. I have tested the application generating 180000 id's without duplicates.
+A CSharp library to generate completely random short id's. They can be used as primary keys or unique identifiers. This library is different in that you can specify the length of the ids to be generated. This library is thread-safe and can generate millions of unique ids across multiple threads.
 
-## How to use
+## Getting Started
 
 To make use of the `shortid`, add it to your project via the Nuget package manager UI or console via this command:
 
+#### Package Manager
+
 ```
 Install-Package shortid
 ```
 
+#### .NET CLI
+```
+> dotnet add package shortid
+```
+
+#### PackageReference
+```csharp
+<PackageReference Include="shortid" />
+```
+
+## Usage
+
 Add the following using command to the top of your csharp code file:
 
 ```csharp
 using shortid;
+using shortid.Configuration;
 ```
 
 This gives your code access the classes and methods of the `shortid` namespace.
@@ -29,36 +44,39 @@ string id = ShortId.Generate();
 // id = KXTR_VzGVUoOY
 ```
 
-If you want to include numbers in the generated id, then you call the `Generate` method with a boolean indicating your preference.
+If you want to include numbers in the generated id, then you call the `Generate` method with options indicating your preference.
 
 ```csharp
-string id = ShortId.Generate(true);
+var options = new GenerationOptions
+{
+  UseNumbers = true
+};
+string id = ShortId.Generate(options);
 // id = O_bBY-YUkJg
 ```
 
-If you do not want special characters *i.e _ and -* in your generated id, then call the `Generate` method with two boolean parameters, the first indicating whether or not you want numbers and the second indicating whether or not you want special characeters.
+If you do not want special characters *i.e _ and -* in your generated id, then call the `Generate` method with options indicating your preferences.
 
 ```csharp
-string id = ShortId.Generate(true, false);
+var options = new GenerationOptions
+{
+  UseSpecialCharacters = false
+};
+string id = ShortId.Generate(options);
 // id = waBfk3z
 ```
 
-If you want to specify the length of the generated id, call the `Generate` method with an integer parameter which is the desired length.
+If you want to specify the length of the generated id, call the `Generate` method with options indicating your preferences.
 
 ```csharp
-string id = ShortId.Generate(8);
-// id = M-snXzBk
+var options = new GenerationOptions
+{
+  Length = 9
+};
+string id = ShortId.Generate(options);
+// id = M-snXzBkj
 ```
 
-If you want to control the type of id generated by specifying whether you want numbers, special characters and the length, call the `Generate` method and pass three parameters, the first a boolean stating whether you want numbers, the second a boolean stating whether you want special characters, the last a number indicating your length preference.
-
-```csharp
-string id = ShortId.Generate(true, false, 12);
-// id = VvoCDPazES_w
-```
-
-**NOTE: v2.0.0 introduced a change that prevents lengths of less than 7**
-
 
 ## Customize ShortId
 
@@ -67,11 +85,11 @@ string id = ShortId.Generate(true, false, 12);
 To change the character set in use, run the following:
 
 ```csharp
-string characters = //whatever you want;
+string characters = "ⒶⒷⒸⒹⒺⒻⒼⒽⒾⒿⓀⓁⓂⓃⓄⓅⓆⓇⓈⓉⓊⓋⓌⓍⓎⓏⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙⓚⓛⓜⓝⓞⓟⓠⓡⓢⓣⓤⓥⓦⓧⓨⓩ①②③④⑤⑥⑦⑧⑨⑩⑪⑫"; //whatever you want;
 ShortId.SetCharacters(characters);
 ```
 
-**NOTE: the new character set must not be `null`, an empty string or whitespace. Also, all whitespace characters would be removed, finally the character set cannot be less than 20 characters.**
+**NOTE: the new character set must not be `null`, an empty string or whitespace. Also, all whitespace and duplicate characters would be removed, finally the character set cannot be less than 20 characters.**
 
 `ShortId` also allows the seed for the random number generator to be set.
 
@@ -86,4 +104,4 @@ Finally, `ShortId` allows for all customizations to be reset using the following
 
 ```csharp
 ShortId.Reset();
-```
+```

shortid.Test/Configuration/GenerationOptions.Tests.cs

@@ -33,7 +33,7 @@ public void ShouldAssignRandomLengthOnInstantiation()
             options
                 .Length
                 .Should()
-                .BeGreaterThan(7);
+                .BeGreaterThan(6);
             options
                 .Length
                 .Should()

shortid/ShortId.cs

@@ -1,17 +1,18 @@
 using System;
 using System.Text;
 using shortid.Configuration;
+using shortid.Utils;
 
 namespace shortid
 {
     public static class ShortId
     {
         // app variables
         private static Random _random = new Random();
-        private const string Bigs = "ABCDEFGHIJKLMNOPQRSTUVWXY";
-        private const string Smalls = "abcdefghjlkmnopqrstuvwxyz";
+        private const string Bigs = "ABCDEFGHIJKLMNPQRSTUVWXY";
+        private const string Smalls = "abcdefghjklmnopqrstuvwxyz";
         private const string Numbers = "0123456789";
-        private const string Specials = "-_";
+        private const string Specials = "_-";
         private static string _pool = $"{Smalls}{Bigs}";
 
         // thread management variables
@@ -85,21 +86,13 @@ public static string Generate(GenerationOptions options)
                 throw new ArgumentNullException(nameof(options));
             }
 
-            if (options.Length < 7)
+            if (options.Length < Constants.MinimumAutoLength)
             {
                 throw new ArgumentException(
-                    $"The specified length of {options.Length} is less than the lower limit of 7.");
-            }
-
-            string characterPool;
-            Random rand;
-
-            lock (ThreadLock)
-            {
-                characterPool = _pool;
-                rand = _random;
+                    $"The specified length of {options.Length} is less than the lower limit of {Constants.MinimumAutoLength}.");
             }
 
+            var characterPool = _pool;
             var poolBuilder = new StringBuilder(characterPool);
             if (options.UseNumbers)
             {
@@ -116,8 +109,11 @@ public static string Generate(GenerationOptions options)
             var output = new char[options.Length];
             for (var i = 0; i < options.Length; i++)
             {
-                var charIndex = rand.Next(0, pool.Length);
-                output[i] = pool[charIndex];
+                lock (ThreadLock)
+                {
+                    var charIndex = _random.Next(0, pool.Length);
+                    output[i] = pool[charIndex];
+                }
             }
 
             return new string(output);
@@ -145,7 +141,7 @@ public static void SetCharacters(string characters)
                 }
             }
 
-            if (stringBuilder.Length < 20)
+            if (stringBuilder.Length < Constants.MinimumCharacterSetLength)
             {
                 throw new InvalidOperationException(
                     "The replacement characters must be at least 20 letters in length and without whitespace.");

shortid/Utils/Constants.cs

@@ -5,5 +5,7 @@ internal static class Constants
         public const int MinimumAutoLength = 7;
 
         public const int MaximumAutoLength = 15;
+
+        public const int MinimumCharacterSetLength = 20;
     }
 }

shortid/shortid.csproj

@@ -8,13 +8,16 @@
     <PackageIconUrl>https://members.orcid.org/sites/default/files/vector_iD_icon.svg</PackageIconUrl>
     <RepositoryUrl>https://github.com/bolorundurowb/shortid/</RepositoryUrl>
     <PackageTags>shortid short id databse identifier key primarykey mongodb sql</PackageTags>
-    <PackageReleaseNotes>- add in options validation</PackageReleaseNotes>
+    <PackageReleaseNotes>- fix- random usages</PackageReleaseNotes>
     <Authors>Bolorunduro Winner-Timothy</Authors>
     <Description>A library that generates random identifiers from 7 to 14 characters. Identifiers generated can be used as primary keys for databases or unique identifiers.</Description>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <Title>shortid</Title>
     <RepositoryType>git</RepositoryType>
-    <PackageVersion>2.0.3</PackageVersion>
+    <PackageVersion>2.0.4</PackageVersion>
+    <AssemblyVersion>2.0.4.0</AssemblyVersion>
+    <FileVersion>2.0.4.0</FileVersion>
+    <NeutralLanguage>en-NG</NeutralLanguage>
   </PropertyGroup>
 </Project>