Merge pull request #135 from Stravaig-Projects/#129/yt-style

#129 Add You Tube style short codes

Author: colinangusmackay

.vscode/settings.json

@@ -1,13 +1,14 @@
 {
     "restructuredtext.confPath": "",
     "cSpell.words": [
+        "commitish",
         "Dependabot",
         "Dependabots",
         "Nuget",
-        "Stravaig",
-        "commitish",
         "nupkg",
         "pwsh",
-        "snupkg"
+        "Shouldly",
+        "snupkg",
+        "Stravaig"
     ]
 }

README.md

@@ -70,6 +70,10 @@ There are some configuration methods you can call during your app's startup:
   - `RandomCodeGenerator`: The code is generated from the `Random` class.
   - `CryptographicallyRandomCodeGenerator`: The code is generated using a cryptographic strength random number generator.
 
+Starting from v2, there is a configuration methods for specific configurations. 
+
+- `ShortCode.InitYouTubeStyle(bool)`: The short code is configured to generate short codes in the same style as You Tube, i.e. 11 character URL safe base64 without trailing equal signs.
+
 ## Setting up Short Codes with Microsoft's Dependency Injection
 
 If web apps this will be in your `Startup` class, somewhere in the `ConfigureServices` method. Otherwise it will go wherever you are adding your dependency to the service collection.
@@ -94,6 +98,17 @@ The `options` are not required, and if missing a reasonable set of defaults will
 
 Once set up, in your application code you need to add `IShortCodeFactory` to any class that needs to generate short codes.
 
+### Configuring preset styles
+
+Starting from Version 2, you can set up preset styles of short code.
+
+e.g.
+```csharp
+  services.AddYouTubeStyleShortCodeGenerator<GuidCodeGenerator>();
+```
+
+This will set up the short code factory to generate codes that are like those used on You Tube, i.e. 11 character, base64 like without trailing equals signs.
+
 ### SequentialCodeGenerator
 
 This generator takes additional options as it will reset to zero on each application run (which may not be desirable).

release-notes/wip-release-notes.md

@@ -4,15 +4,15 @@
 
 Date: ???
 
-### Bugs
-
 ### Features
 
+- #129: Add built in settings for You Tube style (11-char base64-like) short codes.
+
 ### Miscellaneous
 
 - #127: Add support for .NET 8.0
 - #128: Drop support for .NET Core 3.1 and .NET 5.0. For these projects use v1.x.
 
 ### Dependencies
 
-
+- Updated SourceLink to 8.0.0

src/Example/Program.cs

@@ -13,7 +13,8 @@ static void Main()
             var config = BuildConfig();
 
             ServiceCollection services = new ServiceCollection();
-            services.AddShortCodeGenerator<SequentialCodeGenerator>(config);
+            services.AddYouTubeStyleShortCodeGenerator<RandomCodeGenerator>();
+            //services.AddShortCodeGenerator<SequentialCodeGenerator>(config);
 
             ServiceProvider provider = services.BuildServiceProvider();
             var factory = provider.GetRequiredService<IShortCodeFactory>();

src/Stravaig.ShortCode.DependencyInjection/ServiceProviderExtensions.cs

@@ -7,6 +7,13 @@ namespace Stravaig.ShortCode.DependencyInjection
 {
     public static class ServiceProviderExtensions
     {
+        public static IServiceCollection AddYouTubeStyleShortCodeGenerator<TGenerator>(
+            this IServiceCollection services)
+            where TGenerator : class, IShortCodeGenerator
+        {
+            return services.AddShortCodeGenerator<TGenerator>(opts => opts.SetYouTubeStyle());
+        }
+
         public static IServiceCollection AddShortCodeGenerator<TGenerator>(
             this IServiceCollection services,
             Action<ShortCodeOptions> options = null)

src/Stravaig.ShortCode.Tests/ShortCodeFactoryTests.cs

@@ -106,6 +106,23 @@ public void GetNextCode_ShouldReturnCode()
             Console.WriteLine(result);
             result.Length.ShouldBe(5);
         }
+
+        [Test]
+        public void GetNextCode_WithYouTubeOptionsShouldYouTubeStyleCode()
+        {
+            var options = new ShortCodeOptions();
+            options.SetYouTubeStyle();
+
+            var factory = new ShortCodeFactory(
+                new GuidCodeGenerator(),
+                new Encoder(NamedCharacterSpaces.ReducedAmbiguity),
+                options,
+                new NullLogger<ShortCodeFactory>());
+
+            var result = factory.GetNextCode();
+            Console.WriteLine(result);
+            result.Length.ShouldBe(11);
+        }
 
         [TestCase(1)]
         [TestCase(5)]

src/Stravaig.ShortCode.Tests/ShortCodeTests.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using NUnit.Framework;
 using Shouldly;
@@ -33,6 +34,27 @@ public void DefaultSettings_HappyPath()
             randomCode2.Length.ShouldBe(7);
             randomCode1.ShouldNotBe(randomCode2);
         }
