Ensured localization consistency with IFormatProvider

JeremyCaney · JeremyCaney · commit d52a7a1335e9 · 2020-11-24T13:24:19.000-08:00
Where appropriate, implemented the `IFormatProvider` overload to ensure consistent behavior regardless of the browser's locale settings. This resolves CA1305.
diff --git a/OnTopic.Editor.AspNetCore/Components/LastModifiedViewComponent.cs b/OnTopic.Editor.AspNetCore/Components/LastModifiedViewComponent.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
+using System.Globalization;
 using Microsoft.AspNetCore.Mvc;
 using OnTopic.Editor.Models;
 using OnTopic.Editor.Models.Components.ViewModels;
@@ -61,12 +62,12 @@ string htmlFieldPrefix
       | Set model values
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (currentTopic.LastModified != DateTime.MinValue) {
-        model.CurrentValue      = currentTopic.LastModified.ToString();
+        model.CurrentValue      = currentTopic.LastModified.ToString(CultureInfo.InvariantCulture);
       }
       else {
         model.CurrentValue      = model.Value;
       }
-      model.Value               = DateTime.Now.ToString();
+      model.Value               = DateTime.Now.ToString(CultureInfo.InvariantCulture);
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Return view with view model
diff --git a/OnTopic.Editor.AspNetCore/Components/TokenizedTopicListViewComponent.cs b/OnTopic.Editor.AspNetCore/Components/TokenizedTopicListViewComponent.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
+using System.Globalization;
 using Microsoft.AspNetCore.Mvc;
 using OnTopic.Editor.Models;
 using OnTopic.Editor.Models.Components.ViewModels;
