Last bits of tidying.

trichards57 · Oct 28, 2020 · fa8dec9 · fa8dec9
1 parent 5d10039
commit fa8dec9
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 41 deletions.
diff --git a/zxcvbn-core-list-builder/GlobalSuppressions.cs b/zxcvbn-core-list-builder/GlobalSuppressions.cs
@@ -0,0 +1,14 @@
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1101:Prefix local calls with this", Justification = "To match this project's coding style.")]
+[assembly: SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1200:Using directives should be placed correctly", Justification = "To match this project's coding style.")]
+[assembly: SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1503:Braces should not be omitted", Justification = "To match this project's coding style.")]
+[assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "This normalization isn't security critical.")]
+[assembly: SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1208:System using directives should be placed before other using directives", Justification = "Using CodeMaid for this task.")]
+[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "This isn't actually publicly released.")]
+[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1633:File should have header", Justification = "No header required.")]
diff --git a/zxcvbn-core-list-builder/ListBuilder.cs b/zxcvbn-core-list-builder/ListBuilder.cs
@@ -1,32 +1,37 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.IO;
 using System.Linq;
 
-namespace zxcvbn_core_list_builder
+namespace Zxcvbn.ListBuilder
 {
     internal static class ListBuilder
     {
         /// <summary>
         /// Returns the maximum number of words for a dictionary.
         /// null means take everything.
         /// </summary>
-        private static readonly Dictionary<string, int?> _dictionaryLimits = new Dictionary<string, int?>
+        private static readonly ReadOnlyDictionary<string, int?> DictionaryLimits = new ReadOnlyDictionary<string, int?>(new Dictionary<string, int?>
         {
             { "us_tv_and_film", 30000 },
             { "english", 30000 },
             { "passwords", 30000 },
             { "surnames", 10000 },
             { "male_names", null },
             { "female_names", null },
-        };
+        });
 
         /// <summary>
         /// Filters the frequency lists to remove:
         /// - Tokens which are short and rare
         /// - Tokens that are already in another dictionary and a lower rank
-        /// - Tokens that end up beyond the end of the limits in <see cref="_dictionaryLimits"/>
+        /// - Tokens that end up beyond the end of the limits in <see cref="DictionaryLimits"/>.
         /// </summary>
+        /// <param name="frequencyLists">The list to filter.</param>
+        /// <returns>
+        /// The filtered output.
+        /// </returns>
         public static Dictionary<string, List<string>> FilterFrequencyLists(Dictionary<string, Dictionary<string, int>> frequencyLists)
         {
             var filteredTokenAndRank = new Dictionary<string, Dictionary<string, int>>();
@@ -53,7 +58,7 @@ internal static class ListBuilder
                         minimumValues[token] = new RankDictionaryName
                         {
                             Name = name,
-                            Rank = rank
+                            Rank = rank,
                         };
                     }
                     else
@@ -63,7 +68,7 @@ internal static class ListBuilder
                             minimumValues[token] = new RankDictionaryName
                             {
                                 Rank = rank,
-                                Name = name
+                                Name = name,
                             };
                         }
                     }
@@ -80,7 +85,7 @@ internal static class ListBuilder
 
                     if (token == "o")
                     {
-                        Console.Write("");
+                        Console.Write(string.Empty);
                     }
 
                     if (minimumValues[token].Name != name)
@@ -99,8 +104,8 @@ internal static class ListBuilder
                 var name = kvp.Key;
                 var values = kvp.Value;
                 var res = values.OrderBy(s => s.Value).Select(kvp => kvp.Key);
-                if (_dictionaryLimits[name].HasValue)
-                    res = res.Take(_dictionaryLimits[name].Value);
+                if (DictionaryLimits[name].HasValue)
+                    res = res.Take(DictionaryLimits[name].Value);
                 result[name] = res.ToList();
             }
 
@@ -114,7 +119,7 @@ internal static class ListBuilder
             foreach (var file in Directory.GetFiles(directory))
             {
                 var name = Path.GetFileNameWithoutExtension(file);
-                if (!_dictionaryLimits.ContainsKey(name))
+                if (!DictionaryLimits.ContainsKey(name))
                 {
                     Console.WriteLine($"Warning: {name} is in directory {directory} but was not expected.  Skipped.");
                     continue;
@@ -129,10 +134,11 @@ internal static class ListBuilder
                     var token = line.Split(" ")[0];
                     tokenToRank[token] = rank;
                 }
+
                 result[name] = tokenToRank;
             }
 