+
+        [Test]
+        public void YouTubeStyleSettings_HappyPath()
+        {
+            ShortCode.InitYouTubeStyle(resetGenerators: true);
+
+            var sequentialCode1 = ShortCode.GenerateSequentialShortCode();
+            sequentialCode1.Length.ShouldBe(11);
+            sequentialCode1.ShouldBe("AAAAAAAAAAB");
+            
+            var sequentialCode2 = ShortCode.GenerateSequentialShortCode();
+            sequentialCode2.Length.ShouldBe(11);
+            sequentialCode2.ShouldBe("AAAAAAAAAAC");
+
+            var randomCode1 = ShortCode.GenerateRandomShortCode();
+            randomCode1.Length.ShouldBe(11);
+
+            var randomCode2 = ShortCode.GenerateRandomShortCode();
+            randomCode2.Length.ShouldBe(11);
+            randomCode1.ShouldNotBe(randomCode2);
+        }
 
         [Test]
         [TestCaseSource(sourceName: nameof(Lengths))]
@@ -103,6 +125,48 @@ public void Use_SetsTheInternalGeneratorToCryptographicallyRandom()
             generator.ShouldBeOfType(typeof(CryptographicallyRandomCodeGenerator));
         }
 
+        [Test]
+        public void InitYouTubeStyle_ShouldSetupForYouTubeStyle()
+        {
+            // arrange
+            dynamic shortCode = typeof(ShortCode).Jailbreak();
+            var originalRandGenerator = (IShortCodeGenerator)shortCode._randomGenerator;
+            var originalSeqGenerator = (IShortCodeGenerator)shortCode._sequentialCodeGenerator;
+
+            // Act
+            ShortCode.InitYouTubeStyle();
+
+            // Assert
+            ((int)shortCode._defaultLength).ShouldBe(11);
+            ((IShortCodeGenerator)shortCode._randomGenerator).ShouldBe(originalRandGenerator);
+            ((IShortCodeGenerator)shortCode._sequentialCodeGenerator).ShouldBe(originalSeqGenerator);
+
+            dynamic encoder = ((Encoder)shortCode._encoder).Jailbreak();
+            var characterSpace = (string)encoder._characterSpace;
+            characterSpace.ShouldBe(NamedCharacterSpaces.UrlSafeBase64);
+        }
+
+        [Test]
+        public void InitYouTubeStyleWithReset_ShouldSetupForYouTubeStyle()
+        {
+            // arrange
+            dynamic shortCode = typeof(ShortCode).Jailbreak();
+            var originalRandGenerator = (IShortCodeGenerator)shortCode._randomGenerator;
+            var originalSeqGenerator = (IShortCodeGenerator)shortCode._sequentialCodeGenerator;
+
+            // Act
+            ShortCode.InitYouTubeStyle(resetGenerators: true);
+
+            // Assert
+            ((int)shortCode._defaultLength).ShouldBe(11);
+            ((IShortCodeGenerator)shortCode._randomGenerator).ShouldNotBe(originalRandGenerator);
+            ((IShortCodeGenerator)shortCode._sequentialCodeGenerator).ShouldNotBe(originalSeqGenerator);
+
+            dynamic encoder = ((Encoder)shortCode._encoder).Jailbreak();
+            var characterSpace = (string)encoder._characterSpace;
+            characterSpace.ShouldBe(NamedCharacterSpaces.UrlSafeBase64);
+        }
+
         private static IEnumerable<int> Lengths()
         {
             for (int i = 1; i <= 9; i++)

src/Stravaig.ShortCode/NamedCharacterSpaces.cs

@@ -12,6 +12,8 @@ public class NamedCharacterSpaces
         public const string LettersAndDigits = LatinLetters + Digits;
         public const string ReducedAmbiguity = "ABCDEFGHJKLMNPRTUVWXY2346789";
 
+        public const string UrlSafeBase64 = UpperLatinLetters + LowerLatinLetters + Digits + "-_";
+
         public static readonly IReadOnlyDictionary<string, string> SpaceToName = new Dictionary<string, string>
         {
             {Digits, nameof(Digits)},
@@ -21,6 +23,7 @@ public class NamedCharacterSpaces
             {LatinLetters, nameof(LatinLetters)},
             {LettersAndDigits, nameof(LettersAndDigits)},
             {ReducedAmbiguity, nameof(ReducedAmbiguity)},
+            {UrlSafeBase64, nameof(UrlSafeBase64)},
         };
     }
 }

src/Stravaig.ShortCode/ShortCode.cs

@@ -21,6 +21,17 @@ private static void Init()
             _sequentialCodeGenerator = new SequentialCodeGenerator();
             _randomGenerator = new CryptographicallyRandomCodeGenerator();
         }
+
+        public static void InitYouTubeStyle(bool resetGenerators = false)
+        {
+            _defaultLength = 11;
+            _encoder = new Encoder(NamedCharacterSpaces.UrlSafeBase64);
+            if (resetGenerators)
+            {
+                _sequentialCodeGenerator = new SequentialCodeGenerator();
+                _randomGenerator = new CryptographicallyRandomCodeGenerator();
+            }
+        }
 
         public static string GenerateSequentialShortCode(int? length = null)
         {

src/Stravaig.ShortCode/ShortCodeOptions.cs

@@ -57,5 +57,12 @@ public int? FixedLength
         }
 
         public Dictionary<string, object> Generator { get; set; } = new Dictionary<string, object>();
+    
+        public void SetYouTubeStyle()
+        {
+            CharacterSpace = NamedCharacterSpaces.UrlSafeBase64;
+            MaxLength = 11;
+            FixedLength = 11;
+        }
     }
 }