Closes #11: Merge branch '#11-missing-config' into main

Author: colinangusmackay

src/.idea/.idea.Stravaig.ShortCode/.idea/riderModule.iml

@@ -17,7 +17,6 @@ public Config()
         }
 
         private ulong[] _codes = new ulong[1];
-        private IEncoder _defaultEncoder;
 
         [Params(3, 5, 7, 9)]
         public int FixedLength { get; set; }

src/Stravaig.ShortCode.Benchmarks/EncoderBenchmarks.cs

@@ -5,8 +5,8 @@ namespace Stravaig.ShortCode.Benchmarks
 {
     public class EncoderVariantBenchmarks
     {
-        private ulong[] _codes = new ulong[1024];
-        private int _index = 0;
+        private readonly ulong[] _codes = new ulong[1024];
+        private int _index;
         private Encoder _baselineEncoder = new Encoder(NamedCharacterSpaces.ReducedAmbiguity);
         private Encoder1 _encoder1 = new Encoder1(NamedCharacterSpaces.ReducedAmbiguity);
         private Encoder2 _encoder2 = new Encoder2(NamedCharacterSpaces.ReducedAmbiguity);

src/Stravaig.ShortCode.Benchmarks/EncoderVariantBenchmarks.cs

@@ -0,0 +1,100 @@
+using System;
+using NUnit.Framework;
+using Shouldly;
+
+namespace Stravaig.ShortCode.Tests
+{
+    [TestFixture]
+    public class ShortCodeOptionsTests
+    {
+        [Test]
+        public void Ctor_ProducesReasonableValues()
+        {
+            ShortCodeOptions opts = new ShortCodeOptions();
+            opts.Generator.ShouldNotBeNull();
+            opts.Generator.ShouldBeEmpty();
+            opts.CharacterSpace.ShouldBe(NamedCharacterSpaces.ReducedAmbiguity);
+            opts.FixedLength.ShouldBeNull();
+            opts.MaxLength.ShouldBe(64);
+        }
+
+        [Test]
+        [TestCase(null)]
+        [TestCase("")]
+        [TestCase("      ")]
+        [TestCase("A")]
+        public void SetCharacterSpace_InvalidValues_ThrowsException(string value)
+        {
+            Should.Throw<ArgumentException>(() =>
+                new ShortCodeOptions()
+                {
+                    CharacterSpace = value,
+                }).ParamName.ShouldBe("CharacterSpace");
+        }
+        
+        [Test]
+        [TestCase("AB")]
+        [TestCase(NamedCharacterSpaces.LettersAndDigits)]
+        public void SetCharacterSpace_ValidValues_GetsSameValue(string value)
+        {
+            var opts = new ShortCodeOptions()
+            {
+                CharacterSpace = value,
+            };
+            opts.CharacterSpace.ShouldBe(value);
+        }
+
+        [Test]
+        [TestCase(-1)]
+        [TestCase(0)]
+        [TestCase(65)]
+        public void SetFixedLength_InvalidValues_ThrowsException(int? value)
+        {
+            Should.Throw<ArgumentException>(() =>
+                new ShortCodeOptions()
+                {
+                    FixedLength = value,
+                }).ParamName.ShouldBe("FixedLength");
+        }
+        
+        [Test]
+        [TestCase(null)]
+        [TestCase(1)]
+        [TestCase(64)]
+        public void SetFixedLength_ValidValues_GetsSameValue(int? value)
+        {
+            var opts = new ShortCodeOptions()
+            {
+                FixedLength = value,
+            };
+            opts.FixedLength.ShouldBe(value);
+        }
+        
+        [Test]
+        [TestCase(-1)]
+        [TestCase(0)]
+        [TestCase(65)]
+        public void SetMaxLength_InvalidValues_ThrowsException(int value)
+        {
+            Should.Throw<ArgumentException>(() =>
+                new ShortCodeOptions
+                {
+                    MaxLength = value,
+                }).ParamName.ShouldBe("MaxLength");
+        }
+        
+        [Test]
+        [TestCase(1)]
+        [TestCase(10)]
+        [TestCase(64)]
+        public void SetMaxLength_ValidValues_GetsSameValue(int value)
+        {
+            var opts = new ShortCodeOptions
+            {
+                MaxLength = value,
+            };
+            opts.MaxLength.ShouldBe(value);
+        }
+
+    }
+}

src/Stravaig.ShortCode.Tests/ShortCodeOptionsTests.cs

@@ -16,6 +16,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "__Build_and_Deploy", "__Bui
 		..\.stravaig\list-contributor-akas.json = ..\.stravaig\list-contributor-akas.json
 		..\Run-Benchmarks.ps1 = ..\Run-Benchmarks.ps1
 		..\build-release-notes.ps1 = ..\build-release-notes.ps1
+		..\version.txt = ..\version.txt
+		..\Set-Version.ps1 = ..\Set-Version.ps1
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "__Documenation", "__Documenation", "{9342FEEB-81FD-48BE-BA72-773C679EB0D1}"

src/Stravaig.ShortCode.sln

@@ -1,5 +1,3 @@
-using System;
-using System.Linq;
 using Microsoft.Extensions.Options;
 using Stravaig.ShortCode.Internal;
 

src/Stravaig.ShortCode/SequentialCodeGenerator.cs

@@ -1,12 +1,60 @@
+using System;
 using System.Collections.Generic;
 
 namespace Stravaig.ShortCode
 {
     public class ShortCodeOptions
     {
-        public string CharacterSpace { get; set; } = Stravaig.ShortCode.NamedCharacterSpaces.ReducedAmbiguity;
-        public int MaxLength { get; set; } = int.MaxValue;
-        public int? FixedLength { get; set; }
+        private const int AbsoluteMinLength = 1;
+        private const int AbsoluteMaxLength = 64;
+        private const int CharacterSpaceMinLength = 2;
+
+        private int _maxLength = AbsoluteMaxLength;
+        private int? _fixedLength;
+        private string _characterSpace = NamedCharacterSpaces.ReducedAmbiguity;
+
+        public string CharacterSpace
+        {
+            get => _characterSpace;
+            set
+            {
+                if (string.IsNullOrWhiteSpace(value))
+                    throw new ArgumentException(
+                        "The value cannot be, null, Empty or contain whitespace.",
+                        nameof(CharacterSpace));
+                if (value.Length < CharacterSpaceMinLength)
+                    throw new ArgumentException(
+                        $"The value must contain at least {CharacterSpaceMinLength} characters.",
+                        nameof(CharacterSpace));
+                _characterSpace = value;
+            }
+        }
+
+        public int MaxLength
+        {
+            get => _maxLength;
+            set
+            {
+                if (value < AbsoluteMinLength || value > AbsoluteMaxLength)
+                    throw new ArgumentOutOfRangeException(
+                        nameof(MaxLength),
+                        $"The value must be between {AbsoluteMinLength} and {AbsoluteMaxLength}.");
+                _maxLength = value;
+            }
+        }
+
+        public int? FixedLength
+        {
+            get => _fixedLength;
+            set
+            {
+                if (value.HasValue && (value.Value < AbsoluteMinLength || value.Value > AbsoluteMaxLength))
+                    throw new ArgumentOutOfRangeException(
+                        nameof(FixedLength),
+                        $"The value, if present, must be between {AbsoluteMinLength} and {AbsoluteMaxLength}");
+                _fixedLength = value;
+            }
+        }
 
         public Dictionary<string, object> Generator { get; set; } = new Dictionary<string, object>();
     }