-            foreach (var expectedKey in _dictionaryLimits.Keys)
+            foreach (var expectedKey in DictionaryLimits.Keys)
             {
                 if (!result.ContainsKey(expectedKey))
                 {

diff --git a/zxcvbn-core-list-builder/Program.cs b/zxcvbn-core-list-builder/Program.cs
@@ -2,7 +2,7 @@
 using System.IO;
 using System.Reflection;
 
-namespace zxcvbn_core_list_builder
+namespace Zxcvbn.ListBuilder
 {
     internal class Program
     {

diff --git a/zxcvbn-core-list-builder/RankDictionaryName.cs b/zxcvbn-core-list-builder/RankDictionaryName.cs
@@ -1,8 +1,9 @@
-namespace zxcvbn_core_list_builder
+namespace Zxcvbn.ListBuilder
 {
     internal struct RankDictionaryName
     {
         public string Name { get; set; }
+
         public int Rank { get; set; }
     }
 }
diff --git a/zxcvbn-core-list-builder/zxcvbn-core-list-builder.csproj b/zxcvbn-core-list-builder/zxcvbn-core-list-builder.csproj
@@ -3,7 +3,14 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-    <RootNamespace>zxcvbn_core_list_builder</RootNamespace>
+    <RootNamespace>Zxcvbn.ListBuilder</RootNamespace>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 </Project>
diff --git a/zxcvbn-core-test/GlobalSuppressions.cs b/zxcvbn-core-test/GlobalSuppressions.cs
@@ -8,6 +8,7 @@
 [assembly: SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1101:Prefix local calls with this", Justification = "To match this project's coding style.")]
 [assembly: SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1200:Using directives should be placed correctly", Justification = "To match this project's coding style.")]
 [assembly: SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1503:Braces should not be omitted", Justification = "To match this project's coding style.")]
-[assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "This normalization isn't security critical")]
+[assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "This normalization isn't security critical.")]
 [assembly: SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1208:System using directives should be placed before other using directives", Justification = "Using CodeMaid for this task.")]
-[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "This isn't actually publicly released")]
+[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "This isn't actually publicly released.")]
+[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1633:File should have header", Justification = "No header required.")]
diff --git a/zxcvbn-core/GlobalSuppressions.cs b/zxcvbn-core/GlobalSuppressions.cs
@@ -9,3 +9,4 @@
 [assembly: SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1200:Using directives should be placed correctly", Justification = "To match this project's coding style.")]
 [assembly: SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1503:Braces should not be omitted", Justification = "To match this project's coding style.")]
 [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "This normalization isn't security critical")]
+[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1633:File should have header", Justification = "No header required.")]
diff --git a/zxcvbn-core/Matcher/L33tMatcher.cs b/zxcvbn-core/Matcher/L33tMatcher.cs
@@ -11,25 +11,6 @@ namespace Zxcvbn.Matcher
     /// </summary>
     internal class L33tMatcher : IMatcher
     {
-        /// <summary>
-        /// The table of l33t transforms.
-        /// </summary>
-        internal static ReadOnlyDictionary<char, char[]> L33tTable = new ReadOnlyDictionary<char, char[]>(new Dictionary<char, char[]>
-        {
-            ['a'] = new[] { '4', '@' },
-            ['b'] = new[] { '8' },
-            ['c'] = new[] { '(', '{', '[', '<' },
-            ['e'] = new[] { '3' },
-            ['g'] = new[] { '6', '9' },
-            ['i'] = new[] { '1', '!', '|' },
-            ['l'] = new[] { '1', '|', '7' },
-            ['o'] = new[] { '0' },
-            ['s'] = new[] { '$', '5' },
-            ['t'] = new[] { '+', '7' },
-            ['x'] = new[] { '%' },
-            ['z'] = new[] { '2' },
-        });
-
         private readonly IEnumerable<IMatcher> dictionaryMatchers;
 
         /// <summary>
@@ -52,6 +33,25 @@ public L33tMatcher(DictionaryMatcher dictionaryMatcher)
         {
         }
 
+        /// <summary>
+        /// Gets or sets the table of l33t transforms.
+        /// </summary>
+        internal static ReadOnlyDictionary<char, char[]> L33tTable { get; set; } = new ReadOnlyDictionary<char, char[]>(new Dictionary<char, char[]>
+        {
+            ['a'] = new[] { '4', '@' },
+            ['b'] = new[] { '8' },
+            ['c'] = new[] { '(', '{', '[', '<' },
+            ['e'] = new[] { '3' },
+            ['g'] = new[] { '6', '9' },
+            ['i'] = new[] { '1', '!', '|' },
+            ['l'] = new[] { '1', '|', '7' },
+            ['o'] = new[] { '0' },
+            ['s'] = new[] { '$', '5' },
+            ['t'] = new[] { '+', '7' },
+            ['x'] = new[] { '%' },
+            ['z'] = new[] { '2' },
+        });
+
         /// <summary>
         /// Find l33t dictionary matches in <paramref name="password"/>.
         /// </summary>

diff --git a/zxcvbn-core/Matcher/SpatialMatcher.cs b/zxcvbn-core/Matcher/SpatialMatcher.cs
@@ -15,7 +15,7 @@ internal class SpatialMatcher : IMatcher
         private const string ShiftedRegex = "[~!@#$%^&*()_+QWERTYUIOP{}|ASDFGHJKL:\"ZXCVBNM<>?]";
 
         /// <summary>
-        /// Gets the spatial graphs to match against.
+        /// Gets or sets the spatial graphs to match against.
         /// </summary>
         internal static ReadOnlyCollection<SpatialGraph> SpatialGraphs { get; set; } = GenerateSpatialGraphs();
 
@@ -61,11 +61,13 @@ 0 .
   0 .
 ";
 
-            return new List<SpatialGraph> { new SpatialGraph("qwerty", qwerty, true),
-                    new SpatialGraph("dvorak", dvorak, true),
-                    new SpatialGraph("keypad", keypad, false),
-                    new SpatialGraph("mac_keypad", macKeypad, false),
-                }.AsReadOnly();
+            return new List<SpatialGraph>
+            {
+                new SpatialGraph("qwerty", qwerty, true),
+                new SpatialGraph("dvorak", dvorak, true),
+                new SpatialGraph("keypad", keypad, false),
+                new SpatialGraph("mac_keypad", macKeypad, false),
+            }.AsReadOnly();
         }
 
         private static IEnumerable<Matches.Match> SpatialMatch(SpatialGraph graph, string password)