@@ -125,7 +126,7 @@ private string GetTopicJson(string topicId) {
     | Set initial variables
     \---------------------------------------------------------------------------------------------------------------------------*/
       var topicJson               = "";
-      var topic                   = _topicRepository.Load(Int32.Parse(topicId));
+      var topic                   = _topicRepository.Load(Int32.Parse(topicId, CultureInfo.InvariantCulture));
 
     /*----------------------------------------------------------------------------------------------------------------------------
     | Write out JSON for existing topic, if available
diff --git a/OnTopic.Editor.AspNetCore/Components/TopicListViewComponent.cs b/OnTopic.Editor.AspNetCore/Components/TopicListViewComponent.cs
@@ -5,6 +5,7 @@
 \=============================================================================================================================*/
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Rendering;
@@ -228,7 +229,7 @@ public static List<QueryResultTopicViewModel> GetTopics(
     private static string ReplaceTokens(QueryResultTopicViewModel topic, string source) {
       if (topic is not null && !String.IsNullOrEmpty(source)) {
         source = source
-          .Replace("{TopicId}", topic.Id.ToString(), StringComparison.InvariantCultureIgnoreCase)
+          .Replace("{TopicId}", topic.Id.ToString(CultureInfo.InvariantCulture), StringComparison.InvariantCultureIgnoreCase)
           .Replace("{Key}", topic.Key, StringComparison.InvariantCultureIgnoreCase)
           .Replace("{UniqueKey}", topic.UniqueKey, StringComparison.InvariantCultureIgnoreCase)
           .Replace("{WebPath}", topic.WebPath, StringComparison.InvariantCultureIgnoreCase)
diff --git a/OnTopic.Editor.AspNetCore/Controllers/EditorController.cs b/OnTopic.Editor.AspNetCore/Controllers/EditorController.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
+using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -257,7 +258,7 @@ public async Task<IActionResult> Edit(
       var parentTopic           = isNew? CurrentTopic : CurrentTopic.Parent;
       var contentTypeDescriptor = GetContentType(contentType?? CurrentTopic.ContentType);
       var derivedTopicValue     = model.Attributes.Contains("TopicID")? model.Attributes["TopicID"].Value : "-1";
-      var derivedTopicId        = String.IsNullOrWhiteSpace(derivedTopicValue)? -1 : Int32.Parse(derivedTopicValue);
+      var derivedTopicId        = String.IsNullOrWhiteSpace(derivedTopicValue)? -1 : Int32.Parse(derivedTopicValue, CultureInfo.InvariantCulture);
       var derivedTopic          = (derivedTopicId >= 0)? TopicRepository.Load(derivedTopicId) : null;
       var newKey                = model.Attributes.Contains("Key")? model.Attributes["Key"].Value : null;
 
diff --git a/OnTopic.Editor.AspNetCore/Infrastructure/TopicQueryService.cs b/OnTopic.Editor.AspNetCore/Infrastructure/TopicQueryService.cs
@@ -152,12 +152,13 @@ public static bool IsValidTopic(Topic topic, TopicQueryOptions options) {
       | Validate filtered attribute
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (!String.IsNullOrEmpty(options.AttributeName) && !String.IsNullOrEmpty(options.AttributeName)) {
+        var attributeValue = topic.Attributes.GetValue(options.AttributeName, "");
         if (options.UsePartialMatch) {
-          if (topic.Attributes.GetValue(options.AttributeName, "").IndexOf(options.AttributeValue) is -1) {
+          if (attributeValue.IndexOf(options.AttributeValue, StringComparison.Ordinal) is -1) {
             return false;
           }
         }
-        if (!topic.Attributes.GetValue(options.AttributeName, "").Equals(options.AttributeValue)) {
+        if (!attributeValue.Equals(options.AttributeValue)) {
           return false;
         }
       }
diff --git a/OnTopic.Editor.Models/Components/ViewModels/DateTimeAttributeViewModel.cs b/OnTopic.Editor.Models/Components/ViewModels/DateTimeAttributeViewModel.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
+using System.Globalization;
 using OnTopic.Editor.Models.Metadata;
 
 namespace OnTopic.Editor.Models.Components.ViewModels {
@@ -23,6 +24,7 @@ public class DateTimeAttributeViewModel: AttributeViewModel<DateTimeAttributeTop
     \-------------------------------------------------------------------------------------------------------------------------*/
     private                     string                          _defaultDate;
     private                     string                          _defaultTime;
+    private readonly            IFormatProvider                 _format                         = CultureInfo.InvariantCulture;
 
     /*==========================================================================================================================
     | CONSTRUCTOR
@@ -54,11 +56,11 @@ public string GetDefaultDate() {
         var dateFormat = AttributeDescriptor.DateFormat.Replace("y", "yy").Replace("mm", "MM");
         if (!String.IsNullOrEmpty(Value)) {
           if (DateTime.TryParse(Value, out var dateValue)) {
-            _defaultDate        = dateValue.ToString(dateFormat);
+            _defaultDate        = dateValue.ToString(dateFormat, _format);
           }
         }
         else {
-          _defaultDate          = CalculateOffset(DateTime.Now).ToString(dateFormat);
+          _defaultDate          = CalculateOffset(DateTime.Now).ToString(dateFormat, _format);
         }
       }
       return _defaultDate;
@@ -74,11 +76,11 @@ public string GetDefaultTime() {
       if (String.IsNullOrEmpty(_defaultTime)) {
         if (!String.IsNullOrEmpty(Value)) {
           if (DateTime.TryParse(Value, out var timeValue)) {
-            _defaultTime        = timeValue.ToString(AttributeDescriptor.TimeFormat);
+            _defaultTime        = timeValue.ToString(AttributeDescriptor.TimeFormat, _format);
           }
         }
         else {
-          _defaultTime          = CalculateOffset(DateTime.Now).ToString(AttributeDescriptor.TimeFormat);
+          _defaultTime          = CalculateOffset(DateTime.Now).ToString(AttributeDescriptor.TimeFormat, _format);
         }
       }
       return _defaultTime;
diff --git a/OnTopic.Editor.Models/Metadata/AttributeDescriptorTopicViewModel.cs b/OnTopic.Editor.Models/Metadata/AttributeDescriptorTopicViewModel.cs
@@ -5,6 +5,7 @@
 \=============================================================================================================================*/
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using OnTopic.Metadata;
 using OnTopic.Metadata.AttributeTypes;
@@ -153,7 +154,7 @@ public bool GetBooleanConfigurationValue(string key, bool defaultValue = false)
       "AttributeDescriptor."
     )]
     public int GetIntegerConfigurationValue(string key, int defaultValue = 0) {
-      if (Int32.TryParse(GetConfigurationValue(key, defaultValue.ToString()), out var value)) {
+      if (Int32.TryParse(GetConfigurationValue(key, defaultValue.ToString(CultureInfo.InvariantCulture)), out var value)) {
         return value;
       }
       return defaultValue;

Original file line number	Diff line number	Diff line change
`@@ -152,12 +152,13 @@ public static bool IsValidTopic(Topic topic, TopicQueryOptions options) {`
`152`	`152`	`\| Validate filtered attribute`
`153`	`153`	`\-----------------------------------------------------------------------------------------------------------------------*/`
`154`	`154`	`if (!String.IsNullOrEmpty(options.AttributeName) && !String.IsNullOrEmpty(options.AttributeName)) {`
	`155`	`+ var attributeValue = topic.Attributes.GetValue(options.AttributeName, "");`
`155`	`156`	`if (options.UsePartialMatch) {`
`156`		`- if (topic.Attributes.GetValue(options.AttributeName, "").IndexOf(options.AttributeValue) is -1) {`
	`157`	`+ if (attributeValue.IndexOf(options.AttributeValue, StringComparison.Ordinal) is -1) {`
`157`	`158`	`return false;`
`158`	`159`	`}`
`159`	`160`	`}`
`160`		`- if (!topic.Attributes.GetValue(options.AttributeName, "").Equals(options.AttributeValue)) {`
	`161`	`+ if (!attributeValue.Equals(options.AttributeValue)) {`
`161`	`162`	`return false;`
`162`	`163`	`}`
`163`	`164`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`\| Project Topics Library`
`5`	`5`	`\=============================================================================================================================*/`
`6`	`6`	`using System;`
	`7`	`+using System.Globalization;`
`7`	`8`	`using OnTopic.Editor.Models.Metadata;`
`8`	`9`
`9`	`10`	`namespace OnTopic.Editor.Models.Components.ViewModels {`
`@@ -23,6 +24,7 @@ public class DateTimeAttributeViewModel: AttributeViewModel<DateTimeAttributeTop`
`23`	`24`	`\-------------------------------------------------------------------------------------------------------------------------*/`
`24`	`25`	`private string _defaultDate;`
`25`	`26`	`private string _defaultTime;`
	`27`	`+ private readonly IFormatProvider _format = CultureInfo.InvariantCulture;`
`26`	`28`
`27`	`29`	`/*==========================================================================================================================`
`28`	`30`	`\| CONSTRUCTOR`
`@@ -54,11 +56,11 @@ public string GetDefaultDate() {`
`54`	`56`	`var dateFormat = AttributeDescriptor.DateFormat.Replace("y", "yy").Replace("mm", "MM");`
`55`	`57`	`if (!String.IsNullOrEmpty(Value)) {`
`56`	`58`	`if (DateTime.TryParse(Value, out var dateValue)) {`
`57`		`- _defaultDate = dateValue.ToString(dateFormat);`
	`59`	`+ _defaultDate = dateValue.ToString(dateFormat, _format);`
`58`	`60`	`}`
`59`	`61`	`}`
`60`	`62`	`else {`
`61`		`- _defaultDate = CalculateOffset(DateTime.Now).ToString(dateFormat);`
	`63`	`+ _defaultDate = CalculateOffset(DateTime.Now).ToString(dateFormat, _format);`
`62`	`64`	`}`
`63`	`65`	`}`
`64`	`66`	`return _defaultDate;`
`@@ -74,11 +76,11 @@ public string GetDefaultTime() {`
`74`	`76`	`if (String.IsNullOrEmpty(_defaultTime)) {`
`75`	`77`	`if (!String.IsNullOrEmpty(Value)) {`
`76`	`78`	`if (DateTime.TryParse(Value, out var timeValue)) {`
`77`		`- _defaultTime = timeValue.ToString(AttributeDescriptor.TimeFormat);`
	`79`	`+ _defaultTime = timeValue.ToString(AttributeDescriptor.TimeFormat, _format);`
`78`	`80`	`}`
`79`	`81`	`}`
`80`	`82`	`else {`
`81`		`- _defaultTime = CalculateOffset(DateTime.Now).ToString(AttributeDescriptor.TimeFormat);`
	`83`	`+ _defaultTime = CalculateOffset(DateTime.Now).ToString(AttributeDescriptor.TimeFormat, _format);`
`82`	`84`	`}`
`83`	`85`	`}`
`84`	`86`	`return _defaultTime;`